diff --git a/docs/ddm/api-ref/ALL_META.TXT.json b/docs/ddm/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..cb92cdad6 --- /dev/null +++ b/docs/ddm/api-ref/ALL_META.TXT.json @@ -0,0 +1,923 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"ddm_api_01_0001.html", + "node_id":"ddm_api_01_0001.xml", + "product_code":"ddm", + "code":"1", + "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":"Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0002.html", + "node_id":"ddm_api_01_0002.xml", + "product_code":"ddm", + "code":"2", + "des":"Welcome to Distributed Database Middleware (DDM). This document describes functions, syntax, parameters, and examples of DDM.If you plan to access DDM through an API, ens", + "doc_type":"api", + "kw":"Overview,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0003.html", + "node_id":"ddm_api_01_0003.xml", + "product_code":"ddm", + "code":"3", + "des":"DDM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.", + "doc_type":"api", + "kw":"API Calling,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0004.html", + "node_id":"ddm_api_01_0004.xml", + "product_code":"ddm", + "code":"4", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "doc_type":"api", + "kw":"Endpoints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0005.html", + "node_id":"ddm_api_01_0005.xml", + "product_code":"ddm", + "code":"5", + "des":"The number of DDM instances that you can create is determined by your quota.For more constraints, see API description.", + "doc_type":"api", + "kw":"Constraints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0006.html", + "node_id":"ddm_api_01_0006.xml", + "product_code":"ddm", + "code":"6", + "des":"AccountAn account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset us", + "doc_type":"api", + "kw":"Concepts,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0007.html", + "node_id":"ddm_api_01_0007.xml", + "product_code":"ddm", + "code":"7", + "des":"DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including creating DDM instances and schemas.", + "doc_type":"api", + "kw":"API Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0008.html", + "node_id":"ddm_api_01_0008.xml", + "product_code":"ddm", + "code":"8", + "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":"Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Calling APIs", + "githuburl":"" + }, + { + "uri":"ddm_03_0002.html", + "node_id":"ddm_03_0002.xml", + "product_code":"ddm", + "code":"9", + "des":"This section describes the structure of a REST API and how to call an API. Before calling an API, you need to obtain the user token using the IAM API.A request URI is in ", + "doc_type":"api", + "kw":"Making an API Request,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Making an API Request", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0011.html", + "node_id":"ddm_api_01_0011.xml", + "product_code":"ddm", + "code":"10", + "des":"Token authentication is required to call APIs.Authentication using tokens: General requests are authenticated using tokens.The validity period of a token is 24 hours. If ", + "doc_type":"api", + "kw":"Authentication,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Authentication", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0012.html", + "node_id":"ddm_api_01_0012.xml", + "product_code":"ddm", + "code":"11", + "des":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 1xx to", + "doc_type":"api", + "kw":"Returned Values,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Returned Values", + "githuburl":"" + }, + { + "uri":"ddm_api_02_0000.html", + "node_id":"ddm_api_02_0000.xml", + "product_code":"ddm", + "code":"12", + "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":"APIs (Recommended)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"APIs (Recommended)", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0014.html", + "node_id":"ddm_api_01_0014.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":"DDM Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"DDM Instances", + "githuburl":"" + }, + { + "uri":"ddm_04_0001.html", + "node_id":"ddm_04_0001.xml", + "product_code":"ddm", + "code":"14", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Creating a DDM instance", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0018.html", + "node_id":"ddm_api_01_0018.xml", + "product_code":"ddm", + "code":"15", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Querying DDM Instances", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0019.html", + "node_id":"ddm_api_01_0019.xml", + "product_code":"ddm", + "code":"16", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Querying Details of a DDM Instance", + "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", + "doc_type":"api", + "kw":"Modifying the Name of a DDM Instance,DDM Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Modifying the Name of a DDM Instance", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0021.html", + "node_id":"ddm_api_01_0021.xml", + "product_code":"ddm", + "code":"18", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0024.html", + "node_id":"ddm_api_01_0024.xml", + "product_code":"ddm", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0026.html", + "node_id":"ddm_api_01_0026.xml", + "product_code":"ddm", + "code":"23", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Scaling In a DDM instance", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0080.html", + "node_id":"ddm_api_01_0080.xml", + "product_code":"ddm", + "code":"24", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0082.html", + "node_id":"ddm_api_01_0082.xml", + "product_code":"ddm", + "code":"26", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0084.html", + "node_id":"ddm_api_01_0084.xml", + "product_code":"ddm", + "code":"28", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Querying Parameters of a Specified DDM Instance", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0085.html", + "node_id":"ddm_api_01_0085.xml", + "product_code":"ddm", + "code":"29", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0017.html", + "node_id":"ddm_api_01_0017.xml", + "product_code":"ddm", + "code":"32", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Changing the Node Class of a DDM Instance", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0027.html", + "node_id":"ddm_api_01_0027.xml", + "product_code":"ddm", + "code":"33", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "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", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0100.html", + "node_id":"ddm_api_01_0100.xml", + "product_code":"ddm", + "code":"38", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Querying DB Instances Available for Creating a Schema", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0041.html", + "node_id":"ddm_api_01_0041.xml", + "product_code":"ddm", + "code":"39", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"DDM Accounts", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0101.html", + "node_id":"ddm_api_01_0101.xml", + "product_code":"ddm", + "code":"40", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Managing the Administrator Password", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0102.html", + "node_id":"ddm_api_01_0102.xml", + "product_code":"ddm", + "code":"41", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Validating Password Strength", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0089.html", + "node_id":"ddm_api_01_0089.xml", + "product_code":"ddm", + "code":"42", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Monitoring", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0090.html", + "node_id":"ddm_api_01_0090.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", + "doc_type":"api", + "kw":"Monitoring Slow Query Logs,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Monitoring Slow Query Logs", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0058.html", + "node_id":"ddm_api_01_0058.xml", + "product_code":"ddm", + "code":"44", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0059.html", + "node_id":"ddm_api_01_0059.xml", + "product_code":"ddm", + "code":"45", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Abnormal Request Results,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Abnormal Request Results", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0060.html", + "node_id":"ddm_api_01_0060.xml", + "product_code":"ddm", + "code":"46", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0061.html", + "node_id":"ddm_api_01_0061.xml", + "product_code":"ddm", + "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":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0062.html", + "node_id":"ddm_api_01_0062.xml", + "product_code":"ddm", + "code":"48", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Node Classes", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0063.html", + "node_id":"ddm_api_01_0063.xml", + "product_code":"ddm", + "code":"49", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0064.html", + "node_id":"ddm_api_01_0064.xml", + "product_code":"ddm", + "code":"50", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Status Description", + "githuburl":"" + }, + { + "uri":"ddm_api_01_0069.html", + "node_id":"ddm_api_01_0069.xml", + "product_code":"ddm", + "code":"51", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ddm" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/ddm/api-ref/CLASS.TXT.json b/docs/ddm/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..58127b124 --- /dev/null +++ b/docs/ddm/api-ref/CLASS.TXT.json @@ -0,0 +1,461 @@ +[ + { + "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":"Before You Start", + "uri":"ddm_api_01_0001.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"Welcome to Distributed Database Middleware (DDM). This document describes functions, syntax, parameters, and examples of DDM.If you plan to access DDM through an API, ens", + "product_code":"ddm", + "title":"Overview", + "uri":"ddm_api_01_0002.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"DDM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.", + "product_code":"ddm", + "title":"API Calling", + "uri":"ddm_api_01_0003.html", + "doc_type":"api", + "p_code":"1", + "code":"3" + }, + { + "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "product_code":"ddm", + "title":"Endpoints", + "uri":"ddm_api_01_0004.html", + "doc_type":"api", + "p_code":"1", + "code":"4" + }, + { + "desc":"The number of DDM instances that you can create is determined by your quota.For more constraints, see API description.", + "product_code":"ddm", + "title":"Constraints", + "uri":"ddm_api_01_0005.html", + "doc_type":"api", + "p_code":"1", + "code":"5" + }, + { + "desc":"AccountAn account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset us", + "product_code":"ddm", + "title":"Concepts", + "uri":"ddm_api_01_0006.html", + "doc_type":"api", + "p_code":"1", + "code":"6" + }, + { + "desc":"DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including creating DDM instances and schemas.", + "product_code":"ddm", + "title":"API Overview", + "uri":"ddm_api_01_0007.html", + "doc_type":"api", + "p_code":"", + "code":"7" + }, + { + "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":"Calling APIs", + "uri":"ddm_api_01_0008.html", + "doc_type":"api", + "p_code":"", + "code":"8" + }, + { + "desc":"This section describes the structure of a REST API and how to call an API. Before calling an API, you need to obtain the user token using the IAM API.A request URI is in ", + "product_code":"ddm", + "title":"Making an API Request", + "uri":"ddm_03_0002.html", + "doc_type":"api", + "p_code":"8", + "code":"9" + }, + { + "desc":"Token authentication is required to call APIs.Authentication using tokens: General requests are authenticated using tokens.The validity period of a token is 24 hours. If ", + "product_code":"ddm", + "title":"Authentication", + "uri":"ddm_api_01_0011.html", + "doc_type":"api", + "p_code":"8", + "code":"10" + }, + { + "desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 1xx to", + "product_code":"ddm", + "title":"Returned Values", + "uri":"ddm_api_01_0012.html", + "doc_type":"api", + "p_code":"8", + "code":"11" + }, + { + "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":"APIs (Recommended)", + "uri":"ddm_api_02_0000.html", + "doc_type":"api", + "p_code":"", + "code":"12" + }, + { + "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":"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", + "product_code":"ddm", + "title":"Creating a DDM instance", + "uri":"ddm_04_0001.html", + "doc_type":"api", + "p_code":"13", + "code":"14" + }, + { + "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", + "uri":"ddm_api_01_0018.html", + "doc_type":"api", + "p_code":"13", + "code":"15" + }, + { + "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", + "uri":"ddm_api_01_0019.html", + "doc_type":"api", + "p_code":"13", + "code":"16" + }, + { + "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", + "product_code":"ddm", + "title":"Modifying the Name of a DDM Instance", + "uri":"ddm_api_01_0020.html", + "doc_type":"api", + "p_code":"13", + "code":"17" + }, + { + "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", + "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", + "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", + "uri":"ddm_api_01_0024.html", + "doc_type":"api", + "p_code":"13", + "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", + "uri":"ddm_api_01_0026.html", + "doc_type":"api", + "p_code":"13", + "code":"23" + }, + { + "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", + "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" + }, + { + "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", + "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" + }, + { + "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", + "uri":"ddm_api_01_0084.html", + "doc_type":"api", + "p_code":"13", + "code":"28" + }, + { + "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", + "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" + }, + { + "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", + "uri":"ddm_api_01_0017.html", + "doc_type":"api", + "p_code":"13", + "code":"32" + }, + { + "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":"Schemas", + "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" + }, + { + "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", + "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" + }, + { + "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", + "uri":"ddm_api_01_0100.html", + "doc_type":"api", + "p_code":"33", + "code":"38" + }, + { + "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 Accounts", + "uri":"ddm_api_01_0041.html", + "doc_type":"api", + "p_code":"12", + "code":"39" + }, + { + "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", + "uri":"ddm_api_01_0101.html", + "doc_type":"api", + "p_code":"39", + "code":"40" + }, + { + "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", + "uri":"ddm_api_01_0102.html", + "doc_type":"api", + "p_code":"39", + "code":"41" + }, + { + "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":"Monitoring", + "uri":"ddm_api_01_0089.html", + "doc_type":"api", + "p_code":"12", + "code":"42" + }, + { + "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", + "product_code":"ddm", + "title":"Monitoring Slow Query Logs", + "uri":"ddm_api_01_0090.html", + "doc_type":"api", + "p_code":"42", + "code":"43" + }, + { + "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":"Appendix", + "uri":"ddm_api_01_0058.html", + "doc_type":"api", + "p_code":"", + "code":"44" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ddm", + "title":"Abnormal Request Results", + "uri":"ddm_api_01_0059.html", + "doc_type":"api", + "p_code":"44", + "code":"45" + }, + { + "desc":"Table 1 lists the status codes that may be returned.Table 2 lists the status codes that may be returned.", + "product_code":"ddm", + "title":"Status Codes", + "uri":"ddm_api_01_0060.html", + "doc_type":"api", + "p_code":"44", + "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", + "title":"Error Codes", + "uri":"ddm_api_01_0061.html", + "doc_type":"api", + "p_code":"44", + "code":"47" + }, + { + "desc":"DDM node classes are listed in the following table and vary according to actual situations.", + "product_code":"ddm", + "title":"Node Classes", + "uri":"ddm_api_01_0062.html", + "doc_type":"api", + "p_code":"44", + "code":"48" + }, + { + "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", + "product_code":"ddm", + "title":"Obtaining a Project ID", + "uri":"ddm_api_01_0063.html", + "doc_type":"api", + "p_code":"44", + "code":"49" + }, + { + "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":"Status Description", + "uri":"ddm_api_01_0064.html", + "doc_type":"api", + "p_code":"44", + "code":"50" + }, + { + "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":"Change History", + "uri":"ddm_api_01_0069.html", + "doc_type":"api", + "p_code":"", + "code":"51" + } +] \ No newline at end of file diff --git a/docs/ddm/api-ref/PARAMETERS.txt b/docs/ddm/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/ddm/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ 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 new file mode 100644 index 000000000..9f842797f --- /dev/null +++ b/docs/ddm/api-ref/ddm_03_0002.html @@ -0,0 +1,191 @@ + + +

Making an API Request

+

This section describes the structure of a REST API and how to call an API. Before calling an API, you need to obtain the user token using the IAM API.

+

Request URI

A request URI is in the following format:

+

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

+

Although a request URI is a part of a request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 URI parameter description

Parameter

+

Description

+

URI-scheme

+

Protocol used to transmit requests. All APIs use HTTPS.

+

Endpoint

+

Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on the service and service region. Endpoint: Endpoint of the Objective-func function. For details, see Regions and Endpoints.

+

resource-path

+

Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.

+

Query string

+

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.

+
+
+
+
+

To simplify the URI display, each API is provided only with a resource-path and a request method. This is because the URI-scheme value of all APIs is HTTPS, and the endpoints in a region are the same. Therefore, the two parts are omitted.

+
+

Request Method

HTTP methods, which are also called operations or actions, specify the type of operations that you are requesting. +
+ + + + + + + + + + + + + + + + + + + +
Table 2 HTTP methods

Method

+

Description

+

GET

+

Requests a server to return specified resources.

+

PUT

+

Requests a server to update specified resources.

+

POST

+

Requests the server to add a resource or perform special operations.

+

DELETE

+

Requests a server to delete specified resources, for example, an object.

+

PATCH

+

Requests a server to update partial content of a specified resource.

+

If the resource does not exist, a new resource will be created.

+
+
+
+

For example, for the URI of the API used to obtain a user token, the request method is POST. The request is as follows:

+
1
POST https://{{Endpoint}}/v3/auth/tokens
+
+ +
+
+

Request Headers

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

+

You can also add additional fields to the request header, for example, the fields required by a specified URI and an HTTP method. Table 3 lists common request header fields.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Common request headers

Field

+

Description

+

Mandatory

+

Example

+

Content-Type

+

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

+

Yes

+

application/json

+

Content-Length

+

Length of the request body. The unit is byte.

+

This parameter is optional for POST requests, but must be left blank for GET requests.

+

3495

+

X-Project-Id

+

Project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.

+

No

+

e9993fc787d94b6c886cbaa340f9c0f4

+

X-Auth-Token

+

User token

+

After the request is processed, the value of X-Subject-Token in the header is the token value.

+

Yes

+

The following is part of an example token:

+

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

+
+
+
+

The API used to obtain a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The request with the added Content-Type header is as follows:

+
POST https://{{endpoint}}/v3/auth/tokens
+Content-Type: application/json
+

(Optional) Request Body

This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field.

+

The request body varies depending on APIs. Some APIs do not require the request body, such as the APIs requested using GET and DELETE methods.

+

For the API used to obtain a user token, the request parameters and parameter description can be obtained in the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with actual values. You can obtain the values from Regions and Endpoints.

+

The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project.

+
+
+POST https://{{endpoint}}/v3/auth/tokens
+Content-Type: application/json
+
+{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "username",
+                    "password": "********",
+                    "domain": {
+                        "name": "domainname"
+                    }
+                }
+            }
+        },
+        "scope": {
+            "project": {
+                "name": "xxxxxxxxxxxxxxxxxx"
+            }
+        }
+    }
+}
+

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:

+ +
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/ddm/api-ref/ddm_04_0001.html b/docs/ddm/api-ref/ddm_04_0001.html new file mode 100644 index 000000000..2744bc5ba --- /dev/null +++ b/docs/ddm/api-ref/ddm_04_0001.html @@ -0,0 +1,378 @@ + + +

Creating a DDM instance

+

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 /v1/{project_id}/instances

+ +
+ + + + + + + + + + + +
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.

+

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

+

Type

+

Description

+

instance

+

Yes

+

CreateInstanceDetail object

+

Instance information

+

extend_param

+

No

+

object

+

The function has not been supported, and this field is reserved.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreateInstanceDetail

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, and hyphens (-).
+

Minimum length: 4 characters

+

Maximum length: 64 characters

+

flavor_id

+

Yes

+

String

+

Class ID

+

node_num

+

Yes

+

Integer

+

Number of nodes

+

engine_id

+

Yes

+

String

+

Engine ID

+

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+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

+

No

+

String

+

Username of the administrator. The username:

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

admin_user_password

+

No

+

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.
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Instance ID.

+

order_id

+

String

+

The function has not been supported, and this field is reserved.

+

job_id

+

String

+

ID of the job for creating an instance.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

POST https://{endpoint}/v1/{project_id}/instances
+
+{
+  "instance" : {
+    "name" : "ddm-test-001",
+    "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
+    "node_num" : "4,",
+    "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437",
+   
+    "available_zones" : [ "az1xahz" ],
+    "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172",
+    "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e",
+    "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx",
+    "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx"
+  }
+}
+ +
+

Example Response

Status code: 200

+

OK

+
{
+  "job_id" : "2x414788a5112333a02390e2eb0ea227",
+  "id" : "7191674e562d495d9e8e4b23ece6522ein09",
+  "order_id" : null
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_16_0001.html b/docs/ddm/api-ref/ddm_16_0001.html new file mode 100644 index 000000000..0f186f301 --- /dev/null +++ b/docs/ddm/api-ref/ddm_16_0001.html @@ -0,0 +1,373 @@ + + +

Creating a Schema

+

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.

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

databases

+

Yes

+

Array of CreateDatabaseDetail objects

+

Schema information

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreateDatabaseDetail

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Schema name, which:

+
  • Can include 2 to 48 characters.
  • Must start with a letter.
  • Contains only lowercase letters, digits, and underscores (_).
  • Cannot contain keywords information_schema, mysql, performance_schema, or sys.
+

Minimum length: 2 characters

+

Maximum length: 48 characters

+

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

+
  • If shard_unit is not empty, the value is the product of shard_unit multiplied by the associated RDS instances.
  • If shard_unit is left blank, the value must be greater than the number of associated RDS instances and less than or equal to the product of the associated RDS instances multiplied by 64.
+

shard_unit

+

No

+

Integer

+

Number of shards per RDS instance This parameter is optional.

+
  • The value is 1 if the schema is unsharded.
  • The value ranges from 1 to 64 if the schema is sharded.
+

Minimum value: 1

+

Maximum value: 64

+

used_rds

+

Yes

+

Array of DatabaseInstabcesParam objects

+

RDS instances associated with the schema

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 DatabaseInstabcesParam

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

ID of the RDS instance associated with the schema

+

adminUser

+

Yes

+

String

+

Username for logging in to the associated RDS instance

+

adminPassword

+

Yes

+

String

+

Password for logging in to the associated RDS instance

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

databases

+

Array of CreateDatabaseDetailResponses objects

+

Schema information

+

job_id

+

String

+

ID of the job for creating a schema.

+
+
+ +
+ + + + + + + + + +
Table 7 CreateDatabaseDetailResponses

Parameter

+

Type

+

Description

+

name

+

String

+

Schema name

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

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
+
+{
+  "databases" : [ {
+    "name" : "mytestdb",
+    "shard_mode" : "cluster",
+    "shard_number" : 8,
+    "shard_unit" : 8,
+    "used_rds" : [ {
+      "id" : "f296c394f13f48449d715bf99af07e59in01",
+      "adminUser" : "root",
+      "adminPassword" : "PassWord_234"
+    } ]
+  } ]
+}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "databases" : [ {
+    "name" : "mytestdb"
+  } ],
+  "job_id" : "68a55553-4057-4d05-b074-d6£090e08a50"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0001.html b/docs/ddm/api-ref/ddm_api_01_0001.html new file mode 100644 index 000000000..f6dd2da06 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0001.html @@ -0,0 +1,19 @@ + + +

Before You Start

+
+
+ +
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0002.html b/docs/ddm/api-ref/ddm_api_01_0002.html new file mode 100644 index 000000000..41672430a --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0002.html @@ -0,0 +1,15 @@ + + +

Overview

+

Welcome to Distributed Database Middleware (DDM). This document describes functions, syntax, parameters, and examples of DDM.

+

If you plan to access DDM through an API, ensure that you are familiar with DDM concepts.

+

This document describes how to use application programming interfaces (APIs) to perform creating, querying, deleting, and updating operations.

+
  • This document will be updated when APIs of new functions are added, for example, adding response parameters.
  • To reduce impacts caused by API changes, DDM is backward compatible with existing APIs. When using DDM, you should accept and ignore unused parameters and parameter values in JSON responses.
+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0003.html b/docs/ddm/api-ref/ddm_api_01_0003.html new file mode 100644 index 000000000..304f86f2a --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0003.html @@ -0,0 +1,11 @@ + + +

API Calling

+

DDM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0004.html b/docs/ddm/api-ref/ddm_api_01_0004.html new file mode 100644 index 000000000..eddbb3d1d --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0004.html @@ -0,0 +1,11 @@ + + +

Endpoints

+

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0005.html b/docs/ddm/api-ref/ddm_api_01_0005.html new file mode 100644 index 000000000..2830ef6d6 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0005.html @@ -0,0 +1,11 @@ + + +

Constraints

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0006.html b/docs/ddm/api-ref/ddm_api_01_0006.html new file mode 100644 index 000000000..54cc2b87a --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0006.html @@ -0,0 +1,19 @@ + + +

Concepts

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0007.html b/docs/ddm/api-ref/ddm_api_01_0007.html new file mode 100644 index 000000000..72da352fa --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0007.html @@ -0,0 +1,163 @@ + + +

API Overview

+

DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including creating DDM instances and schemas.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 API description

Type

+

Subtype

+

Description

+

APIs for managing DDM instances

+

Creating a DDM instance

+

This API is used to create a DDM instance.

+

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

+

Querying DDM instances

+

This API is used to query DDM instances.

+

Querying details of a DDM instance

+

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

+

Modifying the name of a DDM instance

+

This API is used to modify the name of an existing DDM instance.

+

Modifying the security group of a DDM instance

+

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

+

Deleting a DDM instance

+

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

+

Restarting a DDM instance

+

This API is used to restart a DDM instance.

+

Reloading table data

+

This API is used to reload table data of the required DDM instance for cross-region DR.

+

Scaling out a DDM instance

+

This API is used to add nodes to a specified DDM instance.

+

Scaling in a DDM instance

+

This API is used to remove nodes from a specified DDM instance.

+

Modifying the read policy of the associated DB instance

+

This API is used to modify the read policy of the DB instance associated with a DDM instance.

+

Synchronizing data node information

+

This API is used to synchronize configuration information of all data nodes that are associated with the current DDM instance.

+

Querying nodes of a DDM instance

+

This API is used to query nodes of a DDM instance.

+

Querying details of a DDM instance node

+

This API is used to query details of a DDM instance node.

+

Querying parameters of a specified DDM instance

+

This API is used to query parameters of a specified DDM instance.

+

Modifying parameters of a DDM instance

+

This API is used to modify parameters of a DDM instance.

+

Querying DDM engine information

+

This API is used to query information about DDM engine.

+

Querying DDM node classes available in an AZ

+

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

+

Changing the node class of a DDM Instance

+

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

+

APIs for managing schemas

+

Creating a schema

+

This API is used to create a schema.

+

Before creating a schema, ensure that there is an RDS instance available and that the instance is running properly and not associated with any DDM instance.

+

Querying schemas of a DDM instance

+

This API is used to query schemas of a DDM instance.

+

Querying details of a schema

+

This API is used to query details about a schema.

+

Deleting a schema

+

This API is used to delete a schema to release all its resources.

+

Querying DB instances available for creating a schema

+

This API is used to query DB instances that can be used for creating a schema.

+

APIs for managing DDM accounts

+

Managing the administrator password

+

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.

+

Validating password strength

+

This API is used to validate whether an instance password is a weak password.

+

Monitoring

+

Monitoring slow query logs

+

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.

+
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0008.html b/docs/ddm/api-ref/ddm_api_01_0008.html new file mode 100644 index 000000000..1ea2aa849 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0008.html @@ -0,0 +1,15 @@ + + +

Calling APIs

+
+
+ +
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0011.html b/docs/ddm/api-ref/ddm_api_01_0011.html new file mode 100644 index 000000000..b48bbe620 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0011.html @@ -0,0 +1,50 @@ + + +

Authentication

+

Token authentication is required to call APIs.

+

Authentication using tokens: General requests are authenticated using tokens.

+

Token-based Authentication

The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.

+
+

A token specifies temporary permissions in a computer system. Token-based authentication adds a token in a request as its header during API calling to obtain the permissions for operating APIs on IAM.

+
{ 
+     "auth": { 
+         "identity": { 
+             "methods": [ 
+                 "password" 
+             ], 
+             "password": { 
+                 "user": { 
+                     "name": "username", 
+                     "password": "********", 
+                     "domain": { 
+                         "name": "domainname" 
+                     } 
+                 } 
+             } 
+         }, 
+         "scope": { 
+             "project": { 
+                 "name": "xxxxxxxx" 
+             } 
+         } 
+     } 
+ }
+
+

In Making an API Request, the process of calling the API used to obtain a user token is described.

+

After obtaining the token, add the X-Auth-Token header in a request to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

+
1
+2
+3
POST https://{{Endpoint}}/v3/auth/projects
+Content-Type: application/json
+X-Auth-Token: ABCDEFJ....
+
+ +
+
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0012.html b/docs/ddm/api-ref/ddm_api_01_0012.html new file mode 100644 index 000000000..b009cb6a7 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0012.html @@ -0,0 +1,39 @@ + + +

Returned Values

+

Status Code

After sending a request, you will receive a response, including the status code, response header, and response body.

+

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.

+

For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

+
+

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

+

Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.

+
Figure 1 Header fields of the response to the request for obtaining a user token
+
+

(Optional) Response Body

This part is optional. The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.

+
For the API used to obtain a user token, the following information is returned. The following describes part of the request body.
{
+    "token": {
+        "expires_at": "2019-02-13T06:52:13.855000Z",
+        "methods": [
+            "password"
+        ],
+        "catalog": [
+            {
+                "endpoints": [
+                    {
+                        "region_id": "az-01",
+......
+
+
If an error occurs during API calling, the system returns an error code and message to you. The following shows the format of an error response body:
{
+	"error_code": "AS.0001",
+	"error_msg": "The format of message is error"
+}
+
+

In the response body, error_code is an error code, and error_msg provides information about the error.

+
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0014.html b/docs/ddm/api-ref/ddm_api_01_0014.html new file mode 100644 index 000000000..cda1a3fc4 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0014.html @@ -0,0 +1,51 @@ + + +

DDM Instances

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0015.html b/docs/ddm/api-ref/ddm_api_01_0015.html new file mode 100644 index 000000000..20b95d0ce --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0015.html @@ -0,0 +1,333 @@ + + +

Querying DDM Engine Information

+

Function

This API is used to query engines that DDM supports.

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + +
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 positive integer.

+

limit

+

No

+

Integer

+

A maximum of engines to be queried.

+

Value range: 1 to 128.

+

If the parameter value is not specified, 10 engines are queried by default.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

engineGroups

+

Array of EngineGroupsInfo 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 EngineGroupsInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Engine ID

+

name

+

String

+

Engine name

+

version

+

String

+

Engine version

+

supportAzs

+

Array of SupportAzsInfo objects

+

AZs

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 SupportAzsInfo

Parameter

+

Type

+

Description

+

code

+

String

+

AZ code

+

name

+

String

+

AZ name

+

favored

+

Boolean

+

Whether the current AZ is supported

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v2/{project_id}/engines?offset={offset}&limit={limit}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "engineGroups" : [ {
+    "id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c",
+    "name" : "ddm",
+    "version" : "3.0.8",
+    "supportAzs" : [ {
+      "code" : "az1",
+      "name" : "az1",
+      "favored" : false
+    }, {
+      "code" : "az2",
+      "name" : "az2",
+      "favored" : true
+    } ]
+  } ],
+  "offset" : 0,
+  "limit" : 128,
+  "total" : 1
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0016.html b/docs/ddm/api-ref/ddm_api_01_0016.html new file mode 100644 index 000000000..b38a14c36 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0016.html @@ -0,0 +1,465 @@ + + +

Querying DDM Node Classes Available in an AZ

+

Function

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

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + +
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

+

Yes

+

String

+

Engine ID, which can be obtained by calling the API for querying DDM engine information.

+

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 positive integer.

+

limit

+

No

+

Integer

+

A maximum of node classes to be queried.

+

Value range: 1 to 128.

+

If the parameter value is not specified, 10 node classes are queried by default.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

computeFlavorGroups

+

Array of ComputeFlavorGroupsInfo objects

+

Compute flavor information

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ComputeFlavorGroupsInfo

Parameter

+

Type

+

Description

+

groupType

+

String

+

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

+

computeFlavors

+

Array of ComputeFlavors objects

+

Compute flavors

+

offset

+

Integer

+

Which page the server starts returning items

+

limit

+

Integer

+

Number of records displayed on each page

+

total

+

Integer

+

Total number of compute flavors

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 ComputeFlavors

Parameter

+

Type

+

Description

+

id

+

String

+

Flavor ID

+

typeCode

+

String

+

Resource type code

+

code

+

String

+

VM flavor types recorded in DDM

+

iaasCode

+

String

+

VM flavor types recorded by the IaaS layer

+

cpu

+

String

+

Number of CPUs

+

mem

+

String

+

Memory size, in GB

+

maxConnections

+

String

+

Maximum number of connections

+

serverType

+

String

+

Compute resource type

+

architecture

+

String

+

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

+

azStatus

+

Map<String,String>

+

Status of the AZ where node classes are available. The key is the AZ ID and the value is the AZ status. The value can be:

+
  • normal: indicates that the node classes in the AZ are available.
  • unsupported: indicates that the node classes are not supported by the AZ.
  • sellout: indicates that the node classes in the AZ are sold out.
+

regionStatus

+

String

+

Region status

+

groupType

+

String

+

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

+

dbType

+

String

+

Engine type

+

extendFields

+

Map<String,String>

+

Extension field for storing AZ information

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v2/{project_id}/flavors?engine_id={engine_id}
+
+

Example Response

Status code: 200

+

OK

+
{
+	"computeFlavorGroups": [{
+		"offset": 0,
+		"limit": 100,
+		"total": 3,
+		"groupType": "X86",
+		"computeFlavors": [{
+				"id": "7267235a-80b0-3fd4-892f-4f3dd0cd60e4",
+				"typeCode": "hws.resource.type.ddm",
+				"code": "ddm.2xlarge.2",
+				"iaasCode": "s2.xlarge.2",
+				"cpu": "8",
+				"mem": "16",
+				"maxConnections": null,
+				"serverType": "KVM",
+				"architecture": "X86",
+				"azStatus": {
+					"eu-de-03": "unsupported",
+					"eu-de-02": "normal",
+					"eu-de-01": "normal"
+				},
+				"regionStatus": "abandon",
+				"groupType": null,
+				"dbType": "DDM",
+				"extendFields": {
+					"azCode": "eu-de-03,eu-de-02,eu-de-01",
+					"azDescription": "eu-de-03,eu-de-02,eu-de-01"
+				}
+			},
+			{
+				"id": "8cfd2730-1d53-3349-acbb-12a741767f70",
+				"typeCode": "hws.resource.type.ddm",
+				"code": "ddm.4xlarge.2",
+				"iaasCode": "s2.xlarge.2",
+				"cpu": "16",
+				"mem": "32",
+				"maxConnections": null,
+				"serverType": "KVM",
+				"architecture": "X86",
+				"azStatus": {
+					"eu-de-03": "unsupported",
+					"eu-de-02": "normal",
+					"eu-de-01": "normal"
+				},
+				"regionStatus": "abandon",
+				"groupType": null,
+				"dbType": "DDM",
+				"extendFields": {
+					"azCode": "eu-de-03,eu-de-02,eu-de-01,",
+					"azDescription": "eu-de-03,eu-de-02,eu-de-01"
+				}
+			},
+			{
+				"id": "f8388a59-b2af-3be0-8fe5-7422755d4570",
+				"typeCode": "hws.resource.type.ddm",
+				"code": "ddm.8xlarge.2",
+				"iaasCode": "s2.xlarge.2",
+				"cpu": "32",
+				"mem": "64",
+				"maxConnections": null,
+				"serverType": "KVM",
+				"architecture": "X86",
+				"azStatus": {
+					"eu-de-03": "unsupported",
+					"eu-de-02": "normal",
+					"eu-de-01": "normal"
+				},
+				"regionStatus": "abandon",
+				"groupType": null,
+				"dbType": "DDM",
+				"extendFields": {
+					"azCode": "eu-de-03,eu-de-02,eu-de-01",
+					"azDescription": "eu-de-03,eu-de-02,eu-de-01"
+				}
+			}
+		]
+	}]
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0017.html b/docs/ddm/api-ref/ddm_api_01_0017.html new file mode 100644 index 000000000..82137b091 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0017.html @@ -0,0 +1,242 @@ + + +

Changing the Node Class of a DDM Instance

+

Function

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

+
+

Constraints

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

spec_code

+

Yes

+

String

+

Resource specification code of the new node class

+

group_id

+

No

+

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.

+

is_auto_pay

+

No

+

Boolean

+

The function has not been supported, and this field is reserved.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the task for changing node class.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/flavor
+
+{
+  "spec_code" : "ddm.8xlarge.2",
+  "group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09"
+  }
+
+

Example Response

Status code: 200

+

ok

+
{
+  "job_id" : "2x414788a5112333a02390e2eb0ea227"
+}
+
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0018.html b/docs/ddm/api-ref/ddm_api_01_0018.html new file mode 100644 index 000000000..97b1e31ac --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0018.html @@ -0,0 +1,421 @@ + + +

Querying DDM Instances

+

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

+

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 positive integer.

+

limit

+

No

+

Integer

+

A maximum of instances to be queried.

+

Value range: 1 to 128.

+

If the parameter value is not specified, 10 DDM instances are queried by default.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of ShowInstanceBeanResponse objects

+

DDM instance information

+

instance_num

+

Integer

+

Number of DDM instances of a tenant

+

page_no

+

Integer

+

Current page

+

page_size

+

Integer

+

Data records on the current page

+

total_record

+

Integer

+

Total records

+

total_page

+

Integer

+

Total pages

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ShowInstanceBeanResponse

Parameter

+

Type

+

Description

+

id

+

String

+

DDM instance ID

+

status

+

String

+

DDM instance status. For details about this parameter value, see Status Description.

+

name

+

String

+

Name of the created DDM instance

+

created

+

String

+

Time when the DDM instance is created. The time must be in the format of yyyy-mm-dd Thh:mm:ssZ.

+

T indicates the separator between the calendar and the hourly notation of time. Z indicates Coordinated Universal Time (UTC).

+

updated

+

String

+

Time when the DDM instance is last updated, which is in the same format as created.

+

available_zone

+

String

+

AZ name

+

vpc_id

+

String

+

VPC ID

+

subnet_id

+

String

+

Subnet ID

+

security_group_id

+

String

+

Security group ID

+

node_count

+

Integer

+

Number of nodes

+

access_ip

+

String

+

Address for accessing the DDM instance

+

access_port

+

String

+

Port for accessing the DDM instance

+

core_count

+

String

+

Number of CPUs

+

ram_capacity

+

String

+

Memory size in GB

+

error_msg

+

String

+

Response message. This parameter is not returned if no abnormality occurs.

+

node_status

+

String

+

Node status For details, see Status Description.

+

project_id

+

String

+

Project ID of a tenant in a region

+

engine_version

+

String

+

Engine version (core instance version)

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances?offset={offset}&limit={limit}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "instance_num" : 26,
+  "instances" : [ {
+    "id" : "73f27bb0b26d4a79a9b0c58a4c700c4fin09",
+    "status" : "RUNNING",
+    "name" : "ddm-36c7",
+    "created" : "2021-12-14T07:46:22+0000",
+    "updated" : "2021-12-14T10:11:22+0000",
+    "available_zone" : "az1",
+    "vpc_id" : "1d9441c5-1a4b-431d-9edb-bf3564a83e74",
+    "subnet_id" : "20c2d83c-755b-42a2-846a-4688eb35d1a7",
+    "security_group_id" : "fbdff89d-32fe-45a4-832b-115ac4bfaac9",
+    "node_count" : 1,
+    "access_ip" : "192.168.23.143",
+    "access_port" : "5066",
+    "core_count" : "2",
+    "ram_capacity" : "4",
+    "node_status" : "RUNNING",
+    
+    "project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c",
+    "engine_version" : "3.0.8"
+  } ],
+  "page_size" : 1,
+  "total_record" : 26,
+  "total_page" : 26,
+  "page_no" : 3
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0019.html b/docs/ddm/api-ref/ddm_api_01_0019.html new file mode 100644 index 000000000..3b4736c82 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0019.html @@ -0,0 +1,393 @@ + + +

Querying Details of a DDM Instance

+

Function

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

+
+

Constraints

None

+
+

URI

GET /v1/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

DDM instance ID

+

status

+

String

+

DDM instance status. For details about this parameter value, see Status Description.

+

name

+

String

+

DDM instance name

+

created

+

String

+

Time when the DDM instance is created

+

updated

+

String

+

Time when the DDM instance is last updated

+

available_zone

+

String

+

Name of the AZ where the DDM instance is located

+

vpc_id

+

String

+

VPC ID

+

subnet_id

+

String

+

Subnet ID

+

security_group_id

+

String

+

Security group ID

+

node_count

+

Integer

+

Number of nodes

+

access_ip

+

String

+

Address for accessing the DDM instance

+

access_port

+

String

+

Port for accessing the DDM instance

+

node_status

+

String

+

Node status For details, see Status Description.

+

core_count

+

String

+

Number of CPUs

+

ram_capacity

+

String

+

Memory size in GB

+

error_msg

+

String

+

Response message. This parameter is not returned if no abnormality occurs.

+

project_id

+

String

+

Project ID

+

order_id

+

String

+

The function has not been supported, and this field is reserved.

+

engine_version

+

String

+

Engine version (core instance version)

+

nodes

+

Array of GetDetailfNodesInfo objects

+

Node information

+

admin_user_name

+

String

+

Username of the administrator. The username:

+
  • Can include 1 to 32 characters.
  • Must start with a letter.
  • Can contain only letters, digits, and underscores (_).
+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 GetDetailfNodesInfo

Parameter

+

Type

+

Description

+

status

+

String

+

Status of the DDM instance node For details, see Status Description.

+

port

+

String

+

Port of the DDM instance node

+

ip

+

String

+

IP address of the DDM instance node

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "nodes" : [ {
+    "status" : "RUNNING",
+    "port" : "5066",
+    "ip" : "192.168.0.160"
+  } ],
+  "id" : "1f5c9fd6cd984056ba89c8c87cc03278in09",
+  "status" : "RUNNING",
+  "name" : "ddm2-test",
+  "created" : "2021-11-09T03:30:01+0000",
+  "updated" : "2021-12-15T09:12:58+0000",
+  "available_zone" : "az1",
+  "vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb",
+  "subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93",
+  "security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6",
+  "node_count" : 1,
+  "access_ip" : "192.168.0.160",
+  "access_port" : "5066",
+  "core_count" : "2",
+  "ram_capacity" : "8",
+  "node_status" : "RUNNING",
+ 
+  "project_id" : "070c071d8e80d58c2f42c0121b10cf9f",
+  "engine_version" : "3.0.6",
+  "admin_user_name" : "root"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0020.html b/docs/ddm/api-ref/ddm_api_01_0020.html new file mode 100644 index 000000000..5199dac77 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0020.html @@ -0,0 +1,226 @@ + + +

Modifying the Name of a DDM Instance

+

Function

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

+
+

Constraints

None

+
+

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-name

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+ +
+ + + + + + + + + + + +
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, and hyphens (-).
+

Minimum length: 4 characters

+

Maximum length: 64 characters

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

DDM instance name

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-name
+
+{
+  "name" : "DDM-test-04"
+}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "name" : "DDM-test-04"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0021.html b/docs/ddm/api-ref/ddm_api_01_0021.html new file mode 100644 index 000000000..93e165b56 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0021.html @@ -0,0 +1,223 @@ + + +

Modifying the Security Group of a DDM Instance

+

Function

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

+
+

Constraints

None

+
+

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-security-group

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

security_group_id

+

Yes

+

String

+

Security group ID. The default value is the original security group ID. You can change the value as required.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

security_group_id

+

String

+

Security group ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-security-group
+
+{
+  "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"
+}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0022.html b/docs/ddm/api-ref/ddm_api_01_0022.html new file mode 100644 index 000000000..26cc348ae --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0022.html @@ -0,0 +1,232 @@ + + +

Deleting a DDM Instance

+

Function

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

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

delete_rds_data

+

No

+

String

+

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. It is left blank by default.
+

Enumerated values:

+
  • true
  • false
+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

DDM instance ID

+

job_id

+

String

+

ID of the job for deleting an instance.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

+
+

Example Response

Status code: 200

+

OK

+
{
+  "job_id" : "394976a1-8fb1-48b8-a2c0-a733405c1bb9",
+  "id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0023.html b/docs/ddm/api-ref/ddm_api_01_0023.html new file mode 100644 index 000000000..58ea5e544 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0023.html @@ -0,0 +1,267 @@ + + +

Restarting a DDM Instance

+

Function

This API is used to restart a DDM instance.

+
+

Constraints

None

+
+

URI

POST /v1/{project_id}/instances/{instance_id}/action

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

restart

+

No

+

RestarInstanceInfo object

+

Restart-related parameter

+
+
+ +
+ + + + + + + + + + + +
Table 4 RestarInstanceInfo

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Restart type, which can be soft or hard.

+
  • soft: Only the process is restarted.
  • hard: The instance VM is forcibly restarted.
+

Enumerated values:

+
  • soft
  • hard
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

instanceId

+

String

+

DDM instance ID

+

instanceName

+

String

+

DDM instance name

+

jobId

+

String

+

Task ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/action
+
+{
+  "restart" : {
+    "type" : "soft"
+  }
+}
+
+

Example Response

Status code: 200

+

ok

+
{
+  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
+  "instanceName" : "ddm-fb88-test",
+  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0024.html b/docs/ddm/api-ref/ddm_api_01_0024.html new file mode 100644 index 000000000..43684fc4c --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0024.html @@ -0,0 +1,178 @@ + + +

Reloading Table Data

+

Function

This API is used to reload table data of the destination DDM instance for cross-region DR.

+
+

Constraints

None

+
+

URI

POST /v1/{project_id}/instances/{instance_id}/reload-config

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Response Parameters

Status code: 200

+

No response parameters

+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/reload_config
+
+{ }
+
+

Example Response

Status code: 200

+

ok

+
{ }
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0025.html b/docs/ddm/api-ref/ddm_api_01_0025.html new file mode 100644 index 000000000..7033305a1 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0025.html @@ -0,0 +1,275 @@ + + +

Scaling Out a DDM Instance

+

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

POST /v2/{project_id}/instances/{instance_id}/action/enlarge

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

flavor_id

+

Yes

+

String

+

Flavor ID of the VM for deploying the DDM instance that is to be scaled out

+

node_number

+

Yes

+

Integer

+

Number of nodes to be added

+

group_id

+

No

+

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.

+

is_auto_pay

+

No

+

Boolean

+

The function has not been supported, and this field is reserved.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instanceId

+

String

+

DDM instance ID

+

instanceName

+

String

+

DDM instance name

+

jobId

+

String

+

Task ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

+
+

Example Response

Status code: 200

+

ok

+
{
+  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
+  "instanceName" : "BUG-ddm-fb88-test",
+  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0026.html b/docs/ddm/api-ref/ddm_api_01_0026.html new file mode 100644 index 000000000..10e78f404 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0026.html @@ -0,0 +1,255 @@ + + +

Scaling In a DDM instance

+

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.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/action/reduce

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

node_number

+

Yes

+

Integer

+

Number of nodes to be removed. The maximum value is the instance nodes minus 1.

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instanceId

+

String

+

DDM instance ID

+

instanceName

+

String

+

DDM instance name

+

jobId

+

String

+

Task ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

+
+

Example Response

Status code: 200

+

ok

+
{
+  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
+  "instanceName" : "ddm-test",
+  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0027.html b/docs/ddm/api-ref/ddm_api_01_0027.html new file mode 100644 index 000000000..5f491d4a2 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0027.html @@ -0,0 +1,23 @@ + + +

Schemas

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0029.html b/docs/ddm/api-ref/ddm_api_01_0029.html new file mode 100644 index 000000000..90cf6f687 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0029.html @@ -0,0 +1,354 @@ + + +

Querying Schemas

+

Function

This API is used to query schemas of a DDM instance.

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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

+

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 positive integer.

+

limit

+

No

+

Integer

+

Maximum schemas to be queried.

+

Value range: 1 to 128.

+

If the parameter value is not specified, 10 schemas are queried by default.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

databases

+

Array of GetDatabaseInfo objects

+

Schema information

+

total

+

Integer

+

Total records

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GetDatabaseInfo

Parameter

+

Type

+

Description

+

name

+

String

+

Schema name

+

shard_mode

+

String

+

Sharding mode of the schema

+
  • cluster: indicates that the schema is in sharded mode.
  • single: indicates that the schema is in unsharded mode.
+

shard_number

+

Integer

+

Number of shards in the same working mode

+

status

+

String

+

Schema status. For details about this parameter value, see Status Description.

+

created

+

Integer

+

Time when the schema is created

+

used_rds

+

Array of GetDatabaseUsedRds objects

+

RDS instances associated with the schema

+

shard_unit

+

Integer

+

Number of shards per RDS instance

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 GetDatabaseUsedRds

Parameter

+

Type

+

Description

+

id

+

String

+

Node ID of the associated RDS instance

+

name

+

String

+

Name of the associated RDS instance

+

status

+

String

+

Status of the associated RDS instance

+

error_msg

+

String

+

Response message. This parameter is not returned if no abnormality occurs.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}
+
+

Example Response

Status code: 200

+

OK

+
{
+	"databases": [{
+		"status": "RUNNING",
+		"created": 1642063713625,
+		"name": "mytestdb170",
+		"shard_mode": "cluster",
+		"shard_number": 8,
+		"shard_unit": 8,
+		"used_rds": [{
+			"id": "c6f68fed9e74478c8679479a07d7d568in01",
+			"status": "normal",
+			"name": "rds-test"
+		}]
+	}],
+	"total": 172
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0030.html b/docs/ddm/api-ref/ddm_api_01_0030.html new file mode 100644 index 000000000..4ddb05f22 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0030.html @@ -0,0 +1,470 @@ + + +

Querying Details of a Schema

+

Function

This API is used to query details about a schema.

+
+

Constraints

None

+
+

URI

GET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

instance_id

+

Yes

+

String

+

DDM instance ID

+

ddm_dbname

+

Yes

+

String

+

Name of the schema to be queried, which is case-insensitive

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

database

+

GetDatabaseResponseBean object

+

Schema information

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 GetDatabaseResponseBean

Parameter

+

Type

+

Description

+

name

+

String

+

Schema name

+

created

+

String

+

Time when the schema is created

+

status

+

String

+

Schema status. For details about this parameter value, see Status Description.

+

updated

+

String

+

Time when the DDM instance is last updated

+

databases

+

Array of GetDatabases objects

+

Sharding information of the schema

+

shard_mode

+

String

+

Sharding mode of the schema

+
  • cluster: indicates that the schema is in sharded mode.
  • single: indicates that the schema is in unsharded mode.
+

shard_number

+

Integer

+

Number of shards in the same working mode

+

shard_unit

+

Integer

+

Number of shards per RDS instance

+

dataVips

+

Array of strings

+

IP address and port number for connecting to the schema

+

used_rds

+

Array of GetDatabaseUsedRds objects

+

Associated RDS instances

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GetDatabases

Parameter

+

Type

+

Description

+

dbslot

+

Integer

+

Number of shards

+

name

+

String

+

Shard name

+

status

+

String

+

Shard status

+

created

+

String

+

Time when the shard is created

+

updated

+

String

+

Time when the shard is last updated

+

id

+

String

+

ID of the RDS instance where the shard is located

+

idName

+

String

+

Name of the RDS instance where the shard is located

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 GetDatabaseUsedRds

Parameter

+

Type

+

Description

+

id

+

String

+

Node ID of the associated RDS instance

+

name

+

String

+

Name of the associated RDS instance

+

status

+

String

+

Status of the associated RDS instance

+

error_msg

+

String

+

Response message. This parameter is not returned if no abnormality occurs.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "database" : {
+    "name" : "db_7567",
+    "created" : 1604631243234,
+    "status" : "RUNNING",
+    "updated" : 1604631243234,
+    "databases" : [ {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0000",
+      "idName" : "db_7567_0000",
+      "dbslot" : 0,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0001",
+      "idName" : "db_7567_0001",
+      "dbslot" : 1,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0002",
+      "idName" : "db_7567_0002",
+      "dbslot" : 2,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0003",
+      "idName" : "db_7567_0003",
+      "dbslot" : 3,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0004",
+      "idName" : "db_7567_0004",
+      "dbslot" : 4,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0005",
+      "idName" : "db_7567_0005",
+      "dbslot" : 5,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0006",
+      "idName" : "db_7567_0006",
+      "dbslot" : 6,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    }, {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "db_7567_0007",
+      "idName" : "db_7567_0007",
+      "dbslot" : 7,
+      "status" : "RUNNING",
+      "created" : 1604631243234,
+      "updated" : 1604631243234
+    } ],
+    "shard_mode" : "cluster",
+    "shard_number" : 8,
+    "shard_unit" : 8,
+    "dataVips" : [ {
+      "192.168.185.97:5066"
+    } ],
+    "used_rds" : [ {
+      "id" : "e70a82534a364492b795c5080e3a1591in01",
+      "name" : "rds-5338",
+      "status" : "normal"
+    } ]
+  }
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0031.html b/docs/ddm/api-ref/ddm_api_01_0031.html new file mode 100644 index 000000000..30605716c --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0031.html @@ -0,0 +1,233 @@ + + +

Deleting a Schema

+

Function

This API is used to delete a schema to release all its resources.

+
+

Constraints

None

+
+

URI

DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

instance_id

+

Yes

+

String

+

DDM instance ID

+

ddm_dbname

+

Yes

+

String

+

Name of the schema to be queried, which is case-insensitive

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

Parameter

+

Mandatory

+

Type

+

Description

+

delete_rds_data

+

No

+

String

+

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. It is left blank by default.
+

Enumerated values:

+
  • true
  • false
+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the job for deleting a schema.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

+
+

Example Response

Status code: 200

+

OK

+
{ 
+  "job_id" : "01a53563-6057-9ab3-6618-f135nxsj5h2s"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0041.html b/docs/ddm/api-ref/ddm_api_01_0041.html new file mode 100644 index 000000000..358fc8a50 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0041.html @@ -0,0 +1,17 @@ + + +

DDM Accounts

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0058.html b/docs/ddm/api-ref/ddm_api_01_0058.html new file mode 100644 index 000000000..35612adfe --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0058.html @@ -0,0 +1,21 @@ + + +

Appendix

+
+
+ +
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0059.html b/docs/ddm/api-ref/ddm_api_01_0059.html new file mode 100644 index 000000000..285194ea1 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0059.html @@ -0,0 +1,42 @@ + + +

Abnormal Request Results

+

Abnormal Response

+
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Description

+

errCode

+

String

+

Returned error code when a task submission exception occurs. For details, see Error Codes.

+

externalMessage

+

String

+

Description of the error returned when a task submission exception occurs.

+
+
+
+

Example Response

{  
+     "errCode": "DBS.300101",  
+     "externalMessage": "Failed to delete the schema"  
+}
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0060.html b/docs/ddm/api-ref/ddm_api_01_0060.html new file mode 100644 index 000000000..5675f28c5 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0060.html @@ -0,0 +1,130 @@ + + +

Status Codes

+

Normal

Table 1 lists the status codes that may be returned.

+ +
+ + + + + + + + + + + + + +
Table 1 Normal status codes

Status Code

+

Message

+

Description

+

200

+

OK

+

The request has been processed successfully.

+

202

+

OK

+

The asynchronous request is submitted successfully.

+
+
+
+

Abnormal

Table 2 lists the status codes that may be returned.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Abnormal status codes

Status Code

+

Message

+

Description

+

400

+

Bad Request

+

The server fails to process the request. The possible causes are as follows:

+
  • The request could not be parsed by the server due to incorrect syntax.
  • Request parameters are incorrect.
+

401

+

Unauthorized

+

Necessary credentials (for example, username and password) required for user authentication are not provided.

+

403

+

Forbidden

+

You are forbidden to access the page requested.

+

404

+

Not Found

+

The request failed because the requested resource could not be found on the server.

+

405

+

Method Not Allowed

+

You are not allowed to use the method specified in the request.

+

409

+

Conflict

+

The request could not be processed due to a conflict with the current resource status.

+

413

+

Request Entity Too Large

+

The requested resource exceeds the resource quota.

+

415

+

Unsupported Media Type

+

ContentType contained in the request header is neither application nor json.

+

500

+

Internal Server Error

+

The request is not completed due to a service error.

+

501

+

Not Implemented

+

The request is not completed because the server does not support the requested function.

+

503

+

Service Unavailable

+

The request could not be processed by the server because the server is being maintained or overloaded.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0061.html b/docs/ddm/api-ref/ddm_api_01_0061.html new file mode 100644 index 000000000..406bec7bc --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0061.html @@ -0,0 +1,974 @@ + + +

Error Codes

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

Status Code

+

Error Code

+

Error Message

+

Solution

+

400

+

DBS.280001

+

Parameter error.

+

Refresh the page, modify some parameters, and try again.

+

400

+

DBS.300002

+

Server failure.

+

Refresh the page and try again later.

+

400

+

DBS.300005

+

Failed to process the request. Contact technical support.

+

-

+

400

+

DBS.300100

+

Failed to create the schema.

+

Check whether the DDM instance is available, whether the instance is in the Running state, whether the RDS instance is being scaled, and whether the schema name is duplicated. If the schema name is duplicated, modify the name and send the request again.

+

400

+

DBS.300101

+

Failed to delete the schema.

+

Check whether the schema has been deleted and whether the associated RDS instance exists or becomes abnormal.

+

400

+

DBS.300102

+

The number of RDS instances associated with the schema is invalid.

+

Check whether the number of RDS instances associated with the schema is valid and try again.

+

400

+

DBS.300103

+

The RDS instance does not exist or it is not in the same VPC as the schema.

+

Check whether the RDS DB instance exists and whether the DB instance is in the same VPC as the required DDM instance, and then try again.

+

400

+

DBS.300104

+

The sharding rule of the schema is invalid.

+

Ensure that the sharding rule is valid and try again.

+

400

+

DBS.300106

+

The number of shards per RDS instance is invalid.

+

Check whether the number of shards per RDS instance in the request is correct. If not, modify the number and try again.

+

400

+

DBS.300107

+

The accounts are duplicated.

+

Check whether the accounts configured in parameters are duplicated and try again.

+

400

+

DBS.300108

+

The RDS instances are duplicated.

+

Check whether there are duplicate RDS instances in the request. If yes, modify them and try again.

+

400

+

DBS.300109

+

The schema name is invalid.

+

Check whether the schema name is valid. If no, modify it and try again.

+

400

+

DBS.300110

+

The status of the RDS instance does not allow associating with the schema.

+

Resolve the RDS instance status exception and try again.

+

400

+

DBS.300112

+

This schema name already exists.

+

Check whether a schema with the same name exists. If yes, modify the name and try again.

+

400

+

DBS.300113

+

Failed to create a physical database.

+

Check whether the RDS instance administrator and password are correct. If no, modify them and try again.

+

400

+

DBS.300114

+

The administrator or password is incorrect.

+

Check whether the RDS administrator and password are correct. If no, modify them and try again.

+

400

+

DBS.300115

+

Failed to delete the shard.

+

To delete the schema, check whether there are RDS instances associated with it. If the associated RDS DB instances have been deleted, click Synchronize DB Instance Data on the Basic Information page and delete the schema again.

+

400

+

DBS.300116

+

Failed to query available RDS instances.

+

Check whether the RDS service is running properly and try again.

+

400

+

DBS.300117

+

Failed to obtain the associated RDS instances.

+

Check whether the RDS service is running properly and try again.

+

400

+

DBS.300118

+

Failed to scale out the schema.

+

Check input parameters in the request.

+

400

+

DBS.300120

+

Failed to obtain task information.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300121

+

Failed to clear source data.

+

Ensure that the scale-out task exists and is in the valid state and that the administrator password of the destination RDS instance is correct, and try again.

+

400

+

DBS.300122

+

Failed to roll back the scale-out task.

+

Ensure that the scale-out task exists and is in the valid state and that the administrator password of the destination RDS instance is correct, and try again.

+

400

+

DBS.300123

+

Failed to retry the scale-out task.

+

Ensure that the scaling out task exists and its status is normal, and try again.

+

400

+

DBS.300125

+

Failed to synchronize RDS information.

+

Ensure that the RDS service is running properly and try again.

+

400

+

DBS.300127

+

The number of shards in the RDS instances associated with the schema is invalid.

+

Ensure that the total number of shards in the associated RDS DB instances is valid and try again.

+

400

+

DBS.300128

+

Failed to query schema information.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300129

+

Failed to query schema information.

+

Ensure that the schema exists and try again.

+

400

+

DBS.300130

+

Invalid schema status.

+

Ensure that the schema is in the Running state and try again.

+

400

+

DBS.300131

+

Failed to update the schema SQL blacklist.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300132

+

Failed to query the schema SQL blacklist.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300133

+

The RDS instance is being used to scale out a schema.

+

Ensure that the RDS DB instance status is not Scaling out or Scaling failed and try again.

+

400

+

DBS.300134

+

The schema status does not allow rolling back or canceling the scale-out task.

+

Refresh the page and try again later.

+

400

+

DBS.300135

+

Failed to update the relative read weight of the RDS instance.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300300

+

Failed to create a DDM account

+

Ensure that the DDM instance, schema, and account exist and try again.

+

400

+

DBS.300301

+

Failed to update the account.

+

Ensure that the account and associated schema exist and that the password meets the requirements, and try again.

+

400

+

DBS.300302

+

Failed to delete the account.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300305

+

Invalid DDM account name.

+

Ensure that the account name is valid and try again.

+

400

+

DBS.300306

+

The account password is invalid.

+

Ensure that the account name and password in the request body are correct and try again.

+

400

+

DBS.300307

+

The account description is invalid.

+

Ensure that the maximum length of account description does not exceed 256 characters and try again.

+

400

+

DBS.300309

+

The account basic permissions are invalid.

+

Ensure that basic permissions configured for the account are correct and try again.

+

400

+

DBS.300310

+

The account extended permissions are invalid.

+

Ensure that extended permissions configured for the account are correct and try again.

+

400

+

DBS.300311

+

The account already exists.

+

Ensure that the account name is unique and try again.

+

400

+

DBS.300312

+

Failed to query the account.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300313

+

Failed to configure the SQL blacklist.

+

Ensure that the schema exists and is in the Running state, and try again.

+

400

+

DBS.300314

+

Failed to modify the read/write policy.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300315

+

Invalid read/write relative weight.

+

Ensure that the weight is greater than 0 and less than 100.

+

400

+

DBS.300316

+

Failed to query the read/write policy.

+

Ensure that the DDM instance is running properly and try again.

+

400

+

DBS.300322

+

Failed to save instance metadata.

+

Provide environment information, instance ID, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300323

+

The associated RDS instance is unavailable or this operation cannot be performed when the RDS instance is in the current state.

+

Ensure that the associated RDS DB instance exists and is in normal state, and try again.

+

400

+

DBS.300327

+

The account does not exist.

+

Ensure that the account exists and try again.

+

400

+

DBS.300328

+

Failed to reset the password.

+

Ensure that the account exists and try again.

+

400

+

DBS.300329

+

Failed to obtain the step name.

+

Try again or roll back the scale-out task.

+

400

+

DBS.300330

+

Failed to convert the string from JSON to the required format.

+

Provide environment information, involved operations, instance ID, and symptom description and contact technical support.

+

400

+

DBS.300331

+

Data migration error.

+

Provide environment information, involved operations, instance ID, and symptom description and contact technical support.

+

400

+

DBS.300332

+

The scale-out task timed out.

+

Try again or roll back the scale-out task.

+

400

+

DBS.300333

+

Failed to check the time zone.

+

Log in to the RDS console. In the instance list, locate the source RDS instance and click its name. In the navigation pane, choose Parameters, search for time_zone in the upper right text box to check its value. Then, perform these operations on the target RDS instance, and check whether its time_zone value is consistent with the source instance. If not, modify it to ensure that the two values are consistent and retry.

+

400

+

DBS.300334

+

sql_mode check failed.

+

Log in to the RDS console. In the instance list, locate the source RDS instance and click its name. In the navigation pane, choose Parameters, search for sql_mode in the upper right text box to check its value. Then, perform these operations on the target RDS instance, and check whether its sql_mode value is consistent with the source instance. If not, modify it to ensure that the two values are consistent and retry.

+

400

+

DBS.300335

+

Failed to obtain the RDS link.

+

Check whether the RDS service is running properly.

+

400

+

DBS.300336

+

Physical database not found.

+

Log in to the associated RDS instance and execute SHOW DATABASES. Check whether there is a physical database whose name starts with the schema name, and whether the number of physical databases must be the same as the number of shards in the schema.

+

400

+

DBS.300337

+

Failed to check the primary key.

+

Check whether there are tables without primary keys. If yes, add primary keys for those tables and retry.

+

400

+

DBS.300338

+

Failed to disable DDL or DML.

+

Provide environment information, instance ID, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300339

+

Failed to insert a scale-out subtask.

+

Contact technical support.

+

400

+

DBS.300340

+

Failed to change statuses of scale-out subtasks to Initialization.

+

Contact technical support.

+

400

+

DBS.300341

+

Failed to issue a scale-out subtask.

+

Contact technical support.

+

400

+

DBS.300342

+

Failed to obtain scale-out subtasks.

+

Contact technical support.

+

400

+

DBS.300343

+

The volume of remaining subtask data is invalid.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300344

+

Status check for scale-out task failed.

+

Contact technical support.

+

400

+

DBS.300345

+

Failed to obtain information about the scale-out task.

+

Try again.

+

400

+

DBS.300346

+

Failed to obtain information about the DDM process.

+

Try again.

+

400

+

DBS.300347

+

Failed to disable the link.

+

Try again.

+

400

+

DBS.300348

+

Failed to obtain subtasks during data verification.

+

Contact technical support.

+

400

+

DBS.300349

+

Failed to update the schema status during route switching.

+

Contact technical support.

+

400

+

DBS.300350

+

The required data is not found.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300351

+

Failed to change statuses of scale-out subtasks to Error.

+

Contact technical support.

+

400

+

DBS.300352

+

Failed to change statuses of scale-out subtasks to Stop.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300353

+

Data verification failed.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300354

+

Failed to change statuses of scale-out subtasks to Complete.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300355

+

Schema creation failed.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300356

+

Failed to connect to the RDS DB instance.

+

Check whether the RDS service is running properly.

+

400

+

DBS.300357

+

The RDS instance administrator or password is incorrect.

+

If the RDS instance administrator is incorrect, log in to the RDS console, locate the required RDS instance and click its name, and view the administrator on the instance details page.

+

400

+

DBS.300358

+

There is a schema where source data is not cleared.

+

Log in to the DDM console, switch to the schema management page, locate the target schema, and click Clear in the Operation column.

+

400

+

DBS.300360

+

The associated instance does not support this operation.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300362

+

The scaling method is invalid.

+

Select either one of rebalance and reshard.

+

400

+

DBS.300363

+

Pre-check failed.

+

Provide environment information, involved operations, and symptom description and contact technical support.

+

400

+

DBS.300364

+

Failed to check disk space of the DB instance.

+

Perform the following operations to scale up disk space of the DB instance:

+
  1. Log in to the management console.
  2. Hover on the left menu to display Service List and choose Database > Relational Database Service.
  3. On the Instance Management page, locate the required DB instance and click its name.
  4. On the Basic Information page, locate the Storage Space part.
  5. Click Scale and try again after the scaling is complete.
+

400

+

DBS.300365

+

Failed to update metadata.

+

Retry the scale-out task.

+

400

+

DBS.300366

+

Failed to rename physical tables during migration.

+

Retry the scale-out task.

+

400

+

DBS.300367

+

Failed to clear source data.

+

Try again.

+

400

+

DBS.300368

+

Parameter lower_case_table_names of the DB instance is invalid.

+

Perform the following operations to scale up disk space of the DB instance:

+
  1. Log in to the management console.
  2. Hover on the left menu to display Service List and choose Database > Relational Database Service.
  3. On the Instance Management page, locate the required DB instance and click its name.
  4. Choose Parameters in the left navigation pane, search for lower_case_table_names and verify that its value is 1 and retry.
+

400

+

DBS.300369

+

Failed to configure access control. Contact technical support.

+

View DBS-ddm-instancemanager logs and DBS-resource-manager logs and modify as follows:

+
  • If error code APIG.xxxx is returned, indicating that you have no permission to access the API, contact ELB O&M engineers to grant the user the required permission.

    View the URI of the API in the resource management INFO log.

    +
  • If an error code containing ELB.xxxx is displayed, contact ELB O&M engineers to locate the fault.
+

400

+

DBS.300370

+

Load balancing is not enabled for the current DDM instance. To enable it, contact technical support.

+

If needed, go to DBS Operation System to enable access control for the required DDM instance.

+

400

+

DBS.300371

+

Creating a test DDM instance is not supported. To enable this function, contact technical support.

+

Creating DDM instances using the engine ID of a stable version is recommended. To create a test DDM instance, go to the DBS Operation System platform to add the user to the whitelist.

+

View the DDM instance management logs to obtain the whitelist name.

+

400

+

DBS.300372

+

Invalid destination DDM instance.

+

Create a DDM instance as the destination instance.

+

400

+

DBS.300375

+

Invalid {param}.

+

Change the value of {param} and try again.

+

400

+

DBS.300376

+

The time zone is invalid.

+

Enter a correct time zone.

+

400

+

DBS.300377

+

Invalid time range.

+
  1. Ensure that the format of the time range for route switching is HH:mm:ss.
  2. Ensure that the route switching start time and end time are the same day and the interval is longer than 1 hour.
  3. Retry after completing the above operations.
+

400

+

DBS.300379

+

The operation is not allowed for this type of tasks.

+

Enter the ID of the required schema scale-out task.

+

400

+

DBS.300400

+

The task is not found.

+

Enter a valid task ID.

+

400

+

DBS.300401

+

Failed to modify the automatic route switching time range.

+

Provide environment information, involved operations, symptom description, and tenant node logs and contact technical support.

+

400

+

DBS.300402

+

Failed to switch the route manually.

+

Provide environment information, involved operations, symptom description, and tenant node logs and contact technical support.

+

400

+

DBS.300405

+

The schema name length is invalid.

+

Ensure that the schema name contains 2 to 24 characters.

+

400

+

DBS.300406

+

The schema name cannot contain keyword keyword.

+

Ensure that the schema name does not contain information_schema, mysql, performance_schema, and sys.

+

400

+

DBS.300407

+

The schema name cannot contain uppercase letters.

+

Enter a schema name that only consists of lowercase letters.

+

400

+

DBS.300408

+

Failed to check the RDS connectivity.

+
  1. Upgrade Agent to 2.6.1 or later.
  2. Provide environment information, involved operations, symptom description and contact O&M engineers to check whether the Agent is faulty.
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0062.html b/docs/ddm/api-ref/ddm_api_01_0062.html new file mode 100644 index 000000000..87db26295 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0062.html @@ -0,0 +1,52 @@ + + +

Node Classes

+

DDM node classes are listed in the following table and vary according to actual situations.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Supported DDM node classes

Specification Code

+

vCPUs

+

Memory (GB)

+

Architecture

+

ddm.2xlarge.2

+

8

+

16

+

x86

+

ddm.4xlarge.2

+

16

+

32

+

x86

+

ddm.8xlarge.2

+

32

+

64

+

x86

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0063.html b/docs/ddm/api-ref/ddm_api_01_0063.html new file mode 100644 index 000000000..97ae693fb --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0063.html @@ -0,0 +1,44 @@ + + +

Obtaining a Project ID

+

Scenarios

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 by Calling an API

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints. For details about API authentication, see Authentication.

+

The following is an example response. id indicates the project ID.

+
{
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "project_name",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}
+
+

Obtaining a Project ID from the Console

  1. Sign up and log in to the management console.
  2. Move your pointer over the username and select My Credentials in the displayed drop-down list.

    On the displayed page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

+
+

+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0064.html b/docs/ddm/api-ref/ddm_api_01_0064.html new file mode 100644 index 000000000..e888489e5 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0064.html @@ -0,0 +1,168 @@ + + +

Status Description

+

DDM Instance Statuses

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 DDM instance statuses

Status

+

Description

+

CREATE

+

The DDM instance is being created.

+

CREATEFAILED

+

The DDM instance fails to be created.

+

RUNNING

+

The DDM instance is running and available.

+

ERROR

+

The DDM instance is faulty.

+

RESTARTING

+

The DDM instance is being restarted.

+

RESIZING

+

Class of the DDM instance fail to be changed.

+

GROWING

+

A DDM instance is being scaled out.

+

REDUCING

+

A DDM instance is being scaled in.

+

data_disk_full

+

Disk space is full.

+

RESTORE

+

A DDM instance is being restored.

+

BACKUP

+

A DDM instance is being backed up.

+

SET_CONFIGURATION

+

The instance parameters are being updated.

+
+
+
+

DDM Schema Statuses

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 DDM schema statuses

Status

+

Description

+

CREATE

+

The schema is being created.

+

RUNNING

+

The schema is running and available.

+

CREATEFAILED

+

The schema fails to be created.

+

DELETING

+

The schema is being deleted.

+

Scaling out

+

The schema is being scaled out.

+

Scaling out failed

+

The schema fails to be scaled out.

+

Rolling back

+

The schema is being rolled back.

+
+
+
+

DDM Node Statuses

+
+ + + + + + + + + + + + + + + + + + + + + + +
Table 3 Node statuses

Status

+

Description

+

normal

+

The node is running normally.

+

abnormal

+

The node is abnormal.

+

creating

+

The DDM instance is being created.

+

createfail

+

The DDM instance fails to be created.

+

enlargefail

+

The DDM instance fails to be scaled out.

+

resizing

+

The node class is being changed.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0069.html b/docs/ddm/api-ref/ddm_api_01_0069.html new file mode 100644 index 000000000..39339a318 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0069.html @@ -0,0 +1,43 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + +
Table 1 Document change history

Released On

+

Description

+

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.

+

2024-01-26

+

This issue is the third official release.

+

Added job_id to response parameters in the following sections.

+ +

2023-10-20

+

This issue is the second official release.

+

Added the SET_CONFIGURATION status in Status Description.

+

Changed the CREATING status to CREATE in Status Description.

+

2023-01-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0080.html b/docs/ddm/api-ref/ddm_api_01_0080.html new file mode 100644 index 000000000..a996bcc37 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0080.html @@ -0,0 +1,236 @@ + + +

Modifying the Read Policy of the Associated DB Instance

+

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

+

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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

read_weight

+

Yes

+

Map<String, Integer>

+

Read weights of the primary DB instance and its read replicas

+
  • key: DB instance ID
  • value: read weight parameter
+
+
+

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

success

+

Boolean

+

Whether the operation is successful

+

instance_id

+

String

+

DDM instance ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/read-write-strategy
+
+{
+  "read_weight" : {
+    "395298ae6fb9496d95939ed556474983in01" : 60,
+    "38ef52c365a14b7caeb7333137900e96in01" : 50
+  }
+}
+
+

Example Response

Status code: 200

+

ok

+
{
+  "success" : true,
+  "instance_id" : "175f5aff-xxxx-xxxx-xxxx-d0858982bbec"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0081.html b/docs/ddm/api-ref/ddm_api_01_0081.html new file mode 100644 index 000000000..77d302468 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0081.html @@ -0,0 +1,204 @@ + + +

Synchronizing Data Node Information

+

Function

This API is used to synchronize configuration information of all data nodes that are associated with a DDM instance.

+
+

Constraints

None

+
+

URI

POST /v1/{project_id}/instances/{instance_id}/rds/sync

+ +
+ + + + + + + + + + + + + + + + +
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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

instanceId

+

String

+

DDM instance ID

+

jobId

+

String

+

Task ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds/sync
+
+

Example Response

Status code: 200

+

OK

+
{
+  "instanceId" : "1f5c9fd6cd984056ba89c8c87cc03278in09",
+  "jobId" : "6f1334ca-faa6-479e-837f-f3219192675e"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0082.html b/docs/ddm/api-ref/ddm_api_01_0082.html new file mode 100644 index 000000000..4a85cb736 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0082.html @@ -0,0 +1,301 @@ + + +

Querying Nodes of a DDM Instance

+

Function

This API is used to query nodes of a DDM instance.

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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 positive integer.

+

limit

+

No

+

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.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

nodes

+

Array of NodeList objects

+

Instance node information

+

offset

+

Integer

+

Which page the server starts returning items.

+

limit

+

Integer

+

Number of records displayed on each page

+

total

+

Integer

+

Number of DDM instance nodes

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 NodeList

Parameter

+

Type

+

Description

+

port

+

String

+

Port

+

status

+

String

+

Node status For details, see Status Description.

+

node_id

+

String

+

Node ID

+

ip

+

String

+

ip

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "nodes" : [ {
+    "port" : "5066",
+    "status" : "normal",
+    "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
+    "ip" : "192.168.0.160"
+  } ],
+  "offset" : 0,
+  "limit" : 128,
+  "total" : 1
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0083.html b/docs/ddm/api-ref/ddm_api_01_0083.html new file mode 100644 index 000000000..55d9f9fe0 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0083.html @@ -0,0 +1,277 @@ + + +

Querying Details of a DDM Instance Node

+

Function

This API is used to query details of a DDM instance node.

+
+

Constraints

None

+
+

URI

GET /v1/{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

+

instance_id

+

Yes

+

String

+

DDM instance ID

+

node_id

+

Yes

+

String

+

DDM instance 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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

status

+

String

+

Node status For details, see Status Description.

+

name

+

String

+

Node name

+

node_id

+

String

+

Node ID

+

private_ip

+

String

+

Private IP address of the node

+

floating_ip

+

String

+

Floating IP address of the node

+

server_id

+

String

+

VM ID

+

subnet_name

+

String

+

Subnet name

+

datavolume_id

+

String

+

Data disk ID

+

res_subnet_ip

+

String

+

IP address provided by the resource subnet

+

systemvolume_id

+

String

+

System disk ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes/{node_id}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "status" : "normal",
+  "name" : "ddm2-test_node_01",
+  "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
+  "private_ip" : "192.168.0.160",
+  "floating_ip" : "100.65.78.158",
+  "server_id" : "8bd4d0bd-f63e-489a-95b6-50351f9657e6",
+  "subnet_name": "manageSubnet",
+  "datavolume_id" : "30ade9fb-26de-4d1f-af08-c376974b9d86",
+  "res_subnet_ip" : "172.16.15.224",
+  "systemvolume_id" : "88d7de55-f886-4929-ae7c-04d842959700"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0084.html b/docs/ddm/api-ref/ddm_api_01_0084.html new file mode 100644 index 000000000..1f7a25b8c --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0084.html @@ -0,0 +1,342 @@ + + +

Querying Parameters of a Specified DDM Instance

+

Function

This API is used to query parameters of a specified DDM instance.

+
+

Constraints

None

+
+

URI

GET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}

+ +
+ + + + + + + + + + + + + + + + +
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 positive integer.

+

limit

+

No

+

Integer

+

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.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Language

+

No

+

String

+

Language.

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

updated

+

String

+

Time when DDM instance parameters are last updated

+

configuration_parameter

+

Array of ConfigurationParameterList objects

+

Information about DDM instance parameters

+

offset

+

Integer

+

Which page the server starts returning items

+

limit

+

Integer

+

Number of records displayed on each page

+

total

+

Integer

+

Total collections

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ConfigurationParameterList

Parameter

+

Type

+

Description

+

name

+

String

+

Parameter name

+

value

+

String

+

Parameter value

+

need_restart

+

String

+

Whether the instance needs to be restarted

+

read_only

+

String

+

Whether the parameter is read-only

+

value_range

+

String

+

Parameter value range

+

data_type

+

String

+

Parameter type

+

description

+

String

+

Parameter description

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations
+
+

Example Response

Status code: 200

+

OK

+
{
+  "updated" : "2021-11-09 03:26:52",
+  "configuration_parameter" : [ {
+    "name" : "temp_table_size_limit",
+    "value" : "1000000",
+    "need_restart" : "0",
+    "read_only" : "0",
+    "value_range" : "500000-2000000000",
+    "data_type" : "integer",
+    "description" : "Maximum size of the temporary table."
+  } ],
+  "offset" : 0,
+  "limit" : 128,
+  "total" : 22
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0085.html b/docs/ddm/api-ref/ddm_api_01_0085.html new file mode 100644 index 000000000..7d99ab3a9 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0085.html @@ -0,0 +1,480 @@ + + +

Modifying Parameters of a DDM Instance

+

Function

This API is used to modify parameters of a DDM instance.

+
+

Constraints

None

+
+

URI

PUT /v3/{project_id}/instances/{instance_id}/configurations

+ +
+ + + + + + + + + + + + + + + + +
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-Language

+

No

+

String

+

Language.

+

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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

values

+

Yes

+

values object

+

Parameters that need to be modified

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

nodeList

+

String

+

DDM instance nodes

+

needRestart

+

Boolean

+

Whether the instance needs to be restarted

+

jobId

+

String

+

Task ID

+

configId

+

String

+

Parameter group ID

+

configName

+

String

+

Parameter group name

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations
+
+{
+  "values" : {
+    "long_query_time" : 2
+  }
+}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "nodeList" : null,
+  "needRestart" : "false",
+  "jobId" : "9fe84a77-6a6b-4b03-9a3e-db910a548657",
+  "configId" : null,
+  "configName" : null
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Instances
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0089.html b/docs/ddm/api-ref/ddm_api_01_0089.html new file mode 100644 index 000000000..aa3e2241e --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0089.html @@ -0,0 +1,15 @@ + + +

Monitoring

+
+
+ + +
+
Parent topic: APIs (Recommended)
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0090.html b/docs/ddm/api-ref/ddm_api_01_0090.html new file mode 100644 index 000000000..b7590944e --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0090.html @@ -0,0 +1,340 @@ + + +

Monitoring Slow Query Logs

+

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

GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}

+ +
+ + + + + + + + + + + + + + + + +
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

+

curPage

+

Yes

+

String

+

Which page the server starts returning items. The start value cannot be less than 1.

+

perPage

+

Yes

+

String

+

Number of records displayed on each page

+

startDate

+

Yes

+

String

+

Start time. The format is UNIX timestamp, in milliseconds.

+

endDate

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

totalRecord

+

Integer

+

Number of slow query logs

+

slowLogList

+

Array of SlowLogList objects

+

Information about slow query logs

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 SlowLogList

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

+

querySample

+

String

+

Syntax for executing the slow SQL statement

+

logTime

+

String

+

Time when the slow SQL statement starts to be executed

+

time

+

String

+

Time for a SQL statement to execute, accurate to milliseconds

+

shards

+

String

+

Name of the physical shard

+

rowsExamined

+

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.

+

ddmNodeId

+

String

+

ID of the DDM node for executing the slow SQL statement

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "totalRecord" : 2,
+  "slowLogList" : [ {
+    "users" : "testddm",
+    "database" : "test1",
+    "querySample" : "select id, sleep(3) from test",
+    "logTime" : "2021-04-26T02:40:21",
+    "time" : "12002",
+    "shards" : "test1_0000",
+    "rowsExamined" : "4",
+    "host" : "192.168.16.18",
+    "ddmNodeId":"47667f9ed2a54af7ba9ca46d8d37c26f****"
+  } ]
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0100.html b/docs/ddm/api-ref/ddm_api_01_0100.html new file mode 100644 index 000000000..e1f432902 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0100.html @@ -0,0 +1,369 @@ + + +

Querying DB Instances Available for Creating a Schema

+

Function

This API is used to query DB instances that can be used for creating a schema.

+
+

Constraints

None

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
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 positive integer.

+

limit

+

No

+

Integer

+

Maximum records to be queried.

+

Value range: 1 to 128.

+

If the parameter value is not specified, 10 is used by default.

+
+
+
+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of QueryAvailableRdsList objects

+

DB instances that can be used for creating a schema

+

offset

+

Integer

+

Which page the server starts returning items

+

limit

+

Integer

+

Number of records displayed on each page

+

total

+

Integer

+

Total collections

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 QueryAvailableRdsList

Parameter

+

Type

+

Description

+

id

+

String

+

DB instance ID

+

projectId

+

String

+

Project ID of the tenant that the DB instance belongs to

+

status

+

String

+

DB instance status

+

name

+

String

+

DB instance name

+

engineName

+

String

+

Engine name of the DB instance

+

engineSoftwareVersion

+

String

+

Engine version of the DB instance

+

privateIp

+

String

+

Private IP address for connecting to the DB instance

+

mode

+

String

+

DB instance type (primary/standby or single-node)

+

port

+

Integer

+

Port for connecting to the DB instance

+

azCode

+

String

+

AZ

+

timeZone

+

String

+

Time zone

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "instances" : [ {
+    "id" : "c6f68fed9e74478c8679479a07d7d568in01",
+    "projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
+    "status" : "normal",
+    "name" : "test-ddm",
+    "engineName" : "mysql",
+    "engineSoftwareVersion" : "5.7",
+    "privateIp" : "192.168.23.97",
+    "mode" : "Ha",
+    "port" : 3306,
+    "azCode" : "az1az1",
+    "timeZone" : "UTC+08: 00"
+  }, {
+    "id" : "337e2598c2a64cb5935079f85996731din01",
+    "projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
+    "status" : "normal",
+    "name" : "test-ddm",
+    "engineName" : "mysql",
+    "engineSoftwareVersion" : "5.7",
+    "privateIp" : "192.168.23.221",
+    "mode" : "Ha",
+    "port" : 3306,
+    "azCode" : "az1az1",
+    "timeZone" : "UTC+08: 00"
+  } ],
+  "offset" : 0,
+  "limit" : 6,
+  "total" : 2
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0101.html b/docs/ddm/api-ref/ddm_api_01_0101.html new file mode 100644 index 000000000..781caaf40 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0101.html @@ -0,0 +1,241 @@ + + +

Managing the Administrator Password

+

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

+ +
+ + + + + + + + + + + + + + + + +
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.

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Username of the administrator. The username:

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

password

+

Yes

+

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.
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DDM instance ID

+

job_id

+

String

+

Task ID

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user
+
+{
+  "name" : "root",
+  "password" : "****"
+}
+
+

Example Response

Status code: 200

+

OK

+
{ 
+  "instance_id" : "175f5aff-****-****-****-d0858982bbec",
+  "job_id" : "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
+}
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Accounts
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_01_0102.html b/docs/ddm/api-ref/ddm_api_01_0102.html new file mode 100644 index 000000000..6e5c2f862 --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_01_0102.html @@ -0,0 +1,212 @@ + + +

Validating Password Strength

+

Function

This API is used to check whether an instance password is a weak password.

+
+

URI

POST /v3/{project_id}/weak-password-verification

+ +
+ + + + + + + + + + + +
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.

+

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

+

Type

+

Description

+

password

+

Yes

+

String

+

Character string to be validated

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

is_weak_password

+

Boolean

+

Whether the password is a weak password. The value can be: true: indicating that the password is a weak password. Such a password is not recommended. false: indicating that the password is not a weak password. Such a password is recommended.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

errCode

+

String

+

Service error code

+

externalMessage

+

String

+

Error message

+
+
+
+

Example Request

POST https://{endpoint}/v3/{project_id}/weak-password-verification
+
+{
+  "password" : "xxx"
+}
+
+

Example Response

Status code: 200

+

OK

+
{
+  "is_weak_password" : true
+}
+
+

Status code: 400

+

bad request

+
{
+  "externalMessage" : "Parameter error.",
+  "errCode" : "DBS.280001"
+}
+

Status code: 500

+

server error

+
{
+  "externalMessage" : "Server failure.",
+  "errCode" : "DBS.200412"
+}
+

Status Codes

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

Status Code

+

Description

+

200

+

OK

+

400

+

bad request

+

500

+

server error

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: DDM Accounts
+
+
+ diff --git a/docs/ddm/api-ref/ddm_api_02_0000.html b/docs/ddm/api-ref/ddm_api_02_0000.html new file mode 100644 index 000000000..1a62433ae --- /dev/null +++ b/docs/ddm/api-ref/ddm_api_02_0000.html @@ -0,0 +1,21 @@ + + + +

APIs (Recommended)

+ +

+
+ +
+ +
+ diff --git a/docs/ddm/api-ref/en-us_image_0000001685146158.png b/docs/ddm/api-ref/en-us_image_0000001685146158.png new file mode 100644 index 000000000..d4a37a976 Binary files /dev/null and b/docs/ddm/api-ref/en-us_image_0000001685146158.png differ diff --git a/docs/ddm/api-ref/en-us_image_0000001733265073.png b/docs/ddm/api-ref/en-us_image_0000001733265073.png new file mode 100644 index 000000000..e892e305c Binary files /dev/null and b/docs/ddm/api-ref/en-us_image_0000001733265073.png differ diff --git a/docs/ddm/api-ref/en-us_image_0000001733265081.jpg b/docs/ddm/api-ref/en-us_image_0000001733265081.jpg new file mode 100644 index 000000000..9a3a0c8d8 Binary files /dev/null and b/docs/ddm/api-ref/en-us_image_0000001733265081.jpg differ diff --git a/docs/ddm/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/ddm/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/ddm/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/ddm/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/ddm/api-ref/public_sys-resources/delta.gif b/docs/ddm/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/deltaend.gif b/docs/ddm/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ddm/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..379428032 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/ddm/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..6aaaa11c2 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-caution.gif b/docs/ddm/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-danger.gif b/docs/ddm/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-huawei.gif b/docs/ddm/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-note.gif b/docs/ddm/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-notice.gif b/docs/ddm/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-tip.gif b/docs/ddm/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/icon-warning.gif b/docs/ddm/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/ddm/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/ddm/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/ddm/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/ddm/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/ddm/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/ddm/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/ddm/api-ref/public_sys-resources/warning_3.0-en-us.png differ