From 87153b4b9b0daf91295295215360ef57ca2dde8b Mon Sep 17 00:00:00 2001 From: wangdengke2 Date: Wed, 13 Aug 2025 15:59:03 +0000 Subject: [PATCH] dds_api Reviewed-by: Gladkov, Maksim Co-authored-by: wangdengke2 Co-committed-by: wangdengke2 --- docs/dds/api-ref/ALL_META.TXT.json | 139 ++++---- docs/dds/api-ref/CLASS.TXT.json | 207 +++++------ docs/dds/api-ref/dds_api_0020.html | 8 +- docs/dds/api-ref/dds_api_0029.html | 2 +- docs/dds/api-ref/dds_api_0038.html | 4 +- docs/dds/api-ref/dds_api_0120.html | 2 +- docs/dds/api-ref/dds_api_021.html | 2 +- docs/dds/api-ref/dds_api_022.html | 331 ++++++++++++++++++ docs/dds/api-ref/dds_api_023.html | 127 +++++++ docs/dds/api-ref/dds_api_024.html | 176 ++++++++++ docs/dds/api-ref/dds_api_025.html | 155 ++++++++ docs/dds/api-ref/dds_change_history.html | 19 +- docs/dds/api-ref/dds_connect_0002.html | 2 +- docs/dds/api-ref/dds_connect_0003.html | 2 +- docs/dds/api-ref/dds_database_version.html | 6 +- docs/dds/api-ref/dds_instance_mgmt.html | 8 +- .../api-ref/dds_instance_specification.html | 46 +-- .../api-ref/en-us_topic_0000002107112644.html | 176 ---------- .../api-ref/en-us_topic_0000002107272436.html | 155 -------- .../api-ref/en-us_topic_0000002142831253.html | 331 ------------------ 20 files changed, 1037 insertions(+), 861 deletions(-) create mode 100644 docs/dds/api-ref/dds_api_022.html create mode 100644 docs/dds/api-ref/dds_api_023.html create mode 100644 docs/dds/api-ref/dds_api_024.html create mode 100644 docs/dds/api-ref/dds_api_025.html delete mode 100644 docs/dds/api-ref/en-us_topic_0000002107112644.html delete mode 100644 docs/dds/api-ref/en-us_topic_0000002107272436.html delete mode 100644 docs/dds/api-ref/en-us_topic_0000002142831253.html diff --git a/docs/dds/api-ref/ALL_META.TXT.json b/docs/dds/api-ref/ALL_META.TXT.json index 03241479b..4ecd0a145 100644 --- a/docs/dds/api-ref/ALL_META.TXT.json +++ b/docs/dds/api-ref/ALL_META.TXT.json @@ -759,8 +759,8 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000002142831253.html", - "node_id":"en-us_topic_0000002142831253.xml", + "uri":"dds_api_022.html", + "node_id":"dds_api_022.xml", "product_code":"dds", "code":"37", "des":"This API is used to query LTS log configurations.This API is available only for audit logs.URI formatGET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configsPath", @@ -780,10 +780,31 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000002107112644.html", - "node_id":"en-us_topic_0000002107112644.xml", + "uri":"dds_api_023.html", + "node_id":"dds_api_023.xml", "product_code":"dds", "code":"38", + "des":"This API is used to modify the time range within which you are allowed to start a task that affects the running of database instances, for example, the time window for up", + "doc_type":"api", + "kw":"Configuring the Maintenance Window,DB Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dds", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"Yes" + } + ], + "title":"Configuring the Maintenance Window", + "githuburl":"" + }, + { + "uri":"dds_api_024.html", + "node_id":"dds_api_024.xml", + "product_code":"dds", + "code":"39", "des":"After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream. You will", "doc_type":"api", "kw":"Associating an Instance with an LTS Log Stream,DB Instance Management,API Reference", @@ -801,10 +822,10 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000002107272436.html", - "node_id":"en-us_topic_0000002107272436.xml", + "uri":"dds_api_025.html", + "node_id":"dds_api_025.xml", "product_code":"dds", - "code":"39", + "code":"40", "des":"After you have disassociated an instance from an LTS log stream, logs of the instance are not uploaded to the LTS log stream.URI formatDELETE https://{Endpoint}/v3/{proje", "doc_type":"api", "kw":"Disassociating an Instance from an LTS Log Stream,DB Instance Management,API Reference", @@ -825,7 +846,7 @@ "uri":"dds_connect_0001.html", "node_id":"dds_connect_0001.xml", "product_code":"dds", - "code":"40", + "code":"41", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Connection Management", @@ -846,8 +867,8 @@ "uri":"dds_connect_0002.html", "node_id":"dds_connect_0002.xml", "product_code":"dds", - "code":"41", - "des":"This API is used to query sessions of instance nodes.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nod", + "code":"42", + "des":"This API is used to query sessions of instance nodes.Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nod", "doc_type":"api", "kw":"Querying Sessions of an Instance Node,Connection Management,API Reference", "search_title":"", @@ -867,8 +888,8 @@ "uri":"dds_connect_0003.html", "node_id":"dds_connect_0003.xml", "product_code":"dds", - "code":"42", - "des":"This API is used to kill sessions of an instance node.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.Inactive sessions cannot be terminated.URI formatPO", + "code":"43", + "des":"This API is used to kill sessions of an instance node.Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.Inactive sessions cannot be terminated.URI formatPO", "doc_type":"api", "kw":"Killing Sessions of an Instance Node,Connection Management,API Reference", "search_title":"", @@ -888,7 +909,7 @@ "uri":"dds_connect_0004.html", "node_id":"dds_connect_0004.xml", "product_code":"dds", - "code":"43", + "code":"44", "des":"This API is used to query the number of connections from each client to DDS DB instances.Frozen instances do not support this operation.URI formatGET https://{Endpoint}/v", "doc_type":"api", "kw":"Querying the Number of Connections to an Instance Node,Connection Management,API Reference", @@ -909,7 +930,7 @@ "uri":"dds_backup_restore.html", "node_id":"dds_backup_restore.xml", "product_code":"dds", - "code":"44", + "code":"45", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Backup and Restoration", @@ -930,7 +951,7 @@ "uri":"dds_api_0027.html", "node_id":"dds_api_0027.xml", "product_code":"dds", - "code":"45", + "code":"46", "des":"This API is used to create a manual backup for a DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/backupsPOST https://{Endpoint}/v3/{project_id}/backupsParam", "doc_type":"api", "kw":"Creating a Manual Backup,Backup and Restoration,API Reference", @@ -951,7 +972,7 @@ "uri":"dds_api_0028.html", "node_id":"dds_api_0028.xml", "product_code":"dds", - "code":"46", + "code":"47", "des":"This API is used to delete a manual backup for a DB instance.URI formatDELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}DELETE https://{Endpoint}/v3/{project_", "doc_type":"api", "kw":"Deleting a Manual Backup,Backup and Restoration,API Reference", @@ -972,7 +993,7 @@ "uri":"dds_api_0029.html", "node_id":"dds_api_0029.xml", "product_code":"dds", - "code":"47", + "code":"48", "des":"This API is used to query backups based on specified conditions.URI formatGET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&b", "doc_type":"api", "kw":"Querying the Backup List,Backup and Restoration,API Reference", @@ -993,7 +1014,7 @@ "uri":"dds_api_0030.html", "node_id":"dds_api_0030.xml", "product_code":"dds", - "code":"48", + "code":"49", "des":"This API is used to query an automated backup policy.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyGET https://{Endpoint}/v3/{pro", "doc_type":"api", "kw":"Querying an Automated Backup Policy,Backup and Restoration,API Reference", @@ -1014,7 +1035,7 @@ "uri":"dds_api_0031.html", "node_id":"dds_api_0031.xml", "product_code":"dds", - "code":"49", + "code":"50", "des":"This API is used to set an automated backup policy.URI formatPUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyPUT https://{Endpoint}/v3/{proje", "doc_type":"api", "kw":"Setting an Automated Backup Policy,Backup and Restoration,API Reference", @@ -1035,7 +1056,7 @@ "uri":"dds_api_0038.html", "node_id":"dds_api_0038.xml", "product_code":"dds", - "code":"50", + "code":"51", "des":"This API is used to restore a backup to a new DB instance.The database type of the destination DB instance must be the same as that of the source DB instance.Currently, o", "doc_type":"api", "kw":"Restoring Data to a New DB Instance,Backup and Restoration,API Reference", @@ -1056,7 +1077,7 @@ "uri":"dds_api_0059.html", "node_id":"dds_api_0059.xml", "product_code":"dds", - "code":"51", + "code":"52", "des":"This API is used to obtain the link for downloading a backup file.The backup download link is valid within 15 minutes after being updated.URI formatGET https://{Endpoint}", "doc_type":"api", "kw":"Obtaining the Link for Downloading a Backup File,Backup and Restoration,API Reference", @@ -1077,7 +1098,7 @@ "uri":"dds_api_0080.html", "node_id":"dds_api_0080.xml", "product_code":"dds", - "code":"52", + "code":"53", "des":"This API is used to query the restoration time range of a DB instance.Currently, this API only supports replica set instances and cluster instances 4.0.URI formatGET http", "doc_type":"api", "kw":"Querying the Restoration Time Ranges,Backup and Restoration,API Reference", @@ -1098,7 +1119,7 @@ "uri":"dds_api_0081.html", "node_id":"dds_api_0081.xml", "product_code":"dds", - "code":"53", + "code":"54", "des":"This API is used to obtain the list of databases that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{in", "doc_type":"api", "kw":"Obtaining the List of Databases That Can Be Restored,Backup and Restoration,API Reference", @@ -1119,7 +1140,7 @@ "uri":"dds_api_0082.html", "node_id":"dds_api_0082.xml", "product_code":"dds", - "code":"54", + "code":"55", "des":"This API is used to obtain the list of databases collections that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/i", "doc_type":"api", "kw":"Obtaining the List of Database Collections That Can Be Restored,Backup and Restoration,API Reference", @@ -1140,7 +1161,7 @@ "uri":"dds_api_0083.html", "node_id":"dds_api_0083.xml", "product_code":"dds", - "code":"55", + "code":"56", "des":"This API is used to restore data to the original DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/recoveryPOST https://{Endpoint}/v3/{project_id}/i", "doc_type":"api", "kw":"Restoring Data to the Original DB Instance,Backup and Restoration,API Reference", @@ -1161,7 +1182,7 @@ "uri":"dds_api_0084.html", "node_id":"dds_api_0084.xml", "product_code":"dds", - "code":"56", + "code":"57", "des":"This API is used to restore databases and tables at a point in time.This API applies only to replica sets.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{ins", "doc_type":"api", "kw":"Restoring Databases and Tables to a Point in Time,Backup and Restoration,API Reference", @@ -1182,7 +1203,7 @@ "uri":"dds_api_0085.html", "node_id":"dds_api_0085.xml", "product_code":"dds", - "code":"57", + "code":"58", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Parameter Configuration", @@ -1203,7 +1224,7 @@ "uri":"dds_api_0088.html", "node_id":"dds_api_0088.xml", "product_code":"dds", - "code":"58", + "code":"59", "des":"This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.This API applies only to DDS Com", "doc_type":"api", "kw":"Obtaining Parameter Templates,Parameter Configuration,API Reference", @@ -1224,7 +1245,7 @@ "uri":"dds_api_0089.html", "node_id":"dds_api_0089.xml", "product_code":"dds", - "code":"59", + "code":"60", "des":"This API is used to obtain parameter details of a specified parameter template.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{project", "doc_type":"api", "kw":"Obtaining Details About a Parameter Template,Parameter Configuration,API Reference", @@ -1245,7 +1266,7 @@ "uri":"dds_api_0107.html", "node_id":"dds_api_0107.xml", "product_code":"dds", - "code":"60", + "code":"61", "des":"This API is used to change a parameter template for a specified DB instance.URI formatPUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applyPUT https://{", "doc_type":"api", "kw":"Applying a Parameter Template,Parameter Configuration,API Reference", @@ -1266,7 +1287,7 @@ "uri":"dds_api_0108.html", "node_id":"dds_api_0108.xml", "product_code":"dds", - "code":"61", + "code":"62", "des":"This API is used to obtain information about parameters of a specified DB instance.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{pro", "doc_type":"api", "kw":"Obtaining Parameters of a Specified DB Instance,Parameter Configuration,API Reference", @@ -1287,7 +1308,7 @@ "uri":"dds_api_0092.html", "node_id":"dds_api_0092.xml", "product_code":"dds", - "code":"62", + "code":"63", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Log Information Queries", @@ -1308,7 +1329,7 @@ "uri":"dds_api_0093.html", "node_id":"dds_api_0093.xml", "product_code":"dds", - "code":"63", + "code":"64", "des":"This API is used to query database slow logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpoi", "doc_type":"api", "kw":"Querying Database Slow Logs,Log Information Queries,API Reference", @@ -1329,7 +1350,7 @@ "uri":"dds_api_0094.html", "node_id":"dds_api_0094.xml", "product_code":"dds", - "code":"64", + "code":"65", "des":"This API is used to obtain links for downloading slow query logs.The link for downloading slow query logs is valid within 15 minutes after being updated.URI formatPOSThtt", "doc_type":"api", "kw":"Obtaining Links for Downloading Slow Query Logs,Log Information Queries,API Reference", @@ -1350,7 +1371,7 @@ "uri":"dds_api_0095.html", "node_id":"dds_api_0095.xml", "product_code":"dds", - "code":"65", + "code":"66", "des":"This API is used to query database error logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpo", "doc_type":"api", "kw":"Querying Database Error Logs,Log Information Queries,API Reference", @@ -1371,7 +1392,7 @@ "uri":"dds_api_0096.html", "node_id":"dds_api_0096.xml", "product_code":"dds", - "code":"66", + "code":"67", "des":"This API is used to obtain the download link of error logs.The link for downloading error logs is valid within 15 minutes after being updated.URI formatPOST https://{Endp", "doc_type":"api", "kw":"Obtaining Links for Downloading Error Logs,Log Information Queries,API Reference", @@ -1392,7 +1413,7 @@ "uri":"dds_api_0097.html", "node_id":"dds_api_0097.xml", "product_code":"dds", - "code":"67", + "code":"68", "des":"This API is used to set a policy for SQL audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyPOST https://{Endpoint}/v3/{p", "doc_type":"api", "kw":"Setting SQL Audit,Log Information Queries,API Reference", @@ -1413,7 +1434,7 @@ "uri":"dds_api_0098.html", "node_id":"dds_api_0098.xml", "product_code":"dds", - "code":"68", + "code":"69", "des":"This API is used to query the policy for SQL audit logs.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyGET https://{Endpoint}/v3/", "doc_type":"api", "kw":"Querying SQL Audit Policy,Log Information Queries,API Reference", @@ -1434,7 +1455,7 @@ "uri":"dds_api_0099.html", "node_id":"dds_api_0099.xml", "product_code":"dds", - "code":"69", + "code":"70", "des":"This API is used to obtain an audit log list.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}", "doc_type":"api", "kw":"Obtaining the Audit Log List,Log Information Queries,API Reference", @@ -1455,7 +1476,7 @@ "uri":"dds_api_0100.html", "node_id":"dds_api_0100.xml", "product_code":"dds", - "code":"70", + "code":"71", "des":"This API is used to obtain the link for downloading audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-linksPOST https://{Endpo", "doc_type":"api", "kw":"Obtaining Links for Downloading Audit Logs,Log Information Queries,API Reference", @@ -1476,7 +1497,7 @@ "uri":"dds_tag_mgmt.html", "node_id":"dds_tag_mgmt.xml", "product_code":"dds", - "code":"71", + "code":"72", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Tag Management", @@ -1497,7 +1518,7 @@ "uri":"dds_api_0032.html", "node_id":"dds_api_0032.xml", "product_code":"dds", - "code":"72", + "code":"73", "des":"This API is used to query the specified DB instances by tag.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatPOST https://{Endpoin", "doc_type":"api", "kw":"Querying Resources by Tag,Tag Management,API Reference", @@ -1518,7 +1539,7 @@ "uri":"dds_api_0033.html", "node_id":"dds_api_0033.xml", "product_code":"dds", - "code":"73", + "code":"74", "des":"This API is used to add or delete tags of the specified instance in batches.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.If the request ", "doc_type":"api", "kw":"Adding or Deleting Resource Tags in Batches,Tag Management,API Reference", @@ -1539,7 +1560,7 @@ "uri":"dds_api_0034.html", "node_id":"dds_api_0034.xml", "product_code":"dds", - "code":"74", + "code":"75", "des":"This API is used to query tags of a specified resource.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatGET https://{Endpoint}/v3/", "doc_type":"api", "kw":"Querying Resource Tags,Tag Management,API Reference", @@ -1560,7 +1581,7 @@ "uri":"dds_api_0035.html", "node_id":"dds_api_0035.xml", "product_code":"dds", - "code":"75", + "code":"76", "des":"This API is used to query all tags of instances in a specified project.URI formatGET https://{Endpoint}/v3/{project_id}/tagsGET https://{Endpoint}/v3/{project_id}/tagsPar", "doc_type":"api", "kw":"Querying Tags in a Specified Project,Tag Management,API Reference", @@ -1581,7 +1602,7 @@ "uri":"dds_api_0070.html", "node_id":"dds_api_0070.xml", "product_code":"dds", - "code":"76", + "code":"77", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Managing Databases and Users", @@ -1602,7 +1623,7 @@ "uri":"dds_api_0075.html", "node_id":"dds_api_0075.xml", "product_code":"dds", - "code":"77", + "code":"78", "des":"This API is used to change the password of a database userThis operation cannot be performed on frozen or abnormal instances.URI formatPUT https://{Endpoint}/v3/{project_", "doc_type":"api", "kw":"Changing the Password of a Database User,Managing Databases and Users,API Reference", @@ -1623,7 +1644,7 @@ "uri":"dds_api_0117.html", "node_id":"dds_api_0117.xml", "product_code":"dds", - "code":"78", + "code":"79", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Task Management", @@ -1644,7 +1665,7 @@ "uri":"dds_api_0118.html", "node_id":"dds_api_0118.xml", "product_code":"dds", - "code":"79", + "code":"80", "des":"This API is used to obtain information about a task with a specified ID in the task center.Currently, only asynchronous tasks in the task center of DDS Community Edition ", "doc_type":"api", "kw":"Obtaining Information About a Task with a Specified ID,Task Management,API Reference", @@ -1665,7 +1686,7 @@ "uri":"dds_api_permission.html", "node_id":"dds_api_permission.xml", "product_code":"dds", - "code":"80", + "code":"81", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", @@ -1686,7 +1707,7 @@ "uri":"dds_api_0036.html", "node_id":"dds_api_0036.xml", "product_code":"dds", - "code":"81", + "code":"82", "des":"This chapter describes fine-grained permissions management for your DDS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", @@ -1707,7 +1728,7 @@ "uri":"dds_api_0037.html", "node_id":"dds_api_0037.xml", "product_code":"dds", - "code":"82", + "code":"83", "des":"The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.", "doc_type":"api", "kw":"DDS Actions,Permissions Policies and Supported Actions,API Reference", @@ -1728,7 +1749,7 @@ "uri":"dds_public_parameters.html", "node_id":"dds_public_parameters.xml", "product_code":"dds", - "code":"83", + "code":"84", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -1749,7 +1770,7 @@ "uri":"dds_api_0060.html", "node_id":"dds_api_0060.xml", "product_code":"dds", - "code":"84", + "code":"85", "des":"Abnormal responsesParameter descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_msgStringSpecifies th", "doc_type":"api", "kw":"Abnormal Request Results,Appendix,API Reference", @@ -1770,7 +1791,7 @@ "uri":"dds_status_code.html", "node_id":"dds_status_code.xml", "product_code":"dds", - "code":"85", + "code":"86", "des":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", "doc_type":"api", "kw":"Status Code,Appendix,API Reference", @@ -1791,7 +1812,7 @@ "uri":"dds_error_code.html", "node_id":"dds_error_code.xml", "product_code":"dds", - "code":"86", + "code":"87", "des":"If an error occurs in an API, no result is returned. You can locate the error cause based on the error codes of each API. When the invocation fails, an HTTP status code i", "doc_type":"api", "kw":"Error Code,Appendix,API Reference", @@ -1812,7 +1833,7 @@ "uri":"dds_projectid.html", "node_id":"dds_projectid.xml", "product_code":"dds", - "code":"87", + "code":"88", "des":"A project ID is required for some URLs when an API is called. To obtain the project ID:Obtaining the Project ID by Calling an APIObtain a Project ID from the ConsoleThe A", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1833,7 +1854,7 @@ "uri":"dds_metrics.html", "node_id":"dds_metrics.xml", "product_code":"dds", - "code":"88", + "code":"89", "des":"This section describes metrics reported by Document Database Service (DDS) to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye", "doc_type":"api", "kw":"DDS Metrics,Appendix,API Reference", @@ -1854,7 +1875,7 @@ "uri":"dds_change_history.html", "node_id":"dds_change_history.xml", "product_code":"dds", - "code":"89", + "code":"90", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/dds/api-ref/CLASS.TXT.json b/docs/dds/api-ref/CLASS.TXT.json index e48816ab0..83c006a0b 100644 --- a/docs/dds/api-ref/CLASS.TXT.json +++ b/docs/dds/api-ref/CLASS.TXT.json @@ -327,29 +327,38 @@ "desc":"This API is used to query LTS log configurations.This API is available only for audit logs.URI formatGET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configsPath", "product_code":"dds", "title":"Querying LTS Log Configurations", - "uri":"en-us_topic_0000002142831253.html", + "uri":"dds_api_022.html", "doc_type":"api", "p_code":"16", "code":"37" }, { - "desc":"After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream. You will", + "desc":"This API is used to modify the time range within which you are allowed to start a task that affects the running of database instances, for example, the time window for up", "product_code":"dds", - "title":"Associating an Instance with an LTS Log Stream", - "uri":"en-us_topic_0000002107112644.html", + "title":"Configuring the Maintenance Window", + "uri":"dds_api_023.html", "doc_type":"api", "p_code":"16", "code":"38" }, { - "desc":"After you have disassociated an instance from an LTS log stream, logs of the instance are not uploaded to the LTS log stream.URI formatDELETE https://{Endpoint}/v3/{proje", + "desc":"After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream. You will", "product_code":"dds", - "title":"Disassociating an Instance from an LTS Log Stream", - "uri":"en-us_topic_0000002107272436.html", + "title":"Associating an Instance with an LTS Log Stream", + "uri":"dds_api_024.html", "doc_type":"api", "p_code":"16", "code":"39" }, + { + "desc":"After you have disassociated an instance from an LTS log stream, logs of the instance are not uploaded to the LTS log stream.URI formatDELETE https://{Endpoint}/v3/{proje", + "product_code":"dds", + "title":"Disassociating an Instance from an LTS Log Stream", + "uri":"dds_api_025.html", + "doc_type":"api", + "p_code":"16", + "code":"40" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dds", @@ -357,25 +366,25 @@ "uri":"dds_connect_0001.html", "doc_type":"api", "p_code":"9", - "code":"40" + "code":"41" }, { - "desc":"This API is used to query sessions of instance nodes.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nod", + "desc":"This API is used to query sessions of instance nodes.Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nod", "product_code":"dds", "title":"Querying Sessions of an Instance Node", "uri":"dds_connect_0002.html", "doc_type":"api", - "p_code":"40", - "code":"41" + "p_code":"41", + "code":"42" }, { - "desc":"This API is used to kill sessions of an instance node.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.Inactive sessions cannot be terminated.URI formatPO", + "desc":"This API is used to kill sessions of an instance node.Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.Inactive sessions cannot be terminated.URI formatPO", "product_code":"dds", "title":"Killing Sessions of an Instance Node", "uri":"dds_connect_0003.html", "doc_type":"api", - "p_code":"40", - "code":"42" + "p_code":"41", + "code":"43" }, { "desc":"This API is used to query the number of connections from each client to DDS DB instances.Frozen instances do not support this operation.URI formatGET https://{Endpoint}/v", @@ -383,8 +392,8 @@ "title":"Querying the Number of Connections to an Instance Node", "uri":"dds_connect_0004.html", "doc_type":"api", - "p_code":"40", - "code":"43" + "p_code":"41", + "code":"44" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -393,7 +402,7 @@ "uri":"dds_backup_restore.html", "doc_type":"api", "p_code":"9", - "code":"44" + "code":"45" }, { "desc":"This API is used to create a manual backup for a DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/backupsPOST https://{Endpoint}/v3/{project_id}/backupsParam", @@ -401,8 +410,8 @@ "title":"Creating a Manual Backup", "uri":"dds_api_0027.html", "doc_type":"api", - "p_code":"44", - "code":"45" + "p_code":"45", + "code":"46" }, { "desc":"This API is used to delete a manual backup for a DB instance.URI formatDELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}DELETE https://{Endpoint}/v3/{project_", @@ -410,8 +419,8 @@ "title":"Deleting a Manual Backup", "uri":"dds_api_0028.html", "doc_type":"api", - "p_code":"44", - "code":"46" + "p_code":"45", + "code":"47" }, { "desc":"This API is used to query backups based on specified conditions.URI formatGET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&b", @@ -419,8 +428,8 @@ "title":"Querying the Backup List", "uri":"dds_api_0029.html", "doc_type":"api", - "p_code":"44", - "code":"47" + "p_code":"45", + "code":"48" }, { "desc":"This API is used to query an automated backup policy.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyGET https://{Endpoint}/v3/{pro", @@ -428,8 +437,8 @@ "title":"Querying an Automated Backup Policy", "uri":"dds_api_0030.html", "doc_type":"api", - "p_code":"44", - "code":"48" + "p_code":"45", + "code":"49" }, { "desc":"This API is used to set an automated backup policy.URI formatPUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyPUT https://{Endpoint}/v3/{proje", @@ -437,8 +446,8 @@ "title":"Setting an Automated Backup Policy", "uri":"dds_api_0031.html", "doc_type":"api", - "p_code":"44", - "code":"49" + "p_code":"45", + "code":"50" }, { "desc":"This API is used to restore a backup to a new DB instance.The database type of the destination DB instance must be the same as that of the source DB instance.Currently, o", @@ -446,8 +455,8 @@ "title":"Restoring Data to a New DB Instance", "uri":"dds_api_0038.html", "doc_type":"api", - "p_code":"44", - "code":"50" + "p_code":"45", + "code":"51" }, { "desc":"This API is used to obtain the link for downloading a backup file.The backup download link is valid within 15 minutes after being updated.URI formatGET https://{Endpoint}", @@ -455,8 +464,8 @@ "title":"Obtaining the Link for Downloading a Backup File", "uri":"dds_api_0059.html", "doc_type":"api", - "p_code":"44", - "code":"51" + "p_code":"45", + "code":"52" }, { "desc":"This API is used to query the restoration time range of a DB instance.Currently, this API only supports replica set instances and cluster instances 4.0.URI formatGET http", @@ -464,8 +473,8 @@ "title":"Querying the Restoration Time Ranges", "uri":"dds_api_0080.html", "doc_type":"api", - "p_code":"44", - "code":"52" + "p_code":"45", + "code":"53" }, { "desc":"This API is used to obtain the list of databases that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{in", @@ -473,8 +482,8 @@ "title":"Obtaining the List of Databases That Can Be Restored", "uri":"dds_api_0081.html", "doc_type":"api", - "p_code":"44", - "code":"53" + "p_code":"45", + "code":"54" }, { "desc":"This API is used to obtain the list of databases collections that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/i", @@ -482,8 +491,8 @@ "title":"Obtaining the List of Database Collections That Can Be Restored", "uri":"dds_api_0082.html", "doc_type":"api", - "p_code":"44", - "code":"54" + "p_code":"45", + "code":"55" }, { "desc":"This API is used to restore data to the original DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/recoveryPOST https://{Endpoint}/v3/{project_id}/i", @@ -491,8 +500,8 @@ "title":"Restoring Data to the Original DB Instance", "uri":"dds_api_0083.html", "doc_type":"api", - "p_code":"44", - "code":"55" + "p_code":"45", + "code":"56" }, { "desc":"This API is used to restore databases and tables at a point in time.This API applies only to replica sets.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{ins", @@ -500,8 +509,8 @@ "title":"Restoring Databases and Tables to a Point in Time", "uri":"dds_api_0084.html", "doc_type":"api", - "p_code":"44", - "code":"56" + "p_code":"45", + "code":"57" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -510,7 +519,7 @@ "uri":"dds_api_0085.html", "doc_type":"api", "p_code":"9", - "code":"57" + "code":"58" }, { "desc":"This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.This API applies only to DDS Com", @@ -518,8 +527,8 @@ "title":"Obtaining Parameter Templates", "uri":"dds_api_0088.html", "doc_type":"api", - "p_code":"57", - "code":"58" + "p_code":"58", + "code":"59" }, { "desc":"This API is used to obtain parameter details of a specified parameter template.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{project", @@ -527,8 +536,8 @@ "title":"Obtaining Details About a Parameter Template", "uri":"dds_api_0089.html", "doc_type":"api", - "p_code":"57", - "code":"59" + "p_code":"58", + "code":"60" }, { "desc":"This API is used to change a parameter template for a specified DB instance.URI formatPUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applyPUT https://{", @@ -536,8 +545,8 @@ "title":"Applying a Parameter Template", "uri":"dds_api_0107.html", "doc_type":"api", - "p_code":"57", - "code":"60" + "p_code":"58", + "code":"61" }, { "desc":"This API is used to obtain information about parameters of a specified DB instance.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{pro", @@ -545,8 +554,8 @@ "title":"Obtaining Parameters of a Specified DB Instance", "uri":"dds_api_0108.html", "doc_type":"api", - "p_code":"57", - "code":"61" + "p_code":"58", + "code":"62" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -555,7 +564,7 @@ "uri":"dds_api_0092.html", "doc_type":"api", "p_code":"9", - "code":"62" + "code":"63" }, { "desc":"This API is used to query database slow logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpoi", @@ -563,8 +572,8 @@ "title":"Querying Database Slow Logs", "uri":"dds_api_0093.html", "doc_type":"api", - "p_code":"62", - "code":"63" + "p_code":"63", + "code":"64" }, { "desc":"This API is used to obtain links for downloading slow query logs.The link for downloading slow query logs is valid within 15 minutes after being updated.URI formatPOSThtt", @@ -572,8 +581,8 @@ "title":"Obtaining Links for Downloading Slow Query Logs", "uri":"dds_api_0094.html", "doc_type":"api", - "p_code":"62", - "code":"64" + "p_code":"63", + "code":"65" }, { "desc":"This API is used to query database error logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpo", @@ -581,8 +590,8 @@ "title":"Querying Database Error Logs", "uri":"dds_api_0095.html", "doc_type":"api", - "p_code":"62", - "code":"65" + "p_code":"63", + "code":"66" }, { "desc":"This API is used to obtain the download link of error logs.The link for downloading error logs is valid within 15 minutes after being updated.URI formatPOST https://{Endp", @@ -590,8 +599,8 @@ "title":"Obtaining Links for Downloading Error Logs", "uri":"dds_api_0096.html", "doc_type":"api", - "p_code":"62", - "code":"66" + "p_code":"63", + "code":"67" }, { "desc":"This API is used to set a policy for SQL audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyPOST https://{Endpoint}/v3/{p", @@ -599,8 +608,8 @@ "title":"Setting SQL Audit", "uri":"dds_api_0097.html", "doc_type":"api", - "p_code":"62", - "code":"67" + "p_code":"63", + "code":"68" }, { "desc":"This API is used to query the policy for SQL audit logs.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyGET https://{Endpoint}/v3/", @@ -608,8 +617,8 @@ "title":"Querying SQL Audit Policy", "uri":"dds_api_0098.html", "doc_type":"api", - "p_code":"62", - "code":"68" + "p_code":"63", + "code":"69" }, { "desc":"This API is used to obtain an audit log list.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}", @@ -617,8 +626,8 @@ "title":"Obtaining the Audit Log List", "uri":"dds_api_0099.html", "doc_type":"api", - "p_code":"62", - "code":"69" + "p_code":"63", + "code":"70" }, { "desc":"This API is used to obtain the link for downloading audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-linksPOST https://{Endpo", @@ -626,8 +635,8 @@ "title":"Obtaining Links for Downloading Audit Logs", "uri":"dds_api_0100.html", "doc_type":"api", - "p_code":"62", - "code":"70" + "p_code":"63", + "code":"71" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -636,7 +645,7 @@ "uri":"dds_tag_mgmt.html", "doc_type":"api", "p_code":"9", - "code":"71" + "code":"72" }, { "desc":"This API is used to query the specified DB instances by tag.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatPOST https://{Endpoin", @@ -644,8 +653,8 @@ "title":"Querying Resources by Tag", "uri":"dds_api_0032.html", "doc_type":"api", - "p_code":"71", - "code":"72" + "p_code":"72", + "code":"73" }, { "desc":"This API is used to add or delete tags of the specified instance in batches.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.If the request ", @@ -653,8 +662,8 @@ "title":"Adding or Deleting Resource Tags in Batches", "uri":"dds_api_0033.html", "doc_type":"api", - "p_code":"71", - "code":"73" + "p_code":"72", + "code":"74" }, { "desc":"This API is used to query tags of a specified resource.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatGET https://{Endpoint}/v3/", @@ -662,8 +671,8 @@ "title":"Querying Resource Tags", "uri":"dds_api_0034.html", "doc_type":"api", - "p_code":"71", - "code":"74" + "p_code":"72", + "code":"75" }, { "desc":"This API is used to query all tags of instances in a specified project.URI formatGET https://{Endpoint}/v3/{project_id}/tagsGET https://{Endpoint}/v3/{project_id}/tagsPar", @@ -671,8 +680,8 @@ "title":"Querying Tags in a Specified Project", "uri":"dds_api_0035.html", "doc_type":"api", - "p_code":"71", - "code":"75" + "p_code":"72", + "code":"76" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -681,7 +690,7 @@ "uri":"dds_api_0070.html", "doc_type":"api", "p_code":"9", - "code":"76" + "code":"77" }, { "desc":"This API is used to change the password of a database userThis operation cannot be performed on frozen or abnormal instances.URI formatPUT https://{Endpoint}/v3/{project_", @@ -689,8 +698,8 @@ "title":"Changing the Password of a Database User", "uri":"dds_api_0075.html", "doc_type":"api", - "p_code":"76", - "code":"77" + "p_code":"77", + "code":"78" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -699,7 +708,7 @@ "uri":"dds_api_0117.html", "doc_type":"api", "p_code":"9", - "code":"78" + "code":"79" }, { "desc":"This API is used to obtain information about a task with a specified ID in the task center.Currently, only asynchronous tasks in the task center of DDS Community Edition ", @@ -707,8 +716,8 @@ "title":"Obtaining Information About a Task with a Specified ID", "uri":"dds_api_0118.html", "doc_type":"api", - "p_code":"78", - "code":"79" + "p_code":"79", + "code":"80" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -717,7 +726,7 @@ "uri":"dds_api_permission.html", "doc_type":"api", "p_code":"", - "code":"80" + "code":"81" }, { "desc":"This chapter describes fine-grained permissions management for your DDS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul", @@ -725,8 +734,8 @@ "title":"Introduction", "uri":"dds_api_0036.html", "doc_type":"api", - "p_code":"80", - "code":"81" + "p_code":"81", + "code":"82" }, { "desc":"The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.", @@ -734,8 +743,8 @@ "title":"DDS Actions", "uri":"dds_api_0037.html", "doc_type":"api", - "p_code":"80", - "code":"82" + "p_code":"81", + "code":"83" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -744,7 +753,7 @@ "uri":"dds_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"83" + "code":"84" }, { "desc":"Abnormal responsesParameter descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_msgStringSpecifies th", @@ -752,8 +761,8 @@ "title":"Abnormal Request Results", "uri":"dds_api_0060.html", "doc_type":"api", - "p_code":"83", - "code":"84" + "p_code":"84", + "code":"85" }, { "desc":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", @@ -761,8 +770,8 @@ "title":"Status Code", "uri":"dds_status_code.html", "doc_type":"api", - "p_code":"83", - "code":"85" + "p_code":"84", + "code":"86" }, { "desc":"If an error occurs in an API, no result is returned. You can locate the error cause based on the error codes of each API. When the invocation fails, an HTTP status code i", @@ -770,8 +779,8 @@ "title":"Error Code", "uri":"dds_error_code.html", "doc_type":"api", - "p_code":"83", - "code":"86" + "p_code":"84", + "code":"87" }, { "desc":"A project ID is required for some URLs when an API is called. To obtain the project ID:Obtaining the Project ID by Calling an APIObtain a Project ID from the ConsoleThe A", @@ -779,8 +788,8 @@ "title":"Obtaining a Project ID", "uri":"dds_projectid.html", "doc_type":"api", - "p_code":"83", - "code":"87" + "p_code":"84", + "code":"88" }, { "desc":"This section describes metrics reported by Document Database Service (DDS) to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye", @@ -788,8 +797,8 @@ "title":"DDS Metrics", "uri":"dds_metrics.html", "doc_type":"api", - "p_code":"83", - "code":"88" + "p_code":"84", + "code":"89" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -798,6 +807,6 @@ "uri":"dds_change_history.html", "doc_type":"api", "p_code":"", - "code":"89" + "code":"90" } ] \ No newline at end of file diff --git a/docs/dds/api-ref/dds_api_0020.html b/docs/dds/api-ref/dds_api_0020.html index a593f149b..739bb35a5 100644 --- a/docs/dds/api-ref/dds_api_0020.html +++ b/docs/dds/api-ref/dds_api_0020.html @@ -228,7 +228,7 @@

String

-

Specifies the database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be 4.4, 4.2, 4.0 or 3.4.

+

Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be 5.0, 4.4, 4.2 or 4.0.

storage_engine

@@ -238,7 +238,7 @@

String

Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.

-
  • If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is rocksDB.
  • If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is wiredTiger.
+
  • If the database version is 4.2 or later, the storage engine is rocksDB.
  • If the database version is 4.0, the storage engine is wiredTiger.
@@ -718,7 +718,7 @@ Create a cluster instance:

String

-

Specifies the database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be 4.4, 4.2, 4.0 or 3.4.

+

Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be 5.0, 4.4, 4.2 or 4.0.

storage_engine

@@ -728,7 +728,7 @@ Create a cluster instance:

String

Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.

-
  • If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is rocksDB.
  • If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is wiredTiger.
+
  • If the database version is 4.2 or later, the storage engine is rocksDB.
  • If the database version is 4.0, the storage engine is wiredTiger.
diff --git a/docs/dds/api-ref/dds_api_0029.html b/docs/dds/api-ref/dds_api_0029.html index 12744932b..4fdfe4b77 100644 --- a/docs/dds/api-ref/dds_api_0029.html +++ b/docs/dds/api-ref/dds_api_0029.html @@ -231,7 +231,7 @@

String

-

Indicates the database of version 3.4, 4.0, 4.2, or 4.4. The value is 3.4, 4.0, 4.2, or 4.4.

+

Indicates the database of version 4.0, 4.2, 4.4, or 5.0. The value is 4.0, 4.2, 4.4, or 5.0.

diff --git a/docs/dds/api-ref/dds_api_0038.html b/docs/dds/api-ref/dds_api_0038.html index f3e51b803..0b4c2f4fa 100644 --- a/docs/dds/api-ref/dds_api_0038.html +++ b/docs/dds/api-ref/dds_api_0038.html @@ -584,7 +584,7 @@

String

-

Specifies the database version. Versions 4.4, 4.2, 4.0 and 3.4 are supported. The value can be 4.4, 4.2, 4.0 or 3.4.

+

Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be 5.0, 4.4, 4.2 or 4.0.

storage_engine

@@ -594,7 +594,7 @@

String

Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.

-
  • If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is rocksDB.
  • If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is wiredTiger.
+
  • If the database version is 4.2 or later, the storage engine is rocksDB.
  • If the database version is 4.0, the storage engine is wiredTiger.
diff --git a/docs/dds/api-ref/dds_api_0120.html b/docs/dds/api-ref/dds_api_0120.html index 2cce2d611..90272c7b3 100644 --- a/docs/dds/api-ref/dds_api_0120.html +++ b/docs/dds/api-ref/dds_api_0120.html @@ -3,7 +3,7 @@

Enabling Shard or Config IP Addresses

Function

This API is used to enable the IP addresses of shard or config nodes.

-

Constraints

  • Frozen instances do not support this operation.
  • DB instances associated with the IPv6 subnet do not support this operation.
  • If the IP address is enabled, restart the nodes for the setting to take effect.
  • Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.
  • This function cannot be disabled after being enabled.
+

Constraints

  • Frozen instances do not support this operation.
  • DB instances associated with the IPv6 subnet do not support this operation.
  • If the IP address is enabled, restart the nodes for the setting to take effect.
  • Cluster instances of Community Edition 4.0, 4.2, 4.4 and 5.0 are supported.
  • This function cannot be disabled after being enabled.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip

  • Parameter description diff --git a/docs/dds/api-ref/dds_api_021.html b/docs/dds/api-ref/dds_api_021.html index 844107471..4a282bc9a 100644 --- a/docs/dds/api-ref/dds_api_021.html +++ b/docs/dds/api-ref/dds_api_021.html @@ -212,7 +212,7 @@

    String

    -

    Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be 3.4, 4.0, 4.2, or 4.4.

    +

    Database version. Versions 4.0, 4.2, 4.4, and 5.0 are supported. The value can be 4.0, 4.2, 4.4, or 5.0.

    diff --git a/docs/dds/api-ref/dds_api_022.html b/docs/dds/api-ref/dds_api_022.html new file mode 100644 index 000000000..af5ee88c1 --- /dev/null +++ b/docs/dds/api-ref/dds_api_022.html @@ -0,0 +1,331 @@ + + +

    Querying LTS Log Configurations

    +

    API Description

    This API is used to query LTS log configurations.

    +
    +

    Restrictions

    This API is available only for audit logs.

    +
    +

    URI

    • URI format
      GET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs +
      + + + + + + + + + + + +
      Table 1 Path parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

      +
      +
      + +
      + + + + + + + + + + + + + + + + +
      Table 2 Query parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      offset

      +

      No

      +

      Integer

      +

      Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value must be a positive integer.

      +

      limit

      +

      No

      +

      Integer

      +

      Number of records to be queried. The value ranges from 0 to 50. If this parameter is not transferred, the log configurations of the first 50 DB instances are queried by default.

      +
      +
      + +
      + + + + + + + + + + + +
      Table 3 Request parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token obtained from IAM.

      +
      +
      +
      +
    +
    +

    Requests

    • Parameter description

      None

      +
    • Example request

      Query the log configuration of the first 10 DB instances from the first piece of data.

      +

      GET https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs?offset=0&limit=10

      +
    +
    +

    Responses

    • Parameter description +
      + + + + + + + + + + + + + +
      Table 4 Response body parameters

      Parameter

      +

      Type

      +

      Description

      +

      instance_lts_configs

      +

      Array of Table 5 objects

      +

      LTS log configuration and brief information about each instance.

      +

      total_count

      +

      Integer

      +

      Total number of cloud service log configurations that can be queried, which is equal to the total number of DDS instances.

      +
      +
      + +
      + + + + + + + + + + + + + +
      Table 5 instance_lts_configs

      Parameter

      +

      Type

      +

      Description

      +

      instance

      +

      Table 6 object

      +

      Brief information about an instance.

      +

      lts_configs

      +

      Array of Table lts_configs objects

      +

      LTS log configuration details. If no LTS log stream is configured, no response is returned for this field.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 6 instance

      Parameter

      +

      Type

      +

      Description

      +

      id

      +

      String

      +

      DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

      +

      name

      +

      String

      +

      DDS Instance name.

      +

      mode

      +

      String

      +

      Instance type, which can be single node, replica set, or cluster.

      +

      Enumerated values:

      +
      • ReplicaSingle
      • ReplicaSet
      • Sharding
      +

      datastore

      +

      Table 7 object

      +

      DB engine and version of the DB instance.

      +

      status

      +

      String

      +

      Instance status.

      +

      enterprise_project_id

      +

      String

      +

      ID of the enterprise project to which the instance belongs. For the default enterprise project, the value is 0. For other enterprise projects, see Enterprise Management User Guide.

      +

      actions

      +

      Array of strings

      +

      All actions that are being executed on an instance.

      +
      +
      + +
      + + + + + + + + + + + + + +
      Table 7 datastore

      Parameter

      +

      Type

      +

      Description

      +

      type

      +

      String

      +

      DB engine. The value is mongodb.

      +

      version

      +

      String

      +

      Database major version.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 8 lts_configs

      Parameter

      +

      Type

      +

      Description

      +

      log_type

      +

      String

      +

      LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

      +

      lts_group_id

      +

      String

      +

      LTS log group ID.

      +

      lts_stream_id

      +

      String

      +

      LTS log stream ID.

      +

      enabled

      +

      Boolean

      +

      Indicates whether to upload logs to LTS.

      +
      +
      +
    +
    • Example response
      { 
+  "total_count" : 1, 
+  "instance_lts_configs" : [ { 
+    "instance" : { 
+      "id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
+      "name" : "dds-1f84", 
+      "mode" : "ReplicaSingle", 
+      "datastore" : { 
+        "type" : "mongodb", 
+        "version" : 4.0 
+      }, 
+      "status" : "normal", 
+      "enterprise_project_id" : "0", 
+      "actions" : [ "OPS_AUDIT_LOG" ] 
+    }, 
+    "lts_configs" : [ { 
+      "log_type" : "audit_log", 
+      "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", 
+      "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc", 
+      "enabled" : true 
+    } ] 
+  } ] 
+}
      +
    +
    +

    Status Code

    +
    + + + + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    Success.

    +

    default

    +

    Client or server error.

    +
    +
    +
    +

    Error Code

    For details, see Error Code.

    +
    +

    +
    +
    +
    +
    Parent topic: DB Instance Management
    +
    +
    + diff --git a/docs/dds/api-ref/dds_api_023.html b/docs/dds/api-ref/dds_api_023.html new file mode 100644 index 000000000..d2a4cef8e --- /dev/null +++ b/docs/dds/api-ref/dds_api_023.html @@ -0,0 +1,127 @@ + + +

    Configuring the Maintenance Window

    +

    API Description

    This API is used to modify the time range within which you are allowed to start a task that affects the running of database instances, for example, the time window for upgrading the operating system and database software.

    +
    +

    URI

    • URI format
      PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/maintenance-window +
      + + + + + + + + + + + + + + + + +
      Table 1 Path parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

      +

      instance_id

      +

      Yes

      +

      String

      +

      Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

      +
      +
      +
      +
    +
    +

    Requests

    • Parameter description +
      + + + + + + + + + + + + + + + + +
      Table 2 Request header parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      Content-Type

      +

      Yes

      +

      String

      +

      Specifies the MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token obtained from IAM. For details, see Authentication.

      +
      +
      +
      +
      + + + + + + + + + + + + + + + + +
      Table 3 Request body parameters

      Name

      +

      Mandatory

      +

      Type

      +

      Description

      +

      start_time

      +

      Yes

      +

      String

      +

      Start time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the end time. Gap between "start_time" and "end_time" must be at least 1h.

      +

      end_time

      +

      Yes

      +

      String

      +

      End time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the start time. Gap between "start_time" and "end_time" must be at least 1h.

      +
      +
      +
      +
    • Example request

      Configuring the maintenance window

      +
      { 
+  "start_time" : "14:00",
+  "end_time" : "15:00"
+}
      +
    +
    +

    Responses

    None

    +
    +

    Status Code

    Status Code:200.

    +

    For more information, see Status Code.

    +
    +

    Error Code

    For details, see Error Code.

    +
    +

    +
    +
    +
    +
    Parent topic: DB Instance Management
    +
    +
    + diff --git a/docs/dds/api-ref/dds_api_024.html b/docs/dds/api-ref/dds_api_024.html new file mode 100644 index 000000000..68cc93dca --- /dev/null +++ b/docs/dds/api-ref/dds_api_024.html @@ -0,0 +1,176 @@ + + +

    Associating an Instance with an LTS Log Stream

    +

    API Description

    After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream. You will be billed for log reporting. For details, see LTS pricing details. After a specific log stream is selected, the system creates a structuring rule of the required log type for it.

    +
    +

    Restrictions

    • This operation cannot be performed on instances in the creating, deleted, or frozen state.
    • A maximum of 100 data records are supported.
    +
    +

    URI

    • URI format

      POST https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs

      + +
      + + + + + + + + + + + +
      Table 1 Path parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

      +
      +
      + +
      + + + + + + + + + + + +
      Table 2 Request parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token obtained from IAM.

      +
      +
      +
    +
    +

    Requests

    • Parameter description +
      + + + + + + + + + + + +
      Table 3 Request body parameters

      Parameter

      +

      Type

      +

      Mandatory

      +

      Description

      +

      lts_configs

      +

      Array of Table 4 objects

      +

      Yes

      +

      Each item indicates an LTS configuration for the instance.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 4 lts_configs

      Parameter

      +

      Type

      +

      Mandatory

      +

      Description

      +

      instance_id

      +

      String

      +

      Yes

      +

      DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

      +

      log_type

      +

      String

      +

      Yes

      +

      LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

      +

      lts_group_id

      +

      String

      +

      Yes

      +

      LTS log group ID. You can obtain the value using the LTS API for querying all log groups under an account.

      +

      lts_stream_id

      +

      String

      +

      Yes

      +

      LTS log stream ID. You can obtain the value using the LTS API for querying all log streams in a specified log group.

      +
      +
      +
    • Example request

      Enabling audit log reporting to LTS for a DB instance

      +

      POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs

      +
      { 
+  "lts_configs" : [ { 
+    "instance_id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
+    "log_type" : "audit_log", 
+    "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", 
+    "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc" 
+  } ] 
+}
      +
    +
    +

    Responses

    • Parameter description

      None

      +
    +
    • Example response

      None

      +
    +
    +

    Status Code

    +
    + + + + + + + + + + +

    Status Code

    +

    Description

    +

    202

    +

    Accepted.

    +

    default

    +

    Client or server error.

    +
    +
    +
    +

    Error Code

    For details, see Error Code.

    +
    +
    +
    +
    +
    Parent topic: DB Instance Management
    +
    +
    + diff --git a/docs/dds/api-ref/dds_api_025.html b/docs/dds/api-ref/dds_api_025.html new file mode 100644 index 000000000..fc10ce276 --- /dev/null +++ b/docs/dds/api-ref/dds_api_025.html @@ -0,0 +1,155 @@ + + +

    Disassociating an Instance from an LTS Log Stream

    +

    API Description

    After you have disassociated an instance from an LTS log stream, logs of the instance are not uploaded to the LTS log stream.

    +
    +

    URI

    • URI format

      DELETE https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs

      + +
      + + + + + + + + + + + +
      Table 1 Path parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

      +
      +
      + +
      + + + + + + + + + + + +
      Table 2 Request parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token obtained from IAM.

      +
      +
      +
    +
    +

    Requests

    • Parameter description +
      + + + + + + + + + + + +
      Table 3 Request body parameters

      Parameter

      +

      Type

      +

      Mandatory

      +

      Description

      +

      lts_configs

      +

      Array of Table 4 objects

      +

      Yes

      +

      List of LTS configurations to be disabled. To disable multiple log configurations for an instance, you need to specify multiple items.

      +
      +
      + +
      + + + + + + + + + + + + + + + + +
      Table 4 lts_configs

      Parameter

      +

      Type

      +

      Mandatory

      +

      Description

      +

      instance_id

      +

      String

      +

      Yes

      +

      DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

      +

      log_type

      +

      String

      +

      Yes

      +

      LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

      +
      +
      +
    • Example request

      Disabling audit log reporting to LTS for a DB instance

      +

      DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs

      +
      { 
+   "lts_configs" : [ { 
+     "instance_id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
+     "log_type" : "audit_log" 
+   } ] 
+ }
      +
    +
    +

    Responses

    • Parameter description

      None

      +
    +
    • Example response

      None

      +
    +
    +

    Status Code

    +
    + + + + + + + + + + +

    Status Code

    +

    Description

    +

    202

    +

    Accepted.

    +

    default

    +

    Client or server error.

    +
    +
    +
    +

    Error Code

    For details, see Error Code.

    +
    +

    +
    +
    +
    +
    Parent topic: DB Instance Management
    +
    +
    + diff --git a/docs/dds/api-ref/dds_change_history.html b/docs/dds/api-ref/dds_change_history.html index c074c2e25..b490a01fb 100644 --- a/docs/dds/api-ref/dds_change_history.html +++ b/docs/dds/api-ref/dds_change_history.html @@ -8,7 +8,24 @@ -

    2023-05-30

    +

    2025-08-08

    + +

    Modified the following content:

    + + + +

    2025-08-06

    + +

    Modified the following content:

    + + + +

    2025-07-08

    + +

    APIs added: Configuring the Maintenance Window and added support of DDS version 5.0

    + + +

    2023-05-30

    Modified the following content:

    APIs added: Querying DB Instances in the Recycle Bin, Querying the Recycling Policy of a DB Instance, Setting the Recycle Bin Policy, Configuring Cross-CIDR Access for a Replica Set and added support of DDS version 4.2

    diff --git a/docs/dds/api-ref/dds_connect_0002.html b/docs/dds/api-ref/dds_connect_0002.html index 4be5e9a1b..d4a512539 100644 --- a/docs/dds/api-ref/dds_connect_0002.html +++ b/docs/dds/api-ref/dds_connect_0002.html @@ -3,7 +3,7 @@

    Querying Sessions of an Instance Node

    Function

    This API is used to query sessions of instance nodes.

    -

    Constraints

    Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.

    +

    Constraints

    Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.

    URI

    • URI format

      GET https://{Endpoint}/v3/{project_id}/nodes/{node_id}/sessions?offset={offset}&limit={limit}&plan_summary={plan_summary}&type={type}&namespace={namespace}&cost_time={cost_time}

    • Parameter description diff --git a/docs/dds/api-ref/dds_connect_0003.html b/docs/dds/api-ref/dds_connect_0003.html index 6eaec109e..7477f5793 100644 --- a/docs/dds/api-ref/dds_connect_0003.html +++ b/docs/dds/api-ref/dds_connect_0003.html @@ -3,7 +3,7 @@

      Killing Sessions of an Instance Node

      Function

      This API is used to kill sessions of an instance node.

      -

      Constraints

      • Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
      • Inactive sessions cannot be terminated.
      +

      Constraints

      • Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.
      • Inactive sessions cannot be terminated.

      URI

      • URI format

        POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session

      diff --git a/docs/dds/api-ref/dds_database_version.html b/docs/dds/api-ref/dds_database_version.html index 35237f22f..8a35e388a 100644 --- a/docs/dds/api-ref/dds_database_version.html +++ b/docs/dds/api-ref/dds_database_version.html @@ -48,7 +48,7 @@

      Array of strings

      -

      Indicates the database version. Currently, versions 3.4, 4.0, 4.2, and 4.4 are supported.

      +

      Indicates the database version. Currently, versions 4.0, 4.2, 4.4 and 5.0 are supported.

      @@ -57,10 +57,10 @@
    • Response example
      {
     "versions": [
-        "3.4",
         "4.0",
         "4.2",
-        "4.4"
+        "4.4",
+        "5.0"
     ]
 }
    diff --git a/docs/dds/api-ref/dds_instance_mgmt.html b/docs/dds/api-ref/dds_instance_mgmt.html index 1f18347ad..63d9395cf 100644 --- a/docs/dds/api-ref/dds_instance_mgmt.html +++ b/docs/dds/api-ref/dds_instance_mgmt.html @@ -44,11 +44,13 @@
  • Querying DB Instances in the Recycle Bin
    • -
  • Querying LTS Log Configurations
    +
  • Querying LTS Log Configurations
    • -
  • Associating an Instance with an LTS Log Stream
    +
  • Configuring the Maintenance Window
    • -
  • Disassociating an Instance from an LTS Log Stream
    +
  • Associating an Instance with an LTS Log Stream
    +
    • +
  • Disassociating an Instance from an LTS Log Stream
diff --git a/docs/dds/api-ref/dds_instance_specification.html b/docs/dds/api-ref/dds_instance_specification.html index 1d1820458..1ce8837ca 100644 --- a/docs/dds/api-ref/dds_instance_specification.html +++ b/docs/dds/api-ref/dds_instance_specification.html @@ -55,7 +55,7 @@
-

Requests

  • Example request

    GET https://dds.eu-de.otc.t-systems.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20

    +

    Requests

    • Example request

      GET https://dds.eu-de.otc.t-systems.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=4.0&offset=1&limit=20

    Responses

    • Parameter description @@ -147,7 +147,7 @@

      Array of strings

      Database versions

      -

      For example, DDS mongos node, {"3.4", "4.0", "4.2", "4.4"}

      +

      For example, DDS mongos node, {"4.0", "4.2", "4.4", "5.0", }

      @@ -165,7 +165,7 @@ "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -178,7 +178,7 @@ "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -191,7 +191,7 @@ "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -204,7 +204,7 @@ "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -217,7 +217,7 @@ "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -230,7 +230,7 @@ "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -243,7 +243,7 @@ "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -256,7 +256,7 @@ "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -269,7 +269,7 @@ "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -282,7 +282,7 @@ "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -295,7 +295,7 @@ "vcpus": "2", "ram": "4", "spec_code": "dds.mongodb.s2.large.2.config", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -308,7 +308,7 @@ "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -322,7 +322,7 @@ "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -336,7 +336,7 @@ "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -350,7 +350,7 @@ "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -364,7 +364,7 @@ "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -378,7 +378,7 @@ "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -391,7 +391,7 @@ "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -404,7 +404,7 @@ "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -417,7 +417,7 @@ "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -430,7 +430,7 @@ "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", diff --git a/docs/dds/api-ref/en-us_topic_0000002107112644.html b/docs/dds/api-ref/en-us_topic_0000002107112644.html deleted file mode 100644 index c6a719f9e..000000000 --- a/docs/dds/api-ref/en-us_topic_0000002107112644.html +++ /dev/null @@ -1,176 +0,0 @@ - - -

      Associating an Instance with an LTS Log Stream

      -

      API Description

      After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream. You will be billed for log reporting. For details, see LTS pricing details. After a specific log stream is selected, the system creates a structuring rule of the required log type for it.

      -
      -

      Restrictions

      • This operation cannot be performed on instances in the creating, deleted, or frozen state.
      • A maximum of 100 data records are supported.
      -
      -

      URI

      • URI format

        POST https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs

        - -
        - - - - - - - - - - - -
        Table 1 Path parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        project_id

        -

        Yes

        -

        String

        -

        Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

        -
        -
        - -
        - - - - - - - - - - - -
        Table 2 Request parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        X-Auth-Token

        -

        Yes

        -

        String

        -

        User token obtained from IAM.

        -
        -
        -
      -
      -

      Requests

      • Parameter description -
        - - - - - - - - - - - -
        Table 3 Request body parameters

        Parameter

        -

        Type

        -

        Mandatory

        -

        Description

        -

        lts_configs

        -

        Array of Table 4 objects

        -

        Yes

        -

        Each item indicates an LTS configuration for the instance.

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 4 lts_configs

        Parameter

        -

        Type

        -

        Mandatory

        -

        Description

        -

        instance_id

        -

        String

        -

        Yes

        -

        DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

        -

        log_type

        -

        String

        -

        Yes

        -

        LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

        -

        lts_group_id

        -

        String

        -

        Yes

        -

        LTS log group ID. You can obtain the value using the LTS API for querying all log groups under an account.

        -

        lts_stream_id

        -

        String

        -

        Yes

        -

        LTS log stream ID. You can obtain the value using the LTS API for querying all log streams in a specified log group.

        -
        -
        -
      • Example request

        Enabling audit log reporting to LTS for a DB instance

        -

        POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs

        -
        { 
-  "lts_configs" : [ { 
-    "instance_id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
-    "log_type" : "audit_log", 
-    "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", 
-    "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc" 
-  } ] 
-}
        -
      -
      -

      Responses

      • Parameter description

        None

        -
      -
      • Example response

        None

        -
      -
      -

      Status Code

      -
      - - - - - - - - - - -

      Status Code

      -

      Description

      -

      202

      -

      Accepted.

      -

      default

      -

      Client or server error.

      -
      -
      -
      -

      Error Code

      For details, see Error Code.

      -
      -
      -
      -
      -
      Parent topic: DB Instance Management
      -
      -
      - diff --git a/docs/dds/api-ref/en-us_topic_0000002107272436.html b/docs/dds/api-ref/en-us_topic_0000002107272436.html deleted file mode 100644 index be5a2b125..000000000 --- a/docs/dds/api-ref/en-us_topic_0000002107272436.html +++ /dev/null @@ -1,155 +0,0 @@ - - -

      Disassociating an Instance from an LTS Log Stream

      -

      API Description

      After you have disassociated an instance from an LTS log stream, logs of the instance are not uploaded to the LTS log stream.

      -
      -

      URI

      • URI format

        DELETE https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs

        - -
        - - - - - - - - - - - -
        Table 1 Path parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        project_id

        -

        Yes

        -

        String

        -

        Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

        -
        -
        - -
        - - - - - - - - - - - -
        Table 2 Request parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        X-Auth-Token

        -

        Yes

        -

        String

        -

        User token obtained from IAM.

        -
        -
        -
      -
      -

      Requests

      • Parameter description -
        - - - - - - - - - - - -
        Table 3 Request body parameters

        Parameter

        -

        Type

        -

        Mandatory

        -

        Description

        -

        lts_configs

        -

        Array of Table 4 objects

        -

        Yes

        -

        List of LTS configurations to be disabled. To disable multiple log configurations for an instance, you need to specify multiple items.

        -
        -
        - -
        - - - - - - - - - - - - - - - - -
        Table 4 lts_configs

        Parameter

        -

        Type

        -

        Mandatory

        -

        Description

        -

        instance_id

        -

        String

        -

        Yes

        -

        DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

        -

        log_type

        -

        String

        -

        Yes

        -

        LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

        -
        -
        -
      • Example request

        Disabling audit log reporting to LTS for a DB instance

        -

        DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs

        -
        { 
-   "lts_configs" : [ { 
-     "instance_id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
-     "log_type" : "audit_log" 
-   } ] 
- }
        -
      -
      -

      Responses

      • Parameter description

        None

        -
      -
      • Example response

        None

        -
      -
      -

      Status Code

      -
      - - - - - - - - - - -

      Status Code

      -

      Description

      -

      202

      -

      Accepted.

      -

      default

      -

      Client or server error.

      -
      -
      -
      -

      Error Code

      For details, see Error Code.

      -
      -

      -
      -
      -
      -
      Parent topic: DB Instance Management
      -
      -
      - diff --git a/docs/dds/api-ref/en-us_topic_0000002142831253.html b/docs/dds/api-ref/en-us_topic_0000002142831253.html deleted file mode 100644 index cb1875c3b..000000000 --- a/docs/dds/api-ref/en-us_topic_0000002142831253.html +++ /dev/null @@ -1,331 +0,0 @@ - - -

      Querying LTS Log Configurations

      -

      API Description

      This API is used to query LTS log configurations.

      -
      -

      Restrictions

      This API is available only for audit logs.

      -
      -

      URI

      • URI format
        GET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs -
        - - - - - - - - - - - -
        Table 1 Path parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        project_id

        -

        Yes

        -

        String

        -

        Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

        -
        -
        - -
        - - - - - - - - - - - - - - - - -
        Table 2 Query parameters

        Name

        -

        Mandatory

        -

        Type

        -

        Description

        -

        offset

        -

        No

        -

        Integer

        -

        Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value must be a positive integer.

        -

        limit

        -

        No

        -

        Integer

        -

        Number of records to be queried. The value ranges from 0 to 50. If this parameter is not transferred, the log configurations of the first 50 DB instances are queried by default.

        -
        -
        - -
        - - - - - - - - - - - -
        Table 3 Request parameters

        Parameter

        -

        Mandatory

        -

        Type

        -

        Description

        -

        X-Auth-Token

        -

        Yes

        -

        String

        -

        User token obtained from IAM.

        -
        -
        -
        -
      -
      -

      Requests

      • Parameter description

        None

        -
      • Example request

        Query the log configuration of the first 10 DB instances from the first piece of data.

        -

        GET https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs?offset=0&limit=10

        -
      -
      -

      Responses

      • Parameter description -
        - - - - - - - - - - - - - -
        Table 4 Response body parameters

        Parameter

        -

        Type

        -

        Description

        -

        instance_lts_configs

        -

        Array of Table 5 objects

        -

        LTS log configuration and brief information about each instance.

        -

        total_count

        -

        Integer

        -

        Total number of cloud service log configurations that can be queried, which is equal to the total number of DDS instances.

        -
        -
        - -
        - - - - - - - - - - - - - -
        Table 5 instance_lts_configs

        Parameter

        -

        Type

        -

        Description

        -

        instance

        -

        Table 6 object

        -

        Brief information about an instance.

        -

        lts_configs

        -

        Array of Table lts_configs objects

        -

        LTS log configuration details. If no LTS log stream is configured, no response is returned for this field.

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 6 instance

        Parameter

        -

        Type

        -

        Description

        -

        id

        -

        String

        -

        DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.

        -

        name

        -

        String

        -

        DDS Instance name.

        -

        mode

        -

        String

        -

        Instance type, which can be single node, replica set, or cluster.

        -

        Enumerated values:

        -
        • ReplicaSingle
        • ReplicaSet
        • Sharding
        -

        datastore

        -

        Table 7 object

        -

        DB engine and version of the DB instance.

        -

        status

        -

        String

        -

        Instance status.

        -

        enterprise_project_id

        -

        String

        -

        ID of the enterprise project to which the instance belongs. For the default enterprise project, the value is 0. For other enterprise projects, see Enterprise Management User Guide.

        -

        actions

        -

        Array of strings

        -

        All actions that are being executed on an instance.

        -
        -
        - -
        - - - - - - - - - - - - - -
        Table 7 datastore

        Parameter

        -

        Type

        -

        Description

        -

        type

        -

        String

        -

        DB engine. The value is mongodb.

        -

        version

        -

        String

        -

        Database major version.

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - -
        Table 8 lts_configs

        Parameter

        -

        Type

        -

        Description

        -

        log_type

        -

        String

        -

        LTS log type. This parameter cannot be left empty. The only supported option is audit_log.

        -

        lts_group_id

        -

        String

        -

        LTS log group ID.

        -

        lts_stream_id

        -

        String

        -

        LTS log stream ID.

        -

        enabled

        -

        Boolean

        -

        Indicates whether to upload logs to LTS.

        -
        -
        -
      -
      • Example response
        { 
-  "total_count" : 1, 
-  "instance_lts_configs" : [ { 
-    "instance" : { 
-      "id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
-      "name" : "dds-1f84", 
-      "mode" : "ReplicaSingle", 
-      "datastore" : { 
-        "type" : "mongodb", 
-        "version" : 4.0 
-      }, 
-      "status" : "normal", 
-      "enterprise_project_id" : "0", 
-      "actions" : [ "OPS_AUDIT_LOG" ] 
-    }, 
-    "lts_configs" : [ { 
-      "log_type" : "audit_log", 
-      "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", 
-      "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc", 
-      "enabled" : true 
-    } ] 
-  } ] 
-}
        -
      -
      -

      Status Code

      -
      - - - - - - - - - - -

      Status Code

      -

      Description

      -

      200

      -

      Success.

      -

      default

      -

      Client or server error.

      -
      -
      -
      -

      Error Code

      For details, see Error Code.

      -
      -

      -
      -
      -
      -
      Parent topic: DB Instance Management
      -
      -
      -