diff --git a/docs/ddm/api-ref/ALL_META.TXT.json b/docs/ddm/api-ref/ALL_META.TXT.json index cb92cdad6..bbe7ac549 100644 --- a/docs/ddm/api-ref/ALL_META.TXT.json +++ b/docs/ddm/api-ref/ALL_META.TXT.json @@ -14,7 +14,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Before You Start", @@ -32,7 +35,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Overview", @@ -50,7 +56,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"API Calling", @@ -68,7 +77,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Endpoints", @@ -86,7 +98,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Constraints", @@ -104,7 +119,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Concepts", @@ -122,7 +140,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"API Overview", @@ -140,7 +161,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Calling APIs", @@ -158,7 +182,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Making an API Request", @@ -176,7 +203,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Authentication", @@ -194,7 +224,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Returned Values", @@ -212,17 +245,62 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"APIs (Recommended)", "githuburl":"" }, + { + "uri":"ddm_api_01_0107.html", + "node_id":"ddm_api_01_0107.xml", + "product_code":"ddm", + "code":"13", + "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":"Querying API Versions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0108.html", + "node_id":"ddm_api_01_0108.xml", + "product_code":"ddm", + "code":"14", + "des":"This API is used to query API versions.NoneURL formatGET /Parameter descriptionNoneNoneNoneQuerying API versionsNormal responseNormal response exampleAbnormal responseFor", + "doc_type":"api", + "kw":"Querying API Versions (a V3 API),Querying API Versions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying API Versions (a V3 API)", + "githuburl":"" + }, { "uri":"ddm_api_01_0014.html", "node_id":"ddm_api_01_0014.xml", "product_code":"ddm", - "code":"13", + "code":"15", "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":"DDM Instances", @@ -230,136 +308,118 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"DDM Instances", "githuburl":"" }, { - "uri":"ddm_04_0001.html", - "node_id":"ddm_04_0001.xml", + "uri":"en-us_topic_0000002332909529.html", + "node_id":"en-us_topic_0000002332909529.xml", "product_code":"ddm", - "code":"14", + "code":"16", "des":"This API is used to create a DDM instance.DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been con", "doc_type":"api", - "kw":"Creating a DDM instance,DDM Instances,API Reference", + "kw":"Creating a DDM Instance(a V3 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Creating a DDM instance", + "title":"Creating a DDM Instance(a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0018.html", "node_id":"ddm_api_01_0018.xml", "product_code":"ddm", - "code":"15", + "code":"17", "des":"This API is used to query DDM instances.NoneGET /v1/{project_id}/instances?offset={offset}&limit={limit}Status code: 200Status code: 400Status code: 500Status code: 200OK", "doc_type":"api", - "kw":"Querying DDM Instances,DDM Instances,API Reference", + "kw":"Querying DDM Instances (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying DDM Instances", + "title":"Querying DDM Instances (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0019.html", "node_id":"ddm_api_01_0019.xml", "product_code":"ddm", - "code":"16", + "code":"18", "des":"This API is used to query details about a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}Status code: 200Status code: 400Status code: 500Status code: 200OKS", "doc_type":"api", - "kw":"Querying Details of a DDM Instance,DDM Instances,API Reference", + "kw":"Querying Details of a DDM Instance (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying Details of a DDM Instance", + "title":"Querying Details of a DDM Instance (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0020.html", "node_id":"ddm_api_01_0020.xml", "product_code":"ddm", - "code":"17", - "des":"This API is used to modify the name of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-nameStatus code: 200Status code: 400Status code: 500Status c", + "code":"19", + "des":"This API is used to change the name of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-nameStatus code: 200Status code: 400Status code: 500Status c", "doc_type":"api", - "kw":"Modifying the Name of a DDM Instance,DDM Instances,API Reference", + "kw":"Changing the Name of a DDM Instance (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Modifying the Name of a DDM Instance", + "title":"Changing the Name of a DDM Instance (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0021.html", "node_id":"ddm_api_01_0021.xml", "product_code":"ddm", - "code":"18", + "code":"20", "des":"This API is used to modify the security group of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-security-groupStatus code: 200Status code: 400Stat", "doc_type":"api", - "kw":"Modifying the Security Group of a DDM Instance,DDM Instances,API Reference", + "kw":"Modifying the Security Group of a DDM Instance (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Modifying the Security Group of a DDM Instance", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0022.html", - "node_id":"ddm_api_01_0022.xml", - "product_code":"ddm", - "code":"19", - "des":"This API is used to delete a DDM instance to release all its resources.NoneDELETE /v1/{project_id}/instances/{instance_id}Status code: 200Status code: 400Status code: 500", - "doc_type":"api", - "kw":"Deleting a DDM Instance,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Deleting a DDM Instance", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0023.html", - "node_id":"ddm_api_01_0023.xml", - "product_code":"ddm", - "code":"20", - "des":"This API is used to restart a DDM instance.NonePOST /v1/{project_id}/instances/{instance_id}/actionStatus code: 200Status code: 400Status code: 500Status code: 200okStatu", - "doc_type":"api", - "kw":"Restarting a DDM Instance,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Restarting a DDM Instance", + "title":"Modifying the Security Group of a DDM Instance (a V1 API)", "githuburl":"" }, { @@ -369,220 +429,546 @@ "code":"21", "des":"This API is used to reload table data of the destination DDM instance for cross-region DR.NonePOST /v1/{project_id}/instances/{instance_id}/reload-configStatus code: 200N", "doc_type":"api", - "kw":"Reloading Table Data,DDM Instances,API Reference", + "kw":"Reloading Table Data (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Reloading Table Data", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0025.html", - "node_id":"ddm_api_01_0025.xml", - "product_code":"ddm", - "code":"22", - "des":"This API is used to scale out a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.POST /v2/{project_id}", - "doc_type":"api", - "kw":"Scaling Out a DDM Instance,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Scaling Out a DDM Instance", + "title":"Reloading Table Data (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0026.html", "node_id":"ddm_api_01_0026.xml", "product_code":"ddm", - "code":"23", + "code":"22", "des":"This API is used to remove nodes from a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.POST /v2/{pro", "doc_type":"api", - "kw":"Scaling In a DDM instance,DDM Instances,API Reference", + "kw":"Scaling In a DDM instance (a V2 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Scaling In a DDM instance", + "title":"Scaling In a DDM instance (a V2 API)", "githuburl":"" }, { "uri":"ddm_api_01_0080.html", "node_id":"ddm_api_01_0080.xml", "product_code":"ddm", - "code":"24", + "code":"23", "des":"This API is used to modify the read policy of the DB instance associated with a DDM instance.Make sure that the associated RDS instances are available and not undergoing ", "doc_type":"api", - "kw":"Modifying the Read Policy of the Associated DB Instance,DDM Instances,API Reference", + "kw":"Modifying the Read Policy of the Associated DB Instance (a V2 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Modifying the Read Policy of the Associated DB Instance", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0081.html", - "node_id":"ddm_api_01_0081.xml", - "product_code":"ddm", - "code":"25", - "des":"This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.NonePOST /v1/{project_id}/instances/{instance_id}/rds/", - "doc_type":"api", - "kw":"Synchronizing Data Node Information,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Synchronizing Data Node Information", + "title":"Modifying the Read Policy of the Associated DB Instance (a V2 API)", "githuburl":"" }, { "uri":"ddm_api_01_0082.html", "node_id":"ddm_api_01_0082.xml", "product_code":"ddm", - "code":"26", + "code":"24", "des":"This API is used to query nodes of a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}Status code: 200Status code: 400Stat", "doc_type":"api", - "kw":"Querying Nodes of a DDM Instance,DDM Instances,API Reference", + "kw":"Querying Nodes of a DDM Instance (a V1 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying Nodes of a DDM Instance", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0083.html", - "node_id":"ddm_api_01_0083.xml", - "product_code":"ddm", - "code":"27", - "des":"This API is used to query details of a DDM instance node.NoneGET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}Status code: 200Status code: 400Status code: 500S", - "doc_type":"api", - "kw":"Querying Details of a DDM Instance Node,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Querying Details of a DDM Instance Node", + "title":"Querying Nodes of a DDM Instance (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0084.html", "node_id":"ddm_api_01_0084.xml", "product_code":"ddm", - "code":"28", + "code":"25", "des":"This API is used to query parameters of a specified DDM instance.NoneGET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}Status code:", "doc_type":"api", - "kw":"Querying Parameters of a Specified DDM Instance,DDM Instances,API Reference", + "kw":"Querying Parameters of a Specified DDM Instance (a V3 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying Parameters of a Specified DDM Instance", + "title":"Querying Parameters of a Specified DDM Instance (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0085.html", "node_id":"ddm_api_01_0085.xml", "product_code":"ddm", - "code":"29", + "code":"26", "des":"This API is used to modify parameters of a DDM instance.NonePUT /v3/{project_id}/instances/{instance_id}/configurationsStatus code: 200Status code: 400Status code: 500Sta", "doc_type":"api", - "kw":"Modifying Parameters of a DDM Instance,DDM Instances,API Reference", + "kw":"Modifying Parameters of a DDM Instance (a V3 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Modifying Parameters of a DDM Instance", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0015.html", - "node_id":"ddm_api_01_0015.xml", - "product_code":"ddm", - "code":"30", - "des":"This API is used to query engines that DDM supports.NoneGET /v2/{project_id}/engines?offset={offset}&limit={limit}Status code: 200Status code: 400Status code: 500Status c", - "doc_type":"api", - "kw":"Querying DDM Engine Information,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Querying DDM Engine Information", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0016.html", - "node_id":"ddm_api_01_0016.xml", - "product_code":"ddm", - "code":"31", - "des":"This API is used to query DDM node classes available in an AZ.NoneGET /v2/{project_id}/flavors?engine_id={engine_id}?offset={offset}&limit={limit}Status code: 200Status c", - "doc_type":"api", - "kw":"Querying DDM Node Classes Available in an AZ,DDM Instances,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Querying DDM Node Classes Available in an AZ", + "title":"Modifying Parameters of a DDM Instance (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0017.html", "node_id":"ddm_api_01_0017.xml", "product_code":"ddm", - "code":"32", + "code":"27", "des":"This API is used to change the node class of a DDM instance.The node class can be changed only when the corresponding DDM instance is normal.The new node class cannot be ", "doc_type":"api", - "kw":"Changing the Node Class of a DDM Instance,DDM Instances,API Reference", + "kw":"Changing the Node Class of a DDM Instance (a V3 API),DDM Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Changing the Node Class of a DDM Instance", + "title":"Changing the Node Class of a DDM Instance (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0093.html", + "node_id":"ddm_api_01_0093.xml", + "product_code":"ddm", + "code":"28", + "des":"Obtain DDM instance group information.NoneURL formatGET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}GET /v3/{project_id}/instances/{insta", + "doc_type":"api", + "kw":"Obtaining the Instance Group Information (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Obtaining the Instance Group Information (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0094.html", + "node_id":"ddm_api_01_0094.xml", + "product_code":"ddm", + "code":"29", + "des":"This API is used to create a DDM instance group.NoneURL formatPOST /v3/{project_id}/instances/{instance_id}/groupsPOST /v3/{project_id}/instances/{instance_id}/groupsPara", + "doc_type":"api", + "kw":"Creating an Instance Group (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Creating an Instance Group (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181783542.html", + "node_id":"en-us_topic_0000002181783542.xml", + "product_code":"", + "code":"30", + "des":"This API is used to delete a DDM instance group.NoneDELETE /v3/{project_id}/instances/{instance_id}/groups/{group_id}Parameter descriptionParameterMandatoryTypeDescriptio", + "doc_type":"", + "kw":"Deleting an Instance Group(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Deleting an Instance Group(a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0109.html", + "node_id":"ddm_api_01_0109.xml", + "product_code":"ddm", + "code":"31", + "des":"This V3 API is used to query information about DDM engine.NoneURL formatGET /v3/{project_id}/engines?offset={offset}&limit={limit}Parameter descriptionQuerying DDM engine", + "doc_type":"api", + "kw":"Querying DDM Engine Information (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying DDM Engine Information (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0110.html", + "node_id":"ddm_api_01_0110.xml", + "product_code":"ddm", + "code":"32", + "des":"This V3 API is used to query DDM node classes available in an AZ.NoneURL formatGET /v3/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit}&engine_ver", + "doc_type":"api", + "kw":"Querying DDM Node Classes Available in Each AZ (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying DDM Node Classes Available in Each AZ (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0111.html", + "node_id":"ddm_api_01_0111.xml", + "product_code":"ddm", + "code":"33", + "des":"This API is used to scale out a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.URL formatPOST /v3/{p", + "doc_type":"api", + "kw":"Scaling Out a DDM Instance (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Scaling Out a DDM Instance (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0112.html", + "node_id":"ddm_api_01_0112.xml", + "product_code":"ddm", + "code":"34", + "des":"This API is used to obtain information about a task with a specified ID in the DDM task center.NoneURL formatGET /v3/{project_id}/jobs/{job_id}GET /v3/{project_id}/jobs/{", + "doc_type":"api", + "kw":"Obtaining Information About a Task with a Specified ID (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Obtaining Information About a Task with a Specified ID (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0113.html", + "node_id":"ddm_api_01_0113.xml", + "product_code":"ddm", + "code":"35", + "des":"This API is used to delete a DDM instance to release all its resources.NoneURL formatDELETE /v3/{project_id}/instances/{instance_id}DELETE /v3/{project_id}/instances/{ins", + "doc_type":"api", + "kw":"Deleting an Instance (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting an Instance (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0114.html", + "node_id":"ddm_api_01_0114.xml", + "product_code":"ddm", + "code":"36", + "des":"This API is used to configure SSL to encrypt connections.NonePOST /v3/{project_id}/instances/{instance_id}/switch-sslEnabling SSLPOST https://ddm.eu-de.otc.t-systems.com/", + "doc_type":"api", + "kw":"Enabling or Disabling SSL (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Enabling or Disabling SSL (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217069689.html", + "node_id":"en-us_topic_0000002217069689.xml", + "product_code":"ddm", + "code":"37", + "des":"This API is used to change an instance port.NonePUT /v3/{project_id}/instances/{instance_id}/portChanging an instance port to 5067POST https://ddm.eu-de.otc.t-systems.com", + "doc_type":"api", + "kw":"Changing an Instance Port(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Changing an Instance Port(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181623846.html", + "node_id":"en-us_topic_0000002181623846.xml", + "product_code":"ddm", + "code":"38", + "des":"This API is used to restart a specific instance.NonePOST /v3/{project_id}/instances/{instance_id}/restartWhether to restart the instance.Normal responseResponse body para", + "doc_type":"api", + "kw":"Restarting a DDM Instance(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Restarting a DDM Instance(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217144121.html", + "node_id":"en-us_topic_0000002217144121.xml", + "product_code":"ddm", + "code":"39", + "des":"This API is used to restart a specific node.NonePOST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/restartRestarting a nodeNormal responseResponse body paramet", + "doc_type":"api", + "kw":"Restarting a DDM Node(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Restarting a DDM Node(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181783546.html", + "node_id":"en-us_topic_0000002181783546.xml", + "product_code":"ddm", + "code":"40", + "des":"This API is used to bind an EIP.NonePOST /v3/{project_id}/instances/{instance_id}/eipBinding an EIP to an instancePOST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b", + "doc_type":"api", + "kw":"Binding an EIP(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Binding an EIP(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217069693.html", + "node_id":"en-us_topic_0000002217069693.xml", + "product_code":"ddm", + "code":"41", + "des":"This API is used to unbind an EIP from an instance.NoneDELETE /v3/{project_id}/instances/{instance_id}/eipUnbinding an EIP from an instanceDELETE https://ddm.eu-de.otc.t-", + "doc_type":"api", + "kw":"Unbinding an EIP(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Unbinding an EIP(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181623850.html", + "node_id":"en-us_topic_0000002181623850.xml", + "product_code":"ddm", + "code":"42", + "des":"This API is used to change the load balancer IP address of an instance.NonePUT /v3/{project_id}/instances/{instance_id}/elb/ipChanging an ELB load balancer IP addressPUT ", + "doc_type":"api", + "kw":"Changing the Load Balancer IP Address of an Instance(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Changing the Load Balancer IP Address of an Instance(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002299876902.html", + "node_id":"en-us_topic_0000002299876902.xml", + "product_code":"ddm", + "code":"43", + "des":"This API is used to delete multiple nodes from an instance at a time.Nodes in different groups cannot be deleted at the same time.POST /v3/{project_id}/instances/{instanc", + "doc_type":"api", + "kw":"Deleting Multiple Nodes from an Instance at a Time(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting Multiple Nodes from an Instance at a Time(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181783550.html", + "node_id":"en-us_topic_0000002181783550.xml", + "product_code":"ddm", + "code":"44", + "des":"This API is used to query details about an instance node.NoneGET /v3/{project_id}/instances/{instance_id}/nodes/{node_id}Querying details about an instance nodeGET https:", + "doc_type":"api", + "kw":"Querying Details About a DDM Instance Node(a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Details About a DDM Instance Node(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869325.html", + "node_id":"en-us_topic_0000002332869325.xml", + "product_code":"ddm", + "code":"45", + "des":"This API is used to synchronize data node information.NonePOST /v3/{project_id}/instances/{instance_id}/data-nodes/syncSynchronizing data node informationPOST https://ddm", + "doc_type":"api", + "kw":"Synchronizing Data Node Information (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Synchronizing Data Node Information (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949840.html", + "node_id":"en-us_topic_0000002298949840.xml", + "product_code":"ddm", + "code":"46", + "des":"This API is used to query information about tasks.NoneGET /v3/{project_id}/jobsQuerying information about tasksGET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be6", + "doc_type":"api", + "kw":"Querying Information About Tasks (a V3 API),DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Information About Tasks (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0027.html", "node_id":"ddm_api_01_0027.xml", "product_code":"ddm", - "code":"33", + "code":"47", "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":"Schemas", @@ -590,107 +976,415 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Schemas", "githuburl":"" }, - { - "uri":"ddm_16_0001.html", - "node_id":"ddm_16_0001.xml", - "product_code":"ddm", - "code":"34", - "des":"This API is used to create a schema.Before creating a schema, ensure that you have associated RDS instances with your DDM instance and that the RDS instances are not asso", - "doc_type":"api", - "kw":"Creating a Schema,Schemas,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Creating a Schema", - "githuburl":"" - }, { "uri":"ddm_api_01_0029.html", "node_id":"ddm_api_01_0029.xml", "product_code":"ddm", - "code":"35", + "code":"48", "des":"This API is used to query schemas of a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}Status code: 200Status code: 4", "doc_type":"api", - "kw":"Querying Schemas,Schemas,API Reference", + "kw":"Querying Schemas (a V1 API),Schemas,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying Schemas", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0030.html", - "node_id":"ddm_api_01_0030.xml", - "product_code":"ddm", - "code":"36", - "des":"This API is used to query details about a schema.NoneGET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}Status code: 200Status code: 400Status code: 500St", - "doc_type":"api", - "kw":"Querying Details of a Schema,Schemas,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Querying Details of a Schema", - "githuburl":"" - }, - { - "uri":"ddm_api_01_0031.html", - "node_id":"ddm_api_01_0031.xml", - "product_code":"ddm", - "code":"37", - "des":"This API is used to delete a schema to release all its resources.NoneDELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_da", - "doc_type":"api", - "kw":"Deleting a Schema,Schemas,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"ddm" - } - ], - "title":"Deleting a Schema", + "title":"Querying Schemas (a V1 API)", "githuburl":"" }, { "uri":"ddm_api_01_0100.html", "node_id":"ddm_api_01_0100.xml", "product_code":"ddm", - "code":"38", + "code":"49", "des":"This API is used to query DB instances that can be used for creating a schema.NoneGET /v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}Status cod", "doc_type":"api", - "kw":"Querying DB Instances Available for Creating a Schema,Schemas,API Reference", + "kw":"Querying DB Instances Available for Creating a Schema (a V1 API),Schemas,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Querying DB Instances Available for Creating a Schema", + "title":"Querying DB Instances Available for Creating a Schema (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0115.html", + "node_id":"ddm_api_01_0115.xml", + "product_code":"ddm", + "code":"50", + "des":"This API is used to create a schema.Before creating a schema, ensure that an RDS instance has been created, is in the normal state, and is not associated with other DDM i", + "doc_type":"api", + "kw":"Creating a Schema(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Creating a Schema(a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0116.html", + "node_id":"ddm_api_01_0116.xml", + "product_code":"ddm", + "code":"51", + "des":"This API is used to delete a schema to release all its resources.NoneURL formatDELETE /v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data={d", + "doc_type":"api", + "kw":"Deleting a Schema(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting a Schema(a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0104.html", + "node_id":"ddm_api_01_0104.xml", + "product_code":"ddm", + "code":"52", + "des":"This API is used to export all schema metadata about distribution of physical shards on data nodes.NoneGET /v3/{project_id}/instances/{instance_id}/schema-metadataNormal ", + "doc_type":"api", + "kw":"Exporting Schema Metadata(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Exporting Schema Metadata(a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0105.html", + "node_id":"ddm_api_01_0105.xml", + "product_code":"ddm", + "code":"53", + "des":"This API is used to import distribution information of physical shards in all schemas and use it to create schemas that contain the same physical shards and distribution ", + "doc_type":"api", + "kw":"Importing Schema Metadata(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Importing Schema Metadata(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217069697.html", + "node_id":"en-us_topic_0000002217069697.xml", + "product_code":"", + "code":"54", + "des":"This API is used to query details about a schema.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{database_name}Querying details about a schemaGET https://ddm.", + "doc_type":"", + "kw":"Querying Details About a Schema(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying Details About a Schema(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790184.html", + "node_id":"en-us_topic_0000002298790184.xml", + "product_code":"ddm", + "code":"55", + "des":"This API is used to query data nodes that can be used for creating a schema.NoneGET /v3/{project_id}/instances/{instance_id}/available-data-nodesQuerying data nodes that ", + "doc_type":"api", + "kw":"Querying Data Nodes Available for Creating a Schema (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Data Nodes Available for Creating a Schema (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909537.html", + "node_id":"en-us_topic_0000002332909537.xml", + "product_code":"ddm", + "code":"56", + "des":"This API is used to query data nodes that can be used for shard configuration.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/available-dat", + "doc_type":"api", + "kw":"Querying Data Nodes Available for Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Data Nodes Available for Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869333.html", + "node_id":"en-us_topic_0000002332869333.xml", + "product_code":"ddm", + "code":"57", + "des":"This API is used to pre-check shard configuration to prevent shard configuration failures. For details about pre-check items, see the user guide.This API returns the foll", + "doc_type":"api", + "kw":"Pre-checking Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Pre-checking Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949848.html", + "node_id":"en-us_topic_0000002298949848.xml", + "product_code":"ddm", + "code":"58", + "des":"This API is used to query the pre-check result of a shard configuration task that takes some time to execute. For details about pre-check items, see the user guide.The as", + "doc_type":"api", + "kw":"Querying the Asynchronous Pre-check Result of Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying the Asynchronous Pre-check Result of Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790192.html", + "node_id":"en-us_topic_0000002298790192.xml", + "product_code":"ddm", + "code":"59", + "des":"This API is used to add data nodes or shards to enhance data storage and provide better support for concurrency.The shard configuration task can only be performed after a", + "doc_type":"api", + "kw":"Performing Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Performing Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909545.html", + "node_id":"en-us_topic_0000002332909545.xml", + "product_code":"ddm", + "code":"60", + "des":"This API is used to query details about a shard configuration task.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}Querying de", + "doc_type":"api", + "kw":"Querying Details About a Shard Configuration Task(a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Details About a Shard Configuration Task(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869341.html", + "node_id":"en-us_topic_0000002332869341.xml", + "product_code":"ddm", + "code":"61", + "des":"This API is used to cancel shard configuration.The shard configuration task to be canceled must be in the Running, Failed, or ToBeSwitched state.PUT /v3/{project_id}/inst", + "doc_type":"api", + "kw":"Canceling Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Canceling Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949856.html", + "node_id":"en-us_topic_0000002298949856.xml", + "product_code":"ddm", + "code":"62", + "des":"This API is used to roll back shard configuration.Only tasks in the Failed state can be rolled back.PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migra", + "doc_type":"api", + "kw":"Rolling Back Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Rolling Back Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790204.html", + "node_id":"en-us_topic_0000002298790204.xml", + "product_code":"ddm", + "code":"63", + "des":"This API is used to clear shard configuration data.Only data of shard configuration tasks in the ToBeCleaned state can be cleared.PUT /v3/{project_id}/instances/{instance", + "doc_type":"api", + "kw":"Clearing Shard Configuration Data (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Clearing Shard Configuration Data (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909553.html", + "node_id":"en-us_topic_0000002332909553.xml", + "product_code":"ddm", + "code":"64", + "des":"This API is used to retry shard configuration.Only shard configuration tasks in the Failed state can be retried.PUT /v3/{project_id}/instances/{instance_id}/databases/{db", + "doc_type":"api", + "kw":"Retrying Shard Configuration (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Retrying Shard Configuration (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869349.html", + "node_id":"en-us_topic_0000002332869349.xml", + "product_code":"ddm", + "code":"65", + "des":"This API is used to change a route switching policy.Only the route switching policy of a shard configuration task in the ToBeSwitched state can be changed.PUT /v3/{projec", + "doc_type":"api", + "kw":"Changing a Route Switching Policy (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Changing a Route Switching Policy (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949868.html", + "node_id":"en-us_topic_0000002298949868.xml", + "product_code":"ddm", + "code":"66", + "des":"This API is used to switch read and write requests to a new instance. During the switching process, one or two intermittent disconnections may occur but do not affect ser", + "doc_type":"api", + "kw":"Switching Routes (a V3 API),Schemas,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Switching Routes (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0041.html", "node_id":"ddm_api_01_0041.xml", "product_code":"ddm", - "code":"39", + "code":"67", "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":"DDM Accounts", @@ -698,7 +1392,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"DDM Accounts", @@ -708,43 +1405,49 @@ "uri":"ddm_api_01_0101.html", "node_id":"ddm_api_01_0101.xml", "product_code":"ddm", - "code":"40", + "code":"68", "des":"If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the ad", "doc_type":"api", - "kw":"Managing the Administrator Password,DDM Accounts,API Reference", + "kw":"Managing the Administrator Password (a V3 API),DDM Accounts,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Managing the Administrator Password", + "title":"Managing the Administrator Password (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0102.html", "node_id":"ddm_api_01_0102.xml", "product_code":"ddm", - "code":"41", + "code":"69", "des":"This API is used to check whether an instance password is a weak password.POST /v3/{project_id}/weak-password-verificationStatus code: 200Status code: 400Status code: 500", "doc_type":"api", - "kw":"Validating Password Strength,DDM Accounts,API Reference", + "kw":"Checking Whether a Password Is Weak (a V3 API),DDM Accounts,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Validating Password Strength", + "title":"Checking Whether a Password Is Weak (a V3 API)", "githuburl":"" }, { "uri":"ddm_api_01_0089.html", "node_id":"ddm_api_01_0089.xml", "product_code":"ddm", - "code":"42", + "code":"70", "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":"Monitoring", @@ -752,35 +1455,845 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Monitoring", "githuburl":"" }, { - "uri":"ddm_api_01_0090.html", - "node_id":"ddm_api_01_0090.xml", + "uri":"ddm_api_01_0117.html", + "node_id":"ddm_api_01_0117.xml", "product_code":"ddm", - "code":"43", - "des":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.NoneGET /v2/{project_id}/instances/{instan", + "code":"71", + "des":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.NoneURL formatGET /v3/{project_id}/instanc", "doc_type":"api", - "kw":"Monitoring Slow Query Logs,Monitoring,API Reference", + "kw":"Monitoring Slow Query Logs(a V3 API),Monitoring,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], - "title":"Monitoring Slow Query Logs", + "title":"Monitoring Slow Query Logs(a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0104_0.html", + "node_id":"ddm_api_01_0104_0.xml", + "product_code":"ddm", + "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":"Parameter Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Parameter Management", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0105_0.html", + "node_id":"ddm_api_01_0105_0.xml", + "product_code":"ddm", + "code":"73", + "des":"This API is used to obtain parameter templates, including all default and custom parameter templates.NoneURL formatGET /v3/{project_id}/configurations?offset={offset}&lim", + "doc_type":"api", + "kw":"Obtaining Parameter Templates (a V3 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Obtaining Parameter Templates (a V3 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0106.html", + "node_id":"ddm_api_01_0106.xml", + "product_code":"ddm", + "code":"74", + "des":"This API is used to obtain information about a specified parameter template.NoneURL formatGET /v3/{project_id}/configurations/{config_id}Parameter descriptionObtaining in", + "doc_type":"api", + "kw":"Obtaining Parameters in a Specified Parameter Template (a V3 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Obtaining Parameters in a Specified Parameter Template (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181623854.html", + "node_id":"en-us_topic_0000002181623854.xml", + "product_code":"ddm", + "code":"75", + "des":"This API is used to modify parameters of a DDM instance.The values of the modified parameters must be within the value range defined on the DDM console. For details about", + "doc_type":"api", + "kw":"Modifying Parameters of an Instance(a V3.1 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Modifying Parameters of an Instance(a V3.1 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790216.html", + "node_id":"en-us_topic_0000002298790216.xml", + "product_code":"ddm", + "code":"76", + "des":"This API is used to create a parameter group.NonePOST /v3/{project_id}/configurationsCreating a parameter groupPOST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e", + "doc_type":"api", + "kw":"Creating a Parameter Group(a V3 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Creating a Parameter Group(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909561.html", + "node_id":"en-us_topic_0000002332909561.xml", + "product_code":"ddm", + "code":"77", + "des":"This API is used to delete a parameter group.NoneDELETE /v3/{project_id}/configurations/{config_id}Deleting a parameter groupDELETE https://ddm.eu-de.otc.t-systems.com/v3", + "doc_type":"api", + "kw":"Deleting a Parameter Group(a V3 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting a Parameter Group(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217144129.html", + "node_id":"en-us_topic_0000002217144129.xml", + "product_code":"", + "code":"78", + "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":"", + "kw":"Backup Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Backup Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002181783554.html", + "node_id":"en-us_topic_0000002181783554.xml", + "product_code":"", + "code":"79", + "des":"This API is used to query backups.NoneGET /v3/{project_id}/backupsThis API is used to query backups.Normal responseNormal response exampleAbnormal responseFor details, se", + "doc_type":"", + "kw":"Querying Backups(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying Backups(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002217069701.html", + "node_id":"en-us_topic_0000002217069701.xml", + "product_code":"", + "code":"80", + "des":"This API is used to delete a specified backup.NoneDELETE /v3/{project_id}/backups/{backup_id}Deleting a specified backupNormal responseResponse body parametersParameterTy", + "doc_type":"", + "kw":"Deleting a Backup(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Deleting a Backup(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869361.html", + "node_id":"en-us_topic_0000002332869361.xml", + "product_code":"ddm", + "code":"81", + "des":"This API is used to query details about a backup.NoneGET /v3/{project_id}/instances/{instance_id}/backups/{backup_id}Querying details about a backupGET https://ddm.eu-de.", + "doc_type":"api", + "kw":"Querying Details About a Backup(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Details About a Backup(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949876.html", + "node_id":"en-us_topic_0000002298949876.xml", + "product_code":"ddm", + "code":"82", + "des":"This API is used to query data nodes associated with an instance at a restoration time point.NoneGET /v3/{project_id}/instances/{instance_id}/backups/related-dnNormal res", + "doc_type":"api", + "kw":"Querying Data Nodes Associated with an Instance at a Restoration Time Point(a V3 API),Backup Managem", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Data Nodes Associated with an Instance at a Restoration Time Point(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790224.html", + "node_id":"en-us_topic_0000002298790224.xml", + "product_code":"ddm", + "code":"83", + "des":"This API is used to query the restoration time range of an instance.The intersection between the restoration time range of an instance and those of all data nodes associa", + "doc_type":"api", + "kw":"Querying the Restoration Time Range(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying the Restoration Time Range(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909569.html", + "node_id":"en-us_topic_0000002332909569.xml", + "product_code":"ddm", + "code":"84", + "des":"This API is used to query data nodes available for restoration.You must call the API for querying the restoration time range first.GET /v3/{project_id}/instances/{instanc", + "doc_type":"api", + "kw":"Querying Data Nodes Available to Restore Data to a Point in Time(a V3 API),Backup Management,API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Data Nodes Available to Restore Data to a Point in Time(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869369.html", + "node_id":"en-us_topic_0000002332869369.xml", + "product_code":"ddm", + "code":"85", + "des":"This API is used to query instances available for restoration.NoneGET /v3/{project_id}/instances/{instance_id}/backups/restorable-instancesQuerying instances available fo", + "doc_type":"api", + "kw":"Querying Instances Available for Restoration(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Instances Available for Restoration(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949884.html", + "node_id":"en-us_topic_0000002298949884.xml", + "product_code":"ddm", + "code":"86", + "des":"This API is used to restore metadata.Metadata restoration mainly restores the metadata of your DDM instance to a new DDM instance. It starts after a point-in-time recover", + "doc_type":"api", + "kw":"Restoring Metadata(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Restoring Metadata(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790232.html", + "node_id":"en-us_topic_0000002298790232.xml", + "product_code":"ddm", + "code":"87", + "des":"This API is used to restore data to a new instance.NonePOST /v3/{project_id}/instances/{instance_id}/backups/recoveryRestoring data to a new instancePOST https://ddm.eu-d", + "doc_type":"api", + "kw":"Restoring Data to a New Instance(a V3 API),Backup Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Restoring Data to a New Instance(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909577.html", + "node_id":"en-us_topic_0000002332909577.xml", + "product_code":"", + "code":"88", + "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":"", + "kw":"Tag Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869377.html", + "node_id":"en-us_topic_0000002332869377.xml", + "product_code":"ddm", + "code":"89", + "des":"This API is used to query project tags.NoneGET /v3/{project_id}/instances/tagsQuerying project tagsNormal responseNormal response exampleAbnormal responseFor details, see", + "doc_type":"api", + "kw":"Querying Project Tags(a V3 API),Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Project Tags(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298949892.html", + "node_id":"en-us_topic_0000002298949892.xml", + "product_code":"ddm", + "code":"90", + "des":"This API is used to query instance tags.NoneGET /v3/{project_id}/instances/{instance_id}/tagsQuerying instance tagsNormal responseNormal response exampleAbnormal response", + "doc_type":"api", + "kw":"Querying Instance Tags(a V3 API),Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Instance Tags(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002298790240.html", + "node_id":"en-us_topic_0000002298790240.xml", + "product_code":"ddm", + "code":"91", + "des":"This API is used to add tags for an instance.A maximum of 20 tags can be added for an instance. The tag key must be unique.If the request body contains duplicated keys, a", + "doc_type":"api", + "kw":"Adding Tags for an Instance(a V3 API),Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Adding Tags for an Instance(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332909585.html", + "node_id":"en-us_topic_0000002332909585.xml", + "product_code":"ddm", + "code":"92", + "des":"This API is used to delete tags from an instance at a time.If the tag to be deleted does not exist, the system deems the deletion operation successful by default. The tag", + "doc_type":"api", + "kw":"Deleting Tags from an Instance at a Time (a V3 API),Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting Tags from an Instance at a Time (a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002332869385.html", + "node_id":"en-us_topic_0000002332869385.xml", + "product_code":"ddm", + "code":"93", + "des":"This API is used to change an instance tag.NonePUT /v3/{project_id}/instances/{instance_id}/tags/{key}Changing an instance tagNormal responseNoneNormal response exampleNo", + "doc_type":"api", + "kw":"Changing an Instance Tag(a V3 API),Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Changing an Instance Tag(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002318291129.html", + "node_id":"en-us_topic_0000002318291129.xml", + "product_code":"", + "code":"94", + "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":"", + "kw":"APIs (Unavailable Soon)", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"APIs (Unavailable Soon)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002283971858.html", + "node_id":"en-us_topic_0000002283971858.xml", + "product_code":"", + "code":"95", + "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":"", + "kw":"Instance Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Instance Management", + "githuburl":"" + }, + { + "uri":"ddm_04_0001.html", + "node_id":"ddm_04_0001.xml", + "product_code":"ddm", + "code":"96", + "des":"This API is used to create a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Creating a DDM Instance (a V3 API)", + "doc_type":"api", + "kw":"Creating a DDM instance (a V1 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Creating a DDM instance (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0015.html", + "node_id":"ddm_api_01_0015.xml", + "product_code":"ddm", + "code":"97", + "des":"This API is used to query engines that DDM supports.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying DDM Engine Info", + "doc_type":"api", + "kw":"Querying DDM Engine Information (a V2 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying DDM Engine Information (a V2 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0016.html", + "node_id":"ddm_api_01_0016.xml", + "product_code":"ddm", + "code":"98", + "des":"This API is used to query DDM node classes available in an AZ.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying DDM N", + "doc_type":"api", + "kw":"Querying DDM Node Classes Available in an AZ (a V2 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying DDM Node Classes Available in an AZ (a V2 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0083.html", + "node_id":"ddm_api_01_0083.xml", + "product_code":"ddm", + "code":"99", + "des":"This API is used to query details of a DDM instance node.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying Details Ab", + "doc_type":"api", + "kw":"Querying Details of a DDM Instance Node (a V1 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Details of a DDM Instance Node (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0023.html", + "node_id":"ddm_api_01_0023.xml", + "product_code":"ddm", + "code":"100", + "des":"This API is used to restart a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Restarting a DDM Instance (a V3 A", + "doc_type":"api", + "kw":"Restarting a DDM Instance (a V1 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Restarting a DDM Instance (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0022.html", + "node_id":"ddm_api_01_0022.xml", + "product_code":"ddm", + "code":"101", + "des":"This API is used to delete a DDM instance to release all its resources.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Delet", + "doc_type":"api", + "kw":"Deleting a DDM Instance (a V1 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting a DDM Instance (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0025.html", + "node_id":"ddm_api_01_0025.xml", + "product_code":"ddm", + "code":"102", + "des":"This API is used to scale out a specified DDM instance.This API is to be removed soon, so it is not recommended.Use the API of the latest version in Scaling Out a DDM Ins", + "doc_type":"api", + "kw":"Scaling Out a DDM Instance (a V2 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Scaling Out a DDM Instance (a V2 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0081.html", + "node_id":"ddm_api_01_0081.xml", + "product_code":"ddm", + "code":"103", + "des":"This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.This API is to be removed soon, so it is not recommend", + "doc_type":"api", + "kw":"Synchronizing Data Node Information (a V1 API),Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Synchronizing Data Node Information (a V1 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002318531425.html", + "node_id":"en-us_topic_0000002318531425.xml", + "product_code":"", + "code":"104", + "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":"", + "kw":"Schema Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Schema Management", + "githuburl":"" + }, + { + "uri":"ddm_16_0001.html", + "node_id":"ddm_16_0001.xml", + "product_code":"ddm", + "code":"105", + "des":"This API is used to create a schema.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Creating a Schema (a V3 API).POST /v1/{p", + "doc_type":"api", + "kw":"Creating a Schema (a V1 API),Schema Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Creating a Schema (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0031.html", + "node_id":"ddm_api_01_0031.xml", + "product_code":"ddm", + "code":"106", + "des":"This API is used to delete a schema to release all its resources.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Deleting a ", + "doc_type":"api", + "kw":"Deleting a Schema (a V1 API),Schema Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Deleting a Schema (a V1 API)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0030.html", + "node_id":"ddm_api_01_0030.xml", + "product_code":"ddm", + "code":"107", + "des":"This API is used to query details about a schema.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying Details About a Sc", + "doc_type":"api", + "kw":"Querying Details of a Schema (a V1 API),Schema Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Querying Details of a Schema (a V1 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002514999631.html", + "node_id":"en-us_topic_0000002514999631.xml", + "product_code":"", + "code":"108", + "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":"", + "kw":"Parameter Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Parameter Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002510482745.html", + "node_id":"en-us_topic_0000002510482745.xml", + "product_code":"ddm", + "code":"109", + "des":"This API is used to modify parameters of a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Modifying Parameters", + "doc_type":"api", + "kw":"Modifying Parameters of an Instance(a V3 API),Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Modifying Parameters of an Instance(a V3 API)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002318604513.html", + "node_id":"en-us_topic_0000002318604513.xml", + "product_code":"", + "code":"110", + "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":"", + "kw":"Monitoring Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Monitoring Management", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0090.html", + "node_id":"ddm_api_01_0090.xml", + "product_code":"ddm", + "code":"111", + "des":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.This API is to be removed soon, so it is n", + "doc_type":"api", + "kw":"Monitoring Slow Query Logs (a V2 API),Monitoring Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" + } + ], + "title":"Monitoring Slow Query Logs (a V2 API)", "githuburl":"" }, { "uri":"ddm_api_01_0058.html", "node_id":"ddm_api_01_0058.xml", "product_code":"ddm", - "code":"44", + "code":"112", "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", @@ -788,7 +2301,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Appendix", @@ -798,7 +2314,7 @@ "uri":"ddm_api_01_0059.html", "node_id":"ddm_api_01_0059.xml", "product_code":"ddm", - "code":"45", + "code":"113", "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":"Abnormal Request Results,Appendix,API Reference", @@ -806,7 +2322,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Abnormal Request Results", @@ -816,7 +2335,7 @@ "uri":"ddm_api_01_0060.html", "node_id":"ddm_api_01_0060.xml", "product_code":"ddm", - "code":"46", + "code":"114", "des":"Table 1 lists the status codes that may be returned.Table 2 lists the status codes that may be returned.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", @@ -824,7 +2343,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Status Codes", @@ -834,7 +2356,7 @@ "uri":"ddm_api_01_0061.html", "node_id":"ddm_api_01_0061.xml", "product_code":"ddm", - "code":"47", + "code":"115", "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":"Error Codes,Appendix,API Reference", @@ -842,7 +2364,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Error Codes", @@ -852,7 +2377,7 @@ "uri":"ddm_api_01_0062.html", "node_id":"ddm_api_01_0062.xml", "product_code":"ddm", - "code":"48", + "code":"116", "des":"DDM node classes are listed in the following table and vary according to actual situations.", "doc_type":"api", "kw":"Node Classes,Appendix,API Reference", @@ -860,7 +2385,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Node Classes", @@ -870,7 +2398,7 @@ "uri":"ddm_api_01_0063.html", "node_id":"ddm_api_01_0063.xml", "product_code":"ddm", - "code":"49", + "code":"117", "des":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first Two methods are available:Obtaining the Project ID b", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -878,7 +2406,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Obtaining a Project ID", @@ -888,7 +2419,7 @@ "uri":"ddm_api_01_0064.html", "node_id":"ddm_api_01_0064.xml", "product_code":"ddm", - "code":"50", + "code":"118", "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":"Status Description,Appendix,API Reference", @@ -896,7 +2427,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Status Description", @@ -906,7 +2440,7 @@ "uri":"ddm_api_01_0069.html", "node_id":"ddm_api_01_0069.xml", "product_code":"ddm", - "code":"51", + "code":"119", "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", @@ -914,7 +2448,10 @@ "metedata":[ { "documenttype":"api", - "prodname":"ddm" + "prodname":"ddm", + "opensource":"true", + "IsMulti":"No", + "IsBot":"Yes" } ], "title":"Change History", diff --git a/docs/ddm/api-ref/CLASS.TXT.json b/docs/ddm/api-ref/CLASS.TXT.json index 58127b124..7d8e5dfba 100644 --- a/docs/ddm/api-ref/CLASS.TXT.json +++ b/docs/ddm/api-ref/CLASS.TXT.json @@ -110,183 +110,309 @@ { "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":"ddm", - "title":"DDM Instances", - "uri":"ddm_api_01_0014.html", + "title":"Querying API Versions", + "uri":"ddm_api_01_0107.html", "doc_type":"api", "p_code":"12", "code":"13" }, { - "desc":"This API is used to create a DDM instance.DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been con", + "desc":"This API is used to query API versions.NoneURL formatGET /Parameter descriptionNoneNoneNoneQuerying API versionsNormal responseNormal response exampleAbnormal responseFor", "product_code":"ddm", - "title":"Creating a DDM instance", - "uri":"ddm_04_0001.html", + "title":"Querying API Versions (a V3 API)", + "uri":"ddm_api_01_0108.html", "doc_type":"api", "p_code":"13", "code":"14" }, + { + "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":"ddm", + "title":"DDM Instances", + "uri":"ddm_api_01_0014.html", + "doc_type":"api", + "p_code":"12", + "code":"15" + }, + { + "desc":"This API is used to create a DDM instance.DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been con", + "product_code":"ddm", + "title":"Creating a DDM Instance(a V3 API)", + "uri":"en-us_topic_0000002332909529.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, { "desc":"This API is used to query DDM instances.NoneGET /v1/{project_id}/instances?offset={offset}&limit={limit}Status code: 200Status code: 400Status code: 500Status code: 200OK", "product_code":"ddm", - "title":"Querying DDM Instances", + "title":"Querying DDM Instances (a V1 API)", "uri":"ddm_api_01_0018.html", "doc_type":"api", - "p_code":"13", - "code":"15" + "p_code":"15", + "code":"17" }, { "desc":"This API is used to query details about a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}Status code: 200Status code: 400Status code: 500Status code: 200OKS", "product_code":"ddm", - "title":"Querying Details of a DDM Instance", + "title":"Querying Details of a DDM Instance (a V1 API)", "uri":"ddm_api_01_0019.html", "doc_type":"api", - "p_code":"13", - "code":"16" + "p_code":"15", + "code":"18" }, { - "desc":"This API is used to modify the name of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-nameStatus code: 200Status code: 400Status code: 500Status c", + "desc":"This API is used to change the name of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-nameStatus code: 200Status code: 400Status code: 500Status c", "product_code":"ddm", - "title":"Modifying the Name of a DDM Instance", + "title":"Changing the Name of a DDM Instance (a V1 API)", "uri":"ddm_api_01_0020.html", "doc_type":"api", - "p_code":"13", - "code":"17" + "p_code":"15", + "code":"19" }, { "desc":"This API is used to modify the security group of a DDM instance.NonePUT /v1/{project_id}/instances/{instance_id}/modify-security-groupStatus code: 200Status code: 400Stat", "product_code":"ddm", - "title":"Modifying the Security Group of a DDM Instance", + "title":"Modifying the Security Group of a DDM Instance (a V1 API)", "uri":"ddm_api_01_0021.html", "doc_type":"api", - "p_code":"13", - "code":"18" - }, - { - "desc":"This API is used to delete a DDM instance to release all its resources.NoneDELETE /v1/{project_id}/instances/{instance_id}Status code: 200Status code: 400Status code: 500", - "product_code":"ddm", - "title":"Deleting a DDM Instance", - "uri":"ddm_api_01_0022.html", - "doc_type":"api", - "p_code":"13", - "code":"19" - }, - { - "desc":"This API is used to restart a DDM instance.NonePOST /v1/{project_id}/instances/{instance_id}/actionStatus code: 200Status code: 400Status code: 500Status code: 200okStatu", - "product_code":"ddm", - "title":"Restarting a DDM Instance", - "uri":"ddm_api_01_0023.html", - "doc_type":"api", - "p_code":"13", + "p_code":"15", "code":"20" }, { "desc":"This API is used to reload table data of the destination DDM instance for cross-region DR.NonePOST /v1/{project_id}/instances/{instance_id}/reload-configStatus code: 200N", "product_code":"ddm", - "title":"Reloading Table Data", + "title":"Reloading Table Data (a V1 API)", "uri":"ddm_api_01_0024.html", "doc_type":"api", - "p_code":"13", + "p_code":"15", "code":"21" }, - { - "desc":"This API is used to scale out a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.POST /v2/{project_id}", - "product_code":"ddm", - "title":"Scaling Out a DDM Instance", - "uri":"ddm_api_01_0025.html", - "doc_type":"api", - "p_code":"13", - "code":"22" - }, { "desc":"This API is used to remove nodes from a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.POST /v2/{pro", "product_code":"ddm", - "title":"Scaling In a DDM instance", + "title":"Scaling In a DDM instance (a V2 API)", "uri":"ddm_api_01_0026.html", "doc_type":"api", - "p_code":"13", - "code":"23" + "p_code":"15", + "code":"22" }, { "desc":"This API is used to modify the read policy of the DB instance associated with a DDM instance.Make sure that the associated RDS instances are available and not undergoing ", "product_code":"ddm", - "title":"Modifying the Read Policy of the Associated DB Instance", + "title":"Modifying the Read Policy of the Associated DB Instance (a V2 API)", "uri":"ddm_api_01_0080.html", "doc_type":"api", - "p_code":"13", - "code":"24" - }, - { - "desc":"This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.NonePOST /v1/{project_id}/instances/{instance_id}/rds/", - "product_code":"ddm", - "title":"Synchronizing Data Node Information", - "uri":"ddm_api_01_0081.html", - "doc_type":"api", - "p_code":"13", - "code":"25" + "p_code":"15", + "code":"23" }, { "desc":"This API is used to query nodes of a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}Status code: 200Status code: 400Stat", "product_code":"ddm", - "title":"Querying Nodes of a DDM Instance", + "title":"Querying Nodes of a DDM Instance (a V1 API)", "uri":"ddm_api_01_0082.html", "doc_type":"api", - "p_code":"13", - "code":"26" - }, - { - "desc":"This API is used to query details of a DDM instance node.NoneGET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}Status code: 200Status code: 400Status code: 500S", - "product_code":"ddm", - "title":"Querying Details of a DDM Instance Node", - "uri":"ddm_api_01_0083.html", - "doc_type":"api", - "p_code":"13", - "code":"27" + "p_code":"15", + "code":"24" }, { "desc":"This API is used to query parameters of a specified DDM instance.NoneGET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}Status code:", "product_code":"ddm", - "title":"Querying Parameters of a Specified DDM Instance", + "title":"Querying Parameters of a Specified DDM Instance (a V3 API)", "uri":"ddm_api_01_0084.html", "doc_type":"api", - "p_code":"13", - "code":"28" + "p_code":"15", + "code":"25" }, { "desc":"This API is used to modify parameters of a DDM instance.NonePUT /v3/{project_id}/instances/{instance_id}/configurationsStatus code: 200Status code: 400Status code: 500Sta", "product_code":"ddm", - "title":"Modifying Parameters of a DDM Instance", + "title":"Modifying Parameters of a DDM Instance (a V3 API)", "uri":"ddm_api_01_0085.html", "doc_type":"api", - "p_code":"13", - "code":"29" - }, - { - "desc":"This API is used to query engines that DDM supports.NoneGET /v2/{project_id}/engines?offset={offset}&limit={limit}Status code: 200Status code: 400Status code: 500Status c", - "product_code":"ddm", - "title":"Querying DDM Engine Information", - "uri":"ddm_api_01_0015.html", - "doc_type":"api", - "p_code":"13", - "code":"30" - }, - { - "desc":"This API is used to query DDM node classes available in an AZ.NoneGET /v2/{project_id}/flavors?engine_id={engine_id}?offset={offset}&limit={limit}Status code: 200Status c", - "product_code":"ddm", - "title":"Querying DDM Node Classes Available in an AZ", - "uri":"ddm_api_01_0016.html", - "doc_type":"api", - "p_code":"13", - "code":"31" + "p_code":"15", + "code":"26" }, { "desc":"This API is used to change the node class of a DDM instance.The node class can be changed only when the corresponding DDM instance is normal.The new node class cannot be ", "product_code":"ddm", - "title":"Changing the Node Class of a DDM Instance", + "title":"Changing the Node Class of a DDM Instance (a V3 API)", "uri":"ddm_api_01_0017.html", "doc_type":"api", - "p_code":"13", + "p_code":"15", + "code":"27" + }, + { + "desc":"Obtain DDM instance group information.NoneURL formatGET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}GET /v3/{project_id}/instances/{insta", + "product_code":"ddm", + "title":"Obtaining the Instance Group Information (a V3 API)", + "uri":"ddm_api_01_0093.html", + "doc_type":"api", + "p_code":"15", + "code":"28" + }, + { + "desc":"This API is used to create a DDM instance group.NoneURL formatPOST /v3/{project_id}/instances/{instance_id}/groupsPOST /v3/{project_id}/instances/{instance_id}/groupsPara", + "product_code":"ddm", + "title":"Creating an Instance Group (a V3 API)", + "uri":"ddm_api_01_0094.html", + "doc_type":"api", + "p_code":"15", + "code":"29" + }, + { + "desc":"This API is used to delete a DDM instance group.NoneDELETE /v3/{project_id}/instances/{instance_id}/groups/{group_id}Parameter descriptionParameterMandatoryTypeDescriptio", + "product_code":"", + "title":"Deleting an Instance Group(a V3 API)", + "uri":"en-us_topic_0000002181783542.html", + "doc_type":"", + "p_code":"15", + "code":"30" + }, + { + "desc":"This V3 API is used to query information about DDM engine.NoneURL formatGET /v3/{project_id}/engines?offset={offset}&limit={limit}Parameter descriptionQuerying DDM engine", + "product_code":"ddm", + "title":"Querying DDM Engine Information (a V3 API)", + "uri":"ddm_api_01_0109.html", + "doc_type":"api", + "p_code":"15", + "code":"31" + }, + { + "desc":"This V3 API is used to query DDM node classes available in an AZ.NoneURL formatGET /v3/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit}&engine_ver", + "product_code":"ddm", + "title":"Querying DDM Node Classes Available in Each AZ (a V3 API)", + "uri":"ddm_api_01_0110.html", + "doc_type":"api", + "p_code":"15", "code":"32" }, + { + "desc":"This API is used to scale out a specified DDM instance.Make sure that the associated RDS instances are available and not undergoing other operations.URL formatPOST /v3/{p", + "product_code":"ddm", + "title":"Scaling Out a DDM Instance (a V3 API)", + "uri":"ddm_api_01_0111.html", + "doc_type":"api", + "p_code":"15", + "code":"33" + }, + { + "desc":"This API is used to obtain information about a task with a specified ID in the DDM task center.NoneURL formatGET /v3/{project_id}/jobs/{job_id}GET /v3/{project_id}/jobs/{", + "product_code":"ddm", + "title":"Obtaining Information About a Task with a Specified ID (a V3 API)", + "uri":"ddm_api_01_0112.html", + "doc_type":"api", + "p_code":"15", + "code":"34" + }, + { + "desc":"This API is used to delete a DDM instance to release all its resources.NoneURL formatDELETE /v3/{project_id}/instances/{instance_id}DELETE /v3/{project_id}/instances/{ins", + "product_code":"ddm", + "title":"Deleting an Instance (a V3 API)", + "uri":"ddm_api_01_0113.html", + "doc_type":"api", + "p_code":"15", + "code":"35" + }, + { + "desc":"This API is used to configure SSL to encrypt connections.NonePOST /v3/{project_id}/instances/{instance_id}/switch-sslEnabling SSLPOST https://ddm.eu-de.otc.t-systems.com/", + "product_code":"ddm", + "title":"Enabling or Disabling SSL (a V3 API)", + "uri":"ddm_api_01_0114.html", + "doc_type":"api", + "p_code":"15", + "code":"36" + }, + { + "desc":"This API is used to change an instance port.NonePUT /v3/{project_id}/instances/{instance_id}/portChanging an instance port to 5067POST https://ddm.eu-de.otc.t-systems.com", + "product_code":"ddm", + "title":"Changing an Instance Port(a V3 API)", + "uri":"en-us_topic_0000002217069689.html", + "doc_type":"api", + "p_code":"15", + "code":"37" + }, + { + "desc":"This API is used to restart a specific instance.NonePOST /v3/{project_id}/instances/{instance_id}/restartWhether to restart the instance.Normal responseResponse body para", + "product_code":"ddm", + "title":"Restarting a DDM Instance(a V3 API)", + "uri":"en-us_topic_0000002181623846.html", + "doc_type":"api", + "p_code":"15", + "code":"38" + }, + { + "desc":"This API is used to restart a specific node.NonePOST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/restartRestarting a nodeNormal responseResponse body paramet", + "product_code":"ddm", + "title":"Restarting a DDM Node(a V3 API)", + "uri":"en-us_topic_0000002217144121.html", + "doc_type":"api", + "p_code":"15", + "code":"39" + }, + { + "desc":"This API is used to bind an EIP.NonePOST /v3/{project_id}/instances/{instance_id}/eipBinding an EIP to an instancePOST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b", + "product_code":"ddm", + "title":"Binding an EIP(a V3 API)", + "uri":"en-us_topic_0000002181783546.html", + "doc_type":"api", + "p_code":"15", + "code":"40" + }, + { + "desc":"This API is used to unbind an EIP from an instance.NoneDELETE /v3/{project_id}/instances/{instance_id}/eipUnbinding an EIP from an instanceDELETE https://ddm.eu-de.otc.t-", + "product_code":"ddm", + "title":"Unbinding an EIP(a V3 API)", + "uri":"en-us_topic_0000002217069693.html", + "doc_type":"api", + "p_code":"15", + "code":"41" + }, + { + "desc":"This API is used to change the load balancer IP address of an instance.NonePUT /v3/{project_id}/instances/{instance_id}/elb/ipChanging an ELB load balancer IP addressPUT ", + "product_code":"ddm", + "title":"Changing the Load Balancer IP Address of an Instance(a V3 API)", + "uri":"en-us_topic_0000002181623850.html", + "doc_type":"api", + "p_code":"15", + "code":"42" + }, + { + "desc":"This API is used to delete multiple nodes from an instance at a time.Nodes in different groups cannot be deleted at the same time.POST /v3/{project_id}/instances/{instanc", + "product_code":"ddm", + "title":"Deleting Multiple Nodes from an Instance at a Time(a V3 API)", + "uri":"en-us_topic_0000002299876902.html", + "doc_type":"api", + "p_code":"15", + "code":"43" + }, + { + "desc":"This API is used to query details about an instance node.NoneGET /v3/{project_id}/instances/{instance_id}/nodes/{node_id}Querying details about an instance nodeGET https:", + "product_code":"ddm", + "title":"Querying Details About a DDM Instance Node(a V3 API)", + "uri":"en-us_topic_0000002181783550.html", + "doc_type":"api", + "p_code":"15", + "code":"44" + }, + { + "desc":"This API is used to synchronize data node information.NonePOST /v3/{project_id}/instances/{instance_id}/data-nodes/syncSynchronizing data node informationPOST https://ddm", + "product_code":"ddm", + "title":"Synchronizing Data Node Information (a V3 API)", + "uri":"en-us_topic_0000002332869325.html", + "doc_type":"api", + "p_code":"15", + "code":"45" + }, + { + "desc":"This API is used to query information about tasks.NoneGET /v3/{project_id}/jobsQuerying information about tasksGET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be6", + "product_code":"ddm", + "title":"Querying Information About Tasks (a V3 API)", + "uri":"en-us_topic_0000002298949840.html", + "doc_type":"api", + "p_code":"15", + "code":"46" + }, { "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":"ddm", @@ -294,52 +420,178 @@ "uri":"ddm_api_01_0027.html", "doc_type":"api", "p_code":"12", - "code":"33" - }, - { - "desc":"This API is used to create a schema.Before creating a schema, ensure that you have associated RDS instances with your DDM instance and that the RDS instances are not asso", - "product_code":"ddm", - "title":"Creating a Schema", - "uri":"ddm_16_0001.html", - "doc_type":"api", - "p_code":"33", - "code":"34" + "code":"47" }, { "desc":"This API is used to query schemas of a DDM instance.NoneGET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}Status code: 200Status code: 4", "product_code":"ddm", - "title":"Querying Schemas", + "title":"Querying Schemas (a V1 API)", "uri":"ddm_api_01_0029.html", "doc_type":"api", - "p_code":"33", - "code":"35" - }, - { - "desc":"This API is used to query details about a schema.NoneGET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}Status code: 200Status code: 400Status code: 500St", - "product_code":"ddm", - "title":"Querying Details of a Schema", - "uri":"ddm_api_01_0030.html", - "doc_type":"api", - "p_code":"33", - "code":"36" - }, - { - "desc":"This API is used to delete a schema to release all its resources.NoneDELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_da", - "product_code":"ddm", - "title":"Deleting a Schema", - "uri":"ddm_api_01_0031.html", - "doc_type":"api", - "p_code":"33", - "code":"37" + "p_code":"47", + "code":"48" }, { "desc":"This API is used to query DB instances that can be used for creating a schema.NoneGET /v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}Status cod", "product_code":"ddm", - "title":"Querying DB Instances Available for Creating a Schema", + "title":"Querying DB Instances Available for Creating a Schema (a V1 API)", "uri":"ddm_api_01_0100.html", "doc_type":"api", - "p_code":"33", - "code":"38" + "p_code":"47", + "code":"49" + }, + { + "desc":"This API is used to create a schema.Before creating a schema, ensure that an RDS instance has been created, is in the normal state, and is not associated with other DDM i", + "product_code":"ddm", + "title":"Creating a Schema(a V3 API)", + "uri":"ddm_api_01_0115.html", + "doc_type":"api", + "p_code":"47", + "code":"50" + }, + { + "desc":"This API is used to delete a schema to release all its resources.NoneURL formatDELETE /v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data={d", + "product_code":"ddm", + "title":"Deleting a Schema(a V3 API)", + "uri":"ddm_api_01_0116.html", + "doc_type":"api", + "p_code":"47", + "code":"51" + }, + { + "desc":"This API is used to export all schema metadata about distribution of physical shards on data nodes.NoneGET /v3/{project_id}/instances/{instance_id}/schema-metadataNormal ", + "product_code":"ddm", + "title":"Exporting Schema Metadata(a V3 API)", + "uri":"ddm_api_01_0104.html", + "doc_type":"api", + "p_code":"47", + "code":"52" + }, + { + "desc":"This API is used to import distribution information of physical shards in all schemas and use it to create schemas that contain the same physical shards and distribution ", + "product_code":"ddm", + "title":"Importing Schema Metadata(a V3 API)", + "uri":"ddm_api_01_0105.html", + "doc_type":"api", + "p_code":"47", + "code":"53" + }, + { + "desc":"This API is used to query details about a schema.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{database_name}Querying details about a schemaGET https://ddm.", + "product_code":"", + "title":"Querying Details About a Schema(a V3 API)", + "uri":"en-us_topic_0000002217069697.html", + "doc_type":"", + "p_code":"47", + "code":"54" + }, + { + "desc":"This API is used to query data nodes that can be used for creating a schema.NoneGET /v3/{project_id}/instances/{instance_id}/available-data-nodesQuerying data nodes that ", + "product_code":"ddm", + "title":"Querying Data Nodes Available for Creating a Schema (a V3 API)", + "uri":"en-us_topic_0000002298790184.html", + "doc_type":"api", + "p_code":"47", + "code":"55" + }, + { + "desc":"This API is used to query data nodes that can be used for shard configuration.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/available-dat", + "product_code":"ddm", + "title":"Querying Data Nodes Available for Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002332909537.html", + "doc_type":"api", + "p_code":"47", + "code":"56" + }, + { + "desc":"This API is used to pre-check shard configuration to prevent shard configuration failures. For details about pre-check items, see the user guide.This API returns the foll", + "product_code":"ddm", + "title":"Pre-checking Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002332869333.html", + "doc_type":"api", + "p_code":"47", + "code":"57" + }, + { + "desc":"This API is used to query the pre-check result of a shard configuration task that takes some time to execute. For details about pre-check items, see the user guide.The as", + "product_code":"ddm", + "title":"Querying the Asynchronous Pre-check Result of Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002298949848.html", + "doc_type":"api", + "p_code":"47", + "code":"58" + }, + { + "desc":"This API is used to add data nodes or shards to enhance data storage and provide better support for concurrency.The shard configuration task can only be performed after a", + "product_code":"ddm", + "title":"Performing Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002298790192.html", + "doc_type":"api", + "p_code":"47", + "code":"59" + }, + { + "desc":"This API is used to query details about a shard configuration task.NoneGET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}Querying de", + "product_code":"ddm", + "title":"Querying Details About a Shard Configuration Task(a V3 API)", + "uri":"en-us_topic_0000002332909545.html", + "doc_type":"api", + "p_code":"47", + "code":"60" + }, + { + "desc":"This API is used to cancel shard configuration.The shard configuration task to be canceled must be in the Running, Failed, or ToBeSwitched state.PUT /v3/{project_id}/inst", + "product_code":"ddm", + "title":"Canceling Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002332869341.html", + "doc_type":"api", + "p_code":"47", + "code":"61" + }, + { + "desc":"This API is used to roll back shard configuration.Only tasks in the Failed state can be rolled back.PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migra", + "product_code":"ddm", + "title":"Rolling Back Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002298949856.html", + "doc_type":"api", + "p_code":"47", + "code":"62" + }, + { + "desc":"This API is used to clear shard configuration data.Only data of shard configuration tasks in the ToBeCleaned state can be cleared.PUT /v3/{project_id}/instances/{instance", + "product_code":"ddm", + "title":"Clearing Shard Configuration Data (a V3 API)", + "uri":"en-us_topic_0000002298790204.html", + "doc_type":"api", + "p_code":"47", + "code":"63" + }, + { + "desc":"This API is used to retry shard configuration.Only shard configuration tasks in the Failed state can be retried.PUT /v3/{project_id}/instances/{instance_id}/databases/{db", + "product_code":"ddm", + "title":"Retrying Shard Configuration (a V3 API)", + "uri":"en-us_topic_0000002332909553.html", + "doc_type":"api", + "p_code":"47", + "code":"64" + }, + { + "desc":"This API is used to change a route switching policy.Only the route switching policy of a shard configuration task in the ToBeSwitched state can be changed.PUT /v3/{projec", + "product_code":"ddm", + "title":"Changing a Route Switching Policy (a V3 API)", + "uri":"en-us_topic_0000002332869349.html", + "doc_type":"api", + "p_code":"47", + "code":"65" + }, + { + "desc":"This API is used to switch read and write requests to a new instance. During the switching process, one or two intermittent disconnections may occur but do not affect ser", + "product_code":"ddm", + "title":"Switching Routes (a V3 API)", + "uri":"en-us_topic_0000002298949868.html", + "doc_type":"api", + "p_code":"47", + "code":"66" }, { "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.", @@ -348,25 +600,25 @@ "uri":"ddm_api_01_0041.html", "doc_type":"api", "p_code":"12", - "code":"39" + "code":"67" }, { "desc":"If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the ad", "product_code":"ddm", - "title":"Managing the Administrator Password", + "title":"Managing the Administrator Password (a V3 API)", "uri":"ddm_api_01_0101.html", "doc_type":"api", - "p_code":"39", - "code":"40" + "p_code":"67", + "code":"68" }, { "desc":"This API is used to check whether an instance password is a weak password.POST /v3/{project_id}/weak-password-verificationStatus code: 200Status code: 400Status code: 500", "product_code":"ddm", - "title":"Validating Password Strength", + "title":"Checking Whether a Password Is Weak (a V3 API)", "uri":"ddm_api_01_0102.html", "doc_type":"api", - "p_code":"39", - "code":"41" + "p_code":"67", + "code":"69" }, { "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.", @@ -375,16 +627,376 @@ "uri":"ddm_api_01_0089.html", "doc_type":"api", "p_code":"12", - "code":"42" + "code":"70" }, { - "desc":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.NoneGET /v2/{project_id}/instances/{instan", + "desc":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.NoneURL formatGET /v3/{project_id}/instanc", "product_code":"ddm", - "title":"Monitoring Slow Query Logs", + "title":"Monitoring Slow Query Logs(a V3 API)", + "uri":"ddm_api_01_0117.html", + "doc_type":"api", + "p_code":"70", + "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.", + "product_code":"ddm", + "title":"Parameter Management", + "uri":"ddm_api_01_0104_0.html", + "doc_type":"api", + "p_code":"12", + "code":"72" + }, + { + "desc":"This API is used to obtain parameter templates, including all default and custom parameter templates.NoneURL formatGET /v3/{project_id}/configurations?offset={offset}&lim", + "product_code":"ddm", + "title":"Obtaining Parameter Templates (a V3 API)", + "uri":"ddm_api_01_0105_0.html", + "doc_type":"api", + "p_code":"72", + "code":"73" + }, + { + "desc":"This API is used to obtain information about a specified parameter template.NoneURL formatGET /v3/{project_id}/configurations/{config_id}Parameter descriptionObtaining in", + "product_code":"ddm", + "title":"Obtaining Parameters in a Specified Parameter Template (a V3 API)", + "uri":"ddm_api_01_0106.html", + "doc_type":"api", + "p_code":"72", + "code":"74" + }, + { + "desc":"This API is used to modify parameters of a DDM instance.The values of the modified parameters must be within the value range defined on the DDM console. For details about", + "product_code":"ddm", + "title":"Modifying Parameters of an Instance(a V3.1 API)", + "uri":"en-us_topic_0000002181623854.html", + "doc_type":"api", + "p_code":"72", + "code":"75" + }, + { + "desc":"This API is used to create a parameter group.NonePOST /v3/{project_id}/configurationsCreating a parameter groupPOST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e", + "product_code":"ddm", + "title":"Creating a Parameter Group(a V3 API)", + "uri":"en-us_topic_0000002298790216.html", + "doc_type":"api", + "p_code":"72", + "code":"76" + }, + { + "desc":"This API is used to delete a parameter group.NoneDELETE /v3/{project_id}/configurations/{config_id}Deleting a parameter groupDELETE https://ddm.eu-de.otc.t-systems.com/v3", + "product_code":"ddm", + "title":"Deleting a Parameter Group(a V3 API)", + "uri":"en-us_topic_0000002332909561.html", + "doc_type":"api", + "p_code":"72", + "code":"77" + }, + { + "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":"", + "title":"Backup Management", + "uri":"en-us_topic_0000002217144129.html", + "doc_type":"", + "p_code":"12", + "code":"78" + }, + { + "desc":"This API is used to query backups.NoneGET /v3/{project_id}/backupsThis API is used to query backups.Normal responseNormal response exampleAbnormal responseFor details, se", + "product_code":"", + "title":"Querying Backups(a V3 API)", + "uri":"en-us_topic_0000002181783554.html", + "doc_type":"", + "p_code":"78", + "code":"79" + }, + { + "desc":"This API is used to delete a specified backup.NoneDELETE /v3/{project_id}/backups/{backup_id}Deleting a specified backupNormal responseResponse body parametersParameterTy", + "product_code":"", + "title":"Deleting a Backup(a V3 API)", + "uri":"en-us_topic_0000002217069701.html", + "doc_type":"", + "p_code":"78", + "code":"80" + }, + { + "desc":"This API is used to query details about a backup.NoneGET /v3/{project_id}/instances/{instance_id}/backups/{backup_id}Querying details about a backupGET https://ddm.eu-de.", + "product_code":"ddm", + "title":"Querying Details About a Backup(a V3 API)", + "uri":"en-us_topic_0000002332869361.html", + "doc_type":"api", + "p_code":"78", + "code":"81" + }, + { + "desc":"This API is used to query data nodes associated with an instance at a restoration time point.NoneGET /v3/{project_id}/instances/{instance_id}/backups/related-dnNormal res", + "product_code":"ddm", + "title":"Querying Data Nodes Associated with an Instance at a Restoration Time Point(a V3 API)", + "uri":"en-us_topic_0000002298949876.html", + "doc_type":"api", + "p_code":"78", + "code":"82" + }, + { + "desc":"This API is used to query the restoration time range of an instance.The intersection between the restoration time range of an instance and those of all data nodes associa", + "product_code":"ddm", + "title":"Querying the Restoration Time Range(a V3 API)", + "uri":"en-us_topic_0000002298790224.html", + "doc_type":"api", + "p_code":"78", + "code":"83" + }, + { + "desc":"This API is used to query data nodes available for restoration.You must call the API for querying the restoration time range first.GET /v3/{project_id}/instances/{instanc", + "product_code":"ddm", + "title":"Querying Data Nodes Available to Restore Data to a Point in Time(a V3 API)", + "uri":"en-us_topic_0000002332909569.html", + "doc_type":"api", + "p_code":"78", + "code":"84" + }, + { + "desc":"This API is used to query instances available for restoration.NoneGET /v3/{project_id}/instances/{instance_id}/backups/restorable-instancesQuerying instances available fo", + "product_code":"ddm", + "title":"Querying Instances Available for Restoration(a V3 API)", + "uri":"en-us_topic_0000002332869369.html", + "doc_type":"api", + "p_code":"78", + "code":"85" + }, + { + "desc":"This API is used to restore metadata.Metadata restoration mainly restores the metadata of your DDM instance to a new DDM instance. It starts after a point-in-time recover", + "product_code":"ddm", + "title":"Restoring Metadata(a V3 API)", + "uri":"en-us_topic_0000002298949884.html", + "doc_type":"api", + "p_code":"78", + "code":"86" + }, + { + "desc":"This API is used to restore data to a new instance.NonePOST /v3/{project_id}/instances/{instance_id}/backups/recoveryRestoring data to a new instancePOST https://ddm.eu-d", + "product_code":"ddm", + "title":"Restoring Data to a New Instance(a V3 API)", + "uri":"en-us_topic_0000002298790232.html", + "doc_type":"api", + "p_code":"78", + "code":"87" + }, + { + "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":"", + "title":"Tag Management", + "uri":"en-us_topic_0000002332909577.html", + "doc_type":"", + "p_code":"12", + "code":"88" + }, + { + "desc":"This API is used to query project tags.NoneGET /v3/{project_id}/instances/tagsQuerying project tagsNormal responseNormal response exampleAbnormal responseFor details, see", + "product_code":"ddm", + "title":"Querying Project Tags(a V3 API)", + "uri":"en-us_topic_0000002332869377.html", + "doc_type":"api", + "p_code":"88", + "code":"89" + }, + { + "desc":"This API is used to query instance tags.NoneGET /v3/{project_id}/instances/{instance_id}/tagsQuerying instance tagsNormal responseNormal response exampleAbnormal response", + "product_code":"ddm", + "title":"Querying Instance Tags(a V3 API)", + "uri":"en-us_topic_0000002298949892.html", + "doc_type":"api", + "p_code":"88", + "code":"90" + }, + { + "desc":"This API is used to add tags for an instance.A maximum of 20 tags can be added for an instance. The tag key must be unique.If the request body contains duplicated keys, a", + "product_code":"ddm", + "title":"Adding Tags for an Instance(a V3 API)", + "uri":"en-us_topic_0000002298790240.html", + "doc_type":"api", + "p_code":"88", + "code":"91" + }, + { + "desc":"This API is used to delete tags from an instance at a time.If the tag to be deleted does not exist, the system deems the deletion operation successful by default. The tag", + "product_code":"ddm", + "title":"Deleting Tags from an Instance at a Time (a V3 API)", + "uri":"en-us_topic_0000002332909585.html", + "doc_type":"api", + "p_code":"88", + "code":"92" + }, + { + "desc":"This API is used to change an instance tag.NonePUT /v3/{project_id}/instances/{instance_id}/tags/{key}Changing an instance tagNormal responseNoneNormal response exampleNo", + "product_code":"ddm", + "title":"Changing an Instance Tag(a V3 API)", + "uri":"en-us_topic_0000002332869385.html", + "doc_type":"api", + "p_code":"88", + "code":"93" + }, + { + "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":"", + "title":"APIs (Unavailable Soon)", + "uri":"en-us_topic_0000002318291129.html", + "doc_type":"", + "p_code":"", + "code":"94" + }, + { + "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":"", + "title":"Instance Management", + "uri":"en-us_topic_0000002283971858.html", + "doc_type":"", + "p_code":"94", + "code":"95" + }, + { + "desc":"This API is used to create a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Creating a DDM Instance (a V3 API)", + "product_code":"ddm", + "title":"Creating a DDM instance (a V1 API)", + "uri":"ddm_04_0001.html", + "doc_type":"api", + "p_code":"95", + "code":"96" + }, + { + "desc":"This API is used to query engines that DDM supports.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying DDM Engine Info", + "product_code":"ddm", + "title":"Querying DDM Engine Information (a V2 API)", + "uri":"ddm_api_01_0015.html", + "doc_type":"api", + "p_code":"95", + "code":"97" + }, + { + "desc":"This API is used to query DDM node classes available in an AZ.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying DDM N", + "product_code":"ddm", + "title":"Querying DDM Node Classes Available in an AZ (a V2 API)", + "uri":"ddm_api_01_0016.html", + "doc_type":"api", + "p_code":"95", + "code":"98" + }, + { + "desc":"This API is used to query details of a DDM instance node.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying Details Ab", + "product_code":"ddm", + "title":"Querying Details of a DDM Instance Node (a V1 API)", + "uri":"ddm_api_01_0083.html", + "doc_type":"api", + "p_code":"95", + "code":"99" + }, + { + "desc":"This API is used to restart a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Restarting a DDM Instance (a V3 A", + "product_code":"ddm", + "title":"Restarting a DDM Instance (a V1 API)", + "uri":"ddm_api_01_0023.html", + "doc_type":"api", + "p_code":"95", + "code":"100" + }, + { + "desc":"This API is used to delete a DDM instance to release all its resources.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Delet", + "product_code":"ddm", + "title":"Deleting a DDM Instance (a V1 API)", + "uri":"ddm_api_01_0022.html", + "doc_type":"api", + "p_code":"95", + "code":"101" + }, + { + "desc":"This API is used to scale out a specified DDM instance.This API is to be removed soon, so it is not recommended.Use the API of the latest version in Scaling Out a DDM Ins", + "product_code":"ddm", + "title":"Scaling Out a DDM Instance (a V2 API)", + "uri":"ddm_api_01_0025.html", + "doc_type":"api", + "p_code":"95", + "code":"102" + }, + { + "desc":"This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.This API is to be removed soon, so it is not recommend", + "product_code":"ddm", + "title":"Synchronizing Data Node Information (a V1 API)", + "uri":"ddm_api_01_0081.html", + "doc_type":"api", + "p_code":"95", + "code":"103" + }, + { + "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":"", + "title":"Schema Management", + "uri":"en-us_topic_0000002318531425.html", + "doc_type":"", + "p_code":"94", + "code":"104" + }, + { + "desc":"This API is used to create a schema.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Creating a Schema (a V3 API).POST /v1/{p", + "product_code":"ddm", + "title":"Creating a Schema (a V1 API)", + "uri":"ddm_16_0001.html", + "doc_type":"api", + "p_code":"104", + "code":"105" + }, + { + "desc":"This API is used to delete a schema to release all its resources.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Deleting a ", + "product_code":"ddm", + "title":"Deleting a Schema (a V1 API)", + "uri":"ddm_api_01_0031.html", + "doc_type":"api", + "p_code":"104", + "code":"106" + }, + { + "desc":"This API is used to query details about a schema.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Querying Details About a Sc", + "product_code":"ddm", + "title":"Querying Details of a Schema (a V1 API)", + "uri":"ddm_api_01_0030.html", + "doc_type":"api", + "p_code":"104", + "code":"107" + }, + { + "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":"", + "title":"Parameter Management", + "uri":"en-us_topic_0000002514999631.html", + "doc_type":"", + "p_code":"94", + "code":"108" + }, + { + "desc":"This API is used to modify parameters of a DDM instance.This API is to be removed soon, so it is not recommended.Use the latest API. For details, see Modifying Parameters", + "product_code":"ddm", + "title":"Modifying Parameters of an Instance(a V3 API)", + "uri":"en-us_topic_0000002510482745.html", + "doc_type":"api", + "p_code":"108", + "code":"109" + }, + { + "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":"", + "title":"Monitoring Management", + "uri":"en-us_topic_0000002318604513.html", + "doc_type":"", + "p_code":"94", + "code":"110" + }, + { + "desc":"This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.This API is to be removed soon, so it is n", + "product_code":"ddm", + "title":"Monitoring Slow Query Logs (a V2 API)", "uri":"ddm_api_01_0090.html", "doc_type":"api", - "p_code":"42", - "code":"43" + "p_code":"110", + "code":"111" }, { "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 +1005,7 @@ "uri":"ddm_api_01_0058.html", "doc_type":"api", "p_code":"", - "code":"44" + "code":"112" }, { "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.", @@ -401,8 +1013,8 @@ "title":"Abnormal Request Results", "uri":"ddm_api_01_0059.html", "doc_type":"api", - "p_code":"44", - "code":"45" + "p_code":"112", + "code":"113" }, { "desc":"Table 1 lists the status codes that may be returned.Table 2 lists the status codes that may be returned.", @@ -410,8 +1022,8 @@ "title":"Status Codes", "uri":"ddm_api_01_0060.html", "doc_type":"api", - "p_code":"44", - "code":"46" + "p_code":"112", + "code":"114" }, { "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.", @@ -419,8 +1031,8 @@ "title":"Error Codes", "uri":"ddm_api_01_0061.html", "doc_type":"api", - "p_code":"44", - "code":"47" + "p_code":"112", + "code":"115" }, { "desc":"DDM node classes are listed in the following table and vary according to actual situations.", @@ -428,8 +1040,8 @@ "title":"Node Classes", "uri":"ddm_api_01_0062.html", "doc_type":"api", - "p_code":"44", - "code":"48" + "p_code":"112", + "code":"116" }, { "desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first Two methods are available:Obtaining the Project ID b", @@ -437,8 +1049,8 @@ "title":"Obtaining a Project ID", "uri":"ddm_api_01_0063.html", "doc_type":"api", - "p_code":"44", - "code":"49" + "p_code":"112", + "code":"117" }, { "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.", @@ -446,8 +1058,8 @@ "title":"Status Description", "uri":"ddm_api_01_0064.html", "doc_type":"api", - "p_code":"44", - "code":"50" + "p_code":"112", + "code":"118" }, { "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.", @@ -456,6 +1068,6 @@ "uri":"ddm_api_01_0069.html", "doc_type":"api", "p_code":"", - "code":"51" + "code":"119" } ] \ No newline at end of file diff --git a/docs/ddm/api-ref/ddm_03_0002.html b/docs/ddm/api-ref/ddm_03_0002.html index 8c4a6b6e8..692333941 100644 --- a/docs/ddm/api-ref/ddm_03_0002.html +++ b/docs/ddm/api-ref/ddm_03_0002.html @@ -173,14 +173,6 @@ Content-Type: application/json }

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. For the API of obtaining a user token, x-subject-token in the response header is the required user token. This token can then be used to authenticate the calling of other APIs.

-

Initiating Requests

You can initiate a request based on the constructed request message in one of the following ways:

- -
diff --git a/docs/ddm/api-ref/ddm_04_0001.html b/docs/ddm/api-ref/ddm_04_0001.html index 2744bc5ba..04289cec3 100644 --- a/docs/ddm/api-ref/ddm_04_0001.html +++ b/docs/ddm/api-ref/ddm_04_0001.html @@ -1,9 +1,9 @@ -

Creating a DDM instance

+

Creating a DDM instance (a V1 API)

Function

This API is used to create a DDM instance.

-

Constraints

DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been configured.

+

Constraints

URI

POST /v1/{project_id}/instances

@@ -31,24 +31,34 @@

Request Parameters

-
Table 2 Request header parameters

Parameter

+
- - - - - - - + + + + + @@ -57,9 +67,9 @@
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

-

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+

User token.

+

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. Value range:

+
  • application/json
  • application/json;charset=utf-8
- - @@ -89,9 +99,9 @@
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

- - @@ -178,7 +188,7 @@ - -
Table 4 CreateInstanceDetail

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

String

Parameter group ID

+

Parameter group ID. It can be obtained from Obtaining Parameter Templates (a V3 API).

time_zone

@@ -187,7 +197,7 @@

String

UTC time zone. The default value is UTC. The value can be UTC, UTC-12:00, UTC-11:00, UTC-10:00, UTC-09:00, UTC-08:00, UTC-07:00, UTC-06:00, UTC-05:00, UTC-04:00, UTC-03:00, UTC-02:00, UTC-01:00, UTC+01:00, UTC+02:00, UTC+03:00, UTC+05:00, UTC+06:00, UTC+07:00, UTC+08:00, UTC+09:00, UTC+10:00, UTC+11:00, and UTC+12:00.

+

UTC time zone. The default value is UTC. The value can be UTC, UTC-12:00, UTC-11:00, UTC-10:00, UTC-09:00, UTC-08:00, UTC-07:00, UTC-06:00, UTC-05:00, UTC-04:00, UTC-03:00, UTC-02:00, UTC-01:00, UTC+01:00, UTC+02:00, UTC+03:00, UTC+04:00, UTC+05:00, UTC+06:00, UTC+07:00, UTC+08:00, UTC+09:00, UTC+10:00, UTC+11:00, and UTC+12:00.

admin_user_name

@@ -250,9 +260,9 @@

Status code: 400

-
Table 6 Response body parameters

Parameter

+
- @@ -277,11 +287,11 @@

Status code: 500

-
Table 6 Response body parameters

Parameter

Type

+

Type

Description
Table 7 Response body parameters

Parameter

+
- - @@ -303,7 +313,7 @@
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description
-

Example Request

POST https://{endpoint}/v1/{project_id}/instances
+
Example Request
POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances
 
 {
   "instance" : {
@@ -312,7 +322,7 @@
     "node_num" : "4,",
     "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437",
    
-    "available_zones" : [ "az1xahz" ],
+    "available_zones" : [ "eu-de-01" ],
     "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172",
     "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e",
     "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx",
@@ -372,7 +382,7 @@
 

 

 

-
Parent topic: DDM Instances

+
Parent topic: Instance Management

 

 

 
diff --git a/docs/ddm/api-ref/ddm_16_0001.html b/docs/ddm/api-ref/ddm_16_0001.html
index 0f186f301..4ea951f36 100644
--- a/docs/ddm/api-ref/ddm_16_0001.html
+++ b/docs/ddm/api-ref/ddm_16_0001.html
@@ -1,9 +1,9 @@
 
 
-
Creating a Schema

+
Creating a Schema (a V1 API)

 
Function
This API is used to create a schema.

 

-
Constraints
Before creating a schema, ensure that you have associated RDS instances with your DDM instance and that the RDS instances are not associated with other DDM instances.

+
Constraints

 

 
URI
POST /v1/{project_id}/instances/{instance_id}/databases

 
@@ -40,24 +40,34 @@
 

 

 
Request Parameters

-
Table 2 Request header parameters
Parameter

+

-
-
-
-
-
-
-
+
+
+
+
+
@@ -299,7 +309,7 @@
 
Example Request
The following is an example request of creating a schema and associating it with an existing DDM account.

-
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases
+
POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases
 
 {
   "databases" : [ {
@@ -367,7 +377,7 @@
 

 

-
Parent topic: Schemas

+
Parent topic: Schema Management

 

 

 
diff --git a/docs/ddm/api-ref/ddm_api_01_0014.html b/docs/ddm/api-ref/ddm_api_01_0014.html
index cda1a3fc4..1258248ad 100644
--- a/docs/ddm/api-ref/ddm_api_01_0014.html
+++ b/docs/ddm/api-ref/ddm_api_01_0014.html
@@ -4,43 +4,67 @@
 

 
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0015.html b/docs/ddm/api-ref/ddm_api_01_0015.html
index 20b95d0ce..b9d07078e 100644
--- a/docs/ddm/api-ref/ddm_api_01_0015.html
+++ b/docs/ddm/api-ref/ddm_api_01_0015.html
@@ -1,13 +1,13 @@
 
 
-
Querying DDM Engine Information

+
Querying DDM Engine Information (a V2 API)

 
Function
This API is used to query engines that DDM supports.

 

-
Constraints
None

+
Constraints

 

 
URI
GET /v2/{project_id}/engines?offset={offset}&limit={limit}

 
-
Table 2 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token

-
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
User token.

+
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
Content-Type

+
Yes

+
String

+
MIME type of the request body. Value range:

+
  • application/json
  • application/json;charset=utf-8

 		
 

 
 
 
 
 
Table 1 Path parameters
Parameter

+

@@ -260,7 +260,7 @@
 
Table 1 Path parameter
Parameter

 		
 
Mandatory

 

 

 
-
Example Request
GET https://{endpoint}/v2/{project_id}/engines?offset={offset}&limit={limit}

+
Example Request
GET https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/engines?offset=0&limit=10

 

 
Example Response
Status code: 200

 
OK

@@ -327,7 +327,7 @@
 

 

 

-
Parent topic: DDM Instances

+
Parent topic: Instance Management

 

 

 
diff --git a/docs/ddm/api-ref/ddm_api_01_0016.html b/docs/ddm/api-ref/ddm_api_01_0016.html
index b38a14c36..07fe61233 100644
--- a/docs/ddm/api-ref/ddm_api_01_0016.html
+++ b/docs/ddm/api-ref/ddm_api_01_0016.html
@@ -1,13 +1,13 @@
 
 
-
Querying DDM Node Classes Available in an AZ

+
Querying DDM Node Classes Available in an AZ (a V2 API)

 
Function
This API is used to query DDM node classes available in an AZ.

 

-
Constraints
None

+
Constraints

 

 
URI
GET /v2/{project_id}/flavors?engine_id={engine_id}?offset={offset}&limit={limit}

 
-
Table 1 Path parameters
Parameter

+

@@ -133,7 +133,7 @@
 
-
-
-
Table 1 Path parameter
Parameter

 		
 
Mandatory

 		
 
String

 
Compute resource architecture type. The value can be x86 or ARM.

+
Compute resource architecture type. The value can be X86 or ARM.

 		
 

 
computeFlavors

@@ -236,7 +236,7 @@
 		
 
String

 
Compute resource architecture type. The value can be x86 or ARM.

+
Compute resource architecture type. The value can be X86 or ARM.

 		
 

 
azStatus

@@ -258,7 +258,7 @@
 		
 
String

 
Compute resource architecture type. The value can be x86 or ARM.

+
Compute resource architecture type. The value can be X86 or ARM.

 		
 

 
dbType

@@ -333,7 +333,7 @@
 

 

 
-
Example Request
GET https://{endpoint}/v2/{project_id}/flavors?engine_id={engine_id}

+
Example Request
GET https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/flavors?engine_id=b6907aa2-aacb-3ac9-9782-b90b152d456c

 

 
Example Response
Status code: 200

 
OK

@@ -459,7 +459,7 @@
 

 

 

-
Parent topic: DDM Instances

+
Parent topic: Instance Management

 

 

 
diff --git a/docs/ddm/api-ref/ddm_api_01_0017.html b/docs/ddm/api-ref/ddm_api_01_0017.html
index 82137b091..bec28a260 100644
--- a/docs/ddm/api-ref/ddm_api_01_0017.html
+++ b/docs/ddm/api-ref/ddm_api_01_0017.html
@@ -1,13 +1,13 @@
 
 
-
Changing the Node Class of a DDM Instance

+
Changing the Node Class of a DDM Instance (a V3 API)

 
Function
This API is used to change the node class of a DDM instance.

 

 
Constraints
  • The node class can be changed only when the corresponding DDM instance is normal.
  • The new node class cannot be the same as the original one.
  • Node classes of c6s series cannot be changed to those classes of c6 series.

 

 
URI
PUT /v3/{project_id}/instances/{instance_id}/flavor

 
-
Table 1 Path parameters
Parameter

+

@@ -40,24 +40,34 @@
 
Request Parameters

-
Table 1 URI parameters
Parameter

 		
 
Mandatory

 		
 
 
Table 2 Request header parameters
Parameter

+

-
-
-
-
-
-
-
+
+
+
+
+
@@ -90,6 +100,7 @@
 
Table 2 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
x-auth-token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token.

-
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
User token.

+
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
Content-Type

+
Yes

+
String

+
MIME type of the request body. Value range:

+
  • application/json
  • application/json;charset=utf-8

 		
 

 
String

 		
 
This parameter is not required if the instance has only one node group. Each instance has one node group by default. If you need to create multiple node groups, set this parameter to the ID of the group whose node class you want to change.

+
It can be obtained from Obtaining the Instance Group Information (a V3 API).

 		
 

 
is_auto_pay

@@ -127,9 +138,9 @@
 
 
Status code: 400

 
-
Table 5 Response body parameters
Parameter

+

-
@@ -154,11 +165,11 @@
 
Status code: 500

 
-
Table 5 Response body parameters
Parameter

 
Type

+
Type

 		
 
Description

 		
 
Table 6 Response body parameters
Parameter

+

-
-
@@ -180,7 +191,7 @@
 
Table 6 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 

 

 
-
Example Request
PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/flavor
+
Example Request
PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/flavor
 
 {
   "spec_code" : "ddm.8xlarge.2",
diff --git a/docs/ddm/api-ref/ddm_api_01_0018.html b/docs/ddm/api-ref/ddm_api_01_0018.html
index 97b1e31ac..a103a5094 100644
--- a/docs/ddm/api-ref/ddm_api_01_0018.html
+++ b/docs/ddm/api-ref/ddm_api_01_0018.html
@@ -1,13 +1,13 @@
 
 
-
Querying DDM Instances

+
Querying DDM Instances (a V1 API)

 
Function
This API is used to query DDM instances.

 

 
Constraints
None

 

 
URI
GET /v1/{project_id}/instances?offset={offset}&limit={limit}

 
-
Table 1 Path parameters
Parameter

+

@@ -48,7 +48,7 @@
 
+
+
+
+
+
+
+
+
Table 1 Path parameter
Parameter

 		
 
Mandatory

 		
 
Index offset.

 
The query starts from the next piece of data indexed by this parameter. The value is 0 by default.

-
The value must be a positive integer.

+
The value must be a number but cannot be a negative number.

 		
 

 
limit

@@ -282,6 +282,21 @@
 
Engine version (core instance version)

 		
 
enable_ssl

+
Boolean

+
Whether SSL is enabled. The value can be:

+
  • true: SSL is enabled for the instance.
  • false: SSL is disabled for the instance.

+
flavor_ref

+
String

+
Specification code

+

 
 

 

@@ -340,7 +355,7 @@
 

 

 

-
Example Request
GET https://{endpoint}/v1/{project_id}/instances?offset={offset}&limit={limit}

+
Example Request
GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances?offset=0&limit=10

 

 
Example Response
Status code: 200

 
OK

@@ -364,7 +379,9 @@
     "node_status" : "RUNNING",
     
     "project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c",
-    "engine_version" : "3.0.8"
+    "engine_version" : "3.0.8",
+    "enable_ssl" : false,
+    "flavor_ref" : "ddm.c6.large.2"
   } ],
   "page_size" : 1,
   "total_record" : 26,
diff --git a/docs/ddm/api-ref/ddm_api_01_0019.html b/docs/ddm/api-ref/ddm_api_01_0019.html
index 3b4736c82..efd0bf113 100644
--- a/docs/ddm/api-ref/ddm_api_01_0019.html
+++ b/docs/ddm/api-ref/ddm_api_01_0019.html
@@ -1,6 +1,6 @@
 
 
-
Querying Details of a DDM Instance

+
Querying Details of a DDM Instance (a V1 API)

 
Function
This API is used to query details about a DDM instance.

 

 
Constraints
None

@@ -42,9 +42,9 @@
 
Request Parameters

 

-
-
@@ -222,13 +222,28 @@
 
  • Can include 1 to 32 characters.
  • Must start with a letter.
  • Can contain only letters, digits, and underscores (_).

+
+
+
+
+
+
+
+
Table 2 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 		
 
Description

 		
 
 
enable_ssl

+
Boolean

+
Whether SSL is enabled. The value can be:

+
  • true: SSL is enabled for the instance.
  • false: SSL is disabled for the instance.

+
flavor_ref

+
String

+
Specification code

+

 
 

 

 
 

-
@@ -252,7 +267,21 @@
 
-
+
+
+
+
+
+
+
+
@@ -260,9 +289,9 @@
 
Status code: 400

 
-
Table 4 GetDetailfNodesInfo
Parameter

 
Type

+
Type

 		
 
Description

 		
 
String

 
IP address of the DDM instance node

+
ELB IP address of the group that the node belongs to.

+
group_id

+
String

+
ID of the group that the node belongs to

+
node_id

+
String

+
Node ID

 		
 

 
 
Table 5 Response body parameters
Parameter

+

-
@@ -287,11 +316,11 @@
 
Status code: 500

 
-
Table 5 Response body parameters
Parameter

 
Type

+
Type

 		
 
Description

 		
 

+
+
+
+
+
Table 6 Response body parameters
Parameter

+

-
-
@@ -313,7 +342,7 @@
 
Table 6 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 

 

 
-
Example Request
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}

+
Example Request
GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09

 

 
Example Response
Status code: 200

 
OK

@@ -321,7 +350,9 @@
   "nodes" : [ {
     "status" : "RUNNING",
     "port" : "5066",
-    "ip" : "192.168.0.160"
+    "ip" : "192.168.0.160",
+    "group_id": "b4153b807b1a4f83870bf868fcc4f4eagr09",
+    "node_id": "4a2b97b7f5e3462c9c78aae93b46ed83no09"
   } ],
   "id" : "1f5c9fd6cd984056ba89c8c87cc03278in09",
   "status" : "RUNNING",
@@ -341,7 +372,9 @@
  
   "project_id" : "070c071d8e80d58c2f42c0121b10cf9f",
   "engine_version" : "3.0.6",
-  "admin_user_name" : "root"
+  "admin_user_name" : "root",
+  "enable_ssl" : false,
+  "flavor_ref" : "ddm.c6.large.2"
 }
 
Status code: 400

 
bad request

diff --git a/docs/ddm/api-ref/ddm_api_01_0020.html b/docs/ddm/api-ref/ddm_api_01_0020.html
index 5199dac77..69ea93304 100644
--- a/docs/ddm/api-ref/ddm_api_01_0020.html
+++ b/docs/ddm/api-ref/ddm_api_01_0020.html
@@ -1,7 +1,7 @@
 
 
-
Modifying the Name of a DDM Instance

-
Function
This API is used to modify the name of a DDM instance.

+
Changing the Name of a DDM Instance (a V1 API)

+
Function
This API is used to change the name of a DDM instance.

 

 
Constraints
None

 

@@ -60,6 +60,16 @@
 
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

 
 
Content-Type

+
Yes

+
String

+
MIME type of the request body. Value range:

+
  • application/json
  • application/json;charset=utf-8

+

 
 

 

@@ -165,7 +175,7 @@
 

 

 

-
Example Request
PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-name
+
Example Request
PUT https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/modify-name
 
 {
   "name" : "DDM-test-04"
diff --git a/docs/ddm/api-ref/ddm_api_01_0021.html b/docs/ddm/api-ref/ddm_api_01_0021.html
index 93e165b56..adb50c90c 100644
--- a/docs/ddm/api-ref/ddm_api_01_0021.html
+++ b/docs/ddm/api-ref/ddm_api_01_0021.html
@@ -1,6 +1,6 @@
 
 
-
Modifying the Security Group of a DDM Instance

+
Modifying the Security Group of a DDM Instance (a V1 API)

 
Function
This API is used to modify the security group of a DDM instance.

 

 
Constraints
None

@@ -40,24 +40,34 @@
 

 

 
Request Parameters

-
Table 2 Request header parameters
Parameter

+

-
-
-
-
-
-
-
+
+
+
+
+
@@ -162,7 +172,7 @@
 
Table 2 Request header parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
X-Auth-Token

+
X-Auth-Token

 
Yes

+
Yes

 
String

+
String

 
User token

-
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
User token.

+
It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

+
Content-Type

+
Yes

+
String

+
MIME type of the request body. Value range:

+
  • application/json
  • application/json;charset=utf-8

 		
 

 

 

 
-
Example Request
PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-security-group
+
Example Request
PUT https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/modify-security-group
 
 {
   "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"
diff --git a/docs/ddm/api-ref/ddm_api_01_0022.html b/docs/ddm/api-ref/ddm_api_01_0022.html
index 26cc348ae..8415c949e 100644
--- a/docs/ddm/api-ref/ddm_api_01_0022.html
+++ b/docs/ddm/api-ref/ddm_api_01_0022.html
@@ -1,9 +1,9 @@
 
 
-
Deleting a DDM Instance

+
Deleting a DDM Instance (a V1 API)

 
Function
This API is used to delete a DDM instance to release all its resources.

 

-
Constraints
None

+
Constraints

 

 
URI
DELETE /v1/{project_id}/instances/{instance_id}

 
@@ -172,8 +172,8 @@
 

 

 

-
Example Request
  • Request to delete a DDM instance (including the data stored on the associated DB instances)
    DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true
    
-
  • Request to delete a DDM instance (excluding the data stored on the associated DB instances)
    DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false
    
+
    Example Request
    • Request to delete a DDM instance (including the data stored on the associated DB instances)
      DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_rds_data=true
      
+
    • Request to delete a DDM instance (excluding the data stored on the associated DB instances)
      DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_rds_data=false
      
 
    
 
    
 
    Example Response
    Status code: 200
    
@@ -226,7 +226,7 @@
 
    
 
    
 
    
-
    Parent topic: DDM Instances
    
+
    Parent topic: Instance Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0023.html b/docs/ddm/api-ref/ddm_api_01_0023.html
index 58ea5e544..ef96a54f0 100644
--- a/docs/ddm/api-ref/ddm_api_01_0023.html
+++ b/docs/ddm/api-ref/ddm_api_01_0023.html
@@ -1,9 +1,9 @@
 
 
-
    Restarting a DDM Instance
    
+
    Restarting a DDM Instance (a V1 API)
    
 
    Function
    This API is used to restart a DDM instance.
    
 
    
-
    Constraints
    None
    
+
    Constraints
    
 
    
 
    URI
    POST /v1/{project_id}/instances/{instance_id}/action
    
 
@@ -40,24 +40,34 @@
 
    
 
    
 
    Request Parameters
    
-
    Table 2 Request header parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
+
+
+
+
+
@@ -202,7 +212,7 @@
 
    Table 2 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    X-Auth-Token
    
+
    X-Auth-Token
    
 
    Yes
    
+
    Yes
    
 
    String
    
+
    String
    
 
    User token.
    
-
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
     		
 
    
 
    
 
    
 
-
    Example Request
    POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/action
+
    Example Request
    POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/action
 
 {
   "restart" : {
@@ -261,7 +271,7 @@
 
    
 
    
 
    
-
    Parent topic: DDM Instances
    
+
    Parent topic: Instance Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0024.html b/docs/ddm/api-ref/ddm_api_01_0024.html
index 43684fc4c..871470422 100644
--- a/docs/ddm/api-ref/ddm_api_01_0024.html
+++ b/docs/ddm/api-ref/ddm_api_01_0024.html
@@ -1,6 +1,6 @@
 
 
-
    Reloading Table Data
    
+
    Reloading Table Data (a V1 API)
    
 
    Function
    This API is used to reload table data of the destination DDM instance for cross-region DR.
    
 
    
 
    Constraints
    None
    
@@ -121,7 +121,7 @@
 
    
 
    
 
    
-
    Example Request
    POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/reload_config
+
    Example Request
    POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/reload_config
 
 { }
    
 
    
diff --git a/docs/ddm/api-ref/ddm_api_01_0025.html b/docs/ddm/api-ref/ddm_api_01_0025.html
index 7033305a1..6e3f14e7e 100644
--- a/docs/ddm/api-ref/ddm_api_01_0025.html
+++ b/docs/ddm/api-ref/ddm_api_01_0025.html
@@ -1,13 +1,14 @@
 
 
-
    Scaling Out a DDM Instance
    
+
    Scaling Out a DDM Instance (a V2 API)
    
 
    Function
    This API is used to scale out a specified DDM instance.
    
 
    
-
    Constraints
    Make sure that the associated RDS instances are available and not undergoing other operations.
    
+
    Constraints
    
+
    
 
    
 
    URI
    POST /v2/{project_id}/instances/{instance_id}/action/enlarge
    
 
-
    Table 1 Path parameters
    Parameter
    
+
    
@@ -40,24 +41,34 @@
 
    Request Parameters
    
-
    Table 1 URI parameters
    Parameter
    
     		
 
    Mandatory
    
     		
 
 
    
-
-
-
-
-
    Table 2 Request header parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
+
+
+
+
+
@@ -66,9 +77,9 @@
 
 
    Table 2 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    X-Auth-Token
    
+
    X-Auth-Token
    
 
    Yes
    
+
    Yes
    
 
    String
    
+
    String
    
 
    User token.
    
-
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
     		
 
    
 
    
-
-
@@ -99,6 +110,7 @@
 
-
-
-
-
-
-
@@ -69,6 +60,16 @@
 
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    String
    
     		
 
    Group ID, which specifies the node group that is scaled out. This parameter must be specified if there are more than one node group.
    
+
    It can be obtained from Obtaining the Instance Group Information (a V3 API).
    
     		
 
    
 
    is_auto_pay
    
@@ -150,9 +162,9 @@
 
 
    Status code: 400
    
 
-
    Table 5 Response body parameters
    Parameter
    
+
    
-
@@ -177,11 +189,11 @@
 
    Status code: 500
    
 
-
    Table 5 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    
-
-
-
-
-
-
-
-
    Table 6 Response body parameters
    Parameter
    
+
    
-
-
@@ -203,13 +215,13 @@
 
    Table 6 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    
 
    
 
-
    Example Request
    • Example request
      POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge
+
      Example Request
      • Example request
        POST https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/action/enlarge
 
 {
   "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
   "node_number" : 1
 }
        
-
      • Example request where the DDM instance has more than one group
        POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge
+
      • Example request where the DDM instance has more than one group
        POST https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/action/enlarge
 
 {
   "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
@@ -269,7 +281,7 @@
 
      
 
      
 
      
-
      Parent topic: DDM Instances
      
+
      Parent topic: Instance Management
      
 
      
 
      
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0026.html b/docs/ddm/api-ref/ddm_api_01_0026.html
index 10e78f404..88af288f5 100644
--- a/docs/ddm/api-ref/ddm_api_01_0026.html
+++ b/docs/ddm/api-ref/ddm_api_01_0026.html
@@ -1,6 +1,6 @@
 
 
-
      Scaling In a DDM instance
      
+
      Scaling In a DDM instance (a V2 API)
      
 
      Function
      This API is used to remove nodes from a specified DDM instance.
      
 
      
 
      Constraints
      Make sure that the associated RDS instances are available and not undergoing other operations. 
      
@@ -40,24 +40,34 @@
 
      
 
      
 
      Request Parameters
      
-
      
-
-
      Table 2 Request header parameters
      Parameter
      
+
      
-
-
-
-
-
-
-
+
+
+
+
+
@@ -90,6 +100,7 @@
 
@@ -185,12 +196,12 @@
 
      Table 2 Request header parameters
      Parameter
      
 
      Mandatory
      
+
      Mandatory
      
 
      Type
      
+
      Type
      
 
      Description
      
+
      Description
      
       		
 
      
 
      X-Auth-Token
      
+
      X-Auth-Token
      
 
      Yes
      
+
      Yes
      
 
      String
      
+
      String
      
 
      User token.
      
-
      It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
      
+
      User token.
      
+
      It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
      
+
      Content-Type
      
+
      Yes
      
+
      String
      
+
      MIME type of the request body. Value range:
      
+
      • application/json
      • application/json;charset=utf-8
      
       		
 
      
 
      String
      
       		
 
      Group ID, which specifies the group that is scaled out. This parameter must be specified if there are more than one node group.
      
+
      It can be obtained from Obtaining the Instance Group Information (a V3 API).
      
       		
 
      
 
      
 
      
 
-
      Example Request
      
 
      created
      
 
      Integer
      
+
      Long
      
 
      Time when the schema is created
      
+
      Time when the schema was created
      
       		
 
      
 
      used_rds
      
@@ -284,7 +284,7 @@
 
      
 
      
 
      
-
      Example Request
      GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}
      
+
      Example Request
      GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases?offset=0&limit=10
      
 
      
 
      Example Response
      Status code: 200
      
 
      OK
      
diff --git a/docs/ddm/api-ref/ddm_api_01_0030.html b/docs/ddm/api-ref/ddm_api_01_0030.html
index 4ddb05f22..2d8b46cea 100644
--- a/docs/ddm/api-ref/ddm_api_01_0030.html
+++ b/docs/ddm/api-ref/ddm_api_01_0030.html
@@ -1,9 +1,9 @@
 
 
-
      Querying Details of a Schema
      
+
      Querying Details of a Schema (a V1 API)
      
 
      Function
      This API is used to query details about a schema.
      
 
      
-
      Constraints
      None
      
+
      Constraints
      
 
      
 
      URI
      GET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}
      
 
@@ -111,9 +111,9 @@
 
    
 
    created
    
 
    String
    
+
    Long
    
 
    Time when the schema is created
    
+
    Time when the schema was created. The value is a UNIX timestamp, in milliseconds.
    
     		
 
    
 
    status
    
@@ -125,9 +125,9 @@
 
    
 
    updated
    
 
    String
    
+
    Long
    
 
    Time when the DDM instance is last updated
    
+
    Time when the schema was last updated. The value is a UNIX timestamp, in milliseconds.
    
     		
 
    
 
    databases
    
@@ -208,16 +208,16 @@
 
    
 
    created
    
 
    String
    
+
    Long
    
 
    Time when the shard is created
    
+
    Creation time. The value is a UNIX timestamp, in milliseconds.
    
     		
 
    
 
    updated
    
 
    String
    
+
    Long
    
 
    Time when the shard is last updated
    
+
    Last update time. The value is a UNIX timestamp, in milliseconds.
    
     		
 
    
 
    id
    
@@ -332,7 +332,7 @@
 
    
 
    
 
-
    Example Request
    GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/db_7567
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
@@ -464,7 +464,7 @@
 
    
 
    
 
    
-
    Parent topic: Schemas
    
+
    Parent topic: Schema Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0031.html b/docs/ddm/api-ref/ddm_api_01_0031.html
index 30605716c..5316f2060 100644
--- a/docs/ddm/api-ref/ddm_api_01_0031.html
+++ b/docs/ddm/api-ref/ddm_api_01_0031.html
@@ -1,9 +1,9 @@
 
 
-
    Deleting a Schema
    
+
    Deleting a Schema (a V1 API)
    
 
    Function
    This API is used to delete a schema to release all its resources.
    
 
    
-
    Constraints
    None
    
+
    Constraints
    
 
    
 
    URI
    DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data}
    
 
@@ -121,9 +121,9 @@
 
    
 
    Status code: 400
    
 
-
    
-
@@ -86,16 +86,7 @@
 
-
-
-
-
-
-
@@ -154,6 +145,27 @@
 
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 Response body parameters
    Parameter
    
+
    
-
@@ -174,8 +174,8 @@
 
    Table 5 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
 
    
 
-
    Example Request
    • Request to delete a schema (including the data stored on associated DB instances)
      DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=true
      
-
    • Request to delete a schema (excluding the data stored on associated DB instances)
      DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data=false
      
+
      Example Request
      • Request to delete a schema (including the data stored on associated DB instances)
        DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test?delete_rds_data=true
        
+
      • Request to delete a schema (excluding the data stored on associated DB instances)
        DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test?delete_rds_data=false
        
 
      
 
      
 
      Example Response
      Status code: 200
      
@@ -227,7 +227,7 @@
 
      
 
      
 
      
-
      Parent topic: Schemas
      
+
      Parent topic: Schema Management
      
 
      
 
      
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0041.html b/docs/ddm/api-ref/ddm_api_01_0041.html
index 358fc8a50..82707318f 100644
--- a/docs/ddm/api-ref/ddm_api_01_0041.html
+++ b/docs/ddm/api-ref/ddm_api_01_0041.html
@@ -4,9 +4,9 @@
 
      
 
      
 
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0062.html b/docs/ddm/api-ref/ddm_api_01_0062.html
index 8f272f1a9..7108464dc 100644
--- a/docs/ddm/api-ref/ddm_api_01_0062.html
+++ b/docs/ddm/api-ref/ddm_api_01_0062.html
@@ -19,7 +19,7 @@
 
 
    16
    
 
    X86
    
+
    x86
    
     		
 
    
 
    ddm.2xlarge.2
    
diff --git a/docs/ddm/api-ref/ddm_api_01_0064.html b/docs/ddm/api-ref/ddm_api_01_0064.html
index e888489e5..bd6bf2efa 100644
--- a/docs/ddm/api-ref/ddm_api_01_0064.html
+++ b/docs/ddm/api-ref/ddm_api_01_0064.html
@@ -1,14 +1,14 @@
 
 
 
    Status Description
    
-
    DDM Instance Statuses
    
+
    DDM Instance Statuses
    
 
    
-
@@ -48,11 +48,6 @@
 
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 DDM instance statuses
    Status
    
     		
 
    Description
    
     		
 
    
 
    CREATE
    
+
    CREATING
    
     		
 
    The DDM instance is being created.
    
 
    A DDM instance is being scaled in.
    
     		
 
    data_disk_full
    
-
    Disk space is full.
    
-
    
 
    RESTORE
    
     		
 
    A DDM instance is being restored.
    
@@ -63,23 +58,53 @@
 
    A DDM instance is being backed up.
    
     		
 
    MODIFY_NAME
    
+
    A DDM instance name is being changed.
    
+
    RESET_PASSWORD
    
+
    A password is being reset.
    
+
    MIGRATE_DATABASE
    
+
    Shards of a schema are being configured.
    
+
    
 
    SET_CONFIGURATION
    
     		
 
    The instance parameters are being updated.
    
     		
 
    CREATE_GROUP
    
+
    Creating a group
    
+
    DELETE_GROUP
    
+
    Deleting a group
    
+
    SWITCH_SSL
    
+
    Configuring SSL
    
+
    
     
 
    
 
    
 
    
-
    DDM Schema Statuses
    
+
    DDM Schema Statuses
    
 
    
-
@@ -89,7 +114,7 @@
 
-
@@ -99,17 +124,17 @@
 
-
-
-
@@ -118,7 +143,7 @@
 
    Table 2 DDM schema statuses
    Status
    
     		
 
    Description
    
     		
 
    
 
    CREATE
    
+
    CREATING
    
     		
 
    The schema is being created.
    
 
    The schema is running and available.
    
     		
 
    CREATEFAILED
    
+
    CREATE_FAILED
    
     		
 
    The schema fails to be created.
    
 
    The schema is being deleted.
    
     		
 
    Scaling out
    
+
    EXPANDING
    
     		
 
    The schema is being scaled out.
    
     		
 
    Scaling out failed
    
+
    EXPANDING FAILED
    
     		
 
    The schema fails to be scaled out.
    
     		
 
    Rolling back
    
+
    ROLLING BACK
    
     		
 
    The schema is being rolled back.
    
 
    
 
    
 
    
-
    DDM Node Statuses
    
+
    DDM Node Statuses
    
 
    Table 3 Node statuses
    Status
    
     		
 
    Description
    
@@ -159,6 +184,245 @@
 
    
 
    
 
    
+
    Task Statuses
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Task status description
    Status
    
+
    Description
    
+
    CreateInstance
    
+
    Creating a DB Instance
    
+
    DeleteInstance
    
+
    Deleting a DB instance
    
+
    EnlargeNode
    
+
    Changing a node class
    
+
    EnlargeNode
    
+
    Adding nodes
    
+
    ReduceNode
    
+
    Deleting nodes
    
+
    RestartInstance
    
+
    Rebooting a DB instance
    
+
    BindEIP
    
+
    Binding an EIP
    
+
    UnbindEIP
    
+
    Unbinding an EIP
    
+
    RestoreInstance
    
+
    Restoring DB instance data
    
+
    loadMetadata
    
+
    Importing schema information
    
+
    migrateLogicDb
    
+
    Configuring shards
    
+
    retryMigrateLogicDb
    
+
    Retrying shard configuration
    
+
    deleteConsistentBackup
    
+
    Deleting a consistent backup
    
+
    CreateGroup
    
+
    Creating a group
    
+
    DeleteGroup
    
+
    Deleting a group
    
+
    RestartNode
    
+
    Restarting a node
    
+
    
+
    
+
    
+
    Data Node Statuses
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 Data node statuses
    Status
    
+
    Description
    
+
    Normal
    
+
    A DB instance is available.
    
+
    Abnormal
    
+
    A DB instance is abnormal.
    
+
    Creating
    
+
    A DB instance is being created.
    
+
    Creation failed
    
+
    A DB instance fails to be created.
    
+
    Switchover in progress
    
+
    A standby DB instance is being switched over to the primary DB instance.
    
+
    Changing type to primary/standby
    
+
    A single DB instance is being changed to primary/standby DB instances.
    
+
    Rebooting
    
+
    A DB instance is being rebooted.
    
+
    Changing port
    
+
    The DB instance port is being changed.
    
+
    Changing instance class
    
+
    The CPU or memory of a DB instance is being modified.
    
+
    Scaling up
    
+
    Storage space of a DB instance is being scaled up.
    
+
    Backing up
    
+
    A DB instance is being backed up.
    
+
    Restoring
    
+
    A DB instance is in the process of being restored from a backup.
    
+
    Restore failed
    
+
    A DB instance fails to be restored.
    
+
    Storage full
    
+
    Storage space of a DB instance is full. Data cannot be written to databases. You need to scale up the storage space to make the instance available.
    
+
    Deleted
    
+
    A DB instance has been deleted and will not be displayed in the instance list.
    
+
    Parameter change. Pending reboot
    
+
    A modification to a database parameter is waiting for an instance reboot before it can take effect.
    
+
    
+
    
+
    
+
    Backup Statuses
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 6 Backup statuses
    Status
    
+
    Description
    
+
    creating
    
+
    A backup is being created.
    
+
    normal
    
+
    A backup is normal and available.
    
+
    deleted
    
+
    A backup has been deleted and will not be displayed in the backup list.
    
+
    createfail
    
+
    A backup fails to be created.
    
+
    
+
    
+
    
+
    AZ Statuses
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 7 AZ statuses
    Status
    
+
    Description
    
+
    normal
    
+
    The node classes in the AZ are available.
    
+
    unsupported
    
+
    The node classes are not supported by the AZ.
    
+
    sellout
    
+
    The node classes in the AZ are sold out.
    
+
    
+
    
+
    
 
    
 
    
 
    
diff --git a/docs/ddm/api-ref/ddm_api_01_0069.html b/docs/ddm/api-ref/ddm_api_01_0069.html
index 39339a318..580d2d47e 100644
--- a/docs/ddm/api-ref/ddm_api_01_0069.html
+++ b/docs/ddm/api-ref/ddm_api_01_0069.html
@@ -11,17 +11,17 @@
 
    2024-02-22
    
     		
 
    This issue is the fourth official release, which incorporates the following changes:
    
-
    Added instance_id to the response parameters in section Managing the Administrator Password.
    
-
    Deleted order_id from the response parameters in section Changing the Node Class of a DDM Instance.
    
-
    Added subnet_name to the response parameters in section Querying Details of a DDM Instance Node.
    
-
    Added ddmNodeId to the response parameters in section Monitoring Slow Query Logs.
    
+
    Added instance_id to the response parameters in section Managing the Administrator Password (a V3 API).
    
+
    Deleted order_id from the response parameters in section Changing the Node Class of a DDM Instance (a V3 API).
    
+
    Added subnet_name to the response parameters in section Querying Details of a DDM Instance Node (a V1 API).
    
+
    Added ddmNodeId to the response parameters in section Monitoring Slow Query Logs (a V2 API).
    
     		
 
    
 
    2024-01-26
    
     		
 
    This issue is the third official release.
    
 
    Added job_id to response parameters in the following sections.
    
-
+
     		
 
    
 
    2023-10-20
    
diff --git a/docs/ddm/api-ref/ddm_api_01_0080.html b/docs/ddm/api-ref/ddm_api_01_0080.html
index a996bcc37..cb617f506 100644
--- a/docs/ddm/api-ref/ddm_api_01_0080.html
+++ b/docs/ddm/api-ref/ddm_api_01_0080.html
@@ -1,15 +1,15 @@
 
 
-
    Modifying the Read Policy of the Associated DB Instance
    
+
    Modifying the Read Policy of the Associated DB Instance (a V2 API)
    
 
    Function
    This API is used to modify the read policy of the DB instance associated with a DDM instance.
    
 
    
 
    Constraints
    Make sure that the associated RDS instances are available and not undergoing other operations.
    
 
    
 
    URI
    PUT /v2/{project_id}/instances/{instance_id}/action/read-write-strategy
    
 
-
    Table 1 Path parameters
    Parameter
    
+
    
-
@@ -17,18 +17,18 @@
 
-
-
-
-
@@ -40,24 +40,34 @@
 
    Request Parameters
    
-
    Table 1 URI parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
     		
 
    Type
    
     		
 
    
 
    project_id
    
+
    project_id
    
 
    Yes
    
+
    Yes
    
     		
 
    String
    
     		
 
    Project ID of a tenant in a region
    
     		
 
    instance_id
    
+
    instance_id
    
 
    Yes
    
+
    Yes
    
     		
 
    String
    
     		
 
 
    
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
+
+
+
+
+
@@ -171,7 +181,7 @@
 
    Table 2 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    X-Auth-Token
    
+
    X-Auth-Token
    
 
    Yes
    
+
    Yes
    
 
    String
    
+
    String
    
 
    User token.
    
-
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
     		
 
    
 
    
 
    
 
-
    Example Request
    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/read-write-strategy
+
    Example Request
    PUT https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/action/read-write-strategy
 
 {
   "read_weight" : {
diff --git a/docs/ddm/api-ref/ddm_api_01_0081.html b/docs/ddm/api-ref/ddm_api_01_0081.html
index 77d302468..d0012ebae 100644
--- a/docs/ddm/api-ref/ddm_api_01_0081.html
+++ b/docs/ddm/api-ref/ddm_api_01_0081.html
@@ -1,13 +1,14 @@
 
 
-
    Synchronizing Data Node Information
    
+
    Synchronizing Data Node Information (a V1 API)
    
 
    Function
    This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.
    
 
    
-
    Constraints
    None
    
+
    Constraints
    
+
    
 
    
 
    URI
    POST /v1/{project_id}/instances/{instance_id}/rds/sync
    
 
-
    
-
@@ -121,7 +121,7 @@
 
-
-
+
+
+
+
@@ -236,7 +243,7 @@
 
    Table 1 Path parameters
    Parameter
    
+
    
@@ -146,7 +147,7 @@
 
    Table 1 URI parameters
    Parameter
    
     		
 
    Mandatory
    
 
    
 
    
 
-
    Example Request
    POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds/sync
    
+
    Example Request
    POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/rds/sync
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
@@ -198,7 +199,7 @@
 
    
 
    
 
    
-
    Parent topic: DDM Instances
    
+
    Parent topic: Instance Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0082.html b/docs/ddm/api-ref/ddm_api_01_0082.html
index 4a85cb736..e4799a2ca 100644
--- a/docs/ddm/api-ref/ddm_api_01_0082.html
+++ b/docs/ddm/api-ref/ddm_api_01_0082.html
@@ -1,6 +1,6 @@
 
 
-
    Querying Nodes of a DDM Instance
    
+
    Querying Nodes of a DDM Instance (a V1 API)
    
 
    Function
    This API is used to query nodes of a DDM instance.
    
 
    
 
    Constraints
    None
    
@@ -57,7 +57,7 @@
 
 
    Index offset.
    
 
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
-
    The value must be a positive integer.
    
+
    The value must be a number but cannot be a negative number.
    
     		
 
    
 
    limit
    
@@ -66,9 +66,9 @@
     		
 
    Integer
    
 
    A maximum of nodes to be queried.
    
-
    Value range: 1 to 128.
    
-
    If the parameter value is not specified, 10 nodes are queried by default.
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 128 records are queried by default.
    
     		
 
    
 
 
    Integer
    
 
    Which page the server starts returning items.
    
+
    Which page the server starts returning items
    
     		
 
    
 
    limit
    
@@ -175,7 +175,14 @@
     		
 
    String
    
 
    ip
    
+
    IP address of a DDM instance node
    
+
    group_id
    
+
    String
    
+
    ID of the group that the node belongs to
    
     		
 
    
 
    
 
    
 
    
-
    Example Request
    GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes?offset=0&limit=1
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
@@ -245,7 +252,8 @@
     "port" : "5066",
     "status" : "normal",
     "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
-    "ip" : "192.168.0.160"
+    "ip" : "192.168.0.160",
+    "group_id": "9fd13885d3354f1f8df256ecda6d3346gr09"
   } ],
   "offset" : 0,
   "limit" : 128,
diff --git a/docs/ddm/api-ref/ddm_api_01_0083.html b/docs/ddm/api-ref/ddm_api_01_0083.html
index 55d9f9fe0..b19ea5c00 100644
--- a/docs/ddm/api-ref/ddm_api_01_0083.html
+++ b/docs/ddm/api-ref/ddm_api_01_0083.html
@@ -1,9 +1,9 @@
 
 
-
    Querying Details of a DDM Instance Node
    
+
    Querying Details of a DDM Instance Node (a V1 API)
    
 
    Function
    This API is used to query details of a DDM instance node.
    
 
    
-
    Constraints
    None
    
+
    Constraints
    
 
    
 
    URI
    GET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}
    
 
@@ -153,6 +153,13 @@
 
    System disk ID
    
     		
 
    group_id
    
+
    String
    
+
    ID of the group that the node belongs to
    
+
    
 
 
    
 
    
@@ -211,7 +218,7 @@
 
    
 
    
 
    
-
    Example Request
    GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes/{node_id}
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes/4a2b97b7f5e3462c9c78aae93b46ed83no09
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
@@ -271,7 +278,7 @@
 
    
 
    
 
    
-
    Parent topic: DDM Instances
    
+
    Parent topic: Instance Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0084.html b/docs/ddm/api-ref/ddm_api_01_0084.html
index 1f7a25b8c..e099de48a 100644
--- a/docs/ddm/api-ref/ddm_api_01_0084.html
+++ b/docs/ddm/api-ref/ddm_api_01_0084.html
@@ -1,6 +1,6 @@
 
 
-
    Querying Parameters of a Specified DDM Instance
    
+
    Querying Parameters of a Specified DDM Instance (a V3 API)
    
 
    Function
    This API is used to query parameters of a specified DDM instance.
    
 
    
 
    Constraints
    None
    
@@ -57,7 +57,7 @@
 
    		
 
    Index offset.
    
 
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
-
    The value must be a positive integer.
    
+
    The value must be a number but cannot be a negative number.
    
     		
 
    
 
    limit
    
@@ -68,7 +68,7 @@
     		
 
    A maximum of parameters to be queried.
    
 
    Value range: 1 to 128.
    
-
    If the parameter value is not specified, 10 parameters are queried by default.
    
+
    If the parameter value is not specified, 128 records are queried by default.
    
     		
 
    
     
 
 
    X-Language
    
-
    No
    
-
    String
    
-
    Language.
    
-
    X-Auth-Token
    
+
    X-Auth-Token
    
     		
 
    Yes
    
 
    Total collections
    
     		
 
    id
    
+
    String
    
+
    Parameter group ID
    
+
    name
    
+
    String
    
+
    Parameter group name
    
+
    description
    
+
    String
    
+
    Parameter group description
    
+
    
     
 
    
 
    
@@ -185,6 +197,7 @@
 
    String
    
     		
 
    Whether the instance needs to be restarted
    
+
    • 0: It does not need to be restarted.
    • 1: It needs to ber restarted.
    
     		
 
    
 
    read_only
    
@@ -192,6 +205,7 @@
 
    String
    
     		
 
    Whether the parameter is read-only
    
+
    • 0: It is not read-only.
    • 1: It is read-only.
    
     		
 
    
 
    value_range
    
@@ -273,11 +287,14 @@
 
    
 
    
 
-
    Example Request
    GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/configurations
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
 
    {
+  "id": "08142a7de30d40549f04fe4757c6660cpr09",
+  "name": "ddm_69873de2-072",
+  "description": "ParamGroup for instance",
   "updated" : "2021-11-09 03:26:52",
   "configuration_parameter" : [ {
     "name" : "temp_table_size_limit",
diff --git a/docs/ddm/api-ref/ddm_api_01_0085.html b/docs/ddm/api-ref/ddm_api_01_0085.html
index 7d99ab3a9..a94356e65 100644
--- a/docs/ddm/api-ref/ddm_api_01_0085.html
+++ b/docs/ddm/api-ref/ddm_api_01_0085.html
@@ -1,6 +1,6 @@
 
 
-
    Modifying Parameters of a DDM Instance
    
+
    Modifying Parameters of a DDM Instance (a V3 API)
    
 
    Function
    This API is used to modify parameters of a DDM instance.
    
 
    
 
    Constraints
    None
    
@@ -50,16 +50,7 @@
 
 
    
 
    X-Language
    
-
    No
    
-
    String
    
-
    Language.
    
-
    X-Auth-Token
    
+
    X-Auth-Token
    
     		
 
    Yes
    
     		
 
 
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
     
 
    
 
    
@@ -87,223 +88,10 @@
 
 
    Yes
    
 
    values object
    
+
    Map<String,String>
    
 
    Parameters that need to be modified
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -312,7 +100,7 @@
 
    Response Parameters
    Status code: 200
    
 
-
    Table 4 values
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    bind_table
    
-
    No
    
-
    String
    
-
    Data association among multiple sharded tables. The optimizer processes JOIN operations at the MySQL layer based on these associations. The format is [{tb.col1,tb2.col2},{tb.col2,tb3.col1},...].
    
-
    character_set_server
    
-
    No
    
-
    String
    
-
    DDM server's character set. To store emoticons, set both this parameter and the character set on RDS to utf8mb4. To modify the character set, you must change the collation of the DDM server correspondingly.
    
-
    Enumerated values:
    
-
    • gbk
    • utf8
    • utf8mb4
    
-
    collation_server
    
-
    No
    
-
    String
    
-
    Collation on the DDM server. To modify the collation, you must modify the server's character set correspondingly.
    
-
    Enumerated values:
    
-
    • utf8_unicode_ci
    • utf8_bin
    • gbk_chinese_ci
    • gbk_bin
    • utf8mb4_unicode_ci
    • utf8mb4_bin
    
-
    concurrent_execution_level
    
-
    No
    
-
    String
    
-
    Concurrency level of scanning table shards in a logical table. DATA_NODE: indicates that database shards are scanned in parallel and table shards in each database shard are scanned in serial. RDS_INSTANCE: indicates that RDS instances are scanned in parallel and shards in each DB instance are scanned in serial. PHY_TABLE: indicates that all table shards are scanned in parallel.
    
-
    Enumerated values:
    
-
    • RDS_INSTANCE
    • DATA_NODE
    • PHY_TABLE
    
-
    connection_idle_timeout
    
-
    No
    
-
    String
    
-
    Number of seconds the server waits for activity on a connection before closing it. The value ranges from 60 to 28800. The default value is 28800, indicating that the server waits for 28800 seconds before closing a connection.
    
-
    enable_table_recycle
    
-
    No
    
-
    String
    
-
    Whether the table recycle bin is enabled.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
-
    insert_to_load_data
    
-
    No
    
-
    String
    
-
    Whether constant values can be inserted by executing the LOAD DATA statement.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
-
    live_transaction_timeout_on_shutdown
    
-
    No
    
-
    String
    
-
    Timeout limit of an in-transit transaction, in seconds. The value ranges from 0 to 100. The default value is 1, indicating that the server waits for 1 second before closing the connection.
    
-
    long_query_time
    
-
    No
    
-
    String
    
-
    Minimum duration of a query to be logged as slow, in seconds. The value ranges from 0.01 to 10. The default value is 1, indicating that the query is considered as a slow query if its execution duration is greater than or equal to 1 second.
    
-
    max_allowed_packet
    
-
    No
    
-
    String
    
-
    Maximum size of a packet or any generated intermediate string. The packet message buffer is initialized to net_buffer_length bytes, but can grow up to max_allowed_packet bytes if required. This value is small by default, to catch large (and possibly incorrect) packets. The value must be a multiple of 1024. The value ranges from 1024 to 1073741824. The default value is 16777216.
    
-
    max_backend_connections
    
-
    No
    
-
    String
    
-
    Maximum of concurrent RDS client connections allowed per DDM instance. When this parameter is set to 0 (default), the maximum concurrent connections from a DDM node to an RDS instance is: (RDS instance's maximum connections - 20)/DDM nodes. The value ranges from 0 to 10000000.
    
-
    max_connections
    
-
    No
    
-
    String
    
-
    Concurrent connections allowed per DDM instance, which depends on the class and quantity of associated RDS instances. The default value is 20000. The value ranges from 10 to 40000, indicating that the maximum of concurrent connections cannot exceed 40,000.
    
-
    min_backend_connections
    
-
    No
    
-
    String
    
-
    Minimum concurrent connections from a DDM node to an RDS instance. The default value is 10. The value ranges from 0 to 10000000.
    
-
    not_from_pushdown
    
-
    No
    
-
    String
    
-
    Whether the SELECT statements that do not contain any FROM clauses are pushed down.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
-
    seconds_behind_master
    
-
    No
    
-
    String
    
-
    Threshold in seconds of the replication lag between a primary RDS instance to its read replica. The value ranges from 0 to 7200. The default value is 30, indicating that the time for data replication between the primary RDS instance and its read replicas cannot exceed 30 seconds. If the time exceeds 30 seconds, the data read requests are no longer forwarded to the read replicas.
    
-
    sql_audit
    
-
    No
    
-
    String
    
-
    Whether SQL audit is enabled.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
-
    sql_execute_timeout
    
-
    No
    
-
    String
    
-
    Number of seconds to wait for a SQL statement to execute before it times out. The value ranges from 100 to 28800. The default value is 28800, indicating that the SQL statement times out if its execution time is greater than or equal to 28,800 seconds.
    
-
    support_ddl_binlog_hint
    
-
    No
    
-
    String
    
-
    Whether a binlog hint is added to each DDL statement.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
-
    transaction_policy
    
-
    No
    
-
    String
    
-
    Transactions supported by DDM. XA transaction, which attempts to ensure atomicity and isolation. FREE transaction, which is a best-effort commit transaction that allows data to be written to multiple shards, without impacting performance. FREE transactions do not ensure atomicity. NO_DTX transaction, which is a single-shard transaction.
    
-
    Enumerated values:
    
-
    • XA
    • FREE
    • NO_DTX
    
-
    ultimate_optimize
    
-
    No
    
-
    String
    
-
    Whether the SQL execution plan is optimized based on parameter values.
    
-
    Enumerated values:
    
-
    • OFF
    • ON
    
+
    Parameter values defined by users based on a default parameter template.
    
+
    • key: parameter name. If a parameter name is left empty, its value is not to be changed.
    • value: parameter value.
    
     		
 
    
     
 
    Table 5 Response body parameters
    Parameter
    
+
    
@@ -360,7 +148,7 @@
 
    Status code: 400
    
 
-
    Table 4 Response body parameters
    Parameter
    
     		
 
    Type
    
     		
 
    Table 6 Response body parameters
    Parameter
    
+
    
@@ -387,7 +175,7 @@
 
    Status code: 500
    
 
-
    Table 5 Response body parameters
    Parameter
    
     		
 
    Type
    
     		
 
    Table 7 Response body parameters
    Parameter
    
+
    
@@ -413,7 +201,7 @@
 
    Table 6 Response body parameters
    Parameter
    
     		
 
    Type
    
 
    
 
    
 
-
    Example Request
    PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations
+
    Example Request
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/configurations
 
 {
   "values" : {
diff --git a/docs/ddm/api-ref/ddm_api_01_0089.html b/docs/ddm/api-ref/ddm_api_01_0089.html
index aa3e2241e..7a908d595 100644
--- a/docs/ddm/api-ref/ddm_api_01_0089.html
+++ b/docs/ddm/api-ref/ddm_api_01_0089.html
@@ -4,7 +4,7 @@
 
    
 
    
 
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0090.html b/docs/ddm/api-ref/ddm_api_01_0090.html
index b7590944e..06c5c7d9f 100644
--- a/docs/ddm/api-ref/ddm_api_01_0090.html
+++ b/docs/ddm/api-ref/ddm_api_01_0090.html
@@ -1,9 +1,9 @@
 
 
-
    Monitoring Slow Query Logs
    
+
    Monitoring Slow Query Logs (a V2 API)
    
 
    Function
    This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.
    
 
    
-
    Constraints
    None
    
+
    Constraints
    
 
    
 
    URI
    GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
    
 
@@ -41,9 +41,9 @@
 
 
    
-
-
@@ -93,9 +93,9 @@
 
    Request Parameters
    
 
    Table 2 Query parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
-
-
@@ -145,7 +145,7 @@
 
 
    Table 3 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
-
@@ -219,9 +219,9 @@
 
    Status code: 400
    
 
-
    Table 5 SlowLogList
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    Table 6 Response body parameters
    Parameter
    
+
    
-
@@ -246,11 +246,11 @@
 
    Status code: 500
    
 
-
    Table 6 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    Table 7 Response body parameters
    Parameter
    
+
    
-
-
@@ -272,7 +272,7 @@
 
    Table 7 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    
 
    
 
-
    Example Request
    GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v2/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/slowlog?curPage=0&perPage=1&startDate=1758286647000&endDate=1758373047000
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
@@ -334,7 +334,7 @@
 
    
 
    
 
    
-
    Parent topic: Monitoring
    
+
    Parent topic: Monitoring Management
    
 
    
 
    
 
diff --git a/docs/ddm/api-ref/ddm_api_01_0093.html b/docs/ddm/api-ref/ddm_api_01_0093.html
new file mode 100644
index 000000000..8effa1e30
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0093.html
@@ -0,0 +1,298 @@
+
+
+
    Obtaining the Instance Group Information (a V3 API)
    
+
    Function
    Obtain DDM instance group information.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
      GET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 Path parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      instance_id
      
+
      Yes
      
+
      String
      
+
      DDM instance ID
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 2 Query parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      offset
      
+
      No
      
+
      Integer
      
+
      Index offset.
      
+
      The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
      
+
      The value must be a number but cannot be a negative number.
      
+
      limit
      
+
      No
      
+
      Integer
      
+
      Maximum records to be queried.
      
+
      Value range: 1 to 128.
      
+
      If the parameter value is not specified, 10 records are obtained by default.
      
+
      
+
      
+
    
+
    
+
    Request
    • Request parameters
+
      
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Request header parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      X-Auth-Token
      
+
      Yes
      
+
      String
      
+
      User token.
      
+
      You can obtain the token by calling the IAM API used to obtain a user token.
      
+
      
+
      
+
    
+
    • URI example
      GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups?offset=null&limit=null
      
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      total_count
      
+
      Integer
      
+
      Total records
      
+
      group_list
      
+
      Array of Table 5 objects
      
+
      Instance group information
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 GroupInfo
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Group ID
      
+
      name
      
+
      String
      
+
      Group name
      
+
      role
      
+
      String
      
+
      Group role type, which can be read/write or read-only.
      
+
      Returned values:
      
+
      • rw: read/write group
      • r: read-only group
      
+
      endpoint
      
+
      String
      
+
      Connection address of the group. If load balancing is not enabled, the connection address string of the node in the group is returned.
      
+
      ipv6_endpoint
      
+
      String
      
+
      IPv6 connection address of the group
      
+
      is_load_balance
      
+
      Boolean
      
+
      Whether load balancing is enabled
      
+
      is_default_group
      
+
      Boolean
      
+
      Whether the API group is the default group
      
+
      cpu_num_per_node
      
+
      Integer
      
+
      Number of CPU cores per node
      
+
      mem_num_per_node
      
+
      Integer
      
+
      Memory size per node, in GB
      
+
      architecture
      
+
      String
      
+
      CPU architecture
      
+
      Returned values:
      
+
      • x86
      • Arm
      
+
      node_list
      
+
      Array of objects (Table 6)
      
+
      Node information list
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 6 GroupNodeInfo
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Node ID
      
+
      name
      
+
      String
      
+
      Node name
      
+
      az
      
+
      String
      
+
      AZ to which the node belongs
      
+
      
+
      
+
    • Normal response example
      { 
+    "group_list":[ 
+        { 
+            "id":"****gr09", 
+            "name":"group-default", 
+            "role":"rw", 
+            "endpoint":"**.**.**.**:5066", 
+            "is_load_balance":true, 
+            "is_default_group":false, 
+            "architecture":"X86", 
+            "cpu_num_per_node":4, 
+            "mem_num_per_node":8, 
+            "node_list":[ 
+                { 
+                    "id":"****no09", 
+                    "name":"node_01", 
+                    "az":"some_az" 
+                } 
+            ] 
+        } 
+    ], 
+    "total_count":1 
+}
      
+
    
+
    
+
+
    Status Code
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0094.html b/docs/ddm/api-ref/ddm_api_01_0094.html
new file mode 100644
index 000000000..af639fcab
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0094.html
@@ -0,0 +1,284 @@
+
+
+
    Creating an Instance Group (a V3 API)
    
+
    Function
    This API is used to create a DDM instance group.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
      POST /v3/{project_id}/instances/{instance_id}/groups
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 URI parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      instance_id
      
+
      Yes
      
+
      String
      
+
      DDM instance ID.
      
+
      
+
      
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    name
    
+
    Yes
    
+
    String
    
+
    Name of a DDM instance group, which:
    
+
    • Can include 4 to 64 characters.
    • Must start with a letter.
    • Can contain only letters, digits, underscores (_), and hyphens (-).
    
+
    Minimum characters: 4
    
+
    Maximum characters: 64
    
+
    type
    
+
    Yes
    
+
    String
    
+
    Type of the instance group.
    
+
    rw: read/write group
    
+
    r: read-only group
    
+
    flavor_id
    
+
    No
    
+
    String
    
+
    Flavor ID. (Either the flavor ID or flavor code must be specified.)
    
+
    It can be obtained by referring to Querying DDM Node Classes Available in Each AZ (a V3 API).
    
+
    flavor_ref
    
+
    No
    
+
    String
    
+
    Flavor code. (Either the flavor ID or flavor code must be specified.)
    
+
    It can be obtained by referring to Querying DDM Node Classes Available in Each AZ (a V3 API).
    
+
    nodes
    
+
    Yes
    
+
    Array of Table NodeInfo objects
    
+
    Node information list.
    
+
    Minimum value: 1
    
+
    Maximum value: 32
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 NodeInfo
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    available_zone
    
+
    Yes
    
+
    String
    
+
    AZ where the node is located. The value cannot be empty. For details, see Regions and Endpoints.
    
+
    subnet_id
    
+
    Yes
    
+
    String
    
+
    Subnet ID.
    
+
    
+
    
+
    
+
    Example Request
    Create a DDM instance group. The group type is read/write and the number of nodes is 1.
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/groups
+{
+    "name": "group-1",
+    "type": "rw",
+    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
+     "nodes": [
+        {
+            "available_zone": "az1", 
+            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
+        }
+    ]
+}
    
+
    
+
    Create a DDM instance group. The group type is read/write, the number of nodes is 1, and the flavor code is ddm.large.2.
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/groups
+{
+    "name": "group-1",
+    "type": "rw",
+    "flavor_ref": "ddm.large.2",
+     "nodes": [
+        {
+            "available_zone": "az1", 
+            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
+        }
+    ]
+}
    
+
    
+
    Create a DDM instance group. The group type is read-only and the number of nodes is 1.
    
+
    POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups
+{
+    "name": "group-2",
+    "type": "r",
+    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
+     "nodes": [
+        {
+            "available_zone": "az1", 
+            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
+        }
+    ]
+}
    
+
    Create a DDM instance group. The group type is read/write and the number of nodes is 2.
    POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups
+{
+    "name": "group-3",
+    "type": "rw",
+    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
+     "nodes": [
+        {
+            "available_zone": "az1", 
+            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
+        },
+        {
+            "available_zone": "az2", 
+            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
+        }
+    ]
+}
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the job for creating an instance group.
      
+
      This parameter is returned only when pay-per-use instances are created.
      
+
      group_id
      
+
      String
      
+
      Group ID.
      
+
      This parameter is returned only for the creation of pay-per-use instances.
      
+
      
+
      
+
    • Normal response example
      { 
+  "job_id" : "1eb697c0-1842-43a3-8671-f562d038****",
+ "group_id": "b4153b807b1a4f83870bf868fcc4f4ea****" 
+}
      
+
    
+
    
+
+
    Status Code
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0100.html b/docs/ddm/api-ref/ddm_api_01_0100.html
index e1f432902..1a4efd373 100644
--- a/docs/ddm/api-ref/ddm_api_01_0100.html
+++ b/docs/ddm/api-ref/ddm_api_01_0100.html
@@ -1,6 +1,6 @@
 
 
-
    Querying DB Instances Available for Creating a Schema
    
+
    Querying DB Instances Available for Creating a Schema (a V1 API)
    
 
    Function
    This API is used to query DB instances that can be used for creating a schema.
    
 
    
 
    Constraints
    None
    
@@ -41,9 +41,9 @@
 
 
    
-
-
@@ -78,9 +78,9 @@
 
    Request Parameters
    
 
    Table 2 Query parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
-
-
@@ -144,7 +144,7 @@
 
 
    Table 3 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
-
@@ -168,7 +168,7 @@
 
-
    Table 5 QueryAvailableRdsList
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    String
    
 
    DB instance status
    
+
    DB instance status. It can be obtained from Data Node Statuses.
    
     		
 
    
 
    name
    
@@ -232,9 +232,9 @@
 
 
    Status code: 400
    
 
-
    Table 6 Response body parameters
    Parameter
    
+
    
-
@@ -259,11 +259,11 @@
 
    Status code: 500
    
 
-
    Table 6 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    Table 7 Response body parameters
    Parameter
    
+
    
-
-
@@ -285,7 +285,7 @@
 
    Table 7 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    
 
    
 
-
    Example Request
    GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/rds?offset=0&limit=1
    
 
    
 
    Example Response
    Status code: 200
    
 
    OK
    
diff --git a/docs/ddm/api-ref/ddm_api_01_0101.html b/docs/ddm/api-ref/ddm_api_01_0101.html
index 781caaf40..9dcb76ca0 100644
--- a/docs/ddm/api-ref/ddm_api_01_0101.html
+++ b/docs/ddm/api-ref/ddm_api_01_0101.html
@@ -1,6 +1,6 @@
 
 
-
    Managing the Administrator Password
    
+
    Managing the Administrator Password (a V3 API)
    
 
    Function
    If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password.
    
 
    
 
    URI
    PUT /v3/{project_id}/instances/{instance_id}/admin-user
    
@@ -38,24 +38,34 @@
 
    
 
    
 
    Request Parameters
    
-
    Table 2 Request header parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
+
+
+
+
+
@@ -89,14 +99,14 @@
 
    Table 2 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    x-auth-token
    
+
    X-Auth-Token
    
 
    Yes
    
+
    Yes
    
 
    String
    
+
    String
    
 
    User token.
    
-
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
     		
 
    
 
    String
    
     		
 
    Password of the administrator. The password:
    
-
    • Can include 8 to 32 characters.
    • Must be a combination of uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_=+? Must be a strong password to improve security and prevent security risks such as brute force cracking.
    
+
    • Can include 8 to 32 characters.
    • Must contain at least three types of uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_=+? Must be a strong password to improve security and prevent security risks such as brute force cracking.
    
     		
 
    
     
 
    
 
    
 
-
    Response Parameters
    Status code: 200
    
+
    Response Parameters
    Status code: 202
    
 
 
    
@@ -106,14 +116,7 @@
 
-
-
-
-
-
@@ -125,9 +128,9 @@
 
    Status code: 400
    
 
-
    Table 4 Response body parameters
    Parameter
    
     		
 
    
 
    instance_id
    
-
    String
    
-
    DDM instance ID
    
-
    job_id
    
+
    job_id
    
     		
 
    String
    
     		
 
    Table 5 Response body parameters
    Parameter
    
+
    
-
@@ -152,9 +155,9 @@
 
    Status code: 500
    
 
-
    Table 5 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    
-
diff --git a/docs/ddm/api-ref/ddm_api_01_0102.html b/docs/ddm/api-ref/ddm_api_01_0102.html
index 6e5c2f862..eda38d0a1 100644
--- a/docs/ddm/api-ref/ddm_api_01_0102.html
+++ b/docs/ddm/api-ref/ddm_api_01_0102.html
@@ -1,6 +1,6 @@
 
 
-
    Validating Password Strength
    
+
    Checking Whether a Password Is Weak (a V3 API)
    Function
    This API is used to check whether an instance password is a weak password.
    
 
    
 
    URI
    POST /v3/{project_id}/weak-password-verification
    
@@ -29,24 +29,34 @@
 
    
 
    Request Parameters
    
-
    Table 6 Response body parameters
    Parameter
    
+
    
-
@@ -178,17 +181,16 @@
 
    Table 6 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
 
    
 
-
    Example Request
    PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user
+
    Example Request
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/admin-user
 
 {
   "name" : "root",
   "password" : "****"
 }
    
 
    
-
    Example Response
    Status code: 200
    
+
    Example Response
    Status code: 202
    
 
    OK
    
 
    { 
-  "instance_id" : "175f5aff-****-****-****-d0858982bbec",
   "job_id" : "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
 }
    
 
    Status code: 400
    
@@ -211,7 +213,7 @@
 
    		
 
    
 
    200
    
+
    202
    
     		
 
    OK
    
     		
 
 
    Table 2 Request header parameters
    Parameter
    
+
    
-
-
-
-
-
-
-
+
+
+
+
+
@@ -98,9 +108,9 @@
 
    Status code: 400
    
 
-
    Table 2 Request header parameters
    Parameter
    
 
    Mandatory
    
+
    Mandatory
    
 
    Type
    
+
    Type
    
 
    Description
    
+
    Description
    
     		
 
    
 
    x-auth-token
    
+
    X-Auth-Token
    
 
    Yes
    
+
    Yes
    
 
    String
    
+
    String
    
 
    User token.
    
-
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
     		
 
    
     
 
    Table 5 Response body parameters
    Parameter
    
+
    
-
@@ -125,9 +135,9 @@
 
    Status code: 500
    
 
-
    Table 5 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
     		
 
    Table 6 Response body parameters
    Parameter
    
+
    
-
@@ -151,7 +161,7 @@
 
    Table 6 Response body parameters
    Parameter
    
 
    Type
    
+
    Type
    
     		
 
    Description
    
 
    
 
    
 
-
    Example Request
    POST https://{endpoint}/v3/{project_id}/weak-password-verification
+
    Example Request
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/weak-password-verification
 
 {
   "password" : "xxx"
diff --git a/docs/ddm/api-ref/ddm_api_01_0104.html b/docs/ddm/api-ref/ddm_api_01_0104.html
new file mode 100644
index 000000000..8194b15bf
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0104.html
@@ -0,0 +1,177 @@
+
+
+
    Exporting Schema Metadata (a V3 API)
    
+
    Function
    This API is used to export all schema metadata about distribution of physical shards on data nodes.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/schema-metadata
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Exporting schema metadata
+GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/schema-metadata
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      compressed_databases_info
      
+
      String
      
+
      Distribution information of physical shards in a schema. This information is compressed and encoded.
      
+
      data_nodes
      
+
      Array of DNInstanceInfo objects
      
+
      Information about data nodes
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 DNInstanceInfo
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Data node ID
      
+
      instance_name
      
+
      String
      
+
      Data node name
      
+
      access_host
      
+
      String
      
+
      Access address
      
+
      access_port
      
+
      Integer
      
+
      Access port
      
+
      engine
      
+
      String
      
+
      Engine type
      
+
      engine_version
      
+
      String
      
+
      Engine version
      
+
      
+
      
+
    • Normal response example
      {
+	"compressed_databases_info": "H4sIAAAAAAAAAN3cTW/bRhgE4P/Csw7aL4rUtQUKX3wo0lMQCPxYNQJsOjApIIWR/17K1RvDPgQ9...",
+	"data_nodes": [{
+		"instance_id": "91b1272b09364ddeb999f1295bf0506ain01",
+		"instance_name": "rds-for-ddm-01",
+		"access_host": "172.16.192.110",
+		"access_port": 3306,
+		"engine": "mysql",
+		"engine_version": "5.7"
+	}]
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0104_0.html b/docs/ddm/api-ref/ddm_api_01_0104_0.html
new file mode 100644
index 000000000..d5a8e8db0
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0104_0.html
@@ -0,0 +1,23 @@
+
+
+
    Parameter Management
    
+
    
+
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0105.html b/docs/ddm/api-ref/ddm_api_01_0105.html
new file mode 100644
index 000000000..9cb10040c
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0105.html
@@ -0,0 +1,217 @@
+
+
+
    Importing Schema Metadata (a V3 API)
    
+
    Function
    This API is used to import distribution information of physical shards in all schemas and use it to create schemas that contain the same physical shards and distribution relationship.
    
+
    
+
    Constraints
    • Ensure that the selected data nodes are not associated with other DDM instances and no schemas are created.
    • The selected data nodes have no physical shards with the same name, for example, db_test_0000.
    • The current DDM instance has no schemas with the same name.
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/schema-metadata
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    compressed_databases_info
    
+
    String
    
+
    Yes
    
+
    Distribution information of physical shards in a schema. This information is compressed and encoded. For the method to obtain the information, see section "Exporting Schema Metadata."
    
+
    dn_instance
    
+
    DnInstance
    
+
    Yes
    
+
    Data nodes required for creating a schema. The number of data nodes should be consistent with the exported schema metadata and meet the following constraints:
    
+
    • The data nodes are not associated with other DDM instances for creating a schema.
    • The data nodes have no physical shards with the same name, for example, db_test_0000.
    • The data nodes must be in the same VPC as your DDM instance and not associated with other DDM instances.
    • The data nodes must be in the Running or Backing up state
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 DnInstance
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    dn_instance_id
    
+
    String
    
+
    Yes
    
+
    Data node ID
    
+
    admin_user
    
+
    String
    
+
    Yes
    
+
    Username for accessing the data node
    
+
    admin_password
    
+
    String
    
+
    Yes
    
+
    Password for accessing the data node
    
+
    
+
    
+
    Example Request
    Importing schema metadata
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/schema-metadata 
+{
+	"compressed_databases_info":"H4sIAAAAAAAAAN3cTW/bRhgE4P/Csw7aL4rUtQUKX3wo0lMQCPxYNQJsOjApIIWR/17K1RvDPgQ9...",
+	"dn_instance":[
+		{
+			"dn_instance_id":"91b1272b09364ddeb999f1295bf0506ain01",
+			"admin_user":"root",
+			"admin_password":"PassWord_234"
+		}
+	]
+}
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      DDM instance ID
      
+
      instance_name
      
+
      String
      
+
      DDM instance name
      
+
      job_id
      
+
      String
      
+
      Task ID
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"441d5677-b76a-4dd4-a97a",
+  "instance_id":"91b1272b09364ddeb999f1295bf0506ain09",
+  "instance_name":"ddm-test-01"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0105_0.html b/docs/ddm/api-ref/ddm_api_01_0105_0.html
new file mode 100644
index 000000000..50b24302a
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0105_0.html
@@ -0,0 +1,237 @@
+
+
+
    Obtaining Parameter Templates (a V3 API)
    
+
    Function
    This API is used to obtain parameter templates, including all default and custom parameter templates.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /v3/{project_id}/configurations?offset={offset}&limit={limit}
    
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128.
    
+
    If the parameter value is not specified, 10 records are obtained by default.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Parameter description
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Obtaining parameter templates
    
+
    GET https:/ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations?offset=0&limit=10
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    configurations
    
+
    Array of ConfigurationInfo objects
    
+
    Information of available engines
    
+
    offset
    
+
    Integer
    
+
    Which page the server starts returning items
    
+
    limit
    
+
    Integer
    
+
    Number of records displayed on each page
    
+
    total
    
+
    Integer
    
+
    Number of engine versions
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 ConfigurationInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    id
    
+
    String
    
+
    Parameter template ID
    
+
    name
    
+
    String
    
+
    Parameter template name
    
+
    description
    
+
    String
    
+
    Parameter template description
    
+
    datastore_name
    
+
    String
    
+
    Database type. The value is fixed at ddm.
    
+
    created
    
+
    String
    
+
    Creation time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    updated
    
+
    String
    
+
    Update time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    user_defined
    
+
    Boolean
    
+
    Whether the parameter template is a custom template. The value can be:
    
+
    false: The parameter template is a default template.
    
+
    true: The parameter template is a custom template.
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "configurations": [
+    {
+      "id": "2aa71dc81e2c47699229b7aa26038f9dpr09",
+      "name": "ddm-param1724812533",
+      "description": "",
+      "datastore_name": "ddm",
+      "created": "2021-12-14T07:46:22+0100",
+      "updated": "2021-12-14T07:46:22+0100",
+      "user_defined": false
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total": 1
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0106.html b/docs/ddm/api-ref/ddm_api_01_0106.html
new file mode 100644
index 000000000..0df903bd5
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0106.html
@@ -0,0 +1,245 @@
+
+
+
    Obtaining Parameters in a Specified Parameter Template (a V3 API)
    
+
    Function
    This API is used to obtain information about a specified parameter template.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /v3/{project_id}/configurations/{config_id}
    
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    config_id
    
+
    Yes
    
+
    String
    
+
    Parameter template ID.
    
+
    When this parameter is empty (not space), the URL of the parameter template list is obtained.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Parameter description
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Obtaining information about a specified parameter template
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/2aa71dc81e2c47699229b7aa26038f9dpr09
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    id
    
+
    String
    
+
    Parameter template ID
    
+
    name
    
+
    String
    
+
    Parameter template name
    
+
    datastore_name
    
+
    String
    
+
    Database name. The value is fixed at ddm.
    
+
    description
    
+
    String
    
+
    Parameter template description.
    
+
    created
    
+
    String
    
+
    Creation time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    updated
    
+
    String
    
+
    Update time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    configuration_parameters
    
+
    Array of ConfigurationParameters objects
    
+
    Parameters defined by users based on a default parameter template
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 ConfigurationParameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    name
    
+
    String
    
+
    Parameter name
    
+
    value
    
+
    String
    
+
    Parameter value
    
+
    restart_required
    
+
    Boolean
    
+
    Whether a restart is required. The value can be:
    
+
    • false: indicates that a restart is not required.
    • true: indicates that a restart is required.
    
+
    readonly
    
+
    Boolean
    
+
    Whether the parameter is read-only. The value can be:
    
+
    • false: indicates that the parameter is not read-only.
    • true: indicates that the parameter is read-only.
    
+
    value_range
    
+
    String
    
+
    Value range.
    
+
    type
    
+
    String
    
+
    Parameter type. The value can be string, integer, boolean, list, or float.
    
+
    description
    
+
    String
    
+
    Parameter description
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
+  "name": "default-ddm-test",
+  "datastore_name": "ddm",
+  "description": "Default parameter group for ddm-test",
+  "created": "2020-05-05T04:40:51+0100",
+  "updated": "2020-05-05T04:40:51+0100",
+  "configuration_parameters": [
+    {
+      "name": "auto_increment_increment",
+      "value": "1",
+      "restart_required": false,
+      "readonly": true,
+      "value_range": "1-65535",
+      "type": "integer",
+      "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns."
+    },
+    {
+      "name": "autocommit",
+      "value": "ON",
+      "restart_required": false,
+      "readonly": true,
+      "value_range": "ON|OFF",
+      "type": "boolean",
+      "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. "
+    }
+  ]
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0107.html b/docs/ddm/api-ref/ddm_api_01_0107.html
new file mode 100644
index 000000000..980e826b8
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0107.html
@@ -0,0 +1,19 @@
+
+
+
+  
    Querying API Versions
    
+
+  
    
+
    
+
+
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0108.html b/docs/ddm/api-ref/ddm_api_01_0108.html
new file mode 100644
index 000000000..f03d64e58
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0108.html
@@ -0,0 +1,148 @@
+
+
+
    Querying API Versions (a V3 API)
    
+
    Function
    This API is used to query API versions.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /
    
+
    • Parameter description
      None
      
+
    
+
    
+
    Request Parameters
    None
    
+
    
+
    Example Request
    Querying API versions
    
+
    GET https://ddm.eu-de.otc.t-systems.com/ 
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
    Table 1 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    versions
    
+
    Array of ApiVersion objects
    
+
    API version information including links.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 ApiVersion
    Parameter
    
+
    Type
    
+
    Description
    
+
    id
    
+
    String
    
+
    API version, for example, v1 or v3.
    
+
    links
    
+
    Array of LinkInfo objects
    
+
    API link information. The value is empty when the version is v1 or v3.
    
+
    status
    
+
    String
    
+
    Version status.
    
+
    CURRENT: recommended version.
    
+
    SUPPORTED: earlier version which is still supported.
    
+
    DEPRECATED: deprecated version which may be deleted later.
    
+
    version
    
+
    String
    
+
    If microversions are supported by APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this field will be empty.
    
+
    updated
    
+
    String
    
+
    Version update time. The format is yyyy-mm-dd Thh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 LinkInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    href
    
+
    String
    
+
    URL of the API.
    
+
    rel
    
+
    String
    
+
    Its value is self, indicating that href is a local link.
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "versions": [
+    {
+      "id": "v3",
+      "links": [],
+      "status": "CURRENT",
+      "updated": "2019-01-15T12:00:00Z",
+      "version":""
+    },
+    {
+      "id": "v1",
+      "links": [],
+      "status": "DEPRECATED",
+      "updated": "2017-02-07T17:34:02Z",
+      "version":""
+    }
+  ]
+}
    
+
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Querying API Versions
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0109.html b/docs/ddm/api-ref/ddm_api_01_0109.html
new file mode 100644
index 000000000..d8ac2422f
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0109.html
@@ -0,0 +1,201 @@
+
+
+
    Querying DDM Engine Information (a V3 API)
    
+
    Function
    This V3 API is used to query information about DDM engine.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /v3/{project_id}/engines?offset={offset}&limit={limit}
    
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are obtained by default.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying DDM engine information
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/engines?offset=0&limit=10
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    engine_groups
    
+
    Array of EngineGroupInfo objects
    
+
    Information of available engines
    
+
    offset
    
+
    Integer
    
+
    Which page the server starts returning items
    
+
    limit
    
+
    Integer
    
+
    Number of records displayed on each page
    
+
    total
    
+
    Integer
    
+
    Number of engine versions
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 EngineGroupInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    id
    
+
    String
    
+
    Engine ID
    
+
    name
    
+
    String
    
+
    Engine name
    
+
    version
    
+
    String
    
+
    Engine version
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "engine_groups": [
+    {
+      "id": "036dc44a-b560-4316-9e7f-e25a60f2aea2",
+      "name": "ddm",
+      "version": "3.1.0.8"
+    }
+  ],
+  "offset": 0,
+  "limit": 1,
+  "total": 1
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0110.html b/docs/ddm/api-ref/ddm_api_01_0110.html
new file mode 100644
index 000000000..1d69dc927
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0110.html
@@ -0,0 +1,344 @@
+
+
+
    Querying DDM Node Classes Available in Each AZ (a V3 API)
    
+
    Function
    This V3 API is used to query DDM node classes available in an AZ.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /v3/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit}&engine_version={engine_version}&available_zones={available_zones}
    
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    engine_id
    
+
    No
    
+
    String
    
+
    Engine ID, which can be obtained by calling the API for querying DDM engine information. At least one of engine_id and engine_version must be specified.
    
+
    engine_version
    
+
    No
    
+
    String
    
+
    Engine version, which can be obtained by calling the API for querying DDM engine information. At least one of engine_id and engine_version must be specified.
    
+
    available_zones
    
+
    No
    
+
    String
    
+
    AZs. Use commas (,) to separate multiple AZs, for example, eu-de-01,eu-de-02. The value cannot be empty. For details, see Regions and Endpoints.
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are obtained by default.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying DDM node classes available in an AZ
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/flavors?engine_id=xxxxxx-xxxx-xxxx-f7ab-100f2cd33008&engine_version=3.x.x.x&available_zones=eu-de-01,eu-de-02&offset=0&limit=10
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    flavor_groups
    
+
    Array of FlavorGroupInfo objects
    
+
    List of node classes.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 FlavorGroupInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    flavors
    
+
    Array of Flavor objects
    
+
    Node class information.
    
+
    group_type
    
+
    String
    
+
    Compute resource architecture type. The value can be X86 or ARM.
    
+
    offset
    
+
    Integer
    
+
    Which page the server starts returning items
    
+
    limit
    
+
    Integer
    
+
    Number of records displayed on each page
    
+
    total
    
+
    Integer
    
+
    Number of engine versions
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 6 Flavor
    Parameter
    
+
    Type
    
+
    Description
    
+
    az_infos
    
+
    Array of AvailableZone objects
    
+
    AZ information. The value can be:
    
+
    id
    
+
    String
    
+
    Node class ID.
    
+
    spec_code
    
+
    String
    
+
    Resource specification code.
    
+
    vcpus
    
+
    String
    
+
    Number of vCPUs. For example, the value 1 indicates 1 vCPU.
    
+
    ram
    
+
    String
    
+
    Memory size in GB.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 7 AvailableZone
    Parameter
    
+
    Type
    
+
    Description
    
+
    code
    
+
    String
    
+
    AZ code.
    
+
    description
    
+
    String
    
+
    AZ description.
    
+
    status
    
+
    String
    
+
    AZ status. It can be obtained from AZ Statuses.
    
+
    support_ipv6
    
+
    Boolean
    
+
    Whether IPv6 is supported.
    
+
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "flavor_groups": [
+    {
+      "offset": 0,
+      "limit": 1,
+      "total": 4,
+      "group_type": "X86",
+      "flavors": [
+        {
+          "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
+          "spec_code": "ddm.c6.xlarge.2",
+          "vcpus": "4",
+          "ram": "8",
+          "az_infos": [
+            {
+              "code": "eu-de-01",
+              "status": "normal",
+              "description": "eu-de-01",
+              "support_ipv6": true
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "offset": 0,
+      "limit": 1,
+      "total": 5,
+      "group_type": "ARM",
+      "flavors": [
+        {
+          "id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
+          "spec_code": "ddm.kc1.large.2",
+          "vcpus": "2",
+          "ram": "4",
+          "az_infos": [
+            {
+              "code": "eu-de-01",
+              "status": "normal",
+              "description": "eu-de-01",
+              "support_ipv6": true
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0111.html b/docs/ddm/api-ref/ddm_api_01_0111.html
new file mode 100644
index 000000000..a2043bbbd
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0111.html
@@ -0,0 +1,204 @@
+
+
+
    Scaling Out a DDM Instance (a V3 API)
    
+
    Function
    This API is used to scale out a specified DDM instance.
    
+
    
+
    Constraints
    Make sure that the associated RDS instances are available and not undergoing other operations.
    
+
    
+
    URI
    • URL format
      POST /v3/{project_id}/instances/{instance_id}/nodes
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 Path parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      instance_id
      
+
      Yes
      
+
      String
      
+
      DDM instance ID.
      
+
      
+
      
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    group_id
    
+
    No
    
+
    String
    
+
    Group ID, which specifies the group that is scaled out. This parameter must be specified if there are more than one node group.
    
+
    It can be obtained from Obtaining the Instance Group Information (a V3 API).
    
+
    subnet_id
    
+
    No
    
+
    String
    
+
    Subnet ID. This parameter is mandatory when there are more than one subnet in the node group.
    
+
    nodes
    
+
    Yes
    
+
    Array of Table EnlargeNodeInfo objects
    
+
    Node information list.
    
+
    The list can include at least one node.
    
+
    The list can include a maximum of 32 nodes.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 EnlargeNodeInfo
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    available_zone
    
+
    Yes
    
+
    String
    
+
    AZ where the node is located. The value cannot be empty. For details, see Regions and Endpoints.
    
+
    
+
    
+
    
+
    Example Request
    Scaling out a DDM instance. The number of nodes to be added is 1.
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes
+{
+     "nodes": [
+        {
+            "available_zone": "az1"
+        }
+    ]
+}
    
+
    
+
    Scaling out a DDM instance that has more than one group. The number of nodes to be added is 1.
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes
+{
+    "group_id": "efd077a3a50e460c8ba62e1956363299gr09",
+    "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22",
+     "nodes": [
+        {
+            "available_zone": "az1"
+        }
+    ]
+}
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of a node scale-out task.
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id": "eff1d289-4d03-4942-8b9f-463ea07c000c"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0112.html b/docs/ddm/api-ref/ddm_api_01_0112.html
new file mode 100644
index 000000000..cba601867
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0112.html
@@ -0,0 +1,212 @@
+
+
+
    Obtaining Information About a Task with a Specified ID (a V3 API)
    
+
    Function
    This API is used to obtain information about a task with a specified ID in the DDM task center.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
      GET /v3/{project_id}/jobs/{job_id}
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 Parameter descriptions
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      job_id
      
+
      Yes
      
+
      String
      
+
      Task ID
      
+
      
+
      
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Obtaining information about a task with a specified ID
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/31b8ae23-c687-4d80-b7b4-42a66c9bb886
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job
      
+
      JobInfo object
      
+
      Task information.
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 JobInfo
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Task ID
      
+
      name
      
+
      String
      
+
      Task name
      
+
      For details, see Task Statuses.
      
+
      status
      
+
      String
      
+
      Task execution status. The value can be:
      
+
      Running: The task is being executed. Completed: The task is successfully executed. Failed: The task fails to be executed.
      
+
      created_time
      
+
      String
      
+
      Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      end_time
      
+
      String
      
+
      End time. The format is yyyy-mm-ddThh:mm:ssZ.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      process
      
+
      String
      
+
      Task execution progress
      
+
      The execution progress (such as "60%", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
      
+
      instance
      
+
      Instance object
      
+
      Instance on which the task is executed
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 Instance
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Instance ID
      
+
      name
      
+
      String
      
+
      Instance name
      
+
      
+
      
+
    • Normal response example
      {
+    "job": {
+        "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
+        "name": "CreateInstance",
+        "status": "Running",
+        "created_time": "2018-08-06T10:41:14+0100",
+        "end_time": "2018-08-06T16:41:14+0100",
+        "process": "60%",
+        "instance": {
+            "id": "a48e43ff268f4c0e879652d65e63d0fbin09",
+            "name": "DDM-test"
+        }
+    }
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0113.html b/docs/ddm/api-ref/ddm_api_01_0113.html
new file mode 100644
index 000000000..718c95355
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0113.html
@@ -0,0 +1,136 @@
+
+
+
    Deleting an Instance (a V3 API)
    
+
    Function
    This API is used to delete a DDM instance to release all its resources.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
      DELETE /v3/{project_id}/instances/{instance_id}
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 Path parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      instance_id
      
+
      Yes
      
+
      String
      
+
      DDM instance ID.
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
      Table 2 Query parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      delete_dn_data
      
+
      No
      
+
      Boolean
      
+
      Whether data stored on the associated DB instances is deleted. This parameter is left empty by default.
      
+
      true: indicates that the data stored on the associated DB instances is deleted.
      
+
      false or leaving this parameter empty: indicates that the data stored on the associated DB instances is not deleted.
      
+
      
+
      
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Deleting an instance (including the data stored on associated DB instances)
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_dn_data=true
    
+
    
+
    Deleting an instance (excluding the data stored on associated DB instances)
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_dn_data=false
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the job for deleting an instance. 
      
+
      
+
      
+
    • Normal response example
      {
+ "job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0114.html b/docs/ddm/api-ref/ddm_api_01_0114.html
new file mode 100644
index 000000000..fdebdcca1
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0114.html
@@ -0,0 +1,146 @@
+
+
+
    Enabling or Disabling SSL (a V3 API)
    
+
    Function
    This API is used to configure SSL to encrypt connections.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/switch-ssl
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID.
    
+
    
+
    
+
    
+
    Request
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    ssl_enabled
    
+
    Yes
    
+
    Boolean
    
+
    true: SSL is enabled.
    
+
    false: SSL is disabled.
    
+
    
+
    
+
    
+
    Example Request
    Enabling SSL
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/switch-ssl
+{
+  "ssl_enabled" : true
+}
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID.
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0115.html b/docs/ddm/api-ref/ddm_api_01_0115.html
new file mode 100644
index 000000000..21120277f
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0115.html
@@ -0,0 +1,234 @@
+
+
+
    Creating a Schema (a V3 API)
    
+
    Function
    This API is used to create a schema.
    
+
    
+
    Constraints
    Before creating a schema, ensure that an RDS instance has been created, is in the normal state, and is not associated with other DDM instances.
    
+
    
+
    URI
    • URL format
      POST /v3/{project_id}/instances/{instance_id}/databases
      
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region.
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    DDM instance ID.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    name
    
+
    Yes
    
+
    String
    
+
    Schema name, which:
    
+
    • Can include 2 to 48 characters.
    • Must start with a lowercase letter.
    • Contains only lowercase letters, digits, and underscores (_).
    • Cannot contain keywords information_schema, mysql, performance_schema, or sys.
    
+
    shard_mode
    
+
    Yes
    
+
    String
    
+
    Sharding mode of the schema. The value can be:
    
+
    • cluster: indicates that the schema is in sharded mode.
    • single: indicates that the schema is in unsharded mode.
    
+
    Enumerated values:
    
+
    • cluster
    • single
    
+
    shard_number
    
+
    Yes
    
+
    Integer
    
+
    Number of shards in the same working mode. The value must be greater than or equal to the number of associated RDS instances and less than or equal to the product of the associated RDS instances multiplied by 64.
    
+
    dn_instances
    
+
    Yes
    
+
    Array of DatabaseDnInstanceInfo objects
    
+
    RDS instances associated with the schema
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 DatabaseDnInstanceInfo
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    id
    
+
    Yes
    
+
    String
    
+
    ID of the RDS instance associated with the schema
    
+
    user_name
    
+
    Yes
    
+
    String
    
+
    Username for logging in to the associated RDS instance
    
+
    user_password
    
+
    Yes
    
+
    String
    
+
    Password for logging in to the associated RDS instance
    
+
    
+
    
+
    
+
    Example Request
    • Creating a schema and associating it with an existing DDM account
      POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases
+{
+  "name": "mytestdb",
+  "shard_mode": "cluster",
+  "shard_number": 8,
+  "dn_instances": [
+    {
+      "id": "f296c394f13f48449d715bf99af07e59in01",
+      "user_name": "root",
+      "user_password": "PassWord_234"
+    }
+  ]
+}
      
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the job for deleting a schema
      
+
      name
      
+
      String
      
+
      Schema name
      
+
      
+
      
+
    • Normal response example
      {
+"job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c",
+  "name": "mytestdb"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0116.html b/docs/ddm/api-ref/ddm_api_01_0116.html
new file mode 100644
index 000000000..cc191fa47
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0116.html
@@ -0,0 +1,155 @@
+
+
+
    Deleting a Schema (a V3 API)
    
+
    Function
    This API is used to delete a schema to release all its resources.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
      DELETE /v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data={delete_dn_data}
      
+
    • Parameter description
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 1 Path parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      project_id
      
+
      Yes
      
+
      String
      
+
      Project ID of a tenant in a region.
      
+
      instance_id
      
+
      Yes
      
+
      String
      
+
      DDM instance ID
      
+
      database_name
      
+
      Yes
      
+
      String
      
+
      Schema name
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
      Table 2 Query parameters
      Parameter
      
+
      Mandatory
      
+
      Type
      
+
      Description
      
+
      delete_dn_data
      
+
      Yes
      
+
      Boolean
      
+
      Whether data stored on the associated DB instances is deleted. The value can be:
      
+
      true: indicates that the data stored on the associated DB instances is deleted.
      
+
      false: indicates that the data stored on the associated DB instances is not deleted.
      
+
      
+
      
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    
+
    
+
    
+
    Request
    • Request Parameters
      None
      
+
    
+
    • URI example
      • Deleting a schema (including the data stored on associated DB instances)
        DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=true
        
+
      • Deleting a schema (excluding the data stored on associated DB instances)
        DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=false
        
+
      
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the job for deleting a schema
      
+
      database_name
      
+
      String
      
+
      Schema name
      
+
      
+
      
+
    • Normal response example
      {
+"job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c",
+ "database_name": "test"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_01_0117.html b/docs/ddm/api-ref/ddm_api_01_0117.html
new file mode 100644
index 000000000..6bd825624
--- /dev/null
+++ b/docs/ddm/api-ref/ddm_api_01_0117.html
@@ -0,0 +1,261 @@
+
+
+
    Monitoring Slow Query Logs (a V3 API)
    
+
    Function
    This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    • URL format
    
+
    GET /v3/{project_id}/instances/{instance_id}/slow-logs?offset={offset}&limit={limit}&start_date={start_date}&end_date={end_date}
    
+
    • Parameter description
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    String
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    String
    
+
    Maximum records to be queried.
    
+
    The value ranges from 1 to 100.
    
+
    If the parameter value is not specified, 10 records are obtained by default.
    
+
    start_date
    
+
    Yes
    
+
    String
    
+
    Start time. The format is UNIX timestamp, in milliseconds.
    
+
    end_date
    
+
    Yes
    
+
    String
    
+
    End time. The format is UNIX timestamp, in milliseconds.
    
+
    The interval between the start time and the end time must be no more than 7 days.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying slow query logs on the DDM instance within a specified time range
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/slow-logs?offset=0&limit=10&start_date=1729872000000&end_date=1729927839000
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    total_record
    
+
    Integer
    
+
    Number of slow query logs
    
+
    slow_log_list
    
+
    Array of SlowLogs objects
    
+
    Information about slow query logs
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 SlowLogs
    Parameter
    
+
    Type
    
+
    Description
    
+
    users
    
+
    String
    
+
    Username of the DDM account for executing the slow SQL statement
    
+
    database
    
+
    String
    
+
    Name of the schema where the slow SQL statement is executed
    
+
    query_sample
    
+
    String
    
+
    Syntax for executing the slow SQL statement
    
+
    log_time
    
+
    String
    
+
    Time when the slow SQL statement starts to be executed. The format is yyyy-mm-ddThh:mm:ssZ.
    
+
    time
    
+
    String
    
+
    Time for a SQL statement to execute, accurate to milliseconds
    
+
    shards
    
+
    String
    
+
    Names of physical shards in the schema
    
+
    node_id
    
+
    String
    
+
    Node ID
    
+
    rows_examined
    
+
    String
    
+
    Number of rows affected by the SQL statements that take a long time to execute
    
+
    host
    
+
    String
    
+
    Client IP address. This IP address may involve personal data. Anonymizing the IP address data is recommended.
    
+
    
+
    
+
    • Normal response example
    
+
    {
+    "total_record": 1,
+    "slow_log_list": [
+        {
+            "users": "testddm",
+            "database": "test1",
+            "query_sample": "select id, sleep(3) from test",
+            "log_time": "2024-10-26T07:30:00",
+            "shards": "",
+            "rows_examined": "1",
+            "node_id": "xxxxx2f8f44546f493d084d0c6b94ecfno09",
+            "host": "192.168.x.x",
+            "time": "3002"
+        }
+    ]
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Monitoring
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/ddm_api_02_0000.html b/docs/ddm/api-ref/ddm_api_02_0000.html
index 1a62433ae..0f1e2a71c 100644
--- a/docs/ddm/api-ref/ddm_api_02_0000.html
+++ b/docs/ddm/api-ref/ddm_api_02_0000.html
@@ -8,6 +8,8 @@
 
 
 
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181623846.html b/docs/ddm/api-ref/en-us_topic_0000002181623846.html
new file mode 100644
index 000000000..01b794867
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181623846.html
@@ -0,0 +1,109 @@
+
+
+
    Restarting a DDM Instance (a V3 API)
    
+
    Function
    This API is used to restart a specific instance.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/restart
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Whether to restart the instance.
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/restart
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181623850.html b/docs/ddm/api-ref/en-us_topic_0000002181623850.html
new file mode 100644
index 000000000..009b9f76c
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181623850.html
@@ -0,0 +1,157 @@
+
+
+
    Changing the Load Balancer IP Address of an Instance (a V3 API)
    
+
    Function
    This API is used to change the load balancer IP address of an instance.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/elb/ip
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    new_ip
    
+
    Yes
    
+
    String
    
+
    New ELB load balancer IP address.
    
+
    It is one of the available and unassigned IP addresses in the CIDR block.
    
+
    group_id
    
+
    No
    
+
    String
    
+
    Instance group ID. If there is only one instance group, this parameter can be left empty.
    
+
    It can be obtained from Obtaining the Instance Group Information (a V3 API).
    
+
    
+
    
+
    Example Request
    Changing an ELB load balancer IP address
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/elb/ip
+{
+  "new_ip": "172.16.192.208",
+  "group_id": "ee8f0a088ec3408880ef1971a96431ecgr09"
+}
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181623854.html b/docs/ddm/api-ref/en-us_topic_0000002181623854.html
new file mode 100644
index 000000000..eaec6c6ee
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181623854.html
@@ -0,0 +1,149 @@
+
+
+
    Modifying Parameters of an Instance (a V3.1 API)
    
+
    Function
    This API is used to modify parameters of a DDM instance.
    
+
    
+
    Constraints
    The values of the modified parameters must be within the value range defined on the DDM console. For details about the range of parameter values, see "Parameter Template Management" > "Instance Parameters" in Distributed Database Middleware User Guide. You can also call the API in Obtaining Parameters in a Specified Parameter Template (a V3 API) to query the value range of a parameter.
    
+
    
+
    URI
    PUT /v3.1/{project_id}/instances/{instance_id}/configurations
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 URI parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    values
    
+
    Yes
    
+
    Map<String,String>
    
+
    Parameter values defined by users based on a default parameter template.
    
+
    • key: parameter name. If a parameter name is left empty, its value is not to be changed.
    • value: indicates the parameter value.
    
+
    
+
    
+
    
+
    Example Request
    Changing the value of long_query_time to 2. The value indicates that the query is considered as a slow query if its execution duration is greater than or equal to 2 seconds.
    
+
    PUT https://ddm.eu-de.otc.t-systems.com/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/configurations
+
+{
+  "values" : {
+    "long_query_time" : "2"
+  }
+}
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      need_restart
      
+
      Boolean
      
+
      Whether the instance needs to be restarted
      
+
      
+
      
+
    
+
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181783542.html b/docs/ddm/api-ref/en-us_topic_0000002181783542.html
new file mode 100644
index 000000000..8160f7a4c
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181783542.html
@@ -0,0 +1,118 @@
+
+
+
    Deleting an Instance Group (a V3 API)
    
+
    Function
    This API is used to delete a DDM instance group.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    DELETE /v3/{project_id}/instances/{instance_id}/groups/{group_id}
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Parameter description
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    group_id
    
+
    Yes
    
+
    String
    
+
    Group ID. It can be obtained from Obtaining the Instance Group Information (a V3 API).
    
+
    
+
    
+
    
+
    
+
    Request
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameter
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Deleting a DDM instance group
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/groups/b4153b807b1a4f83870bf868fcc4f4eagr09
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the job for deleting a group.
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id": "3ae783f3-844e-4051-abd5-b9cc65899785"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181783546.html b/docs/ddm/api-ref/en-us_topic_0000002181783546.html
new file mode 100644
index 000000000..372d24239
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181783546.html
@@ -0,0 +1,158 @@
+
+
+
    Binding an EIP (a V3 API)
    
+
    Function
    This API is used to bind an EIP.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/eip
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    public_ip
    
+
    Yes
    
+
    String
    
+
    EIP to be bound. The value must be in the standard IP address format.
    
+
    For details, see EIP > Assigning an EIP.
    
+
    public_ip_id
    
+
    Yes
    
+
    String
    
+
    EIP ID. The value must be in the standard UUID format.
    
+
    To create an EIP, follow the instructions in EIP > Assigning an EIP.
    
+
    If an EIP has been created, follow the instructions in EIP > Querying an EIP.
    
+
    
+
    
+
    
+
    Example Request
    Binding an EIP to an instance
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/eip
+{
+  "public_ip": "10.83.84.176",
+  "public_ip_id": "7c87996a-85f4-4029-a254-502999d4767a"
+}
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181783550.html b/docs/ddm/api-ref/en-us_topic_0000002181783550.html
new file mode 100644
index 000000000..840369b64
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181783550.html
@@ -0,0 +1,176 @@
+
+
+
    Querying Details About a DDM Instance Node (a V3 API)
    
+
    Function
    This API is used to query details about an instance node.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/nodes/{node_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region.
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    node_id
    
+
    Yes
    
+
    String
    
+
    Node ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
    
+
    Example Request
    Querying details about an instance node
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes/4a2b97b7f5e3462c9c78aae93b46ed83no09
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      status
      
+
      String
      
+
      Node status. For details, see DDM Node Statuses.
      
+
      name
      
+
      String
      
+
      Node name
      
+
      id
      
+
      String
      
+
      Node ID
      
+
      private_ip
      
+
      String
      
+
      Private IP address of the node
      
+
      group_id
      
+
      String
      
+
      Group ID
      
+
      az_code
      
+
      String
      
+
      AZ
      
+
      subnet_id
      
+
      String
      
+
      Subnet ID.
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "id": "8d5601f17b30****da1e69181173cdno09",
+  "private_ip": "172.16.203.68",
+  "status": "normal",
+  "name": "ddm-ag****de2_node_01",
+  "subnet_id": "d27cdc75***b6-b2ab-fec93af33538",
+  "az_code": "eu-de-01",
+  "group_id": "148a54****41ba6ed231487e73ccgr09"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002181783554.html b/docs/ddm/api-ref/en-us_topic_0000002181783554.html
new file mode 100644
index 000000000..d6cd3d208
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002181783554.html
@@ -0,0 +1,268 @@
+
+
+
    Querying Backups (a V3 API)
    
+
    Function
    This API is used to query backups.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/backups
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are obtained by default.
    
+
    
+
    
+
    Example Request
    This API is used to query backups.
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups?offset=0&limit=10
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    backups
    
+
    Array of BackupInfo objects
    
+
    Backup list.
    
+
    offset
    
+
    Integer
    
+
    Which page the server starts returning items
    
+
    limit
    
+
    Integer
    
+
    Number of records displayed on each page
    
+
    total
    
+
    Integer
    
+
    Total number of backup records
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 BackupInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    id
    
+
    String
    
+
    Backup ID
    
+
    name
    
+
    String
    
+
    Parameter template name
    
+
    description
    
+
    String
    
+
    Parameter template description
    
+
    status
    
+
    String
    
+
    Backup status. It can be obtained from Backup Statuses.
    
+
    instance_id
    
+
    String
    
+
    Instance ID
    
+
    instance_name
    
+
    String
    
+
    Instance name
    
+
    instance_status
    
+
    String
    
+
    Instance status. It can be obtained from DDM Instance Statuses.
    
+
    file_size
    
+
    Number
    
+
    Backup size, in KB
    
+
    created
    
+
    String
    
+
    Creation time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    updated
    
+
    String
    
+
    Update time. The format is yyyy-MM-ddTHH:mm:ssZ.
    
+
    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
    
+
    backup_type
    
+
    String
    
+
    Backup type:
    
+
    auto_metadata: Metadata backup is triggered by a scheduled task every day.
    
+
    metadata: Metadata backup is not triggered by a scheduled task. For example, metadata is backed up before instance deletion.
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "backups": [
+    {
+      "id": "c131f9339****5cdebe350228br09",
+      "name": "Backup",
+      "description": "auto metadata backup",
+      "status": "normal",
+      "instance_id": "169f4f2fd6****04385a18ain09",
+      "instance_name": "ddm-test",
+      "instance_status": "normal",
+      "file_size": 5.419922,
+      "created": "2025-02-19T02:50:20+0000",
+      "updated": "2025-02-19T02:50:37+0000",
+      "backup_type": "auto_metadata"
+    }
+  ],
+  "total": 1,
+  "offset": 0,
+  "limit": 10
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217069689.html b/docs/ddm/api-ref/en-us_topic_0000002217069689.html
new file mode 100644
index 000000000..cff31f279
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217069689.html
@@ -0,0 +1,145 @@
+
+
+
    Changing an Instance Port (a V3 API)
    
+
    Function
    This API is used to change an instance port.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/port
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    port
    
+
    Yes
    
+
    Integer
    
+
    Port number
    
+
    
+
    
+
    
+
    Example Request
    Changing an instance port to 5067
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/port
+{
+  "port" : 5067
+}
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217069693.html b/docs/ddm/api-ref/en-us_topic_0000002217069693.html
new file mode 100644
index 000000000..9168d9451
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217069693.html
@@ -0,0 +1,119 @@
+
+
+
    Unbinding an EIP (a V3 API)
    
+
    Function
    This API is used to unbind an EIP from an instance.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    DELETE /v3/{project_id}/instances/{instance_id}/eip
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
    
+
    Example Request
    Unbinding an EIP from an instance
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/eip
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217069697.html b/docs/ddm/api-ref/en-us_topic_0000002217069697.html
new file mode 100644
index 000000000..0bbae9600
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217069697.html
@@ -0,0 +1,300 @@
+
+
+
    Querying Details About a Schema (a V3 API)
    
+
    Function
    This API is used to query details about a schema.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/databases/{database_name}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    database_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying details about a schema
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      shards
      
+
      Array of Shard objects
      
+
      Shard information
      
+
      status
      
+
      String
      
+
      Status of a schema. For details, see DDM Schema Statuses.
      
+
      created
      
+
      String
      
+
      Creation time. The format is yyyy-MM-ddTHH:mm:ssZ.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      updated
      
+
      String
      
+
      Update time. The format is yyyy-MM-ddTHH:mm:ssZ.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      name
      
+
      String
      
+
      Schema name
      
+
      shard_mode
      
+
      String
      
+
      Sharding mode of the schema, which can be:
      
+
      • cluster: indicates that the schema is in sharded mode.
      • single: indicates that the schema is in unsharded mode.
      
+
      shard_number
      
+
      String
      
+
      Number of shards in the same working mode
      
+
      data_nodes
      
+
      Array of DataNode objects
      
+
      Associated data nodes
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Shard
      Parameter
      
+
      Type
      
+
      Description
      
+
      data_node_id
      
+
      String
      
+
      ID of the data node instance where the shard is held
      
+
      physical_db_name
      
+
      String
      
+
      Shard name
      
+
      status
      
+
      String
      
+
      Status of a shard. For details, see DDM Schema Statuses.
      
+
      shard_index
      
+
      Integer
      
+
      Shard index
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 DataNode
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Instance ID of a data node
      
+
      status
      
+
      String
      
+
      Instance status of a data node. It can be obtained from Data Node Statuses.
      
+
      name
      
+
      String
      
+
      Instance name of a data node
      
+
      engine_name
      
+
      String
      
+
      Instance engine name of a data node
      
+
      engine_version
      
+
      String
      
+
      Engine version of a data node
      
+
      mem
      
+
      Integer
      
+
      Memory of a data node
      
+
      cpu
      
+
      Integer
      
+
      Number of vCPUs of a data node
      
+
      
+
      
+
    • Normal response example
      {
+  "shards": [
+    {
+      "data_node_id": "253883d46****d3fb38161b57in01",
+      "physical_db_name": "ddm_db_test_0000",
+      "status": "RUNNING",
+      "shard_index": 0
+    },
+    {
+      "data_node_id": "253883d4*****9960d3fb38161b57in01",
+      "physical_db_name": "ddm_db_test_0001",
+      "status": "RUNNING",
+      "shard_index": 1
+    }
+  ],
+  "status": "RUNNING",
+  "created": "2025-02-10T07:18:26+0000",
+  "updated": "2025-02-10T07:18:26+0000",
+  "name": "ddm_db_test",
+  "shard_mode": "cluster",
+  "shard_number": 2,
+  "data_nodes": [
+    {
+      "id": "253883****089960d3fb38161b57in01",
+      "status": "normal",
+      "name": "mysql*****YwVuVoio6g8AnF5oUH5i",
+      "engine_name": "mysql",
+      "engine_version": "5.7",
+      "mem": 4,
+      "cpu": 2
+    }
+  ]
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217069701.html b/docs/ddm/api-ref/en-us_topic_0000002217069701.html
new file mode 100644
index 000000000..4f7b6ea80
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217069701.html
@@ -0,0 +1,111 @@
+
+
+
    Deleting a Backup (a V3 API)
    
+
    Function
    This API is used to delete a specified backup.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    DELETE /v3/{project_id}/backups/{backup_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    backup_id
    
+
    Yes
    
+
    String
    
+
    Backup ID, which can be obtained from Querying Backups (a V3 API).
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Deleting a specified backup
    
+
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/c131f9339****5cdebe350228br09
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217144121.html b/docs/ddm/api-ref/en-us_topic_0000002217144121.html
new file mode 100644
index 000000000..d35d50d77
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217144121.html
@@ -0,0 +1,118 @@
+
+
+
    Restarting a DDM Node (a V3 API)
    
+
    Function
    This API is used to restart a specific node.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/restart
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 URI parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    node_id
    
+
    Yes
    
+
    String
    
+
    DDM instance node ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameter
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Restarting a node
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes/4a2b97b7f5e3462c9c78aae93b46ed83no09/restart
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Job ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002217144129.html b/docs/ddm/api-ref/en-us_topic_0000002217144129.html
new file mode 100644
index 000000000..4a52f5bb3
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002217144129.html
@@ -0,0 +1,31 @@
+
+
+
    Backup Management
    
+
    
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002283971858.html b/docs/ddm/api-ref/en-us_topic_0000002283971858.html
new file mode 100644
index 000000000..aa5b6523d
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002283971858.html
@@ -0,0 +1,33 @@
+
+
+
+  
    Instance Management
    
+
+  
    
+
    
+
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790184.html b/docs/ddm/api-ref/en-us_topic_0000002298790184.html
new file mode 100644
index 000000000..81b1dbfee
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790184.html
@@ -0,0 +1,246 @@
+
+
+
    Querying Data Nodes Available for Creating a Schema (a V3 API)
    
+
    Function
    This API is used to query data nodes that can be used for creating a schema.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/available-data-nodes
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying data nodes that can be used for creating a schema
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/available-data-nodes?offset=0&limit=10
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      data_nodes
      
+
      Array of AvailableDnInstance objects
      
+
      Instance list
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 AvailableDnInstance
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Instance ID
      
+
      name
      
+
      String
      
+
      Instance name
      
+
      status
      
+
      String
      
+
      Instance status. It can be obtained from Data Node Statuses.
      
+
      engine_name
      
+
      String
      
+
      Engine name
      
+
      engine_version
      
+
      String
      
+
      Engine version
      
+
      private_ip
      
+
      String
      
+
      Private IP address of an instance
      
+
      port
      
+
      Integer
      
+
      Instance port
      
+
      time_zone
      
+
      String
      
+
      Time zone of an instance
      
+
      
+
      
+
    • Normal response example
      {
+  "data_nodes": [
+    {
+      "id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "status": "normal",
+      "name": "UTS-rds-dtc-src",
+      "engine_name": "mysql",
+      "engine_version": "8.0",
+      "private_ip": "172.16.223.151",
+      "port": 3306,
+      "time_zone": "UTC+08:00"
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total": 1
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790192.html b/docs/ddm/api-ref/en-us_topic_0000002298790192.html
new file mode 100644
index 000000000..ce093b736
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790192.html
@@ -0,0 +1,242 @@
+
+
+
    Performing Shard Configuration (a V3 API)
    
+
    Function
    This API is used to add data nodes or shards to enhance data storage and provide better support for concurrency.
    
+
    
+
    Constraints
    The shard configuration task can only be performed after all pre-check items are passed. You can query the task status by calling the API for querying the task list.
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    data_nodes
    
+
    Yes
    
+
    Array of MigrateLogicDbOpenRequest objects
    
+
    Data nodes used for shard configuration.
    
+
    The number of shards or data nodes after the configuration must be greater than that before the configuration.
    
+
    new_shard_number
    
+
    Yes
    
+
    String
    
+
    Number of shards after the shard configuration.
    
+
    The number of shards or data nodes after the configuration must be greater than that before the configuration. A single instance supports a maximum of 64 shards.
    
+
    switch_route_begin_time
    
+
    No
    
+
    String
    
+
    Time when the automatic route switching starts (in the hh:mm:ss format, for example, 17:00:00). The start time must be earlier than the end time, and the interval cannot be less than 60 minutes. Switching routes during off-peak hours is recommended.
    
+
    switch_route_end_time
    
+
    No
    
+
    String
    
+
    Time when the automatic route switching ends (in the hh:mm:ss format, for example, 18:00:00). The end time must be later than the start time, and the interval cannot be less than 60 minutes. Switching routes during off-peak hours is recommended.
    
+
    is_exclusive
    
+
    No
    
+
    Boolean
    
+
    Whether shard configuration exclusively occupies a node. The default value is false. The value can be:
    
+
    • true: It exclusively occupies a node.
    • false: It does not exclusively occupy a node.
    
+
    • If this parameter is set to true, the execution node will be dedicated to configuring shards, so shard configuration is faster. If you are worried about not having enough nodes to handle your services, add more nodes before configuring shards.
    • If this parameter is set to true, you need to enable load balancing for the default group and ensure that the number of nodes exceeds one.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 MigrateLogicDbOpenRequest
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    id
    
+
    Yes
    
+
    String
    
+
    Data node ID
    
+
    user
    
+
    Yes
    
+
    String
    
+
    Database user
    
+
    • Required permissions: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER WITH GRANT OPTION
    
+
    password
    
+
    Yes
    
+
    String
    
+
    Database password
    
+
    
+
    
+
    
+
    Example Request
    Configuring shards
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration
+
+{
+  "new_shard_number": 9,
+  "data_nodes": [
+    {
+      "id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "user": "root",
+      "password": "Ga***123"
+    }
+  ]
+}
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the shard configuration task
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790204.html b/docs/ddm/api-ref/en-us_topic_0000002298790204.html
new file mode 100644
index 000000000..8ad2068a8
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790204.html
@@ -0,0 +1,125 @@
+
+
+
    Clearing Shard Configuration Data (a V3 API)
    
+
    Function
    This API is used to clear shard configuration data.
    
+
    
+
    Constraints
    Only data of shard configuration tasks in the ToBeCleaned state can be cleared.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/clean
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Clearing shard configuration data
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/clean
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the task for clearing shard configuration data
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790216.html b/docs/ddm/api-ref/en-us_topic_0000002298790216.html
new file mode 100644
index 000000000..47bb59351
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790216.html
@@ -0,0 +1,153 @@
+
+
+
    Creating a Parameter Group (a V3 API)
    
+
    Function
    This API is used to create a parameter group.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/configurations
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    name
    
+
    Yes
    
+
    String
    
+
    Parameter group name
    
+
    description
    
+
    Yes
    
+
    String
    
+
    Parameter group description
    
+
    If the description contains more than 256 characters, the parameter group can still be created. The first 256 characters will be automatically used.
    
+
    
+
    
+
    
+
    Example Request
    Creating a parameter group
    POST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/configurations
+{
+  "name": "param1688972688",
+  "description": "test"
+}
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Parameter group ID
      
+
      name
      
+
      String
      
+
      Parameter group name
      
+
      
+
      
+
    • Normal response example
      {
+  "id": "404f3bbb8a724f7697e7fb15a1b09370pr09",
+  "name": "param1688972688"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790224.html b/docs/ddm/api-ref/en-us_topic_0000002298790224.html
new file mode 100644
index 000000000..d97b59427
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790224.html
@@ -0,0 +1,197 @@
+
+
+
    Querying the Restoration Time Range (a V3 API)
    
+
    Function
    This API is used to query the restoration time range of an instance.
    
+
    The intersection between the restoration time range of an instance and those of all data nodes associated with the instance is used.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-interval
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying the restoration time range
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/restorable-time-interval
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      restorable_time_intervals
      
+
      Array of RestoreTimeInterval objects
      
+
      Time ranges
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 RestoreTimeInterval
      Parameter
      
+
      Type
      
+
      Description
      
+
      start_time
      
+
      String
      
+
      Start time in UTC, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      end_time
      
+
      String
      
+
      End time in UTC, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      
+
      
+
    • Normal response example
      {
+	"restorable_time_intervals": [{
+		"start_time": "2025-05-20T09:40:40+0000",
+		"end_time": "2025-05-21T11:15:43+0000"
+	}],
+	"offset": 0,
+	"limit": 10,
+	"total": 1
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790232.html b/docs/ddm/api-ref/en-us_topic_0000002298790232.html
new file mode 100644
index 000000000..eb2e8accd
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790232.html
@@ -0,0 +1,261 @@
+
+
+
    Restoring Data to a New Instance (a V3 API)
    
+
    Function
    This API is used to restore data to a new instance.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/backups/recovery
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    source
    
+
    Yes
    
+
    RestoreInstSource
    
+
    Source instance information.
    
+
    target
    
+
    Yes
    
+
    RestoreInstTarget
    
+
    Target instance information.
    
+
    data_node_relations
    
+
    Yes
    
+
    Array of DataNodeRelation objects
    
+
    Association between the source and target data nodes
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 RestoreInstSource
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Source instance ID.
    
+
    restore_time
    
+
    Yes
    
+
    Long
    
+
    Restoration timestamp, in milliseconds.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 RestoreInstTarget
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Target instance ID. It can be obtained from Querying Instances Available for Restoration (a V3 API).
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 6 DataNodeRelation
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    source_instance_id
    
+
    Yes
    
+
    String
    
+
    Source data node ID. It can be obtained from Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API).
    
+
    target_instance_id
    
+
    Yes
    
+
    String
    
+
    Target data node ID. It can be obtained from Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API).
    
+
    
+
    
+
    
+
    Example Request
    Restoring data to a new instance
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/recovery
+
+{
+  "source": {
+    "instance_id": "733c7e8d73a54c27b8308ec784a8be8cin09",
+    "restore_time": 1747732352076
+  },
+  "target": {
+    "instance_id": "2f0324a93859487eb5566d75951fcd2din09"
+  },
+  "data_node_relations": [
+    {
+      "source_instance_id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "target_instance_id": "f4e2949e9b9b4d60b42c89ed39bfe34cin01"
+    }
+  ]
+}
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 7 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Task ID
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id": "09902ee7866649b8908ec209bfee2747"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298790240.html b/docs/ddm/api-ref/en-us_topic_0000002298790240.html
new file mode 100644
index 000000000..3de7f3241
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298790240.html
@@ -0,0 +1,172 @@
+
+
+
    Adding Tags for an Instance (a V3 API)
    
+
    Function
    This API is used to add tags for an instance.
    
+
    
+
    Constraints
    A maximum of 20 tags can be added for an instance. The tag key must be unique.
    
+
    If the request body contains duplicated keys, an error message will be reported when the API is called.
    
+
    If the key in the request body is the same as an existing key in a specified instance, the value of the value parameter that corresponds to the existing key is overwritten.
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/tags/create
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    tags
    
+
    Yes
    
+
    Array of ResourceTag objects
    
+
    Tag list
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 ResourceTag
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    key
    
+
    Yes
    
+
    String
    
+
    Tag key
    
+
    This parameter is mandatory and cannot be left empty. The key:
    
+
    • Must be unique for each instance.
    • Can contain 1 to 36 characters.
    • Cannot be an empty string or start with _sys_, and cannot start or end with a space.
    • Cannot contain:
      Non-printable ASCII characters (0-31), "*", "<", ">", "\", ",", "|", "/"
      
+
    
+
    value
    
+
    Yes
    
+
    String
    
+
    Tag value
    
+
    This parameter is mandatory. The value:
    • Is an empty string by default if it is not set.
    • Can contain 0 to 43 characters.
    • Cannot contain the following characters:
      Non-printable ASCII characters (0-31), "*", "<", ">", "\", ",", "|"
      
+
    
+
    
+
    
+
    
+
    
+
    Example Request
    Adding tags for an instance
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/tags/create
+
+{
+  "tags": [
+    {
+      "key": "key",
+      "value": "value"
+    }
+  ]
+}
    
+
    
+
    Response
    • Normal response
    
+
    None
    
+
    • Normal response example
    
+
    None
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Tag Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949840.html b/docs/ddm/api-ref/en-us_topic_0000002298949840.html
new file mode 100644
index 000000000..54f15ef64
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949840.html
@@ -0,0 +1,313 @@
+
+
+
    Querying Information About Tasks (a V3 API)
    
+
    Function
    This API is used to query information about tasks.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/jobs
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128.
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    start_time
    
+
    Yes
    
+
    Long
    
+
    Query start time in timestamp format, in milliseconds. It cannot be earlier than 30 days prior to the current time.
    
+
    end_time
    
+
    Yes
    
+
    Long
    
+
    Query end time in timestamp format, in milliseconds.
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying information about tasks
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/jobs?start_time=1746028800000&end_time=1747319097182
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      jobs
      
+
      Array of JobItem objects
      
+
      Task list.
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 JobItem
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Instance ID
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      id
      
+
      String
      
+
      Task ID
      
+
      name
      
+
      String
      
+
      Task name
      
+
      status
      
+
      String
      
+
      Task execution status. The value can be:
      
+
      • Running: The task is being executed.
      • Completed: The task is successfully executed.
      • Failed: The task failed to be executed.
      • Expanding: A shard is being configured.
      • Canceling: Shard configuration is being canceled.
      • Rollbacking: Shard configuration is being rolled back.
      • RollbackSuccess: Shard configuration is rolled back successfully.
      • CancelSuccess: Shard configuration is canceled successfully.
      • ToBeSwitched: The route is to be switched during shard configuration.
      • Switching: The route is being switched during shard configuration.
      
+
      created_time
      
+
      String
      
+
      Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      end_time
      
+
      String
      
+
      End time. The format is yyyy-mm-ddThh:mm:ssZ.
      
+
      T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      process
      
+
      String
      
+
      Task execution progress
      
+
      The execution progress (such as "60%", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
      
+
      fail_reason
      
+
      String
      
+
      Task failure cause
      
+
      database_name
      
+
      String
      
+
      Name of the schema for which shard configuration is performed.
      
+
      operations
      
+
      Array of strings
      
+
      Operations that can be performed on a shard configuration task. The options are as follows:
      
+
      • modifySwitchingStrategy: The route switching policy can be modified.
      • toBeCanceled: The task is to be canceled.
      • toBeRetried: The task can be retried.
      • toBeRolled: The task can be rolled back.
      • toBeSwitched: The route is to be switched.
      • toBeCleaned: The task is to be deleted.
      
+
      
+
      
+
    • Normal response example
      {
+  "jobs": [
+    {
+      "id": "92370d30-3ddc-4e05-b8ab-51662d824318",
+      "name": "migrateLogicDb",
+      "status": "ToBeSwitched",
+      "created_time": "2025-05-20T15:05:13+0000",
+      "end_time": "2025-05-20T15:05:13+0000",
+      "process": "",
+      "instance_name": "UTS-ddm-dtc-src",
+      "instance_id": "733c7e8d73a54c27b8308ec784a8be8cin09",
+      "operations": [
+        "modifySwitchingStrategy",
+        "toBeCanceled"
+      ],
+      "database_name": "db_e487",
+      "fail_reason": ""
+    },
+    {
+      "id": "10501cd3-0c19-498b-9ba4-8935ed447542",
+      "name": "migrateLogicDb",
+      "status": "Completed",
+      "created_time": "2025-05-20T14:48:09+0000",
+      "end_time": "2025-05-20T15:03:45+0000",
+      "process": "",
+      "instance_name": "UTS-ddm-dtc-src",
+      "instance_id": "733c7e8d73a54c27b8308ec784a8be8cin09",
+      "operations": [],
+      "database_name": "db_e487",
+      "fail_reason": ""
+    },
+    {
+      "id": "57933931-9323-422d-8f3d-20a62eb00c4e",
+      "name": "CreateInstance",
+      "status": "Completed",
+      "created_time": "2025-05-20T07:51:47+0000",
+      "end_time": "2025-05-20T07:56:54+0000",
+      "process": "",
+      "instance_name": "UTS-ddm-dtc-src",
+      "instance_id": "733c7e8d73a54c27b8308ec784a8be8cin09",
+      "operations": [],
+      "database_name": "",
+      "fail_reason": ""
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total": 3
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949848.html b/docs/ddm/api-ref/en-us_topic_0000002298949848.html
new file mode 100644
index 000000000..5c64941c6
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949848.html
@@ -0,0 +1,209 @@
+
+
+
    Querying the Asynchronous Pre-check Result of Shard Configuration (a V3 API)
    
+
    Function
    This API is used to query the pre-check result of a shard configuration task that takes some time to execute. For details about pre-check items, see the user guide.
    
+
    The asynchronous pre-check items are as follows:
    
+
    • Broadcast table consistency
    • Character set and collation of source shards
    • SQL statements for creating physical stables.
    • Primary keys
    • Access to DB instances
    • DB instance parameters
    • DB instance storage space
    • DB instance time zone
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/precheck/{job_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    Pre-verification task ID, which can be obtained from Pre-checking Shard Configuration (a V3 API).
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying the asynchronous pre-check result of shard configuration
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/733c7e8d73a54c27b8308ec784a8be8cin09/databases/db_3c46/migration/precheck/daab28f6-efd8-4c5b-bccb-85b4162373c4
    
+
    
+
    
+
    Response
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    job_id
    
+
    String
    
+
    Pre-verification task ID
    
+
    pre_check_results
    
+
    Array of PreCheckResult objects
    
+
    Pre-verification results
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 PreCheckResult
    Parameter
    
+
    Type
    
+
    Description
    
+
    name
    
+
    String
    
+
    Check item
    
+
    status
    
+
    String
    
+
    Check result, which can be:
    
+
    SUCCESS: successful
    
+
    FAILED: failed
    
+
    WARN: Warning
    
+
    note
    
+
    String
    
+
    Prompt information
    
+
    handling_suggestion
    
+
    String
    
+
    Modification suggestions
    
+
    error_message
    
+
    String
    
+
    Error message
    
+
    error_detail_message
    
+
    String
    
+
    Error details
    
+
    
+
    
+
    • Normal response example
      {
+  "job_id": "65c77858-e6a2-4694-8810-ab0b501b0003",
+  "pre_check_results": [
+    {
+      "name": "Expire time of binlog in associated DN instances",
+      "status": "SUCCESS",
+      "note": "",
+      "handling_suggestion": "Configuring shards require expiration of binlog more than 7 days(604800 seconds), please change binlog_expire_logs_seconds",
+      "error_message": "",
+      "error_detail_message": ""
+    },
+    {
+      "name": "Tables with overwhelming table partitions",
+      "status": "SUCCESS",
+      "note": "",
+      "handling_suggestion": "Every single row from source table will be recalculated and routed to all new partition table when shard number is changed. Because your partition table number will be overwhelming after configuring shard, shard configuring will take too long to finish. Please contact customer service.",
+      "error_message": "",
+      "error_detail_message": ""
+    }
+  ]
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949856.html b/docs/ddm/api-ref/en-us_topic_0000002298949856.html
new file mode 100644
index 000000000..7a7bd2851
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949856.html
@@ -0,0 +1,125 @@
+
+
+
    Rolling Back Shard Configuration (a V3 API)
    
+
    Function
    This API is used to roll back shard configuration.
    
+
    
+
    Constraints
    Only tasks in the Failed state can be rolled back.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/rollback
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Rolling back shard configuration
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/rollback
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the task for rolling back shard configuration
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949868.html b/docs/ddm/api-ref/en-us_topic_0000002298949868.html
new file mode 100644
index 000000000..c886cce8a
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949868.html
@@ -0,0 +1,105 @@
+
+
+
    Switching Routes (a V3 API)
    
+
    Function
    This API is used to switch read and write requests to a new instance. During the switching process, one or two intermittent disconnections may occur but do not affect services. You are advised to switch routes during off-peak hours.
    
+
    
+
    Constraints
    You can only switch routes when a shard configuration task is in the ToBeSwitched state.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/route-switch
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Configuring route switching
    PUT https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/733c7e8d73a54c27b8308ec784a8be8cin09/databases/db_e487/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/route-switch
    
+
    
+
    
+
    Response
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949876.html b/docs/ddm/api-ref/en-us_topic_0000002298949876.html
new file mode 100644
index 000000000..f67ded187
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949876.html
@@ -0,0 +1,245 @@
+
+
+
    Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API)
    
+
    Function
    This API is used to query data nodes associated with an instance at a restoration time point.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/backups/related-dn
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    restore_time
    
+
    Yes
    
+
    Long
    
+
    Restoration timestamp, in milliseconds.
    
+
    
+
    
+
    
+
    Example Request
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/related-dn?restore_time=1747728424956
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      related_data_nodes
      
+
      Array of RelatedDn objects
      
+
      Associated data nodes
      
+
      latest_restorable_time
      
+
      String
      
+
      Latest point in time (in UTC) data can be restored to, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 RelatedDn
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Instance ID
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      instance_status
      
+
      String
      
+
      Instance status. It can be obtained from DDM Instance Statuses.
      
+
      engine_name
      
+
      String
      
+
      Instance engine
      
+
      data_volume_size
      
+
      String
      
+
      Instance disk size, in bytes
      
+
      version
      
+
      String
      
+
      Instance version
      
+
      
+
      
+
    • Normal response example
      {
+	"related_data_nodes": [{
+		"instance_name": "UTS-dtc-mysql_80_4u8g_single_2",
+		"instance_id": "41c239a1e9bd4cd2aabd678bab45a886in01",
+		"instance_status": "abnormal",
+		"data_volume_size": 40000000000,
+		"version": "8.0.32",
+		"engine_name": "mysql"
+	}],
+	"latest_restorable_time": "2025-05-27T02:38:15+0000",
+	"offset": 0,
+	"limit": 100,
+	"total": 1
+}
+
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949884.html b/docs/ddm/api-ref/en-us_topic_0000002298949884.html
new file mode 100644
index 000000000..7bd79bfd5
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949884.html
@@ -0,0 +1,231 @@
+
+
+
    Restoring Metadata (a V3 API)
    
+
    Function
    This API is used to restore metadata.
    
+
    
+
    Constraints
    Metadata restoration mainly restores the metadata of your DDM instance to a new DDM instance. It starts after a point-in-time recovery (PITR) for the associated data nodes is complete.
     
    PITR indicates that a data node has been restored to a specified point in time.
    
+
    For details about how to perform PITR on RDS for MySQL, see section "Data Restorations" > "Restoring Data to RDS for MySQL" > "PITR: Restoring a DB Instance to a Point in Time" in Working with RDS for MySQL.
    
+
    You can also refer to section "Backup and Restoration" in RDS for MySQL API Reference.
    
+
    
+
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/backups/metadata-recovery
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    source
    
+
    Yes
    
+
    RestoreMetaDataSource
    
+
    Source instance information
    
+
    target
    
+
    Yes
    
+
    RestoreMetaDataTarget
    
+
    Target instance information
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 RestoreMetaDataSource
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    restore_time
    
+
    No
    
+
    Long
    
+
    Restoration timestamp, accurate to milliseconds. (Either backup_id or restore_time needs to be specified.)
    
+
    backup_id
    
+
    No
    
+
    String
    
+
    Backup ID. (Either restore_time or backup_id needs to be specified.)
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 RestoreMetaDataTarget
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    data_nodes
    
+
    Yes
    
+
    Array of strings
    
+
    Target data nodes.
    
+
    The data nodes are in the same VPC and subnet as the DDM instance and can communicate with the DDM instance.
    
+
    PITR has been completed on the data nodes. For details, see Constraints.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Target instance ID. It can be obtained from Querying Instances Available for Restoration (a V3 API).
    
+
    
+
    
+
    
+
    Example Request
    Restoring metadata
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/metadata-recovery
+
+{
+  "source": {
+    "backup_id": "defa45b24d314e878fde930a61732e9dbr09"
+  },
+  "target": {
+    "instance_id": "2f0324a93859487eb5566d75951fcd2din09",
+    "data_nodes": [
+      "f4e2949e9b9b4d60b42c89ed39bfe34cin01"
+    ]
+  }
+}
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 6 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Task ID
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id": "09902ee7866649b8908ec209bfee2747"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002298949892.html b/docs/ddm/api-ref/en-us_topic_0000002298949892.html
new file mode 100644
index 000000000..b07ab3c3a
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002298949892.html
@@ -0,0 +1,141 @@
+
+
+
    Querying Instance Tags (a V3 API)
    
+
    Function
    This API is used to query instance tags.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/tags
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying instance tags
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/tags
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
    Table 3 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    tags
    
+
    Array of QueryInstanceTagInfo objects
    
+
    Tag list
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 QueryInstanceTagInfo
    Parameter
    
+
    Type
    
+
    Description
    
+
    key
    
+
    String
    
+
    Tag key
    
+
    value
    
+
    String
    
+
    Tag value
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "tags": [
+    {
+      "key": "test",
+      "value": "1"
+    }
+  ]
+}
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Tag Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002299876902.html b/docs/ddm/api-ref/en-us_topic_0000002299876902.html
new file mode 100644
index 000000000..603510294
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002299876902.html
@@ -0,0 +1,145 @@
+
+
+
    Deleting Multiple Nodes from an Instance at a Time (a V3 API)
    
+
    Function
    This API is used to delete multiple nodes from an instance at a time.
    
+
    
+
    Constraints
    Nodes in different groups cannot be deleted at the same time.
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/nodes/batch-delete
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
    
+
    Request
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    node_ids
    
+
    Yes
    
+
    Array of strings
    
+
    ID list of nodes to be deleted. Only nodes in the same group can be selected. After a specified node is deleted from a group, there must be at least one node in the group.
    
+
    
+
    
+
    
+
    Example Request
    Deleting nodes
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/nodes/batch-delete
+{
+  "node_ids": ["116ba14da45678d28ecd83a38c218907no02"]
+}
    
+
    
+
    
+
    Response Parameters
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Task ID
      
+
      
+
      
+
    
+
    • Normal response example
      {
+  "job_id" : "9fe84a77-6a6b-4b03-9a3e-db910a548657"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002318291129.html b/docs/ddm/api-ref/en-us_topic_0000002318291129.html
new file mode 100644
index 000000000..f7ed4f6d1
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002318291129.html
@@ -0,0 +1,21 @@
+
+
+
+  
    APIs (Unavailable Soon)
    
+
+  
    
+
    
+
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002318531425.html b/docs/ddm/api-ref/en-us_topic_0000002318531425.html
new file mode 100644
index 000000000..8af5016d2
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002318531425.html
@@ -0,0 +1,23 @@
+
+
+
+  
    Schema Management
    
+
+  
    
+
    
+
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002318604513.html b/docs/ddm/api-ref/en-us_topic_0000002318604513.html
new file mode 100644
index 000000000..09c193250
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002318604513.html
@@ -0,0 +1,19 @@
+
+
+
+  
    Monitoring Management
    
+
+  
    
+
    
+
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869325.html b/docs/ddm/api-ref/en-us_topic_0000002332869325.html
new file mode 100644
index 000000000..3fbb0d23d
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869325.html
@@ -0,0 +1,87 @@
+
+
+
    Synchronizing Data Node Information (a V3 API)
    
+
    Function
    This API is used to synchronize data node information.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/data-nodes/sync
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Synchronizing data node information
    POST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/733c7e8d73a54c27b8308ec784a8be8cin09/data-nodes/sync
    
+
    
+
    
+
    Response
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869333.html b/docs/ddm/api-ref/en-us_topic_0000002332869333.html
new file mode 100644
index 000000000..262bdcf21
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869333.html
@@ -0,0 +1,295 @@
+
+
+
    Pre-checking Shard Configuration (a V3 API)
    
+
    Function
    This API is used to pre-check shard configuration to prevent shard configuration failures. For details about pre-check items, see the user guide.
    
+
    This API returns the following synchronous pre-check items:
    
+
    • Table name length
    • Binlog full backup time of data nodes
    • Binlog enabled on data nodes
    • Retention period of binlogs on data nodes
    • Maximum number of physical tables
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/precheck
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 URI parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    data_nodes
    
+
    Yes
    
+
    Array of MigratePrecheckOpenRequest objects
    
+
    Data node information after the configuration.
    
+
    The number of shards or data nodes after the configuration must be greater than that before the configuration.
    
+
    new_shard_number
    
+
    Yes
    
+
    String
    
+
    Number of shards after the configuration.
    
+
    The number of shards or data nodes after the configuration must be greater than that before the configuration. A single instance supports a maximum of 64 shards.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 MigratePrecheckOpenRequest
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    id
    
+
    Yes
    
+
    String
    
+
    Data node ID
    
+
    user
    
+
    Yes
    
+
    String
    
+
    Database user
    
+
    password
    
+
    Yes
    
+
    String
    
+
    Database password
    
+
    
+
    
+
    
+
    Example Request
    Pre-verifying shard configuration
    POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/precheck
+
+{
+  "new_shard_number": "9",
+  "data_nodes": [
+    {
+      "id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "user": "root",
+      "password": "Gau***b123"
+    }
+  ]
+}
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      Pre-verification task ID. To obtain the result of an asynchronous task, see Querying the Asynchronous Pre-check Result of Shard Configuration (a V3 API).
      
+
      pre_check_results
      
+
      Array of PreCheckMigrateSyncResult objects
      
+
      Pre-verification results
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 6 PreCheckMigrateSyncResult
      Parameter
      
+
      Type
      
+
      Description
      
+
      name
      
+
      String
      
+
      Check item
      
+
      status
      
+
      String
      
+
      Check result, which can be:
      
+
      • SUCCESS: successful
      • FAILED: failed
      • WARN: Warning
      
+
      note
      
+
      String
      
+
      Prompt information
      
+
      handling_suggestion
      
+
      String
      
+
      Modification suggestions
      
+
      error_message
      
+
      String
      
+
      Error message
      
+
      error_detail_message
      
+
      String
      
+
      Error details
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id": "65c77858-e6a2-4694-8810-ab0b501b0003",
+  "pre_check_results": [
+    {
+      "name": "Expire time of binlog in associated DN instances",
+      "status": "SUCCESS",
+      "note": "",
+      "handling_suggestion": "Configuring shards require expiration of binlog more than 7 days(604800 seconds), please change binlog_expire_logs_seconds",
+      "error_message": "",
+      "error_detail_message": ""
+    },
+    {
+      "name": "Tables with overwhelming table partitions",
+      "status": "SUCCESS",
+      "note": "",
+      "handling_suggestion": "Every single row from source table will be recalculated and routed to all new partition table when shard number is changed. Because your partition table number will be overwhelming after configuring shard, shard configuring will take too long to finish. Please contact customer service.",
+      "error_message": "",
+      "error_detail_message": ""
+    }
+  ]
+}
+
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869341.html b/docs/ddm/api-ref/en-us_topic_0000002332869341.html
new file mode 100644
index 000000000..209186ac0
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869341.html
@@ -0,0 +1,125 @@
+
+
+
    Canceling Shard Configuration (a V3 API)
    
+
    Function
    This API is used to cancel shard configuration.
    
+
    
+
    Constraints
    The shard configuration task to be canceled must be in the Running, Failed, or ToBeSwitched state.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/cancel
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Canceling shard configuration
    PUT https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/cancel
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the task for canceling shard configuration
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869349.html b/docs/ddm/api-ref/en-us_topic_0000002332869349.html
new file mode 100644
index 000000000..d8830f4ae
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869349.html
@@ -0,0 +1,157 @@
+
+
+
    Changing a Route Switching Policy (a V3 API)
    
+
    Function
    This API is used to change a route switching policy.
    
+
    
+
    Constraints
    Only the route switching policy of a shard configuration task in the ToBeSwitched state can be changed.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/route-switch-strategy
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    switch_route_begin_time
    
+
    No
    
+
    String
    
+
    Time when the automatic route switching starts (in the hh:mm:ss format, for example, 17:00:00)
    
+
    • If switch_route_begin_time and switch_route_end_time are not included in the request body, a manual route switching policy is used.
    • The interval between the start time and end time cannot exceed 1 hour.
    
+
    switch_route_end_time
    
+
    No
    
+
    String
    
+
    Time when the automatic route switching ends (in the hh:mm:ss format, for example, 18:00:00)
    
+
    • If switch_route_begin_time and switch_route_end_time are not included in the request body, a manual route switching policy is used.
    • The interval between the start time and end time cannot exceed 1 hour.
    
+
    
+
    
+
    
+
    Example Request
    Configuring an automatic route switching policy
    PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/route-switch-strategy
+
+{
+  "switch_route_begin_time": "17:00:00",
+  "switch_route_end_time": "18:00:00"
+}
    
+
    
+
    
+
    
+
    Configuring a manual route switching policy
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/route-switch-strategy
    
+
    
+
    Response
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869361.html b/docs/ddm/api-ref/en-us_topic_0000002332869361.html
new file mode 100644
index 000000000..b12279cad
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869361.html
@@ -0,0 +1,179 @@
+
+
+
    Querying Details About a Backup (a V3 API)
    
+
    Function
    This API is used to query details about a backup.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/backups/{backup_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    backup_id
    
+
    String
    
+
    Yes
    
+
    Backup ID, which can be obtained from Querying Backups (a V3 API).
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying details about a backup
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/backups/cfea30126a884f46887b4e9211460fc1br09
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Backup ID
      
+
      name
      
+
      String
      
+
      Backup name
      
+
      instance_id
      
+
      String
      
+
      Instance ID
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      related_data_nodes
      
+
      Array of RelatedDn objects
      
+
      Associated data nodes
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 RelatedDn
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Data node ID
      
+
      instance_name
      
+
      String
      
+
      Data node name
      
+
      
+
      
+
    • Normal response example
      {
+  "id": "09902ee7866649b8908ec209bfee2747br09",
+  "name": "Backup-ddm-diagnose3-2u8g-1-4bfGfxqdESTHbkKm5XrWLg-2025052005400",
+  "instance_id": "34970585d4964f2a8d6d9ea8d303398bin09",
+  "instance_name": "ddm-diagnose3-2u8g-1-4bfGfxqdESTHbkKm5XrWLg",
+  "related_data_nodes": [
+    {
+      "instance_id": "fc33739e5d2741529e21d87a7b5923fain01",
+      "instance_name": "mysql_rds_related_ddm_for_diagnose3_01"
+    }
+  ]
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869369.html b/docs/ddm/api-ref/en-us_topic_0000002332869369.html
new file mode 100644
index 000000000..80c3c78dd
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869369.html
@@ -0,0 +1,231 @@
+
+
+
    Querying Instances Available for Restoration (a V3 API)
    
+
    Function
    This API is used to query instances available for restoration.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/backups/restorable-instances
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying instances available for restoration
    GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/restorable-instances
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      instances
      
+
      Array of QueryDDM4RestoreResp objects
      
+
      Associated data node instances.
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 QueryDDM4RestoreResp
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Instance ID
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      status
      
+
      String
      
+
      Instance status. It can be obtained from DDM Instance Statuses.
      
+
      available
      
+
      Boolean
      
+
      Available or not
      
+
      unavailable_reason
      
+
      String
      
+
      Unavailability cause, which can be:
      
+
      • There is a common account for the target instance.
      • Another action is being performed on the target instance.
      • The target instance has been associated with another DN.
      • The instance has been frozen.
      
+
      vpc_name
      
+
      String
      
+
      Name of a VPC
      
+
      
+
      
+
    • Normal response example
      {
+  "instances": [
+    {
+      "instance_id": "3b65c609427c4b20bc0ae93e161dc7adin09",
+      "instance_name": "ddm-agent-create-instance1",
+      "status": "normal",
+      "available": true,
+      "unavailable_reason": "",
+      "vpc_name": "vpc-ddm-172"
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total": 1
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869377.html b/docs/ddm/api-ref/en-us_topic_0000002332869377.html
new file mode 100644
index 000000000..b7accb704
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869377.html
@@ -0,0 +1,201 @@
+
+
+
    Querying Project Tags (a V3 API)
    
+
    Function
    This API is used to query project tags.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/tags
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying project tags
    
+
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/tags?limit=10&offset=0
    
+
    
+
    Response
    • Normal response
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response body parameters
    Parameter
    
+
    Type
    
+
    Description
    
+
    tags
    
+
    Array of ProjectTag objects
    
+
    Tag list
    
+
    offset
    
+
    Integer
    
+
    Which page the server starts returning items
    
+
    limit
    
+
    Integer
    
+
    Number of records displayed on each page
    
+
    total_count
    
+
    Integer
    
+
    Total number of records
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 5 ProjectTag
    Parameter
    
+
    Type
    
+
    Description
    
+
    key
    
+
    String
    
+
    Tag key
    
+
    values
    
+
    Array of strings
    
+
    Tag values
    
+
    
+
    
+
    • Normal response example
    
+
    {
+  "tags": [
+    {
+      "key": "11",
+      "values": [
+        "11"
+      ]
+    },
+    {
+      "key": "12",
+      "values": [
+        "12"
+      ]
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total_count": 2
+}
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Tag Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332869385.html b/docs/ddm/api-ref/en-us_topic_0000002332869385.html
new file mode 100644
index 000000000..a08d072c4
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332869385.html
@@ -0,0 +1,138 @@
+
+
+
    Changing an Instance Tag (a V3 API)
    
+
    Function
    This API is used to change an instance tag.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/tags/{key}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Instance ID
    
+
    key
    
+
    Yes
    
+
    String
    
+
    Tag key
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    value
    
+
    Yes
    
+
    String
    
+
    Tag value. The value:
    • Is an empty string by default if it is not set.
    • Can contain 0 to 43 characters.
    • Cannot contain the following characters:
      Non-printable ASCII characters (0-31), "*", "<", ">", "\", ",", "|"
      
+
    
+
    
+
    
+
    
+
    
+
    Example Request
    Changing an instance tag
    
+
    PUT https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/tags/key
+
+{
+  "value": "value"
+}
    
+
    
+
    Response
    • Normal response
    
+
    None
    
+
    • Normal response example
    
+
    None
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Tag Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909529.html b/docs/ddm/api-ref/en-us_topic_0000002332909529.html
new file mode 100644
index 000000000..a7b44ed2b
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909529.html
@@ -0,0 +1,243 @@
+
+
+
    Creating a DDM Instance (a V3 API)
    
+
    Function
    This API is used to create a DDM instance.
    
+
    
+
    Constraints
    DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been configured.
    
+
    
+
    URI
    POST /v3/{project_id}/instances
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameter
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    name
    
+
    Yes
    
+
    String
    
+
    Name of a DDM instance, which:
    
+
    • Can include 4 to 64 characters.
    • Must start with a letter.
    • Can contain only letters, digits, underscores (_), and hyphens (-).
    
+
    Minimum length: 4 characters
    
+
    Maximum length: 64 characters
    
+
    flavor_ref
    
+
    Yes
    
+
    String
    
+
    Node class ID. It can be obtained by referring to Querying DDM Node Classes Available in Each AZ (a V3 API).
    
+
    node_num
    
+
    Yes
    
+
    Integer
    
+
    Number of nodes
    
+
    engine_version
    
+
    Yes
    
+
    String
    
+
    Engine version (core instance version) It can be obtained by referring to Querying DDM Engine Information (a V3 API).
    
+
    available_zones
    
+
    Yes
    
+
    Array of strings
    
+
    AZ code. The value cannot be empty. For details, see Regions and Endpoints.
    
+
    vpc_id
    
+
    Yes
    
+
    String
    
+
    VPC ID
    
+
    security_group_id
    
+
    Yes
    
+
    String
    
+
    Security group ID
    
+
    subnet_id
    
+
    Yes
    
+
    String
    
+
    Subnet ID
    
+
    param_group_id
    
+
    No
    
+
    String
    
+
    Parameter group ID
    
+
    time_zone
    
+
    No
    
+
    String
    
+
    UTC time zone. The default value is UTC. The value can be UTC, UTC-12:00, UTC-11:00, UTC-10:00, UTC-09:00, UTC-08:00, UTC-07:00, UTC-06:00, UTC-05:00, UTC-04:00, UTC-03:00, UTC-02:00, UTC-01:00, UTC+01:00, UTC+02:00, UTC+03:00, UTC+04:00, UTC+05:00, UTC+06:00, UTC+07:00, UTC+08:00, UTC+09:00, UTC+10:00, UTC+11:00, and UTC+12:00.
    
+
    
+
    
+
    
+
    Example Request
    • Creating a DDM instance.
      POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances
+{
+  "name": "test-ddm",
+  "flavor_ref": "ddm.xlarge.4",
+  "node_num": 1,
+  "engine_version": "3.1.7.0",
+  
+  "available_zones": [
+    "eu-de-01"
+  ],
+  "vpc_id": "f6509a58-51bc-4454-a3e7-6ec7e97xx",
+  "security_group_id": "16cfe4b3-905c-44b8-a29d-e51d8b03c6dc",
+  "subnet_id": "22774dc2-abe8-4435-85b1-c9b997518a5d",
+  "param_group_id": "527818581bee4283ac14cc1e9b457072pr09",
+  "time_zone": "UTC",
+  "admin_user_name": "root",
+  "admin_user_password": "PassWord_234"
+}
      
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Instance ID. 
      
+
      job_id
      
+
      String
      
+
      ID of the job for creating an instance.
      
+
      This parameter is returned only when pay-per-use instances are created.
      
+
      
+
      
+
    • Normal response example
      {
+  "id": "e90bc6739a3c4666a577c3fa1524dac2in09", 
+  "job_id": "3ae783f3-844e-4051-abd5-b9cc65899785",
+ }
      
+
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: DDM Instances
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909537.html b/docs/ddm/api-ref/en-us_topic_0000002332909537.html
new file mode 100644
index 000000000..7218b529a
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909537.html
@@ -0,0 +1,265 @@
+
+
+
    Querying Data Nodes Available for Shard Configuration (a V3 API)
    
+
    Function
    This API is used to query data nodes that can be used for shard configuration.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/available-data-nodes
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying data nodes that can be used for shard configuration
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/2f0324a93859487eb5566d75951fcd2din09/databases/db_d553/migration/available-data-nodes?offset=0&limit=10
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      data_nodes
      
+
      Array of AvailableDnInstance objects
      
+
      Instance list
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 AvailableDnInstance
      Parameter
      
+
      Type
      
+
      Description
      
+
      id
      
+
      String
      
+
      Instance ID
      
+
      name
      
+
      String
      
+
      Instance name
      
+
      status
      
+
      String
      
+
      Instance status. It can be obtained from Data Node Statuses.
      
+
      engine_name
      
+
      String
      
+
      Engine name
      
+
      engine_version
      
+
      String
      
+
      Engine version
      
+
      private_ip
      
+
      String
      
+
      Private IP address of an instance
      
+
      port
      
+
      Integer
      
+
      Instance port
      
+
      time_zone
      
+
      String
      
+
      Time zone of an instance
      
+
      
+
      
+
    • Normal response example
      {
+  "data_nodes": [
+    {
+      "id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "status": "normal",
+      "name": "UTS-rds-dtc-src",
+      "engine_name": "mysql",
+      "engine_version": "8.0",
+      "private_ip": "172.16.223.151",
+      "port": 3306,
+      "time_zone": "UTC+08:00"
+    },
+    {
+      "id": "f8de59e4dd774dbb9a7034857466c377in01",
+      "status": "normal",
+      "name": "mysql_80_4u8g_single_2",
+      "engine_name": "mysql",
+      "engine_version": "8.0",
+      "private_ip": "172.16.208.79",
+      "port": 3306,
+      "time_zone": "UTC+08:00"
+    }
+  ],
+  "offset": 0,
+  "limit": 10,
+  "total": 2
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909545.html b/docs/ddm/api-ref/en-us_topic_0000002332909545.html
new file mode 100644
index 000000000..ba2fc40c3
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909545.html
@@ -0,0 +1,235 @@
+
+
+
    Querying Details About a Shard Configuration Task (a V3 API)
    
+
    Function
    This API is used to query details about a shard configuration task.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Querying details about a shard configuration task
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/733c7e8d73a54c27b8308ec784a8be8cin09/databases/db_e487/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      original_shard_num
      
+
      Integer
      
+
      Total number of shards before configuration
      
+
      after_shard_num
      
+
      Integer
      
+
      Total number of shards after configuration
      
+
      original_dn_info_list
      
+
      Array of DnInfo objects
      
+
      Information about data nodes before configuration
      
+
      after_dn_info_list
      
+
      Array of DnInfo objects
      
+
      Information about data nodes after configuration
      
+
      switch_route_is_manual
      
+
      Boolean
      
+
      Whether manual route switching is used.
      
+
      • true: Manual route switching is used.
      • false: Automatic route switching is used.
      
+
      auto_switch_begin_time
      
+
      String
      
+
      Time when the automatic route switching starts (in the hh:mm:ss format, for example, 17:00:00)
      
+
      auto_switch_end_time
      
+
      String
      
+
      Time when the automatic route switching ends (in the hh:mm:ss format, for example, 18:00:00)
      
+
      node_id_for_migrate
      
+
      String
      
+
      Node where shard configuration is performed
      
+
      is_exclusive
      
+
      Boolean
      
+
      Whether shard configuration exclusively occupies a node. The value can be:
      
+
      • true: It exclusively occupies a node.
      • false: It does not exclusively occupy a node.
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 DnInfo
      Parameter
      
+
      Type
      
+
      Description
      
+
      dn_instance_id
      
+
      String
      
+
      Data node ID
      
+
      dn_instance_name
      
+
      String
      
+
      Data node name
      
+
      
+
      
+
    • Normal response example
      {
+  "instance_name": "UTS-src",
+  "original_shard_num": 8,
+  "after_shard_num": 9,
+  "original_dn_info_list": [
+    {
+      "dn_instance_id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "dn_instance_name": "UTS-rds-src"
+    }
+  ],
+  "after_dn_info_list": [
+    {
+      "dn_instance_id": "7edae0250ebc464897bd92b8d3e8b769in01",
+      "dn_instance_name": "UTS-rds-src"
+    }
+  ],
+  "switch_route_is_manual": true,
+  "auto_switch_begin_time": "",
+  "auto_switch_end_time": "",
+  "node_id_for_migrate": "0c12161a26a4426c9bc72efe4ff05224no09",
+  "is_exclusive": false
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909553.html b/docs/ddm/api-ref/en-us_topic_0000002332909553.html
new file mode 100644
index 000000000..589058508
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909553.html
@@ -0,0 +1,125 @@
+
+
+
    Retrying Shard Configuration (a V3 API)
    
+
    Function
    This API is used to retry shard configuration.
    
+
    
+
    Constraints
    Only shard configuration tasks in the Failed state can be retried.
    
+
    
+
    URI
    PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/retry
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    db_name
    
+
    String
    
+
    Yes
    
+
    Schema name
    
+
    job_id
    
+
    String
    
+
    Yes
    
+
    ID of the shard configuration task
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Retrying shard configuration
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/retry
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 3 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      job_id
      
+
      String
      
+
      ID of the task for retrying shard configuration
      
+
      
+
      
+
    • Normal response example
      {
+  "job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Schemas
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909561.html b/docs/ddm/api-ref/en-us_topic_0000002332909561.html
new file mode 100644
index 000000000..7b2668e82
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909561.html
@@ -0,0 +1,87 @@
+
+
+
    Deleting a Parameter Group (a V3 API)
    
+
    Function
    This API is used to delete a parameter group.
    
+
    
+
    Constraints
    None
    
+
    
+
    URI
    DELETE /v3/{project_id}/configurations/{config_id}
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    config_id
    
+
    String
    
+
    Yes
    
+
    Parameter group ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
    
+
    Example Request
    Deleting a parameter group
    DELETE https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/2aa71dc81e2c47699229b7aa26038f9dpr09
    
+
    
+
    
+
    Response
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909569.html b/docs/ddm/api-ref/en-us_topic_0000002332909569.html
new file mode 100644
index 000000000..722ce053a
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909569.html
@@ -0,0 +1,283 @@
+
+
+
    Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API)
    
+
    Function
    This API is used to query data nodes available for restoration.
    
+
    
+
    Constraints
    You must call the API for querying the restoration time range first.
    
+
    
+
    URI
    GET /v3/{project_id}/instances/{instance_id}/backups/restorable-data-node
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Type
    
+
    Mandatory
    
+
    Description
    
+
    project_id
    
+
    String
    
+
    Yes
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    String
    
+
    Yes
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    You can obtain the token by calling the IAM API used to obtain a user token.
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Query parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    target_instance_id
    
+
    Yes
    
+
    String
    
+
    Target instance that data will be restored to
    
+
    The instance can be selected from those whose available parameter is set to true in the API of Querying Instances Available for Restoration (a V3 API).
    
+
    source_dn_instance_id
    
+
    Yes
    
+
    String
    
+
    Associated data node. The ID of the data node can be obtained from the API of Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API).
    
+
    restore_time
    
+
    Yes
    
+
    Integer
    
+
    Restoration timestamp, in milliseconds.
    
+
    The value of this parameter can be obtained from the API of Querying the Restoration Time Range (a V3 API).
    
+
    offset
    
+
    No
    
+
    Integer
    
+
    Index offset.
    
+
    The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
    
+
    The value must be a number but cannot be a negative number.
    
+
    limit
    
+
    No
    
+
    Integer
    
+
    Maximum records to be queried.
    
+
    Value range: 1 to 128
    
+
    If the parameter value is not specified, 10 records are queried by default.
    
+
    
+
    
+
    
+
    Example Request
    Querying data nodes available for restoration
    GET https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/733c7e8d73a54c27b8308ec784a8be8cin09/backups/restorable-data-node?source_dn_instance_id=41c239a1e9bd4cd2aabd678bab45a886in01&target_instance_id=2f0324a93859487eb5566d75951fcd2din09&restore_time=1747730765390
    
+
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      target_data_nodes
      
+
      Array of TargetDn4Restore objects
      
+
      Available target data nodes
      
+
      offset
      
+
      Integer
      
+
      Which page the server starts returning items
      
+
      limit
      
+
      Integer
      
+
      Number of records displayed on each page
      
+
      total
      
+
      Integer
      
+
      Total number of records
      
+
      
+
      
+
+
      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      Table 5 TargetDn4Restore
      Parameter
      
+
      Type
      
+
      Description
      
+
      instance_id
      
+
      String
      
+
      Instance ID
      
+
      instance_name
      
+
      String
      
+
      Instance name
      
+
      engine_name
      
+
      String
      
+
      Engine name
      
+
      status
      
+
      String
      
+
      Data node status. It can be obtained from Data Node Statuses.
      
+
      available
      
+
      Boolean
      
+
      Available or not
      
+
      unavailable_reason
      
+
      String
      
+
      Unavailability cause, which can be:
      
+
      • The target data node and target instance are not in the same VPC.
      • The target data node is associated with other instances.
      • The data node is abnormal.
      • The version of the target data node is earlier than that of the source data node.
      • The engine of the target data node is different from that of the source data node.
      • The target data node is read-only.
      
+
      vpc_name
      
+
      String
      
+
      Name of a VPC
      
+
      private_ip
      
+
      String
      
+
      Private IP address
      
+
      
+
      
+
    • Normal response example
      {
+	"target_data_nodes": [{
+		"instance_name": "rds-f0e2",
+		"instance_id": "55c26c79139446868919c5b8b2cbb542in01",
+		"engine_name": "mysql",
+		"status": "normal",
+		"available": true,
+		"unavailable_reason": "",
+		"vpc_name": "vpc-ddm-172",
+		"private_ip": "172.16.248.115"
+	}, {
+		"instance_name": "mysql_80_4u8g_single_2",
+		"instance_id": "c5ee103325294f37a8a42e88ba51947ain01",
+		"engine_name": "mysql",
+		"status": "normal",
+		"available": true,
+		"unavailable_reason": "",
+		"vpc_name": "vpc-ddm-172",
+		"private_ip": "172.16.192.156"
+	}],
+	"offset": 0,
+	"limit": 2,
+	"total": 192
+}
      
+
    • Abnormal response
      For details, see Abnormal Request Results.
      
+
    
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Backup Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909577.html b/docs/ddm/api-ref/en-us_topic_0000002332909577.html
new file mode 100644
index 000000000..b5564f2bb
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909577.html
@@ -0,0 +1,23 @@
+
+
+
    Tag Management
    
+
    
+
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002332909585.html b/docs/ddm/api-ref/en-us_topic_0000002332909585.html
new file mode 100644
index 000000000..9aff098d7
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002332909585.html
@@ -0,0 +1,167 @@
+
+
+
    Deleting Tags from an Instance at a Time (a V3 API)
    
+
    Function
    This API is used to delete tags from an instance at a time.
    
+
    
+
    Constraints
    If the tag to be deleted does not exist, the system deems the deletion operation successful by default. The tag structure in the request body cannot be missing, and the key cannot be left blank or an empty string.
    
+
    
+
    URI
    POST /v3/{project_id}/instances/{instance_id}/tags/delete
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 Path parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    Instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    tags
    
+
    Yes
    
+
    Array of DeleteResourceTag objects
    
+
    Tag list
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 DeleteResourceTag
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    key
    
+
    Yes
    
+
    String
    
+
    Tag key
    
+
    value
    
+
    No
    
+
    String
    
+
    Tag value
    
+
    This parameter is optional. The value:
    • Is an empty string by default if it is not set.
    • Can contain 0 to 43 characters.
    • Cannot contain the following characters:
      Non-printable ASCII characters (0-31), "*", "<", ">", "\", ",", "|"
      
+
    
+
    
+
    
+
    
+
    
+
    Example Request
    Deleting tags from an instance at a time
    
+
    POST https://ddm.eu-de.otc.t-systems.com/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/af87aa6635074bd493c6d2106381ecb3in09/tags/delete
+
+{
+  "tags": [
+    {
+      "key": "test",
+      "value": "test"
+    }
+  ]
+}
    
+
    
+
    Response
    • Normal response
    
+
    None
    
+
    • Normal response example
    
+
    None
    
+
    
+
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    
+
    Parent topic: Tag Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002510482745.html b/docs/ddm/api-ref/en-us_topic_0000002510482745.html
new file mode 100644
index 000000000..0dc67bbce
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002510482745.html
@@ -0,0 +1,149 @@
+
+
+
    Modifying Parameters of an Instance (a V3 API)
    
+
    Function
    This API is used to modify parameters of a DDM instance.
    
+
    
+
    Constraints
    
+
    
+
    URI
    PUT /v3.1/{project_id}/instances/{instance_id}/configurations
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 1 URI parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    project_id
    
+
    Yes
    
+
    String
    
+
    Project ID of a tenant in a region
    
+
    For how to obtain a project ID, see Obtaining a Project ID.
    
+
    instance_id
    
+
    Yes
    
+
    String
    
+
    DDM instance ID
    
+
    
+
    
+
    
+
    Request Parameters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Table 2 Request header parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    X-Auth-Token
    
+
    Yes
    
+
    String
    
+
    User token.
    
+
    It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
    
+
    Content-Type
    
+
    Yes
    
+
    String
    
+
    MIME type of the request body. Value range:
    
+
    • application/json
    • application/json;charset=utf-8
    
+
    
+
    
+
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 3 Request body parameters
    Parameter
    
+
    Mandatory
    
+
    Type
    
+
    Description
    
+
    values
    
+
    Yes
    
+
    Map<String,String>
    
+
    Parameter values defined by users based on a default parameter template.
    
+
    • key: parameter name. If a parameter name is left empty, its value is not to be changed.
    • value: indicates the parameter value.
    
+
    
+
    
+
    
+
    Example Request
    Changing the value of long_query_time to 2. The value indicates that the query is considered as a slow query if its execution duration is greater than or equal to 2 seconds.
    
+
    PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/configurations
+
+{
+  "values" : {
+    "long_query_time" : "2"
+  }
+}
    
+
    
+
    Response
    • Normal response
+
      
+
+
+
+
+
+
+
+
+
+
      Table 4 Response body parameters
      Parameter
      
+
      Type
      
+
      Description
      
+
      need_restart
      
+
      Boolean
      
+
      Whether the instance needs to be restarted
      
+
      
+
      
+
    
+
+
    
+
    Status Codes
    
+
    
+
    Error Codes
    For details, see Error Codes.
    
+
    
+
    
+
    
+
    
+
    Parent topic: Parameter Management
    
+
    
+
    
+
diff --git a/docs/ddm/api-ref/en-us_topic_0000002514999631.html b/docs/ddm/api-ref/en-us_topic_0000002514999631.html
new file mode 100644
index 000000000..6f1081dc0
--- /dev/null
+++ b/docs/ddm/api-ref/en-us_topic_0000002514999631.html
@@ -0,0 +1,19 @@
+
+
+
+  
    Parameter Management
    
+
+  
    
+
    
+
+
+