From a6e39ff5b31dbc718fca0896dccca7b2387c5ab0 Mon Sep 17 00:00:00 2001 From: "Ru, Li Yi" Date: Mon, 27 May 2024 08:52:30 +0000 Subject: [PATCH] DDS_API Reviewed-by: Boka, Ladislav Co-authored-by: Ru, Li Yi Co-committed-by: Ru, Li Yi --- docs/dds/api-ref/ALL_META.TXT.json | 299 ++++++++++++------ docs/dds/api-ref/CLASS.TXT.json | 143 ++++++--- docs/dds/api-ref/dds_api_0015.html | 2 +- docs/dds/api-ref/dds_api_0020.html | 72 ++--- docs/dds/api-ref/dds_api_0021.html | 4 +- docs/dds/api-ref/dds_api_0022.html | 4 +- docs/dds/api-ref/dds_api_0024.html | 4 +- docs/dds/api-ref/dds_api_0025.html | 4 +- docs/dds/api-ref/dds_api_0026.html | 4 +- docs/dds/api-ref/dds_api_0038.html | 72 ++--- docs/dds/api-ref/dds_api_0039.html | 4 +- docs/dds/api-ref/dds_api_0050.html | 4 +- docs/dds/api-ref/dds_api_0085.html | 21 ++ docs/dds/api-ref/dds_api_0088.html | 218 +++++++++++++ docs/dds/api-ref/dds_api_0089.html | 224 +++++++++++++ docs/dds/api-ref/dds_api_0107.html | 119 +++++++ docs/dds/api-ref/dds_api_0108.html | 255 +++++++++++++++ docs/dds/api-ref/dds_api_0120.html | 4 +- docs/dds/api-ref/dds_api_description.html | 2 + docs/dds/api-ref/dds_projectid.html | 2 +- ...2.png => en-us_image_0000001803204856.png} | Bin ...1.jpg => en-us_image_0000001803204868.jpg} | Bin 22 files changed, 1225 insertions(+), 236 deletions(-) create mode 100644 docs/dds/api-ref/dds_api_0085.html create mode 100644 docs/dds/api-ref/dds_api_0088.html create mode 100644 docs/dds/api-ref/dds_api_0089.html create mode 100644 docs/dds/api-ref/dds_api_0107.html create mode 100644 docs/dds/api-ref/dds_api_0108.html rename docs/dds/api-ref/{en-us_image_0000001336985362.png => en-us_image_0000001803204856.png} (100%) rename docs/dds/api-ref/{en-us_image_0000001387625321.jpg => en-us_image_0000001803204868.jpg} (100%) diff --git a/docs/dds/api-ref/ALL_META.TXT.json b/docs/dds/api-ref/ALL_META.TXT.json index 5ad091bb..edeef6ab 100644 --- a/docs/dds/api-ref/ALL_META.TXT.json +++ b/docs/dds/api-ref/ALL_META.TXT.json @@ -1,6 +1,6 @@ [ { - "dockw":"dds api" + "dockw":"API Reference" }, { "uri":"dds_api_reference.html", @@ -9,7 +9,7 @@ "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,dds api", + "kw":"Before You Start,API Reference", "search_title":"", "metedata":[ { @@ -27,7 +27,7 @@ "code":"2", "des":"DDS provides extension APIs, allowing you to perform specific operations using APIs.", "doc_type":"api", - "kw":"API Overview,dds api", + "kw":"API Overview,API Reference", "search_title":"", "metedata":[ { @@ -63,7 +63,7 @@ "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,dds api", + "kw":"Authentication,Environment Preparations,API Reference", "search_title":"", "metedata":[ { @@ -99,7 +99,7 @@ "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,dds api", + "kw":"Scenarios,API Calling,API Reference", "search_title":"", "metedata":[ { @@ -117,7 +117,7 @@ "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,dds api", + "kw":"REST APIs,API Calling,API Reference", "search_title":"", "metedata":[ { @@ -135,7 +135,7 @@ "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,dds api", + "kw":"Example,API Calling,API Reference", "search_title":"", "metedata":[ { @@ -189,7 +189,7 @@ "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,dds api", + "kw":"Querying the API Version List,Querying the API Version,API Reference", "search_title":"", "metedata":[ { @@ -207,7 +207,7 @@ "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,dds api", + "kw":"Querying API Version Information,Querying the API Version,API Reference", "search_title":"", "metedata":[ { @@ -225,7 +225,7 @@ "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),dds api", + "kw":"Querying Database Version Information,APIs V3.0 (Recommended),API Reference", "search_title":"", "metedata":[ { @@ -243,7 +243,7 @@ "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),dds api", + "kw":"Querying Database Specifications,APIs V3.0 (Recommended),API Reference", "search_title":"", "metedata":[ { @@ -261,7 +261,7 @@ "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),dds api", + "kw":"Querying the Database Disk Type,APIs V3.0 (Recommended),API Reference", "search_title":"", "metedata":[ { @@ -297,7 +297,7 @@ "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,dds api", + "kw":"Creating a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -315,7 +315,7 @@ "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,dds api", + "kw":"Restarting a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -333,7 +333,7 @@ "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,dds api", + "kw":"Deleting a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -351,7 +351,7 @@ "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,dds api", + "kw":"Querying Instances and Details,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -369,7 +369,7 @@ "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,dds api", + "kw":"Scaling Up Storage Space,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -387,7 +387,7 @@ "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,dds api", + "kw":"Adding Nodes for a Cluster Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -405,7 +405,7 @@ "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,dds api", + "kw":"Modifying DB Instance Specifications,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -423,7 +423,7 @@ "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,dds api", + "kw":"Performing a Primary/Secondary Switchover in a Replica Set Instance,DB Instance Management,API Refer", "search_title":"", "metedata":[ { @@ -441,7 +441,7 @@ "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,dds api", + "kw":"Enabling or Disabling SSL,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -459,7 +459,7 @@ "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,dds api", + "kw":"Modifying a DB Instance Name,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -477,7 +477,7 @@ "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,dds api", + "kw":"Changing a Database Port,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -495,7 +495,7 @@ "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,dds api", + "kw":"Changing a Security Group,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -513,7 +513,7 @@ "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,dds api", + "kw":"Binding an EIP,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -531,7 +531,7 @@ "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,dds api", + "kw":"Unbinding an EIP,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -549,7 +549,7 @@ "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,dds api", + "kw":"Changing a Private IP Address,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -567,7 +567,7 @@ "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,dds api", + "kw":"Enabling Shard or Config IP Addresses,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -585,7 +585,7 @@ "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,dds api", + "kw":"Configuring Cross-CIDR Access for a Replica Set,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -603,7 +603,7 @@ "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,dds api", + "kw":"Setting the Recycle Bin Policy,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -624,7 +624,7 @@ "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,dds api", + "kw":"Querying the Recycling Policy of a DB Instance,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -645,7 +645,7 @@ "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,dds api", + "kw":"Querying DB Instances in the Recycle Bin,DB Instance Management,API Reference", "search_title":"", "metedata":[ { @@ -684,7 +684,7 @@ "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,dds api", + "kw":"Querying Sessions of an Instance Node,Connection Management,API Reference", "search_title":"", "metedata":[ { @@ -702,7 +702,7 @@ "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,dds api", + "kw":"Killing Sessions of an Instance Node,Connection Management,API Reference", "search_title":"", "metedata":[ { @@ -720,7 +720,7 @@ "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,dds api", + "kw":"Querying the Number of Connections to an Instance Node,Connection Management,API Reference", "search_title":"", "metedata":[ { @@ -756,7 +756,7 @@ "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,dds api", + "kw":"Creating a Manual Backup,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -774,7 +774,7 @@ "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,dds api", + "kw":"Deleting a Manual Backup,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -792,7 +792,7 @@ "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,dds api", + "kw":"Querying the Backup List,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -810,7 +810,7 @@ "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,dds api", + "kw":"Querying an Automated Backup Policy,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -828,7 +828,7 @@ "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,dds api", + "kw":"Setting an Automated Backup Policy,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -846,7 +846,7 @@ "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,dds api", + "kw":"Restoring Data to a New DB Instance,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -864,7 +864,7 @@ "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,dds api", + "kw":"Obtaining the Link for Downloading a Backup File,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -882,7 +882,7 @@ "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,dds api", + "kw":"Querying the Restoration Time Ranges,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -900,7 +900,7 @@ "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,dds api", + "kw":"Obtaining the List of Databases That Can Be Restored,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -918,7 +918,7 @@ "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,dds api", + "kw":"Obtaining the List of Database Collections That Can Be Restored,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -936,7 +936,7 @@ "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,dds api", + "kw":"Restoring Data to the Original DB Instance,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -954,7 +954,7 @@ "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,dds api", + "kw":"Restoring Databases and Tables to a Point in Time,Backup and Restoration,API Reference", "search_title":"", "metedata":[ { @@ -965,11 +965,116 @@ "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":"54", + "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", @@ -987,10 +1092,10 @@ "uri":"dds_api_0093.html", "node_id":"dds_api_0093.xml", "product_code":"dds", - "code":"55", + "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,dds api", + "kw":"Querying Database Slow Logs,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1005,10 +1110,10 @@ "uri":"dds_api_0094.html", "node_id":"dds_api_0094.xml", "product_code":"dds", - "code":"56", + "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,dds api", + "kw":"Obtaining Links for Downloading Slow Query Logs,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1023,10 +1128,10 @@ "uri":"dds_api_0095.html", "node_id":"dds_api_0095.xml", "product_code":"dds", - "code":"57", + "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,dds api", + "kw":"Querying Database Error Logs,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1041,10 +1146,10 @@ "uri":"dds_api_0096.html", "node_id":"dds_api_0096.xml", "product_code":"dds", - "code":"58", + "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,dds api", + "kw":"Obtaining Links for Downloading Error Logs,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1059,10 +1164,10 @@ "uri":"dds_api_0097.html", "node_id":"dds_api_0097.xml", "product_code":"dds", - "code":"59", + "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,dds api", + "kw":"Setting SQL Audit,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1077,10 +1182,10 @@ "uri":"dds_api_0098.html", "node_id":"dds_api_0098.xml", "product_code":"dds", - "code":"60", + "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,dds api", + "kw":"Querying SQL Audit Policy,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1095,10 +1200,10 @@ "uri":"dds_api_0099.html", "node_id":"dds_api_0099.xml", "product_code":"dds", - "code":"61", + "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,dds api", + "kw":"Obtaining the Audit Log List,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1113,10 +1218,10 @@ "uri":"dds_api_0100.html", "node_id":"dds_api_0100.xml", "product_code":"dds", - "code":"62", + "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,dds api", + "kw":"Obtaining Links for Downloading Audit Logs,Log Information Queries,API Reference", "search_title":"", "metedata":[ { @@ -1131,7 +1236,7 @@ "uri":"dds_tag_mgmt.html", "node_id":"dds_tag_mgmt.xml", "product_code":"dds", - "code":"63", + "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", @@ -1149,10 +1254,10 @@ "uri":"dds_api_0032.html", "node_id":"dds_api_0032.xml", "product_code":"dds", - "code":"64", + "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,dds api", + "kw":"Querying Resources by Tag,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -1167,10 +1272,10 @@ "uri":"dds_api_0033.html", "node_id":"dds_api_0033.xml", "product_code":"dds", - "code":"65", + "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,dds api", + "kw":"Adding or Deleting Resource Tags in Batches,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -1185,10 +1290,10 @@ "uri":"dds_api_0034.html", "node_id":"dds_api_0034.xml", "product_code":"dds", - "code":"66", + "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,dds api", + "kw":"Querying Resource Tags,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -1203,10 +1308,10 @@ "uri":"dds_api_0035.html", "node_id":"dds_api_0035.xml", "product_code":"dds", - "code":"67", + "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,dds api", + "kw":"Querying Tags in a Specified Project,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -1221,7 +1326,7 @@ "uri":"dds_api_0070.html", "node_id":"dds_api_0070.xml", "product_code":"dds", - "code":"68", + "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", @@ -1239,10 +1344,10 @@ "uri":"dds_api_0075.html", "node_id":"dds_api_0075.xml", "product_code":"dds", - "code":"69", + "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,dds api", + "kw":"Changing the Password of a Database User,Managing Databases and Users,API Reference", "search_title":"", "metedata":[ { @@ -1257,7 +1362,7 @@ "uri":"dds_api_0117.html", "node_id":"dds_api_0117.xml", "product_code":"dds", - "code":"70", + "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", @@ -1275,10 +1380,10 @@ "uri":"dds_api_0118.html", "node_id":"dds_api_0118.xml", "product_code":"dds", - "code":"71", + "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,dds api", + "kw":"Obtaining Information About a Task with a Specified ID,Task Management,API Reference", "search_title":"", "metedata":[ { @@ -1293,7 +1398,7 @@ "uri":"dds_api_permission.html", "node_id":"dds_api_permission.xml", "product_code":"dds", - "code":"72", + "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", @@ -1311,10 +1416,10 @@ "uri":"dds_api_0036.html", "node_id":"dds_api_0036.xml", "product_code":"dds", - "code":"73", + "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,dds api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", "search_title":"", "metedata":[ { @@ -1329,10 +1434,10 @@ "uri":"dds_api_0037.html", "node_id":"dds_api_0037.xml", "product_code":"dds", - "code":"74", + "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,dds api", + "kw":"DDS Actions,Permissions Policies and Supported Actions,API Reference", "search_title":"", "metedata":[ { @@ -1347,7 +1452,7 @@ "uri":"dds_public_parameters.html", "node_id":"dds_public_parameters.xml", "product_code":"dds", - "code":"75", + "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", @@ -1365,10 +1470,10 @@ "uri":"dds_api_0060.html", "node_id":"dds_api_0060.xml", "product_code":"dds", - "code":"76", + "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,dds api", + "kw":"Abnormal Request Results,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -1383,10 +1488,10 @@ "uri":"dds_status_code.html", "node_id":"dds_status_code.xml", "product_code":"dds", - "code":"77", + "code":"82", "des":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", "doc_type":"api", - "kw":"Status Code,Appendix,dds api", + "kw":"Status Code,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -1401,10 +1506,10 @@ "uri":"dds_error_code.html", "node_id":"dds_error_code.xml", "product_code":"dds", - "code":"78", + "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,dds api", + "kw":"Error Code,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -1419,10 +1524,10 @@ "uri":"dds_projectid.html", "node_id":"dds_projectid.xml", "product_code":"dds", - "code":"79", + "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,dds api", + "kw":"Obtaining a Project ID,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -1437,10 +1542,10 @@ "uri":"dds_metrics.html", "node_id":"dds_metrics.xml", "product_code":"dds", - "code":"80", + "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,dds api", + "kw":"DDS Metrics,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -1455,10 +1560,10 @@ "uri":"dds_change_history.html", "node_id":"dds_change_history.xml", "product_code":"dds", - "code":"81", + "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,dds api", + "kw":"Change History,API Reference", "search_title":"", "metedata":[ { diff --git a/docs/dds/api-ref/CLASS.TXT.json b/docs/dds/api-ref/CLASS.TXT.json index 30b6603d..5a3b6ba1 100644 --- a/docs/dds/api-ref/CLASS.TXT.json +++ b/docs/dds/api-ref/CLASS.TXT.json @@ -476,6 +476,51 @@ "p_code":"41", "code":"53" }, + { + "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":"dds", + "title":"Parameter Configuration", + "uri":"dds_api_0085.html", + "doc_type":"api", + "p_code":"9", + "code":"54" + }, + { + "desc":"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", + "product_code":"dds", + "title":"Obtaining Parameter Templates", + "uri":"dds_api_0088.html", + "doc_type":"api", + "p_code":"54", + "code":"55" + }, + { + "desc":"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", + "product_code":"dds", + "title":"Obtaining Details About a Parameter Template", + "uri":"dds_api_0089.html", + "doc_type":"api", + "p_code":"54", + "code":"56" + }, + { + "desc":"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://{", + "product_code":"dds", + "title":"Applying a Parameter Template", + "uri":"dds_api_0107.html", + "doc_type":"api", + "p_code":"54", + "code":"57" + }, + { + "desc":"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", + "product_code":"dds", + "title":"Obtaining Parameters of a Specified DB Instance", + "uri":"dds_api_0108.html", + "doc_type":"api", + "p_code":"54", + "code":"58" + }, { "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":"dds", @@ -483,7 +528,7 @@ "uri":"dds_api_0092.html", "doc_type":"api", "p_code":"9", - "code":"54" + "code":"59" }, { "desc":"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", @@ -491,8 +536,8 @@ "title":"Querying Database Slow Logs", "uri":"dds_api_0093.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"59", + "code":"60" }, { "desc":"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", @@ -500,8 +545,8 @@ "title":"Obtaining Links for Downloading Slow Query Logs", "uri":"dds_api_0094.html", "doc_type":"api", - "p_code":"54", - "code":"56" + "p_code":"59", + "code":"61" }, { "desc":"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", @@ -509,8 +554,8 @@ "title":"Querying Database Error Logs", "uri":"dds_api_0095.html", "doc_type":"api", - "p_code":"54", - "code":"57" + "p_code":"59", + "code":"62" }, { "desc":"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", @@ -518,8 +563,8 @@ "title":"Obtaining Links for Downloading Error Logs", "uri":"dds_api_0096.html", "doc_type":"api", - "p_code":"54", - "code":"58" + "p_code":"59", + "code":"63" }, { "desc":"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", @@ -527,8 +572,8 @@ "title":"Setting SQL Audit", "uri":"dds_api_0097.html", "doc_type":"api", - "p_code":"54", - "code":"59" + "p_code":"59", + "code":"64" }, { "desc":"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/", @@ -536,8 +581,8 @@ "title":"Querying SQL Audit Policy", "uri":"dds_api_0098.html", "doc_type":"api", - "p_code":"54", - "code":"60" + "p_code":"59", + "code":"65" }, { "desc":"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}", @@ -545,8 +590,8 @@ "title":"Obtaining the Audit Log List", "uri":"dds_api_0099.html", "doc_type":"api", - "p_code":"54", - "code":"61" + "p_code":"59", + "code":"66" }, { "desc":"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", @@ -554,8 +599,8 @@ "title":"Obtaining Links for Downloading Audit Logs", "uri":"dds_api_0100.html", "doc_type":"api", - "p_code":"54", - "code":"62" + "p_code":"59", + "code":"67" }, { "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.", @@ -564,7 +609,7 @@ "uri":"dds_tag_mgmt.html", "doc_type":"api", "p_code":"9", - "code":"63" + "code":"68" }, { "desc":"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", @@ -572,8 +617,8 @@ "title":"Querying Resources by Tag", "uri":"dds_api_0032.html", "doc_type":"api", - "p_code":"63", - "code":"64" + "p_code":"68", + "code":"69" }, { "desc":"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 ", @@ -581,8 +626,8 @@ "title":"Adding or Deleting Resource Tags in Batches", "uri":"dds_api_0033.html", "doc_type":"api", - "p_code":"63", - "code":"65" + "p_code":"68", + "code":"70" }, { "desc":"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/", @@ -590,8 +635,8 @@ "title":"Querying Resource Tags", "uri":"dds_api_0034.html", "doc_type":"api", - "p_code":"63", - "code":"66" + "p_code":"68", + "code":"71" }, { "desc":"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", @@ -599,8 +644,8 @@ "title":"Querying Tags in a Specified Project", "uri":"dds_api_0035.html", "doc_type":"api", - "p_code":"63", - "code":"67" + "p_code":"68", + "code":"72" }, { "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.", @@ -609,7 +654,7 @@ "uri":"dds_api_0070.html", "doc_type":"api", "p_code":"9", - "code":"68" + "code":"73" }, { "desc":"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_", @@ -617,8 +662,8 @@ "title":"Changing the Password of a Database User", "uri":"dds_api_0075.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"73", + "code":"74" }, { "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.", @@ -627,7 +672,7 @@ "uri":"dds_api_0117.html", "doc_type":"api", "p_code":"9", - "code":"70" + "code":"75" }, { "desc":"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 ", @@ -635,8 +680,8 @@ "title":"Obtaining Information About a Task with a Specified ID", "uri":"dds_api_0118.html", "doc_type":"api", - "p_code":"70", - "code":"71" + "p_code":"75", + "code":"76" }, { "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.", @@ -645,7 +690,7 @@ "uri":"dds_api_permission.html", "doc_type":"api", "p_code":"", - "code":"72" + "code":"77" }, { "desc":"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", @@ -653,8 +698,8 @@ "title":"Introduction", "uri":"dds_api_0036.html", "doc_type":"api", - "p_code":"72", - "code":"73" + "p_code":"77", + "code":"78" }, { "desc":"The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.", @@ -662,8 +707,8 @@ "title":"DDS Actions", "uri":"dds_api_0037.html", "doc_type":"api", - "p_code":"72", - "code":"74" + "p_code":"77", + "code":"79" }, { "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.", @@ -672,7 +717,7 @@ "uri":"dds_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"75" + "code":"80" }, { "desc":"Abnormal responsesParameter descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_msgStringSpecifies th", @@ -680,8 +725,8 @@ "title":"Abnormal Request Results", "uri":"dds_api_0060.html", "doc_type":"api", - "p_code":"75", - "code":"76" + "p_code":"80", + "code":"81" }, { "desc":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", @@ -689,8 +734,8 @@ "title":"Status Code", "uri":"dds_status_code.html", "doc_type":"api", - "p_code":"75", - "code":"77" + "p_code":"80", + "code":"82" }, { "desc":"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", @@ -698,8 +743,8 @@ "title":"Error Code", "uri":"dds_error_code.html", "doc_type":"api", - "p_code":"75", - "code":"78" + "p_code":"80", + "code":"83" }, { "desc":"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", @@ -707,8 +752,8 @@ "title":"Obtaining a Project ID", "uri":"dds_projectid.html", "doc_type":"api", - "p_code":"75", - "code":"79" + "p_code":"80", + "code":"84" }, { "desc":"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", @@ -716,8 +761,8 @@ "title":"DDS Metrics", "uri":"dds_metrics.html", "doc_type":"api", - "p_code":"75", - "code":"80" + "p_code":"80", + "code":"85" }, { "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.", @@ -726,6 +771,6 @@ "uri":"dds_change_history.html", "doc_type":"api", "p_code":"", - "code":"81" + "code":"86" } ] \ No newline at end of file diff --git a/docs/dds/api-ref/dds_api_0015.html b/docs/dds/api-ref/dds_api_0015.html index 2f6c1431..70c9ddce 100644 --- a/docs/dds/api-ref/dds_api_0015.html +++ b/docs/dds/api-ref/dds_api_0015.html @@ -2,7 +2,7 @@

Scenarios

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 application scenarios are shown as follows.

-
Figure 1 Scenarios
+
Figure 1 Scenarios

Before creating a DB instance, you need to obtain the DB engines and versions, DB instance class, and AZs supported by the system.

After obtaining the information, you can use the returned results as invoked parameters to create a DB instance.

After a DB instance is created, you can query the instance list and delete the instance.

diff --git a/docs/dds/api-ref/dds_api_0020.html b/docs/dds/api-ref/dds_api_0020.html index 4b57aff2..aa14242b 100644 --- a/docs/dds/api-ref/dds_api_0020.html +++ b/docs/dds/api-ref/dds_api_0020.html @@ -735,69 +735,69 @@ Create a cluster instance:
-
Table 9 flavor field data structure description

Name

+
- - - - - - - - - - - - - - - - - - - - - - - @@ -1009,8 +1009,8 @@ Create a cluster instance: -

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0021.html b/docs/dds/api-ref/dds_api_0021.html index edfc2064..dc82a1c0 100644 --- a/docs/dds/api-ref/dds_api_0021.html +++ b/docs/dds/api-ref/dds_api_0021.html @@ -118,8 +118,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0022.html b/docs/dds/api-ref/dds_api_0022.html index c5ea4bbc..5b57bf71 100644 --- a/docs/dds/api-ref/dds_api_0022.html +++ b/docs/dds/api-ref/dds_api_0022.html @@ -60,8 +60,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0024.html b/docs/dds/api-ref/dds_api_0024.html index c0e2c862..6e3af58d 100644 --- a/docs/dds/api-ref/dds_api_0024.html +++ b/docs/dds/api-ref/dds_api_0024.html @@ -139,8 +139,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0025.html b/docs/dds/api-ref/dds_api_0025.html index 9ec431f6..02c32342 100644 --- a/docs/dds/api-ref/dds_api_0025.html +++ b/docs/dds/api-ref/dds_api_0025.html @@ -154,8 +154,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0026.html b/docs/dds/api-ref/dds_api_0026.html index 98ea9827..143f016c 100644 --- a/docs/dds/api-ref/dds_api_0026.html +++ b/docs/dds/api-ref/dds_api_0026.html @@ -162,8 +162,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0038.html b/docs/dds/api-ref/dds_api_0038.html index acf086dd..3ec5f898 100644 --- a/docs/dds/api-ref/dds_api_0038.html +++ b/docs/dds/api-ref/dds_api_0038.html @@ -601,69 +601,69 @@
Table 9 flavor field data structure description

Name

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

String

+

String

Specifies the node type.

-

Valid value:

-
  • For a cluster instance, the value can be mongos, shard, or config.
  • For a replica set instance, the value is replica.
  • For a single node instance, the value is single.
+

Specifies the node type.

+

Valid value:

+
  • For a cluster instance, the value can be mongos, shard, or config.
  • For a replica set instance, the value is replica.
  • For a single node instance, the value is single.

num

+

num

Yes

+

Yes

String

+

String

Specifies node quantity.

-

Valid value:

-
  • mongos: The value ranges from 2 to 32.
  • mongos: The value ranges from 2 to 32.
  • config: The value is 1.
  • replica: The number of nodes can be 3, 5, or 7.
  • single: The value is 1.
+

Specifies node quantity.

+

Valid value:

+
  • mongos: The value ranges from 2 to 32.
  • mongos: The value ranges from 2 to 32.
  • config: The value is 1.
  • replica: The number of nodes can be 3, 5, or 7.
  • single: The value is 1.

storage

+

storage

No

+

No

String

+

String

Specifies the disk type.

-

Valid value: ULTRAHIGH, which indicates the type SSD.

-

This parameter is valid for the shard and config nodes of a cluster instance, replica set instances, and single node instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.

+

Specifies the disk type.

+

Valid value: ULTRAHIGH, which indicates the type SSD.

+

This parameter is valid for the shard and config nodes of a cluster instance, replica set instances, and single node instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.

size

+

size

No

+

No

String

+

String

Specifies the disk size.

-

This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.

-

The value must be a multiple of 10. The unit is GB.

-
  • For a cluster instance, the storage space of a shard node can be 10 to 2000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
  • For a replica set instance, the value ranges from 10 to 2000.
  • For a single node instance, the value ranges from 10 to 1000.
+

Specifies the disk size.

+

This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.

+

The value must be a multiple of 10. The unit is GB.

+
  • For a cluster instance, the storage space of a shard node can be 10 to 2000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
  • For a replica set instance, the value ranges from 10 to 2000.
  • For a single node instance, the value ranges from 10 to 1000.

spec_code

+

spec_code

Yes

+

Yes

String

+

String

Specifies the resource specification code. For details about how to obtain the value, see the response values of spec_code in Querying Database Specifications.

-

In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).

+

Specifies the resource specification code. For details about how to obtain the value, see the response values of spec_code in Querying Database Specifications.

+

In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).
-
Table 8 flavor field data structure description

Name

+
- - - - - - - - - - - - - - - - - - - - - - - @@ -825,8 +825,8 @@ } -

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0039.html b/docs/dds/api-ref/dds_api_0039.html index c327206a..ec00d9db 100644 --- a/docs/dds/api-ref/dds_api_0039.html +++ b/docs/dds/api-ref/dds_api_0039.html @@ -160,8 +160,8 @@
-

Status Code

Status Code:200.

-

For more information, see Status Code.

+

Status Code

Status Code:200.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0050.html b/docs/dds/api-ref/dds_api_0050.html index 334f621d..b22393e7 100644 --- a/docs/dds/api-ref/dds_api_0050.html +++ b/docs/dds/api-ref/dds_api_0050.html @@ -62,8 +62,8 @@ }
-

Status Code

Status Code:202.

-

For more information, see Status Code.

+

Status Code

Status Code:202.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_0085.html b/docs/dds/api-ref/dds_api_0085.html new file mode 100644 index 00000000..a4ad8751 --- /dev/null +++ b/docs/dds/api-ref/dds_api_0085.html @@ -0,0 +1,21 @@ + + +

Parameter Configuration

+
+ + diff --git a/docs/dds/api-ref/dds_api_0088.html b/docs/dds/api-ref/dds_api_0088.html new file mode 100644 index 00000000..db06bc73 --- /dev/null +++ b/docs/dds/api-ref/dds_api_0088.html @@ -0,0 +1,218 @@ + + +

Obtaining Parameter Templates

+

Description

This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.

+
+

Restrictions

This API applies only to DDS Community Edition.

+
+

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/configurations

    +
+
+ +
Table 8 flavor field data structure description

Name

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

Yes

+

Yes

String

+

String

Specifies the node type.

-

Valid value:

-
  • For a cluster instance, the value can be mongos, shard, or config.
  • For a replica set instance, the value is replica.
  • For a single node instance, the value is single.
+

Specifies the node type.

+

Valid value:

+
  • For a cluster instance, the value can be mongos, shard, or config.
  • For a replica set instance, the value is replica.
  • For a single node instance, the value is single.

num

+

num

Yes

+

Yes

String

+

String

Specifies node quantity.

-

Valid value:

-
  • mongos: The value ranges from 2 to 32.
  • mongos: The value ranges from 2 to 32.
  • config: The value is 1.
  • replica: The number of nodes can be 3, 5, or 7.
  • single: The value is 1.
+

Specifies node quantity.

+

Valid value:

+
  • mongos: The value ranges from 2 to 32.
  • mongos: The value ranges from 2 to 32.
  • config: The value is 1.
  • replica: The number of nodes can be 3, 5, or 7.
  • single: The value is 1.

storage

+

storage

No

+

No

String

+

String

Specifies the disk type.

-

Valid value: ULTRAHIGH, which indicates the type SSD.

-

This parameter is valid for the shard and config nodes of a cluster instance, replica set instances, and single node instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.

+

Specifies the disk type.

+

Valid value: ULTRAHIGH, which indicates the type SSD.

+

This parameter is valid for the shard and config nodes of a cluster instance, replica set instances, and single node instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.

size

+

size

No

+

No

String

+

String

Specifies the disk size.

-

This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.

-

The value must be a multiple of 10. The unit is GB.

-
  • For a cluster instance, the storage space of a shard node can be 10 to 2000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
  • For a replica set instance, the value ranges from 10 to 2000.
  • For a single node instance, the value ranges from 10 to 1000.
+

Specifies the disk size.

+

This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes.

+

The value must be a multiple of 10. The unit is GB.

+
  • For a cluster instance, the storage space of a shard node can be 10 to 2000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
  • For a replica set instance, the value ranges from 10 to 2000.
  • For a single node instance, the value ranges from 10 to 1000.

spec_code

+

spec_code

Yes

+

Yes

String

+

String

Specifies the resource specification code. For details about how to obtain the value, see the response values of spec_code in Querying Database Specifications.

-

In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).

+

Specifies the resource specification code. For details about how to obtain the value, see the response values of spec_code in Querying Database Specifications.

+

In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6).
+ + + + + + + + + + + + + + + + +
Table 1 Request parameters

Name

+

Type

+

Mandatory

+

Description

+

x-auth-token

+

String

+

Yes

+

User token.

+

project_id

+

String

+

Yes

+

Specifies the project ID of a tenant in a region.

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

Parameter

+

Type

+

Mandatory

+

Description

+

offset

+

Integer

+

No

+

The index position. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

+

limit

+

Integer

+

No

+

Number of records displayed on each page. The default value is 100.

+
+
+

Requests

None

+
+

Responses

  • Parameter description +
    + + + + + + + + + + + + + + + + + +
    Table 3 Response body parameters

    Name

    +

    Type

    +

    Description

    +

    total_count

    +

    Integer

    +

    The total number of queried records.

    +

    quota

    +

    Integer

    +

    Maximum number of custom parameter templates that can be created.

    +

    configurations

    +

    Array of objects

    +

    The parameter template list. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Data structure description of the configurations field

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Parameter template ID.

    +

    name

    +

    String

    +

    Parameter template name.

    +

    description

    +

    String

    +

    Parameter template description.

    +

    datastore_version

    +

    String

    +

    Database version.

    +

    datastore_name

    +

    String

    +

    Database type.

    +

    node_type

    +

    String

    +

    Node type of the parameter template.

    +
    • mongos: the mongos node type.
    • shard: the shard node type.
    • config: the config node type.
    • replica: the replica set type.
    • single the single node type.
    +

    created

    +

    String

    +

    Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    updated

    +

    String

    +

    Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    user_defined

    +

    Boolean

    +

    Indicates whether the parameter template is created by users.

    +
    • false: The parameter template is a default parameter template.
    • true: The parameter template is a custom template.
    +
    +
    +
+
  • Response example
    { 
+  "total_count" : 1,
+  "quota" : 100, 
+  "configurations" : [ { 
+    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", 
+    "name" : "test1", 
+    "description" : "", 
+    "datastore_name" : "mongos", 
+    "node_type":"shard",
+    "datastore_version" : "4.0", 
+    "created" : "2017-01-01T10:00:00", 
+    "updated" : "2017-01-01T10:00:00", 
+    "user_defined" : true 
+  } ] 
+}
    +
+
+

Status Code

Status Code:200.

+

For more information, see Status Code.

+
+

Error Code

For more information, see Error Code.

+
+ +
+
+
Parent topic: Parameter Configuration
+
+
+ diff --git a/docs/dds/api-ref/dds_api_0089.html b/docs/dds/api-ref/dds_api_0089.html new file mode 100644 index 00000000..82accd47 --- /dev/null +++ b/docs/dds/api-ref/dds_api_0089.html @@ -0,0 +1,224 @@ + + +

Obtaining Details About a Parameter Template

+

Description

This API is used to obtain parameter details of a specified parameter template.

+
+

Restrictions

This API applies only to DDS Community Edition.

+
+

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}

    +
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Request parameters

Name

+

Type

+

Mandatory

+

Description

+

x-auth-token

+

String

+

Yes

+

User token.

+

project_id

+

String

+

Yes

+

Specifies the project ID of a tenant in a region.

+

config_id

+

String

+

Yes

+

Parameter template ID.

+
+
+

Requests

None

+
+

Responses

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response body parameters

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    The parameter template ID.

    +

    name

    +

    String

    +

    Parameter template name.

    +

    datastore_version

    +

    String

    +

    Database version.

    +

    datastore_name

    +

    String

    +

    Database type.

    +

    description

    +

    String

    +

    The parameter template description.

    +

    created

    +

    String

    +

    Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    updated

    +

    String

    +

    Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    parameters

    +

    Array of objects

    +

    The parameters defined by users based on the default parameter templates.

    +

    For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Data structure description of the parameters field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    The parameter name.

    +

    value

    +

    String

    +

    The parameter value.

    +

    description

    +

    String

    +

    The parameter description.

    +

    type

    +

    String

    +

    Parameter type.

    +

    The value can be integer, string, boolean, float, or list.

    +

    value_range

    +

    String

    +

    Value range.

    +

    For example, the value of integer is 0 or 1, and the value of boolean is true or false.

    +

    restart_required

    +

    Boolean

    +

    Whether the instance needs to be restarted.

    +
    • If the value is true, restart is required.
    • If the value is false, restart is not required.
    +

    readonly

    +

    Boolean

    +

    Whether the parameter is read-only.

    +
    • If the value is true, the parameter is read-only.
    • If the value false, the parameter is not read-only.
    +
    +
    +
+
  • Response example
    {
+  "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
+  "name": "paramsGroup-test",
+  "description": "",
+  "datastore_name": "mongodb",
+  "datastore_version": "4.0",
+  "created": "2017-01-01T10:00:00",
+  "updated": "2017-01-01T10:00:00",
+  "parameters": [
+    {
+      "name": "cursorTimeoutMillis",
+      "type": "integer",
+      "value": "600000",
+      "description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
+      "value_range": "600000-1000000",
+      "restart_required": false,
+      "readonly": false
+    }
+  ]
+}
    +
+
+

Status Code

Status Code:200.

+

For more information, see Status Code.

+
+

Error Code

For more information, see Error Code.

+
+
+
+
+
Parent topic: Parameter Configuration
+
+
+ diff --git a/docs/dds/api-ref/dds_api_0107.html b/docs/dds/api-ref/dds_api_0107.html new file mode 100644 index 00000000..a6bd6a3e --- /dev/null +++ b/docs/dds/api-ref/dds_api_0107.html @@ -0,0 +1,119 @@ + + +

Applying a Parameter Template

+

Description

This API is used to change a parameter template for a specified DB instance.

+
+

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply

    +
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Request parameters

Name

+

Type

+

Mandatory

+

Description

+

x-auth-token

+

String

+

Yes

+

User token.

+

project_id

+

String

+

Yes

+

Specifies the project ID of a tenant in a region.

+

config_id

+

String

+

Yes

+

Parameter template ID.

+
+
+

Requests

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Request body parameters

    Name

    +

    Mandatory

    +

    Type

    +

    Description

    +

    entity_ids

    +

    Yes

    +

    Array of strings

    +
    Instance IDs, group IDs, or node IDs. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating an instance.
    • If the DB instance type is cluster and the shard or config parameter template is to be changed, the value is the group ID. If the parameter template of the mongos node is changed, the value is the node ID.
    +
    +
    • If the DB instance to be changed is a replica set instance or a single node instance, the value is the instance ID.
    +
    +
    +
+
+

Example Request

Applying a parameter template whose entity_ids is 73ea2bf70c73497f89ee0ad4ee008aa2no02 to a specified DB instance
{
+  "entity_ids": [
+    "73ea2bf70c73497f89ee0ad4ee008aa2no02"
+  ]
+}
+
+
+

Responses

  • Parameter description +
    + + + + + + + + + +
    Table 3 Response body parameters

    Name

    +

    Type

    +

    Description

    +

    job_id

    +

    String

    +

    Indicates the ID of the asynchronous task for applying a parameter template.

    +
    +
    +
  • Response example
    { 
+  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
+}
    +
+
+

Status Code

Status Code:200.

+

For more information, see Status Code.

+
+

Error Code

For more information, see Error Code.

+
+
+
+
+
Parent topic: Parameter Configuration
+
+
+ diff --git a/docs/dds/api-ref/dds_api_0108.html b/docs/dds/api-ref/dds_api_0108.html new file mode 100644 index 00000000..3a5d2723 --- /dev/null +++ b/docs/dds/api-ref/dds_api_0108.html @@ -0,0 +1,255 @@ + + +

Obtaining Parameters of a Specified DB Instance

+

Description

This API is used to obtain information about parameters of a specified DB instance.

+
+

Restrictions

This API applies only to DDS Community Edition.

+
+

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

    +
+
+

Requests

Parameter description

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Request parameters

Name

+

Type

+

IN

+

Mandatory

+

Description

+

x-auth-token

+

string

+

header

+

Yes

+

User token.

+

Content-Type

+

string

+

header

+

Yes

+

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

+

project_id

+

string

+

path

+

Yes

+

Specifies the project ID of a tenant in a region.

+

instance_id

+

string

+

path

+

Yes

+

Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.

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

Parameter

+

Type

+

Mandatory

+

Description

+

entity_id

+

String

+

Yes

+
  • Instance ID, group ID, or node ID. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating an instance.
  • If the DB instance type is cluster and the shard or config parameter template is obtained, the value is the group ID. If the parameter template of the mongos node is obtained, the value is the node ID.
  • If the DB instance type is a replica set instance or a single node instance, the value is the instance ID.
+
+
+
+

Responses

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Response body parameters

    Name

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Instance parameter configuration ID. This parameter can be used only for parameter comparison.

    +

    node_type

    +

    String

    +

    Node type of the parameter template.

    +
    • mongos: the mongos node type.
    • shard: the shard node type.
    • config: the config node type.
    • replica: the replica set type.
    • single: the single node type.
    • readonly: the read replica type.
    +

    datastore_version

    +

    String

    +

    Database version.

    +

    datastore_name

    +

    String

    +

    Database type.

    +

    created

    +

    String

    +

    Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    updated

    +

    String

    +

    Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.

    +

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

    +

    parameters

    +

    Array of objects

    +

    Indicates the parameters defined by users based on the default parameter templates.

    +

    For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Data structure description of the parameters field

    Name

    +

    Type

    +

    Description

    +

    name

    +

    String

    +

    The parameter name.

    +

    value

    +

    String

    +

    Parameter value.

    +

    value_range

    +

    String

    +

    The value range.

    +

    For example, the value of the Integer type ranges from 0 to 1, and the value of the Boolean type is true or false.

    +

    restart_required

    +

    Boolean

    +

    Whether the instance needs to be restarted.

    +
    • If the value is true, restart is required.
    • If the value is false, restart is not required.
    +

    readonly

    +

    Boolean

    +

    Whether the parameter group is read-only.

    +
    • If the value false, the parameter is not read-only.
    • If the value is true, the parameter is read-only.
    +

    type

    +

    String

    +

    The parameter type. The value can be integer, string, boolean, float, or list.

    +

    description

    +

    String

    +

    The parameter description.

    +
    +
    +
+
+
  • Response example
    { 
+    "id" : "5afa71df29ed4378bd7f6fef107daf6fin02",
+    "node_type" : "replica",     
+    "datastore_version" : "4.0", 
+    "datastore_name" : "mongos", 
+    "created" : "2017-01-01T10:00:00", 
+    "updated" : "2017-01-01T10:00:00", 
+    "parameters" : [ { 
+      "name" : "cursorTimeoutMillis", 
+      "value" : "600000", 
+      "restart_required" : false, 
+      "readonly" : false, 
+      "description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
+      "value_range" : "600000-1000000" 
+    } ] 
+  }
    +
+

Status Code

Status Code:200.

+

For more information, see Status Code.

+
+

Error Code

For more information, see Error Code.

+
+
+
+
+
Parent topic: Parameter Configuration
+
+
+ diff --git a/docs/dds/api-ref/dds_api_0120.html b/docs/dds/api-ref/dds_api_0120.html index f218e683..7796fb13 100644 --- a/docs/dds/api-ref/dds_api_0120.html +++ b/docs/dds/api-ref/dds_api_0120.html @@ -95,8 +95,8 @@ -

Status Code

Status Code:200.

-

For more information, see Status Code.

+

Status Code

Status Code:200.

+

For more information, see Status Code.

Error Code

For more information, see Error Code.

diff --git a/docs/dds/api-ref/dds_api_description.html b/docs/dds/api-ref/dds_api_description.html index b9dbcd8d..3d53bed8 100644 --- a/docs/dds/api-ref/dds_api_description.html +++ b/docs/dds/api-ref/dds_api_description.html @@ -18,6 +18,8 @@
  • Backup and Restoration
    • +
  • Parameter Configuration
    +
  • Log Information Queries
  • Tag Management
    diff --git a/docs/dds/api-ref/dds_projectid.html b/docs/dds/api-ref/dds_projectid.html index 3ff783c8..b2d338eb 100644 --- a/docs/dds/api-ref/dds_projectid.html +++ b/docs/dds/api-ref/dds_projectid.html @@ -31,7 +31,7 @@ }

    • Obtain a Project ID from the Console

    1. Register yourself on the management console and log in to it.
    2. Move your pointer over the username and select My Credential in the displayed drop-down list.

      On the My Credential page, view the project ID in the project list.

      -
      Figure 1 Viewing project IDs
      +
      Figure 1 Viewing project IDs
    diff --git a/docs/dds/api-ref/en-us_image_0000001336985362.png b/docs/dds/api-ref/en-us_image_0000001803204856.png similarity index 100% rename from docs/dds/api-ref/en-us_image_0000001336985362.png rename to docs/dds/api-ref/en-us_image_0000001803204856.png diff --git a/docs/dds/api-ref/en-us_image_0000001387625321.jpg b/docs/dds/api-ref/en-us_image_0000001803204868.jpg similarity index 100% rename from docs/dds/api-ref/en-us_image_0000001387625321.jpg rename to docs/dds/api-ref/en-us_image_0000001803204868.jpg