Compare commits

...

2 Commits

Author SHA1 Message Date
a4e296535b Update content 2023-09-19 07:40:10 +00:00
61b5355d41 Update content 2023-09-05 06:35:14 +00:00
10 changed files with 158 additions and 54 deletions

View File

@ -128,15 +128,15 @@ Responses
.. table:: **Table 4** datastore field data structure description .. table:: **Table 4** datastore field data structure description
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==============================================================================================================+ +=======================+=======================+============================================================================================================================+
| type | String | Indicates the DB engine. | | type | String | Indicates the DB engine. |
| | | | | | | |
| | | Valid value: **DDS-Community**. | | | | Valid value: **DDS-Community**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
| version | 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**. | | version | String | 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**. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
- Response example - Response example

View File

@ -368,18 +368,18 @@ Responses
.. table:: **Table 7** datastore field data structure description .. table:: **Table 7** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | 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**. | | version | Yes | String | 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 | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0038__table119482048538: .. _dds_api_0038__table119482048538:

View File

@ -13,7 +13,7 @@ This API is used to kill sessions of an instance node.
Constraints Constraints
----------- -----------
- 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.
- Inactive sessions cannot be terminated. - Inactive sessions cannot be terminated.
URI URI

View File

@ -13,7 +13,7 @@ This API is used to query sessions of instance nodes.
Constraints Constraints
----------- -----------
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.
URI URI
--- ---

View File

@ -120,18 +120,18 @@ Requests
.. table:: **Table 3** datastore field data structure description .. table:: **Table 3** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | 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**. | | version | Yes | String | 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 | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table94791241013: .. _dds_api_0020__table94791241013:
@ -453,18 +453,18 @@ Responses
.. table:: **Table 8** datastore field data structure description .. table:: **Table 8** datastore field data structure description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+=================+==================================================================================================================================+ +=================+=================+=================+============================================================================================================================================+
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. | | type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| version | Yes | 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**. | | version | Yes | String | 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 | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. | | storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
| | | | | | | | | |
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. | | | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | | | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table119482048538: .. _dds_api_0020__table119482048538:

View File

@ -14,6 +14,7 @@ APIs V3.0 (Recommended)
- :ref:`Backup and Restoration <dds_backup_restore>` - :ref:`Backup and Restoration <dds_backup_restore>`
- :ref:`Log Information Queries <dds_api_0092>` - :ref:`Log Information Queries <dds_api_0092>`
- :ref:`Tag Management <dds_tag_mgmt>` - :ref:`Tag Management <dds_tag_mgmt>`
- :ref:`Managing Databases and Users <dds_api_0070>`
- :ref:`Task Management <dds_api_0117>` - :ref:`Task Management <dds_api_0117>`
.. toctree:: .. toctree::
@ -29,4 +30,5 @@ APIs V3.0 (Recommended)
backup_and_restoration/index backup_and_restoration/index
log_information_queries/index log_information_queries/index
tag_management/index tag_management/index
managing_databases_and_users/index
task_management/index task_management/index

View File

@ -0,0 +1,87 @@
:original_name: dds_api_0075.html
.. _dds_api_0075:
Changing the Password of a Database User
========================================
Function
--------
This API is used to change the password of a database user
Constraints
-----------
This operation cannot be performed on frozen or abnormal instances.
URI
---
- URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reset-password
- Parameter description
.. table:: **Table 1** Parameter description
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Requests
--------
- Parameter description
.. table:: **Table 2** Parameter description
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
| | | | |
| | | | - The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ``~!@#%^*-_=+?`` |
| | | | - Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| db_name | No | String | Specifies the database name. The default value is **"admin"**. |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Request example
.. code-block:: text
{
"user_name": "rwuser",
"user_pwd": "******"
}
Responses
---------
- Response example
.. code-block:: text
{}
Status Code
-----------
Status Code:200.
For more information, see :ref:`Status Code <dds_status_code>`.
Error Code
----------
For more information, see :ref:`Error Code <dds_error_code>`.

View File

@ -0,0 +1,14 @@
:original_name: dds_api_0070.html
.. _dds_api_0070:
Managing Databases and Users
============================
- :ref:`Changing the Password of a Database User <dds_api_0075>`
.. toctree::
:maxdepth: 1
:hidden:
changing_the_password_of_a_database_user

View File

@ -107,7 +107,7 @@ Responses
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| engine_versions | Array of strings | Database versions | | engine_versions | 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"} |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note:: .. note::

View File

@ -43,11 +43,11 @@ Responses
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+----------+------------------+-------------------------------------------------------------------------------------------+ +----------+------------------+------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+==========+==================+===========================================================================================+ +==========+==================+================================================================================================+
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported. | | versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, 4.2, and 4.4 are supported. |
+----------+------------------+-------------------------------------------------------------------------------------------+ +----------+------------------+------------------------------------------------------------------------------------------------+
- Response example - Response example
@ -58,7 +58,8 @@ Responses
"3.2", "3.2",
"3.4", "3.4",
"4.0", "4.0",
"4.2" "4.2",
"4.4"
] ]
} }