vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/ALL_META.TXT.json
Ru, Li Yi a6e39ff5b3 DDS_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-05-27 08:52:30 +00:00

1577 lines
47 KiB
JSON
Raw Blame History

[
{
"dockw":"API Reference"
},
{
"uri":"dds_api_reference.html",
"node_id":"dds_api_reference.xml",
"product_code":"dds",
"code":"1",
"des":"This document describes application programming interfaces (APIs), syntax, parameters, and examples of Document Database Service (DDS). You can search for information you",
"doc_type":"api",
"kw":"Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Before You Start",
"githuburl":""
},
{
"uri":"dds_api_0006.html",
"node_id":"dds_api_0006.xml",
"product_code":"dds",
"code":"2",
"des":"DDS provides extension APIs, allowing you to perform specific operations using APIs.",
"doc_type":"api",
"kw":"API Overview,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"API Overview",
"githuburl":""
},
{
"uri":"dds_api_0007.html",
"node_id":"dds_api_0007.xml",
"product_code":"dds",
"code":"3",
"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":"Environment Preparations",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Environment Preparations",
"githuburl":""
},
{
"uri":"dds_api_0010.html",
"node_id":"dds_api_0010.xml",
"product_code":"dds",
"code":"4",
"des":"DDS supports token authentication.The validity period of a token is 24 hours. If a token needs to be used, the system caches the token to avoid frequent calling.A token s",
"doc_type":"api",
"kw":"Authentication,Environment Preparations,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Authentication",
"githuburl":""
},
{
"uri":"dds_api_0014.html",
"node_id":"dds_api_0014.xml",
"product_code":"dds",
"code":"5",
"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":"API Calling",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"API Calling",
"githuburl":""
},
{
"uri":"dds_api_0015.html",
"node_id":"dds_api_0015.xml",
"product_code":"dds",
"code":"6",
"des":"DDS open APIs allow users to create, view, or delete DB instances, query API versions, DB engines, DB engine versions, and DB instance class supported by the system. The ",
"doc_type":"api",
"kw":"Scenarios,API Calling,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Scenarios",
"githuburl":""
},
{
"uri":"dds_api_0016.html",
"node_id":"dds_api_0016.xml",
"product_code":"dds",
"code":"7",
"des":"API requests sent by third-party applications to public cloud services must be authenticated using signatures.Public cloud APIs follow RESTful API design rules.In REST, s",
"doc_type":"api",
"kw":"REST APIs,API Calling,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"REST APIs",
"githuburl":""
},
{
"uri":"dds_api_0017.html",
"node_id":"dds_api_0017.xml",
"product_code":"dds",
"code":"8",
"des":"This section describes how to create a cluster instance by calling APIs.The validity period of a token obtained from IAM is 24 hours. If you want to use a token for authe",
"doc_type":"api",
"kw":"Example,API Calling,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Example",
"githuburl":""
},
{
"uri":"dds_api_description.html",
"node_id":"dds_api_description.xml",
"product_code":"dds",
"code":"9",
"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 V3.0 (Recommended)",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"APIs V3.0 (Recommended)",
"githuburl":""
},
{
"uri":"dds_api_version.html",
"node_id":"dds_api_version.xml",
"product_code":"dds",
"code":"10",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Querying the API Version",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the API Version",
"githuburl":""
},
{
"uri":"dds_api_0018.html",
"node_id":"dds_api_0018.xml",
"product_code":"dds",
"code":"11",
"des":"This API is used to query the currently supported API version list.URI formatGET https://{Endpoint}/GET https://{Endpoint}/Parameter descriptionN/AN/ANoneParameter descri",
"doc_type":"api",
"kw":"Querying the API Version List,Querying the API Version,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the API Version List",
"githuburl":""
},
{
"uri":"dds_api_0019.html",
"node_id":"dds_api_0019.xml",
"product_code":"dds",
"code":"12",
"des":"This API is used to query the specified API version.URI formatGET https://{Endpoint}/{version}GET https://{Endpoint}/{version}Parameter descriptionN/AN/AExample requestGE",
"doc_type":"api",
"kw":"Querying API Version Information,Querying the API Version,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying API Version Information",
"githuburl":""
},
{
"uri":"dds_database_version.html",
"node_id":"dds_database_version.xml",
"product_code":"dds",
"code":"13",
"des":"This API is used to obtain database version information about a specified type of a DB instance.URI formatGET https://{Endpoint}/v3/{project_id}/datastores/{datastore_nam",
"doc_type":"api",
"kw":"Querying Database Version Information,APIs V3.0 (Recommended),API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Database Version Information",
"githuburl":""
},
{
"uri":"dds_instance_specification.html",
"node_id":"dds_instance_specification.xml",
"product_code":"dds",
"code":"14",
"des":"This API is used to query all instance specifications under a specified condition.URI formatGET https://{Endpoint}/v3.1/{project_id}/flavors?engine_name={engine_name}&eng",
"doc_type":"api",
"kw":"Querying Database Specifications,APIs V3.0 (Recommended),API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Database Specifications",
"githuburl":""
},
{
"uri":"dds_api_0039.html",
"node_id":"dds_api_0039.xml",
"product_code":"dds",
"code":"15",
"des":"This API is used to query the database disk type in the current region.URI formatGET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name}GET https://",
"doc_type":"api",
"kw":"Querying the Database Disk Type,APIs V3.0 (Recommended),API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the Database Disk Type",
"githuburl":""
},
{
"uri":"dds_instance_mgmt.html",
"node_id":"dds_instance_mgmt.xml",
"product_code":"dds",
"code":"16",
"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":"DB Instance Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"DB Instance Management",
"githuburl":""
},
{
"uri":"dds_api_0020.html",
"node_id":"dds_api_0020.xml",
"product_code":"dds",
"code":"17",
"des":"This API is used to create cluster, replica set, and single node instances.URI formatPOST https://{Endpoint}/v3/{project_id}/instancesPOST https://{Endpoint}/v3/{project_",
"doc_type":"api",
"kw":"Creating a DB Instance,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Creating a DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0021.html",
"node_id":"dds_api_0021.xml",
"product_code":"dds",
"code":"18",
"des":"This API is used to restart a DB instance.The DDS DB instance will be unavailable during the restart process. Exercise caution when performing this operation.If the insta",
"doc_type":"api",
"kw":"Restarting a DB Instance,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Restarting a DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0022.html",
"node_id":"dds_api_0022.xml",
"product_code":"dds",
"code":"19",
"des":"This API is used to delete a DB instance.URI formatDELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}DELETE https://{Endpoint}/v3/{project_id}/instances/{i",
"doc_type":"api",
"kw":"Deleting a DB Instance,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Deleting a DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0023.html",
"node_id":"dds_api_0023.xml",
"product_code":"dds",
"code":"20",
"des":"This API is used to query instances and details based on specified conditions.URI formatGET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&d",
"doc_type":"api",
"kw":"Querying Instances and Details,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Instances and Details",
"githuburl":""
},
{
"uri":"dds_api_0024.html",
"node_id":"dds_api_0024.xml",
"product_code":"dds",
"code":"21",
"des":"This API is used to scale up the storage space of a DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-volumePOST https://{Endp",
"doc_type":"api",
"kw":"Scaling Up Storage Space,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Scaling Up Storage Space",
"githuburl":""
},
{
"uri":"dds_api_0025.html",
"node_id":"dds_api_0025.xml",
"product_code":"dds",
"code":"22",
"des":"This API is used to add nodes for a specified cluster instance.Only the mongos and shard nodes can be added.The specifications of the new node must be the same as those o",
"doc_type":"api",
"kw":"Adding Nodes for a Cluster Instance,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Adding Nodes for a Cluster Instance",
"githuburl":""
},
{
"uri":"dds_api_0026.html",
"node_id":"dds_api_0026.xml",
"product_code":"dds",
"code":"23",
"des":"This API is used to modify the instance specifications.Services will be interrupted for 5 to 10 minutes when you modify DB instance specifications. Exercise caution when ",
"doc_type":"api",
"kw":"Modifying DB Instance Specifications,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Modifying DB Instance Specifications",
"githuburl":""
},
{
"uri":"dds_api_0050.html",
"node_id":"dds_api_0050.xml",
"product_code":"dds",
"code":"24",
"des":"This API is used to perform a primary/secondary switchover in a replica set instance.This API supports only DDS replica sets.This operation cannot be performed on frozen ",
"doc_type":"api",
"kw":"Performing a Primary/Secondary Switchover in a Replica Set Instance,DB Instance Management,API Refer",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Performing a Primary/Secondary Switchover in a Replica Set Instance",
"githuburl":""
},
{
"uri":"dds_api_0051.html",
"node_id":"dds_api_0051.xml",
"product_code":"dds",
"code":"25",
"des":"This API is used to enable or disable SSL.This operation cannot be performed on frozen or abnormal instances.The DB instance must be restarted to make port number modific",
"doc_type":"api",
"kw":"Enabling or Disabling SSL,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Enabling or Disabling SSL",
"githuburl":""
},
{
"uri":"dds_api_0053.html",
"node_id":"dds_api_0053.xml",
"product_code":"dds",
"code":"26",
"des":"This API is used to modify a DB instance name.The name of the DB instance that is being created or fails to be created cannot be modified.URI formatPUT https://{Endpoint}",
"doc_type":"api",
"kw":"Modifying a DB Instance Name,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Modifying a DB Instance Name",
"githuburl":""
},
{
"uri":"dds_api_0054.html",
"node_id":"dds_api_0054.xml",
"product_code":"dds",
"code":"27",
"des":"This API is used to change a database port.This operation cannot be performed on frozen or abnormal instances.The DB instance must be restarted to make port number modifi",
"doc_type":"api",
"kw":"Changing a Database Port,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Changing a Database Port",
"githuburl":""
},
{
"uri":"dds_api_0055.html",
"node_id":"dds_api_0055.xml",
"product_code":"dds",
"code":"28",
"des":"This API is used to change the security group associated with a DB instance.Abnormal instances do not support this operation.Please confirm the modified security group po",
"doc_type":"api",
"kw":"Changing a Security Group,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Changing a Security Group",
"githuburl":""
},
{
"uri":"dds_api_0056.html",
"node_id":"dds_api_0056.xml",
"product_code":"dds",
"code":"29",
"des":"This API is used to bind an EIP to a node in a DB instance.This operation cannot be performed on frozen or abnormal instances.Hidden nodes do not support this operation.M",
"doc_type":"api",
"kw":"Binding an EIP,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Binding an EIP",
"githuburl":""
},
{
"uri":"dds_api_0057.html",
"node_id":"dds_api_0057.xml",
"product_code":"dds",
"code":"30",
"des":"This API is used to unbind an EIP from a node in a DB instance.Frozen instances do not support this operation.This operation can be performed only on a node with an EIP a",
"doc_type":"api",
"kw":"Unbinding an EIP,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Unbinding an EIP",
"githuburl":""
},
{
"uri":"dds_api_0058.html",
"node_id":"dds_api_0058.xml",
"product_code":"dds",
"code":"31",
"des":"This API is used to change the private IP address of a DB instance.This operation cannot be performed on frozen or abnormal instances.An in-use IP address cannot be used ",
"doc_type":"api",
"kw":"Changing a Private IP Address,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Changing a Private IP Address",
"githuburl":""
},
{
"uri":"dds_api_0120.html",
"node_id":"dds_api_0120.xml",
"product_code":"dds",
"code":"32",
"des":"This API is used to enable the IP addresses of shard or config nodes.Frozen instances do not support this operation.DB instances associated with the IPv6 subnet do not su",
"doc_type":"api",
"kw":"Enabling Shard or Config IP Addresses,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Enabling Shard or Config IP Addresses",
"githuburl":""
},
{
"uri":"dds_api_0104.html",
"node_id":"dds_api_0104.xml",
"product_code":"dds",
"code":"33",
"des":"This API is used to configure cross-CIDR access for a replica set instance.Only replica set instances are supported.URI formatPOST https://{Endpoint}/v3/{project_id}/inst",
"doc_type":"api",
"kw":"Configuring Cross-CIDR Access for a Replica Set,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Configuring Cross-CIDR Access for a Replica Set",
"githuburl":""
},
{
"uri":"dds_api_0138.html",
"node_id":"dds_api_0138.xml",
"product_code":"dds",
"code":"34",
"des":"This API is used to set the recycle bin policy for an instance.URI formatPUT https://{Endpoint}/v3/{project_id}/instances/recycle-policyPUT https://{Endpoint}/v3/{project",
"doc_type":"api",
"kw":"Setting the Recycle Bin Policy,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Setting the Recycle Bin Policy",
"githuburl":""
},
{
"uri":"dds_api_0215.html",
"node_id":"dds_api_0215.xml",
"product_code":"dds",
"code":"35",
"des":"This API is used to query the recycling policy of a DB instance.URI formatGET https://{Endpoint}/v3/{project_id}/instances/recycle-policyGET https://{Endpoint}/v3/{projec",
"doc_type":"api",
"kw":"Querying the Recycling Policy of a DB Instance,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Querying the Recycling Policy of a DB Instance",
"githuburl":""
},
{
"uri":"dds_api_021.html",
"node_id":"dds_api_021.xml",
"product_code":"dds",
"code":"36",
"des":"This API is used to query DB instances in the recycle bin.URI formatGET https://{Endpoint}/v3/{project_id}/recycle-instancesGET https://{Endpoint}/v3/{project_id}/recycle",
"doc_type":"api",
"kw":"Querying DB Instances in the Recycle Bin,DB Instance Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Querying DB Instances in the Recycle Bin",
"githuburl":""
},
{
"uri":"dds_connect_0001.html",
"node_id":"dds_connect_0001.xml",
"product_code":"dds",
"code":"37",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Connection Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Connection Management",
"githuburl":""
},
{
"uri":"dds_connect_0002.html",
"node_id":"dds_connect_0002.xml",
"product_code":"dds",
"code":"38",
"des":"This API is used to query sessions of instance nodes.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nod",
"doc_type":"api",
"kw":"Querying Sessions of an Instance Node,Connection Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Sessions of an Instance Node",
"githuburl":""
},
{
"uri":"dds_connect_0003.html",
"node_id":"dds_connect_0003.xml",
"product_code":"dds",
"code":"39",
"des":"This API is used to kill sessions of an instance node.Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.Inactive sessions cannot be terminated.URI formatPO",
"doc_type":"api",
"kw":"Killing Sessions of an Instance Node,Connection Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Killing Sessions of an Instance Node",
"githuburl":""
},
{
"uri":"dds_connect_0004.html",
"node_id":"dds_connect_0004.xml",
"product_code":"dds",
"code":"40",
"des":"This API is used to query the number of connections from each client to DDS DB instances.Frozen instances do not support this operation.URI formatGET https://{Endpoint}/v",
"doc_type":"api",
"kw":"Querying the Number of Connections to an Instance Node,Connection Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the Number of Connections to an Instance Node",
"githuburl":""
},
{
"uri":"dds_backup_restore.html",
"node_id":"dds_backup_restore.xml",
"product_code":"dds",
"code":"41",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Backup and Restoration",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Backup and Restoration",
"githuburl":""
},
{
"uri":"dds_api_0027.html",
"node_id":"dds_api_0027.xml",
"product_code":"dds",
"code":"42",
"des":"This API is used to create a manual backup for a DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/backupsPOST https://{Endpoint}/v3/{project_id}/backupsParam",
"doc_type":"api",
"kw":"Creating a Manual Backup,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Creating a Manual Backup",
"githuburl":""
},
{
"uri":"dds_api_0028.html",
"node_id":"dds_api_0028.xml",
"product_code":"dds",
"code":"43",
"des":"This API is used to delete a manual backup for a DB instance.URI formatDELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}DELETE https://{Endpoint}/v3/{project_",
"doc_type":"api",
"kw":"Deleting a Manual Backup,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Deleting a Manual Backup",
"githuburl":""
},
{
"uri":"dds_api_0029.html",
"node_id":"dds_api_0029.xml",
"product_code":"dds",
"code":"44",
"des":"This API is used to query backups based on specified conditions.URI formatGET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&b",
"doc_type":"api",
"kw":"Querying the Backup List,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the Backup List",
"githuburl":""
},
{
"uri":"dds_api_0030.html",
"node_id":"dds_api_0030.xml",
"product_code":"dds",
"code":"45",
"des":"This API is used to query an automated backup policy.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyGET https://{Endpoint}/v3/{pro",
"doc_type":"api",
"kw":"Querying an Automated Backup Policy,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying an Automated Backup Policy",
"githuburl":""
},
{
"uri":"dds_api_0031.html",
"node_id":"dds_api_0031.xml",
"product_code":"dds",
"code":"46",
"des":"This API is used to set an automated backup policy.URI formatPUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policyPUT https://{Endpoint}/v3/{proje",
"doc_type":"api",
"kw":"Setting an Automated Backup Policy,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Setting an Automated Backup Policy",
"githuburl":""
},
{
"uri":"dds_api_0038.html",
"node_id":"dds_api_0038.xml",
"product_code":"dds",
"code":"47",
"des":"This API is used to restore a backup to a new DB instance.The database type of the destination DB instance must be the same as that of the source DB instance.Currently, o",
"doc_type":"api",
"kw":"Restoring Data to a New DB Instance,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Restoring Data to a New DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0059.html",
"node_id":"dds_api_0059.xml",
"product_code":"dds",
"code":"48",
"des":"This API is used to obtain the link for downloading a backup file.The backup download link is valid within 15 minutes after being updated.URI formatGET https://{Endpoint}",
"doc_type":"api",
"kw":"Obtaining the Link for Downloading a Backup File,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining the Link for Downloading a Backup File",
"githuburl":""
},
{
"uri":"dds_api_0080.html",
"node_id":"dds_api_0080.xml",
"product_code":"dds",
"code":"49",
"des":"This API is used to query the restoration time range of a DB instance.Currently, this API only supports replica set instances and cluster instances 4.0.URI formatGET http",
"doc_type":"api",
"kw":"Querying the Restoration Time Ranges,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying the Restoration Time Ranges",
"githuburl":""
},
{
"uri":"dds_api_0081.html",
"node_id":"dds_api_0081.xml",
"product_code":"dds",
"code":"50",
"des":"This API is used to obtain the list of databases that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{in",
"doc_type":"api",
"kw":"Obtaining the List of Databases That Can Be Restored,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining the List of Databases That Can Be Restored",
"githuburl":""
},
{
"uri":"dds_api_0082.html",
"node_id":"dds_api_0082.xml",
"product_code":"dds",
"code":"51",
"des":"This API is used to obtain the list of databases collections that can be restored.This API applies only to replica sets.URI formatGET https://{Endpoint}/v3/{project_id}/i",
"doc_type":"api",
"kw":"Obtaining the List of Database Collections That Can Be Restored,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining the List of Database Collections That Can Be Restored",
"githuburl":""
},
{
"uri":"dds_api_0083.html",
"node_id":"dds_api_0083.xml",
"product_code":"dds",
"code":"52",
"des":"This API is used to restore data to the original DB instance.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/recoveryPOST https://{Endpoint}/v3/{project_id}/i",
"doc_type":"api",
"kw":"Restoring Data to the Original DB Instance,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Restoring Data to the Original DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0084.html",
"node_id":"dds_api_0084.xml",
"product_code":"dds",
"code":"53",
"des":"This API is used to restore databases and tables at a point in time.This API applies only to replica sets.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{ins",
"doc_type":"api",
"kw":"Restoring Databases and Tables to a Point in Time,Backup and Restoration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Restoring Databases and Tables to a Point in Time",
"githuburl":""
},
{
"uri":"dds_api_0085.html",
"node_id":"dds_api_0085.xml",
"product_code":"dds",
"code":"54",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Parameter Configuration",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Parameter Configuration",
"githuburl":""
},
{
"uri":"dds_api_0088.html",
"node_id":"dds_api_0088.xml",
"product_code":"dds",
"code":"55",
"des":"This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.This API applies only to DDS Com",
"doc_type":"api",
"kw":"Obtaining Parameter Templates,Parameter Configuration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Obtaining Parameter Templates",
"githuburl":""
},
{
"uri":"dds_api_0089.html",
"node_id":"dds_api_0089.xml",
"product_code":"dds",
"code":"56",
"des":"This API is used to obtain parameter details of a specified parameter template.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{project",
"doc_type":"api",
"kw":"Obtaining Details About a Parameter Template,Parameter Configuration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Obtaining Details About a Parameter Template",
"githuburl":""
},
{
"uri":"dds_api_0107.html",
"node_id":"dds_api_0107.xml",
"product_code":"dds",
"code":"57",
"des":"This API is used to change a parameter template for a specified DB instance.URI formatPUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applyPUT https://{",
"doc_type":"api",
"kw":"Applying a Parameter Template,Parameter Configuration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Applying a Parameter Template",
"githuburl":""
},
{
"uri":"dds_api_0108.html",
"node_id":"dds_api_0108.xml",
"product_code":"dds",
"code":"58",
"des":"This API is used to obtain information about parameters of a specified DB instance.This API applies only to DDS Community Edition.URI formatGET https://{Endpoint}/v3/{pro",
"doc_type":"api",
"kw":"Obtaining Parameters of a Specified DB Instance,Parameter Configuration,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds",
"opensource":"true",
"IsBot":"Yes",
"IsMulti":"Yes"
}
],
"title":"Obtaining Parameters of a Specified DB Instance",
"githuburl":""
},
{
"uri":"dds_api_0092.html",
"node_id":"dds_api_0092.xml",
"product_code":"dds",
"code":"59",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Log Information Queries",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Log Information Queries",
"githuburl":""
},
{
"uri":"dds_api_0093.html",
"node_id":"dds_api_0093.xml",
"product_code":"dds",
"code":"60",
"des":"This API is used to query database slow logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpoi",
"doc_type":"api",
"kw":"Querying Database Slow Logs,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Database Slow Logs",
"githuburl":""
},
{
"uri":"dds_api_0094.html",
"node_id":"dds_api_0094.xml",
"product_code":"dds",
"code":"61",
"des":"This API is used to obtain links for downloading slow query logs.The link for downloading slow query logs is valid within 15 minutes after being updated.URI formatPOSThtt",
"doc_type":"api",
"kw":"Obtaining Links for Downloading Slow Query Logs,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining Links for Downloading Slow Query Logs",
"githuburl":""
},
{
"uri":"dds_api_0095.html",
"node_id":"dds_api_0095.xml",
"product_code":"dds",
"code":"62",
"des":"This API is used to query database error logs.A maximum of 2000 records can be queried within the period specified by start_date and end_date.URI formatGET https://{Endpo",
"doc_type":"api",
"kw":"Querying Database Error Logs,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Database Error Logs",
"githuburl":""
},
{
"uri":"dds_api_0096.html",
"node_id":"dds_api_0096.xml",
"product_code":"dds",
"code":"63",
"des":"This API is used to obtain the download link of error logs.The link for downloading error logs is valid within 15 minutes after being updated.URI formatPOST https://{Endp",
"doc_type":"api",
"kw":"Obtaining Links for Downloading Error Logs,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining Links for Downloading Error Logs",
"githuburl":""
},
{
"uri":"dds_api_0097.html",
"node_id":"dds_api_0097.xml",
"product_code":"dds",
"code":"64",
"des":"This API is used to set a policy for SQL audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyPOST https://{Endpoint}/v3/{p",
"doc_type":"api",
"kw":"Setting SQL Audit,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Setting SQL Audit",
"githuburl":""
},
{
"uri":"dds_api_0098.html",
"node_id":"dds_api_0098.xml",
"product_code":"dds",
"code":"65",
"des":"This API is used to query the policy for SQL audit logs.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policyGET https://{Endpoint}/v3/",
"doc_type":"api",
"kw":"Querying SQL Audit Policy,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying SQL Audit Policy",
"githuburl":""
},
{
"uri":"dds_api_0099.html",
"node_id":"dds_api_0099.xml",
"product_code":"dds",
"code":"66",
"des":"This API is used to obtain an audit log list.URI formatGET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}",
"doc_type":"api",
"kw":"Obtaining the Audit Log List,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining the Audit Log List",
"githuburl":""
},
{
"uri":"dds_api_0100.html",
"node_id":"dds_api_0100.xml",
"product_code":"dds",
"code":"67",
"des":"This API is used to obtain the link for downloading audit logs.URI formatPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-linksPOST https://{Endpo",
"doc_type":"api",
"kw":"Obtaining Links for Downloading Audit Logs,Log Information Queries,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining Links for Downloading Audit Logs",
"githuburl":""
},
{
"uri":"dds_tag_mgmt.html",
"node_id":"dds_tag_mgmt.xml",
"product_code":"dds",
"code":"68",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Tag Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Tag Management",
"githuburl":""
},
{
"uri":"dds_api_0032.html",
"node_id":"dds_api_0032.xml",
"product_code":"dds",
"code":"69",
"des":"This API is used to query the specified DB instances by tag.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatPOST https://{Endpoin",
"doc_type":"api",
"kw":"Querying Resources by Tag,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Resources by Tag",
"githuburl":""
},
{
"uri":"dds_api_0033.html",
"node_id":"dds_api_0033.xml",
"product_code":"dds",
"code":"70",
"des":"This API is used to add or delete tags of the specified instance in batches.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.If the request ",
"doc_type":"api",
"kw":"Adding or Deleting Resource Tags in Batches,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Adding or Deleting Resource Tags in Batches",
"githuburl":""
},
{
"uri":"dds_api_0034.html",
"node_id":"dds_api_0034.xml",
"product_code":"dds",
"code":"71",
"des":"This API is used to query tags of a specified resource.A maximum of 20 tags can be added to a DB instance. The tag key must be unique.URI formatGET https://{Endpoint}/v3/",
"doc_type":"api",
"kw":"Querying Resource Tags,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Resource Tags",
"githuburl":""
},
{
"uri":"dds_api_0035.html",
"node_id":"dds_api_0035.xml",
"product_code":"dds",
"code":"72",
"des":"This API is used to query all tags of instances in a specified project.URI formatGET https://{Endpoint}/v3/{project_id}/tagsGET https://{Endpoint}/v3/{project_id}/tagsPar",
"doc_type":"api",
"kw":"Querying Tags in a Specified Project,Tag Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Querying Tags in a Specified Project",
"githuburl":""
},
{
"uri":"dds_api_0070.html",
"node_id":"dds_api_0070.xml",
"product_code":"dds",
"code":"73",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Managing Databases and Users",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Managing Databases and Users",
"githuburl":""
},
{
"uri":"dds_api_0075.html",
"node_id":"dds_api_0075.xml",
"product_code":"dds",
"code":"74",
"des":"This API is used to change the password of a database userThis operation cannot be performed on frozen or abnormal instances.URI formatPUT https://{Endpoint}/v3/{project_",
"doc_type":"api",
"kw":"Changing the Password of a Database User,Managing Databases and Users,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Changing the Password of a Database User",
"githuburl":""
},
{
"uri":"dds_api_0117.html",
"node_id":"dds_api_0117.xml",
"product_code":"dds",
"code":"75",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Task Management",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Task Management",
"githuburl":""
},
{
"uri":"dds_api_0118.html",
"node_id":"dds_api_0118.xml",
"product_code":"dds",
"code":"76",
"des":"This API is used to obtain information about a task with a specified ID in the task center.Currently, only asynchronous tasks in the task center of DDS Community Edition ",
"doc_type":"api",
"kw":"Obtaining Information About a Task with a Specified ID,Task Management,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining Information About a Task with a Specified ID",
"githuburl":""
},
{
"uri":"dds_api_permission.html",
"node_id":"dds_api_permission.xml",
"product_code":"dds",
"code":"77",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Permissions Policies and Supported Actions",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Permissions Policies and Supported Actions",
"githuburl":""
},
{
"uri":"dds_api_0036.html",
"node_id":"dds_api_0036.xml",
"product_code":"dds",
"code":"78",
"des":"This chapter describes fine-grained permissions management for your DDS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul",
"doc_type":"api",
"kw":"Introduction,Permissions Policies and Supported Actions,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Introduction",
"githuburl":""
},
{
"uri":"dds_api_0037.html",
"node_id":"dds_api_0037.xml",
"product_code":"dds",
"code":"79",
"des":"The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.",
"doc_type":"api",
"kw":"DDS Actions,Permissions Policies and Supported Actions,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"DDS Actions",
"githuburl":""
},
{
"uri":"dds_public_parameters.html",
"node_id":"dds_public_parameters.xml",
"product_code":"dds",
"code":"80",
"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":"dds"
}
],
"title":"Appendix",
"githuburl":""
},
{
"uri":"dds_api_0060.html",
"node_id":"dds_api_0060.xml",
"product_code":"dds",
"code":"81",
"des":"Abnormal responsesParameter descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_msgStringSpecifies th",
"doc_type":"api",
"kw":"Abnormal Request Results,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Abnormal Request Results",
"githuburl":""
},
{
"uri":"dds_status_code.html",
"node_id":"dds_status_code.xml",
"product_code":"dds",
"code":"82",
"des":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali",
"doc_type":"api",
"kw":"Status Code,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Status Code",
"githuburl":""
},
{
"uri":"dds_error_code.html",
"node_id":"dds_error_code.xml",
"product_code":"dds",
"code":"83",
"des":"If an error occurs in an API, no result is returned. You can locate the error cause based on the error codes of each API. When the invocation fails, an HTTP status code i",
"doc_type":"api",
"kw":"Error Code,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Error Code",
"githuburl":""
},
{
"uri":"dds_projectid.html",
"node_id":"dds_projectid.xml",
"product_code":"dds",
"code":"84",
"des":"A project ID is required for some URLs when an API is called. To obtain the project ID:Obtaining the Project ID by Calling an APIObtain a Project ID from the ConsoleThe A",
"doc_type":"api",
"kw":"Obtaining a Project ID,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"Obtaining a Project ID",
"githuburl":""
},
{
"uri":"dds_metrics.html",
"node_id":"dds_metrics.xml",
"product_code":"dds",
"code":"85",
"des":"This section describes metrics reported by Document Database Service (DDS) to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye",
"doc_type":"api",
"kw":"DDS Metrics,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"dds"
}
],
"title":"DDS Metrics",
"githuburl":""
},
{
"uri":"dds_change_history.html",
"node_id":"dds_change_history.xml",
"product_code":"dds",
"code":"86",
"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":"dds"
}
],
"title":"Change History",
"githuburl":""
}
]
View Git Blame Copy Permalink