Compare commits
4 Commits
main
...
propose-dd
| Author | SHA1 | Date | |
|---|---|---|---|
| 73a1563d4e | |||
| 3dc5140a9a | |||
| ae80d6b8e6 | |||
| e9f8e63934 |
@ -128,15 +128,15 @@ Responses
|
||||
|
||||
.. table:: **Table 4** datastore field data structure description
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+=======================+=======================+================================================================================================+
|
||||
+=======================+=======================+==============================================================================================================+
|
||||
| type | String | Indicates the DB engine. |
|
||||
| | | |
|
||||
| | | Valid value: **DDS-Community**. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| version | String | Indicates the database of version 3.2, 3.4, or 4.0. The value is **3.2**, **3.4**, or **4.0**. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| 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**. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
|
||||
@ -333,7 +333,7 @@ Responses
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| name | String | which is the same as the request parameter. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| datastore | Object | Indicates the database information, which is the same as the request parameter. For more information, see :ref:`Table 7 <dds_api_0038__table149461548134>`. |
|
||||
| datastore | Object | Indicates the database information, which is the same as the request parameter. For more information, see :ref:`Table 7 <dds_api_0038__table228903751753>`. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created | String | Indicates the creation time in the following format: yyyy-mm-dd hh:mm:ss. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -364,22 +364,22 @@ Responses
|
||||
| ssl_option | String | Indicates whether to enable SSL, which functions the same as the request parameter. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0038__table149461548134:
|
||||
.. _dds_api_0038__table228903751753:
|
||||
|
||||
.. table:: **Table 7** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
+=================+=================+=================+==================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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**. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.0 or 3.4 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:
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ This API is used to kill sessions of an instance node.
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
- Community Edition 3.4 and 4.0 instances are supported.
|
||||
- Community Edition 3.4, 4.0 and 4.2 instances are supported.
|
||||
- Inactive sessions cannot be terminated.
|
||||
|
||||
URI
|
||||
|
||||
@ -13,7 +13,7 @@ This API is used to query sessions of instance nodes.
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
Community Edition 3.4 and 4.0 instances are supported.
|
||||
Community Edition 3.4, 4.0 and 4.2 instances are supported.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
@ -0,0 +1,85 @@
|
||||
:original_name: dds_api_0104.html
|
||||
|
||||
.. _dds_api_0104:
|
||||
|
||||
Configuring Cross-CIDR Access for a Replica Set
|
||||
===============================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to configure cross-CIDR access for a replica set instance.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
Only replica set instances are supported.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network
|
||||
|
||||
- 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 |
|
||||
+=======================+=================+==================+=========================================================================================================================================================================================================================================================================================================================================================================================+
|
||||
| client_network_ranges | Yes | Array of strings | CIDR block where the client is located |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | - Cross-CIDR access is required only when the CIDR blocks of the client and the replica set instance are different. For example, if the client CIDR block is 192.168.0.0/16 and the replica set instance's CIDR block is 172.16.0.0/24, add the CIDR block 192.168.0.0/16 so that the client can access the replica set instance. This function is available only for replica sets. |
|
||||
| | | | - For example, if the source network segment is 192.168.0.0/*xx*, the value of *xx* must range from **8** to **32**. |
|
||||
| | | | - To ensure the ECS and the instance can communicate with each other, configure the connection by referring to VPC Peering Connection Overview. |
|
||||
+-----------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Request example
|
||||
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/client-network
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"client_network_ranges":["192.168.0.0/16"]
|
||||
}
|
||||
|
||||
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>`.
|
||||
@ -120,18 +120,18 @@ Requests
|
||||
|
||||
.. table:: **Table 3** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
+=================+=================+=================+==================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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**. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.0 or 3.4 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:
|
||||
|
||||
@ -453,18 +453,18 @@ Responses
|
||||
|
||||
.. table:: **Table 8** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
+=================+=================+=================+==================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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**. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.0 or 3.4 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:
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ Constraints
|
||||
- Frozen instances do not support this operation.
|
||||
- DB instances associated with the IPv6 subnet do not support this operation.
|
||||
- If the IP address is enabled, restart the nodes for the setting to take effect.
|
||||
- Cluster instances of Community Edition 3.4 and 4.0 are supported.
|
||||
- Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported.
|
||||
- This function cannot be disabled after being enabled.
|
||||
|
||||
URI
|
||||
|
||||
@ -21,6 +21,10 @@ DB Instance Management
|
||||
- :ref:`Unbinding an EIP <dds_api_0057>`
|
||||
- :ref:`Changing a Private IP Address <dds_api_0058>`
|
||||
- :ref:`Enabling Shard or Config IP Addresses <dds_api_0120>`
|
||||
- :ref:`Configuring Cross-CIDR Access for a Replica Set <dds_api_0104>`
|
||||
- :ref:`Setting the Recycle Bin Policy <dds_api_0138>`
|
||||
- :ref:`Querying the Recycling Policy of a DB Instance <dds_api_0215>`
|
||||
- :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -42,3 +46,7 @@ DB Instance Management
|
||||
unbinding_an_eip
|
||||
changing_a_private_ip_address
|
||||
enabling_shard_or_config_ip_addresses
|
||||
configuring_cross-cidr_access_for_a_replica_set
|
||||
setting_the_recycle_bin_policy
|
||||
querying_the_recycling_policy_of_a_db_instance
|
||||
querying_db_instances_in_the_recycle_bin
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,87 @@
|
||||
:original_name: dds_api_0215.html
|
||||
|
||||
.. _dds_api_0215:
|
||||
|
||||
Querying the Recycling Policy of a DB Instance
|
||||
==============================================
|
||||
|
||||
API Description
|
||||
---------------
|
||||
|
||||
This API is used to query the recycling policy of a DB instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Request parameters
|
||||
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+==============+===========+========+===================================================+
|
||||
| x-auth-token | Yes | String | User token. |
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
| project_id | Yes | String | Specifies the project ID of a tenant in a region. |
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Example request
|
||||
|
||||
GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/recycle-policy
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Response body parameters
|
||||
|
||||
+----------------+-----------------------------------------------------------------+----------------------------+
|
||||
| Name | Type | Description |
|
||||
+================+=================================================================+============================+
|
||||
| recycle_policy | :ref:`RecyclePolicy <dds_api_0215__table19191130122514>` object | Instance recycling policy. |
|
||||
+----------------+-----------------------------------------------------------------+----------------------------+
|
||||
|
||||
.. _dds_api_0215__table19191130122514:
|
||||
|
||||
.. table:: **Table 3** RecyclePolicy
|
||||
|
||||
+--------------------------+-----------------------+------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+==========================+=======================+==============================================================================+
|
||||
| enabled | Boolean | Whether to enable the recycling policy. |
|
||||
| | | |
|
||||
| | | - **true**: Enable the recycling policy. |
|
||||
+--------------------------+-----------------------+------------------------------------------------------------------------------+
|
||||
| retention_period_in_days | Integer | Policy retention period (1 to 7 days). The value must be a positive integer. |
|
||||
+--------------------------+-----------------------+------------------------------------------------------------------------------+
|
||||
|
||||
- Response Example
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"recycle_policy" : {
|
||||
"enabled" : true,
|
||||
"retention_period_in_days" : 3
|
||||
}
|
||||
}
|
||||
|
||||
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>`.
|
||||
@ -0,0 +1,93 @@
|
||||
:original_name: dds_api_0138.html
|
||||
|
||||
.. _dds_api_0138:
|
||||
|
||||
Setting the Recycle Bin Policy
|
||||
==============================
|
||||
|
||||
API Description
|
||||
---------------
|
||||
|
||||
This API is used to set the recycle bin policy for an instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 1** Request parameters
|
||||
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+==============+===========+========+===================================================+
|
||||
| x-auth-token | Yes | String | User token. |
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
| project_id | Yes | String | Specifies the project ID of a tenant in a region. |
|
||||
+--------------+-----------+--------+---------------------------------------------------+
|
||||
|
||||
Requests
|
||||
--------
|
||||
|
||||
- Parameter description
|
||||
|
||||
.. table:: **Table 2** Request body parameters
|
||||
|
||||
+----------------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+================+===========+========+===============================================================================================+
|
||||
| recycle_policy | Yes | Object | Instance recycling policy. For details, see :ref:`Table 3 <dds_api_0138__table159257245612>`. |
|
||||
+----------------+-----------+--------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0138__table159257245612:
|
||||
|
||||
.. table:: **Table 3** RecyclePolicy
|
||||
|
||||
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+==========================+=================+=================+==========================================================================================================================================================+
|
||||
| enabled | Yes | Boolean | The recycling policy is enabled and cannot be disabled. |
|
||||
| | | | |
|
||||
| | | | - **true**: The recycling policy is enabled. |
|
||||
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| retention_period_in_days | No | Integer | Policy retention duration (1 to 7 days). The value is a positive integer. If this parameter is left blank, the policy is retained for 7 days by default. |
|
||||
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Request example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
PUT https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy
|
||||
|
||||
{
|
||||
"recycle_policy" : {
|
||||
"enabled" : true,
|
||||
"retention_period_in_days" : 3
|
||||
}
|
||||
}
|
||||
|
||||
Responses
|
||||
---------
|
||||
|
||||
- Parameter description
|
||||
|
||||
None
|
||||
|
||||
- Response example
|
||||
|
||||
None
|
||||
|
||||
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>`.
|
||||
@ -62,7 +62,7 @@ Requests
|
||||
|
||||
1. If the body parameter is not specified, the slow query log file links of all instance nodes are returned.
|
||||
|
||||
POST https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog-download
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog-download
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
@ -71,7 +71,7 @@ Requests
|
||||
|
||||
2. If the body parameter is specified, the slow query log file link of the current node is returned.
|
||||
|
||||
POST https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog-download
|
||||
POST https://dds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog-download
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -43,11 +43,11 @@ Responses
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+----------+------------------+--------------------------------------------------------------------------------------+
|
||||
+----------+------------------+-------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+==========+==================+======================================================================================+
|
||||
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, and 4.0 are supported. |
|
||||
+----------+------------------+--------------------------------------------------------------------------------------+
|
||||
+==========+==================+===========================================================================================+
|
||||
| versions | Array of strings | Indicates the database version. Currently, versions 3.2, 3.4, 4.0, and 4.2 are supported. |
|
||||
+----------+------------------+-------------------------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
@ -57,7 +57,8 @@ Responses
|
||||
"versions": [
|
||||
"3.2",
|
||||
"3.4",
|
||||
"4.0"
|
||||
"4.0",
|
||||
"4.2"
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
@ -69,19 +69,19 @@ Requests
|
||||
|
||||
.. table:: **Table 3** tags field data structure description
|
||||
|
||||
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+==================+============================================================================================================================================================================================================================+
|
||||
| key | Yes | String | Specifies the tag key. It contains a maximum of 36 Unicode characters. **key** cannot be empty, an empty string, or spaces. Before using **key**, delete spaces of single-byte character (SBC) before and after the value. |
|
||||
+=================+=================+==================+=============================================================================================================================================================================================+
|
||||
| key | Yes | String | Specifies the tag key. It contains a maximum of 36 Unicode characters. **key** cannot be empty, an empty string, or spaces. Before using **key**, delete spaces before and after the value. |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | The character set of this parameter is not verified in the search process. |
|
||||
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| values | Yes | Array of strings | Lists the tag values. Each value contains a maximum of 43 Unicode characters and cannot contain spaces. Before using **values**, delete SBC spaces before and after the value. |
|
||||
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| values | Yes | Array of strings | Lists the tag values. Each value contains a maximum of 43 Unicode characters and cannot contain spaces. Before using **values**, delete spaces before and after the value. |
|
||||
| | | | |
|
||||
| | | | If the values are null, it indicates querying any value. The values are in OR relationship. |
|
||||
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0032__table86147511997:
|
||||
|
||||
|
||||
@ -5,9 +5,13 @@
|
||||
Change History
|
||||
==============
|
||||
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Date | Description |
|
||||
+===================================+===========================================================================================================================================================================================================================================================================================+
|
||||
+===================================+===================================================================================================================================================================================================================================================================================================================+
|
||||
| 2023-05-30 | Modified the following content: |
|
||||
| | |
|
||||
| | APIs added: :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>`, :ref:`Querying the Recycling Policy of a DB Instance <dds_api_0215>`, :ref:`Setting the Recycle Bin Policy <dds_api_0138>`, :ref:`Configuring Cross-CIDR Access for a Replica Set <dds_api_0104>` and added support of DDS version 4.2 |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2022-10-30 | Modified the following content: |
|
||||
| | |
|
||||
| | - :ref:`Creating a DB Instance <dds_api_0020>` |
|
||||
@ -15,7 +19,7 @@ Change History
|
||||
| | - :ref:`Obtaining Links for Downloading Slow Query Logs <dds_api_0094>` |
|
||||
| | - :ref:`Obtaining Links for Downloading Error Logs <dds_api_0096>` |
|
||||
| | - :ref:`Restoring Data to a New DB Instance <dds_api_0038>` |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2022-04-29 | Added the following API: |
|
||||
| | |
|
||||
| | :ref:`Task Management <dds_api_0117>` |
|
||||
@ -23,7 +27,7 @@ Change History
|
||||
| | Deleted the following API: |
|
||||
| | |
|
||||
| | Managing Databases and Users |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2021-05-30 | Modified the following content: |
|
||||
| | |
|
||||
| | Supported valid port range 2100-9500, 27017, 27018, and 27019. |
|
||||
@ -33,7 +37,7 @@ Change History
|
||||
| | - :ref:`Querying Sessions of an Instance Node <dds_connect_0002>` |
|
||||
| | - :ref:`Killing Sessions of an Instance Node <dds_connect_0003>` |
|
||||
| | - :ref:`Querying the Number of Connections to an Instance Node <dds_connect_0004>` |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2021-02-28 | Added the following content: |
|
||||
| | |
|
||||
| | - :ref:`Querying the Restoration Time Ranges <dds_api_0080>` |
|
||||
@ -48,7 +52,7 @@ Change History
|
||||
| | - :ref:`Querying SQL Audit Policy <dds_api_0098>` |
|
||||
| | - :ref:`Obtaining the Audit Log List <dds_api_0099>` |
|
||||
| | - :ref:`Obtaining Links for Downloading Audit Logs <dds_api_0100>` |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2020-08-30 | Modified the following content: |
|
||||
| | |
|
||||
| | - Modified the description in :ref:`Authentication <dds_api_0010>`. |
|
||||
@ -60,7 +64,7 @@ Change History
|
||||
| | Added the following content: |
|
||||
| | |
|
||||
| | :ref:`Restoring Data to a New DB Instance <dds_api_0038>` |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2020-04-16 | Modified the following content: |
|
||||
| | |
|
||||
| | - Modified the description of the **size** and **spec_code** parameters in :ref:`Creating a DB Instance <dds_api_0020>`. |
|
||||
@ -80,12 +84,12 @@ Change History
|
||||
| | - :ref:`Adding or Deleting Resource Tags in Batches <dds_api_0033>` |
|
||||
| | - :ref:`Querying Resource Tags <dds_api_0034>` |
|
||||
| | - :ref:`Querying Tags in a Specified Project <dds_api_0035>` |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2020-01-15 | Modified the following content: |
|
||||
| | |
|
||||
| | - Modified the description of the **ram** parameter in :ref:`Querying Database Specifications <dds_instance_specification>`. |
|
||||
| | - Modified the description of the **disk_encryption_id** parameter in :ref:`Querying Instances and Details <dds_api_0023>`. |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2019-11-28 | Modified the following content: |
|
||||
| | |
|
||||
| | - Modified the value of **versions** in the response example in :ref:`Querying Database Version Information <dds_database_version>`. |
|
||||
@ -94,10 +98,10 @@ Change History
|
||||
| | - Added the **ssl_option** parameter, modified the description of the **version**, **mode**, and **flavor** parameters, and added the request and response examples for the single node instance in :ref:`Creating a DB Instance <dds_api_0020>`. |
|
||||
| | |
|
||||
| | - Modified the description of the **mode**, **groups**, and **nodes** parameters, and added the response example for the single node instance in :ref:`Querying Instances and Details <dds_api_0023>`. |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2019-09-25 | Modified the following content: |
|
||||
| | |
|
||||
| | - Change the value of **spec_code** in the request and response examples in :ref:`Example <dds_api_0017>`, :ref:`Querying Database Specifications <dds_instance_specification>`, :ref:`Creating a DB Instance <dds_api_0020>`, and :ref:`Querying Instances and Details <dds_api_0023>`. |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2019-08-19 | This issue is the first official release. |
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -18,7 +18,7 @@ import os
|
||||
import sys
|
||||
|
||||
extensions = [
|
||||
'otcdocstheme'
|
||||
'otcdocstheme',
|
||||
]
|
||||
|
||||
otcdocs_auto_name = False
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user