vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ddm/api-ref/CLASS.TXT.json
Ru, Li Yi d804d7d1be ddm_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-04-09 12:27:54 +00:00

461 lines
17 KiB
JSON
Raw Blame History

[
{
"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"
}
]
View Git Blame Copy Permalink