diff --git a/docs/dds/api-ref/ALL_META.TXT.json b/docs/dds/api-ref/ALL_META.TXT.json index 06fed886..36e0d360 100644 --- a/docs/dds/api-ref/ALL_META.TXT.json +++ b/docs/dds/api-ref/ALL_META.TXT.json @@ -373,7 +373,7 @@ "uri":"dds_connect_0002.html", "product_code":"dds", "code":"38", - "des":"This API is used to query sessions of instance nodes.Community Edition 3.4, 4.0 and 4.2 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nodes/{no", + "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", "title":"Querying Sessions of an Instance Node", @@ -383,7 +383,7 @@ "uri":"dds_connect_0003.html", "product_code":"dds", "code":"39", - "des":"This API is used to kill sessions of an instance node.Community Edition 3.4, 4.0 and 4.2 instances are supported.Inactive sessions cannot be terminated.URI formatPOST htt", + "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", "title":"Killing Sessions of an Instance Node", @@ -670,11 +670,31 @@ "githuburl":"" }, { - "uri":"dds_api_0117.html", + "uri":"dds_api_0070.html", "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":"Managing Databases and Users", + "title":"Managing Databases and Users", + "githuburl":"" + }, + { + "uri":"dds_api_0075.html", + "product_code":"dds", + "code":"69", + "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", + "title":"Changing the Password of a Database User", + "githuburl":"" + }, + { + "uri":"dds_api_0117.html", + "product_code":"dds", + "code":"70", + "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", "title":"Task Management", "githuburl":"" @@ -682,7 +702,7 @@ { "uri":"dds_api_0118.html", "product_code":"dds", - "code":"69", + "code":"71", "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", @@ -692,7 +712,7 @@ { "uri":"dds_api_permission.html", "product_code":"dds", - "code":"70", + "code":"72", "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", @@ -702,7 +722,7 @@ { "uri":"dds_api_0036.html", "product_code":"dds", - "code":"71", + "code":"73", "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", @@ -712,7 +732,7 @@ { "uri":"dds_api_0037.html", "product_code":"dds", - "code":"72", + "code":"74", "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", @@ -722,7 +742,7 @@ { "uri":"dds_public_parameters.html", "product_code":"dds", - "code":"73", + "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":"Appendix", @@ -732,7 +752,7 @@ { "uri":"dds_api_0060.html", "product_code":"dds", - "code":"74", + "code":"76", "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", @@ -742,7 +762,7 @@ { "uri":"dds_status_code.html", "product_code":"dds", - "code":"75", + "code":"77", "des":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", "doc_type":"api", "kw":"Status Code,Appendix,dds api", @@ -752,7 +772,7 @@ { "uri":"dds_error_code.html", "product_code":"dds", - "code":"76", + "code":"78", "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", @@ -762,7 +782,7 @@ { "uri":"dds_projectid.html", "product_code":"dds", - "code":"77", + "code":"79", "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", @@ -772,7 +792,7 @@ { "uri":"dds_metrics.html", "product_code":"dds", - "code":"78", + "code":"80", "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", @@ -782,7 +802,7 @@ { "uri":"dds_change_history.html", "product_code":"dds", - "code":"79", + "code":"81", "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", diff --git a/docs/dds/api-ref/CLASS.TXT.json b/docs/dds/api-ref/CLASS.TXT.json index 6ec23ef2..30b6603d 100644 --- a/docs/dds/api-ref/CLASS.TXT.json +++ b/docs/dds/api-ref/CLASS.TXT.json @@ -333,7 +333,7 @@ "code":"37" }, { - "desc":"This API is used to query sessions of instance nodes.Community Edition 3.4, 4.0 and 4.2 instances are supported.URI formatGET https://{Endpoint}/v3/{project_id}/nodes/{no", + "desc":"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", "product_code":"dds", "title":"Querying Sessions of an Instance Node", "uri":"dds_connect_0002.html", @@ -342,7 +342,7 @@ "code":"38" }, { - "desc":"This API is used to kill sessions of an instance node.Community Edition 3.4, 4.0 and 4.2 instances are supported.Inactive sessions cannot be terminated.URI formatPOST htt", + "desc":"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", "product_code":"dds", "title":"Killing Sessions of an Instance Node", "uri":"dds_connect_0003.html", @@ -602,6 +602,24 @@ "p_code":"63", "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.", + "product_code":"dds", + "title":"Managing Databases and Users", + "uri":"dds_api_0070.html", + "doc_type":"api", + "p_code":"9", + "code":"68" + }, + { + "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_", + "product_code":"dds", + "title":"Changing the Password of a Database User", + "uri":"dds_api_0075.html", + "doc_type":"api", + "p_code":"68", + "code":"69" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dds", @@ -609,7 +627,7 @@ "uri":"dds_api_0117.html", "doc_type":"api", "p_code":"9", - "code":"68" + "code":"70" }, { "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 ", @@ -617,8 +635,8 @@ "title":"Obtaining Information About a Task with a Specified ID", "uri":"dds_api_0118.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"70", + "code":"71" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -627,7 +645,7 @@ "uri":"dds_api_permission.html", "doc_type":"api", "p_code":"", - "code":"70" + "code":"72" }, { "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", @@ -635,8 +653,8 @@ "title":"Introduction", "uri":"dds_api_0036.html", "doc_type":"api", - "p_code":"70", - "code":"71" + "p_code":"72", + "code":"73" }, { "desc":"The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.", @@ -644,8 +662,8 @@ "title":"DDS Actions", "uri":"dds_api_0037.html", "doc_type":"api", - "p_code":"70", - "code":"72" + "p_code":"72", + "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.", @@ -654,7 +672,7 @@ "uri":"dds_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"73" + "code":"75" }, { "desc":"Abnormal responsesParameter descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_msgStringSpecifies th", @@ -662,8 +680,8 @@ "title":"Abnormal Request Results", "uri":"dds_api_0060.html", "doc_type":"api", - "p_code":"73", - "code":"74" + "p_code":"75", + "code":"76" }, { "desc":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali", @@ -671,8 +689,8 @@ "title":"Status Code", "uri":"dds_status_code.html", "doc_type":"api", - "p_code":"73", - "code":"75" + "p_code":"75", + "code":"77" }, { "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", @@ -680,8 +698,8 @@ "title":"Error Code", "uri":"dds_error_code.html", "doc_type":"api", - "p_code":"73", - "code":"76" + "p_code":"75", + "code":"78" }, { "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", @@ -689,8 +707,8 @@ "title":"Obtaining a Project ID", "uri":"dds_projectid.html", "doc_type":"api", - "p_code":"73", - "code":"77" + "p_code":"75", + "code":"79" }, { "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", @@ -698,8 +716,8 @@ "title":"DDS Metrics", "uri":"dds_metrics.html", "doc_type":"api", - "p_code":"73", - "code":"78" + "p_code":"75", + "code":"80" }, { "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.", @@ -708,6 +726,6 @@ "uri":"dds_change_history.html", "doc_type":"api", "p_code":"", - "code":"79" + "code":"81" } ] \ No newline at end of file diff --git a/docs/dds/api-ref/dds_api_0020.html b/docs/dds/api-ref/dds_api_0020.html index ba1d99bf..05d6c78e 100644 --- a/docs/dds/api-ref/dds_api_0020.html +++ b/docs/dds/api-ref/dds_api_0020.html @@ -228,7 +228,7 @@
String
Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.2, 4.0, 3.4 or 3.2.
+Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.4, 4.2, 4.0, 3.4 or 3.2.
storage_engine
@@ -238,7 +238,7 @@String
Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.
-String
Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.2, 4.0, 3.4 or 3.2.
+Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.4, 4.2, 4.0, 3.4 or 3.2.
storage_engine
@@ -728,7 +728,7 @@ Create a cluster instance:String
Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.
-String
Indicates the database of version 3.2, 3.4, 4.0, or 4.2. The value is 3.2, 3.4, 4.0, or 4.2.
+Indicates the database of version 3.2, 3.4, 4.0, 4.2, or 4.4. The value is 3.2, 3.4, 4.0, 4.2, or 4.4.
String
Specifies the database version. Versions 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.2, 4.0, 3.4 or 3.2.
+Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be 4.4, 4.2, 4.0, 3.4 or 3.2.
storage_engine
@@ -594,7 +594,7 @@String
Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.
-This API is used to change the password of a database user
+This operation cannot be performed on frozen or abnormal instances.
+PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reset-password
+Name + |
+Mandatory + |
+Description + |
+
---|---|---|
project_id + |
+Yes + |
+Specifies the project ID of a tenant in a region. + |
+
instance_id + |
+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. + |
+
Name + |
+Mandatory + |
+Type + |
+Description + |
+
---|---|---|---|
user_name + |
+No + |
+String + |
+Specifies the database username. The default value is "rwuser". +The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.). + |
+
user_pwd + |
+Yes + |
+String + |
+Specifies the database password. +
|
+
db_name + |
+No + |
+String + |
+Specifies the database name. The default value is "admin". + |
+
{ +"user_name": "rwuser", +"user_pwd": "******" +}+
{}+
For more information, see Error Code.
+This API is used to query sessions of instance nodes.
Community Edition 3.4, 4.0 and 4.2 instances are supported.
+Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.
GET https://{Endpoint}/v3/{project_id}/nodes/{node_id}/sessions?offset={offset}&limit={limit}&plan_summary={plan_summary}&type={type}&namespace={namespace}&cost_time={cost_time}
This API is used to kill sessions of an instance node.
Array of strings
Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported.
+Indicates the database version. Currently, versions 3.2, 3.4, 4.0, 4.2, and 4.4 are supported.
Array of strings
Database versions
-For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2"}
+For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2", "4.4"}