Files
doc-exports/docs/ddm/api-ref/CLASS.TXT.json
wangdengke2 823df869a9 ddm_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-03 12:01:43 +00:00

1073 lines
42 KiB
JSON

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