From 8893a01ea10d009c775833689485efe1a62f1f59 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Tue, 11 Jul 2023 07:30:35 +0000 Subject: [PATCH] Changes to dds_api-ref from docs/doc-exports#698 (dds api for https://gitea.eco. Reviewed-by: Drobnak, David Reviewed-by: Boka, Ladislav Co-authored-by: proposalbot Co-committed-by: proposalbot --- .../querying_the_backup_list.rst | 18 +- .../restoring_data_to_a_new_db_instance.rst | 28 +-- .../killing_sessions_of_an_instance_node.rst | 2 +- .../querying_sessions_of_an_instance_node.rst | 2 +- ...ng_cross-cidr_access_for_a_replica_set.rst | 85 ++++++++ .../creating_a_db_instance.rst | 48 ++--- .../enabling_shard_or_config_ip_addresses.rst | 2 +- .../db_instance_management/index.rst | 8 + ...erying_db_instances_in_the_recycle_bin.rst | 151 ++++++++++++++ ..._the_recycling_policy_of_a_db_instance.rst | 87 ++++++++ .../setting_the_recycle_bin_policy.rst | 93 +++++++++ ..._links_for_downloading_slow_query_logs.rst | 4 +- .../querying_database_specifications.rst | 44 ++-- .../querying_database_version_information.rst | 13 +- .../querying_resources_by_tag.rst | 26 +-- api-ref/source/change_history.rst | 196 +++++++++--------- 16 files changed, 618 insertions(+), 189 deletions(-) create mode 100644 api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.rst create mode 100644 api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst create mode 100644 api-ref/source/apis_v3.0_recommended/db_instance_management/querying_the_recycling_policy_of_a_db_instance.rst create mode 100644 api-ref/source/apis_v3.0_recommended/db_instance_management/setting_the_recycle_bin_policy.rst diff --git a/api-ref/source/apis_v3.0_recommended/backup_and_restoration/querying_the_backup_list.rst b/api-ref/source/apis_v3.0_recommended/backup_and_restoration/querying_the_backup_list.rst index b71ba36..a101b87 100644 --- a/api-ref/source/apis_v3.0_recommended/backup_and_restoration/querying_the_backup_list.rst +++ b/api-ref/source/apis_v3.0_recommended/backup_and_restoration/querying_the_backup_list.rst @@ -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**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==============================================================================================================+ + | type | String | Indicates the DB engine. | + | | | | + | | | 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**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+ - Response example diff --git a/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst b/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst index 28f5226..98c23ef 100644 --- a/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst +++ b/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst @@ -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 `. | + | datastore | Object | Indicates the database information, which is the same as the request parameter. For more information, see :ref:`Table 7 `. | +-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | 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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ + | 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, 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, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ .. _dds_api_0038__table119482048538: diff --git a/api-ref/source/apis_v3.0_recommended/connection_management/killing_sessions_of_an_instance_node.rst b/api-ref/source/apis_v3.0_recommended/connection_management/killing_sessions_of_an_instance_node.rst index 96fa9cc..cf3dc99 100644 --- a/api-ref/source/apis_v3.0_recommended/connection_management/killing_sessions_of_an_instance_node.rst +++ b/api-ref/source/apis_v3.0_recommended/connection_management/killing_sessions_of_an_instance_node.rst @@ -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 diff --git a/api-ref/source/apis_v3.0_recommended/connection_management/querying_sessions_of_an_instance_node.rst b/api-ref/source/apis_v3.0_recommended/connection_management/querying_sessions_of_an_instance_node.rst index e55b59b..42f96c0 100644 --- a/api-ref/source/apis_v3.0_recommended/connection_management/querying_sessions_of_an_instance_node.rst +++ b/api-ref/source/apis_v3.0_recommended/connection_management/querying_sessions_of_an_instance_node.rst @@ -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 --- diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.rst new file mode 100644 index 0000000..a65ed43 --- /dev/null +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.rst @@ -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 `. + +Error Code +---------- + +For more information, see :ref:`Error Code `. diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst index 6f9837e..21b2f42 100644 --- a/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst @@ -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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | 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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ + | 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, 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, 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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | 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**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ + | 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, 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, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ .. _dds_api_0020__table119482048538: diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst index 2d853c9..0f58a0c 100644 --- a/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst @@ -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 diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst index 30952b8..ef90925 100644 --- a/api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst @@ -21,6 +21,10 @@ DB Instance Management - :ref:`Unbinding an EIP ` - :ref:`Changing a Private IP Address ` - :ref:`Enabling Shard or Config IP Addresses ` +- :ref:`Configuring Cross-CIDR Access for a Replica Set ` +- :ref:`Setting the Recycle Bin Policy ` +- :ref:`Querying the Recycling Policy of a DB Instance ` +- :ref:`Querying DB Instances in the Recycle Bin ` .. 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 diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst new file mode 100644 index 0000000..a42d135 --- /dev/null +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst @@ -0,0 +1,151 @@ +:original_name: dds_api_021.html + +.. _dds_api_021: + +Querying DB Instances in the Recycle Bin +======================================== + +API Description +--------------- + +This API is used to query DB instances in the recycle bin. + +URI +--- + +- URI format + + GET https://{Endpoint}/v3/{project_id}/recycle-instances + +- 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. | + +--------------+-----------+--------+---------------------------------------------------+ + + .. table:: **Table 2** Query parameters + + +--------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+=========+===================================================================================================================================================================================================================================+ + | offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The default value is **0**, indicating that the query starts from the first piece of data. The value must be a positive integer. | + +--------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records displayed on each page. The default value is **100**. | + +--------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Requests +-------- + +- Example request + + GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/recycle-instances + +Responses +--------- + +- Parameter description + + .. table:: **Table 3** Response body parameters + + +-------------+-----------------------------------------------------------------+--------------------------+ + | Name | Type | Description | + +=============+=================================================================+==========================+ + | total_count | Integer | Total number of records. | + +-------------+-----------------------------------------------------------------+--------------------------+ + | instances | Array of :ref:`Table 4 ` objects | Instance information. | + +-------------+-----------------------------------------------------------------+--------------------------+ + + .. _dds_api_021__table88115251643: + + .. table:: **Table 4** RecycleInstance + + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================================================+=================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | mode | String | Instance type. Cluster, replica set, and single node instances are supported. The value can be: | + | | | | + | | | - Sharding | + | | | - ReplicaSet | + | | | - Single | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | datastore | :ref:`Table 5 ` object | Database information. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | pay_mode | String | Billing mode. | + | | | | + | | | - **0**: indicates the instance is billed on a pay-per-use basis. | + | | | - **1**: indicates the instance is billed based on a yearly/monthly basis. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. The value **0** indicates the default enterprise project. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | backup_id | String | Backup ID. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | deleted_at | String | Deletion time. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | retained_until | String | Retention end time. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | status | String | Instance backup recycling status. | + +-----------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + + .. _dds_api_021__table38663369715: + + .. table:: **Table 5** RecycleDatastore + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+========================================================================================================+ + | type | String | Database type. The value is **DDS-Community**. | + | | | | + | | | Enumerated values: | + | | | | + | | | - DDS-Community | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + | version | String | Database version. Versions 3.4, 4.0, and 4.2 are supported. The value can be **3.4, 4.0,** or **4.2**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + +- Response Example + + .. code-block:: + + { + "total_count" : 1, + "instances" : [ { + "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in02", + "name" : "test1", + "mode" : "ReplicaSet", + "datastore" : { + "type" : "DDS-Community", + "version" : "4.0" + }, + "pay_mode" : "0", + "enterprise_project_id" : "0", + "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", + "created_at" : "2022-01-01T10:00:00", + "deleted_at" : "2022-02-01T10:00:00", + "retained_until" : "2022-05-01T10:00:00", + "status" : "Active" + } ] + } + +Status Code +----------- + +Status Code:200. + +For more information, see :ref:`Status Code `. + +Error Code +---------- + +For more information, see :ref:`Error Code `. diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_the_recycling_policy_of_a_db_instance.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_the_recycling_policy_of_a_db_instance.rst new file mode 100644 index 0000000..e13c304 --- /dev/null +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_the_recycling_policy_of_a_db_instance.rst @@ -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 ` 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 `. + +Error Code +---------- + +For more information, see :ref:`Error Code `. diff --git a/api-ref/source/apis_v3.0_recommended/db_instance_management/setting_the_recycle_bin_policy.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/setting_the_recycle_bin_policy.rst new file mode 100644 index 0000000..66df38b --- /dev/null +++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/setting_the_recycle_bin_policy.rst @@ -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: + + .. 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 `. + +Error Code +---------- + +For more information, see :ref:`Error Code `. diff --git a/api-ref/source/apis_v3.0_recommended/log_information_queries/obtaining_links_for_downloading_slow_query_logs.rst b/api-ref/source/apis_v3.0_recommended/log_information_queries/obtaining_links_for_downloading_slow_query_logs.rst index dddfaae..d8b3c8d 100644 --- a/api-ref/source/apis_v3.0_recommended/log_information_queries/obtaining_links_for_downloading_slow_query_logs.rst +++ b/api-ref/source/apis_v3.0_recommended/log_information_queries/obtaining_links_for_downloading_slow_query_logs.rst @@ -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 diff --git a/api-ref/source/apis_v3.0_recommended/querying_database_specifications.rst b/api-ref/source/apis_v3.0_recommended/querying_database_specifications.rst index e307c3a..6aec30e 100644 --- a/api-ref/source/apis_v3.0_recommended/querying_database_specifications.rst +++ b/api-ref/source/apis_v3.0_recommended/querying_database_specifications.rst @@ -107,7 +107,7 @@ Responses +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | engine_versions | Array of strings | Database versions | | | | | - | | | For example, DDS mongos node, {"3.4", "4.0"} | + | | | For example, DDS mongos node, {"3.2", "3.4", "4.0", "4.2"} | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: @@ -127,7 +127,7 @@ Responses "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -140,7 +140,7 @@ Responses "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -153,7 +153,7 @@ Responses "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -166,7 +166,7 @@ Responses "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -179,7 +179,7 @@ Responses "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.mongos", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -192,7 +192,7 @@ Responses "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -205,7 +205,7 @@ Responses "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -218,7 +218,7 @@ Responses "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -231,7 +231,7 @@ Responses "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -244,7 +244,7 @@ Responses "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.shard", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -257,7 +257,7 @@ Responses "vcpus": "2", "ram": "4", "spec_code": "dds.mongodb.s2.large.2.config", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -270,7 +270,7 @@ Responses "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -284,7 +284,7 @@ Responses "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -298,7 +298,7 @@ Responses "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -312,7 +312,7 @@ Responses "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -326,7 +326,7 @@ Responses "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.repset", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -340,7 +340,7 @@ Responses "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.s2.medium.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -353,7 +353,7 @@ Responses "vcpus": "2", "ram": "8", "spec_code": "dds.mongodb.s2.large.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -366,7 +366,7 @@ Responses "vcpus": "4", "ram": "16", "spec_code": "dds.mongodb.s2.xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -379,7 +379,7 @@ Responses "vcpus": "8", "ram": "32", "spec_code": "dds.mongodb.s2.2xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", @@ -392,7 +392,7 @@ Responses "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.s2.4xlarge.4.single", - "engine_versions":["3.4","4.0"], + "engine_versions":["3.2","3.4","4.0"], "az_status": { "eu-de-01": "normal", "eu-de-02": "normal", diff --git a/api-ref/source/apis_v3.0_recommended/querying_database_version_information.rst b/api-ref/source/apis_v3.0_recommended/querying_database_version_information.rst index a610167..a83d37f 100644 --- a/api-ref/source/apis_v3.0_recommended/querying_database_version_information.rst +++ b/api-ref/source/apis_v3.0_recommended/querying_database_version_information.rst @@ -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. | - +----------+------------------+--------------------------------------------------------------------------------------+ + +----------+------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+==================+===========================================================================================+ + | 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" ] } diff --git a/api-ref/source/apis_v3.0_recommended/tag_management/querying_resources_by_tag.rst b/api-ref/source/apis_v3.0_recommended/tag_management/querying_resources_by_tag.rst index 51ac03c..c92d2d5 100644 --- a/api-ref/source/apis_v3.0_recommended/tag_management/querying_resources_by_tag.rst +++ b/api-ref/source/apis_v3.0_recommended/tag_management/querying_resources_by_tag.rst @@ -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. | - | | | | | - | | | | .. 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. | - | | | | | - | | | | If the values are null, it indicates querying any value. The values are in OR relationship. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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 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: diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index fdacd62..3d84e07 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,99 +5,103 @@ Change History ============== -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Date | Description | -+===================================+===========================================================================================================================================================================================================================================================================================+ -| 2022-10-30 | Modified the following content: | -| | | -| | - :ref:`Creating a DB Instance ` | -| | - :ref:`Modifying DB Instance Specifications ` | -| | - :ref:`Obtaining Links for Downloading Slow Query Logs ` | -| | - :ref:`Obtaining Links for Downloading Error Logs ` | -| | - :ref:`Restoring Data to a New DB Instance ` | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2022-04-29 | Added the following API: | -| | | -| | :ref:`Task Management ` | -| | | -| | 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. | -| | | -| | Added the following API: | -| | | -| | - :ref:`Querying Sessions of an Instance Node ` | -| | - :ref:`Killing Sessions of an Instance Node ` | -| | - :ref:`Querying the Number of Connections to an Instance Node ` | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-02-28 | Added the following content: | -| | | -| | - :ref:`Querying the Restoration Time Ranges ` | -| | - :ref:`Obtaining the List of Databases That Can Be Restored ` | -| | - :ref:`Obtaining the List of Database Collections That Can Be Restored ` | -| | - :ref:`Restoring Databases and Tables to a Point in Time ` | -| | - :ref:`Querying Database Slow Logs ` | -| | - :ref:`Obtaining Links for Downloading Slow Query Logs ` | -| | - :ref:`Querying Database Error Logs ` | -| | - :ref:`Obtaining Links for Downloading Error Logs ` | -| | - :ref:`Setting SQL Audit ` | -| | - :ref:`Querying SQL Audit Policy ` | -| | - :ref:`Obtaining the Audit Log List ` | -| | - :ref:`Obtaining Links for Downloading Audit Logs ` | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-08-30 | Modified the following content: | -| | | -| | - Modified the description in :ref:`Authentication `. | -| | - Modified the URI format in :ref:`Querying API Version Information `. | -| | - Modified the description of **target_type** in :ref:`Restarting a DB Instance `. | -| | - Modified the description **group_id** in :ref:`Scaling Up Storage Space `. | -| | - Modified the description of **size** in :ref:`Adding Nodes for a Cluster Instance `. | -| | | -| | Added the following content: | -| | | -| | :ref:`Restoring Data to a New DB Instance ` | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-04-16 | Modified the following content: | -| | | -| | - Modified the description of the **size** and **spec_code** parameters in :ref:`Creating a DB Instance `. | -| | | -| | Added the following content: | -| | | -| | - :ref:`Restarting a DB Instance ` | -| | - :ref:`Scaling Up Storage Space ` | -| | - :ref:`Adding Nodes for a Cluster Instance ` | -| | - :ref:`Modifying DB Instance Specifications ` | -| | - :ref:`Creating a Manual Backup ` | -| | - :ref:`Deleting a Manual Backup ` | -| | - :ref:`Querying the Backup List ` | -| | - :ref:`Querying an Automated Backup Policy ` | -| | - :ref:`Setting an Automated Backup Policy ` | -| | - :ref:`Querying Resources by Tag ` | -| | - :ref:`Adding or Deleting Resource Tags in Batches ` | -| | - :ref:`Querying Resource Tags ` | -| | - :ref:`Querying Tags in a Specified Project ` | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-01-15 | Modified the following content: | -| | | -| | - Modified the description of the **ram** parameter in :ref:`Querying Database Specifications `. | -| | - Modified the description of the **disk_encryption_id** parameter in :ref:`Querying Instances and Details `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-11-28 | Modified the following content: | -| | | -| | - Modified the value of **versions** in the response example in :ref:`Querying Database Version Information `. | -| | - Modified the description of the **type** parameter and added the response example for the single node instance in :ref:`Querying Database Specifications `. | -| | - Modified the description of the **num** parameter in :ref:`Creating a DB Instance `. | -| | - 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 `. | -| | | -| | - 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 `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-09-25 | Modified the following content: | -| | | -| | - Change the value of **spec_code** in the request and response examples in :ref:`Example `, :ref:`Querying Database Specifications `, :ref:`Creating a DB Instance `, and :ref:`Querying Instances and Details `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-08-19 | This issue is the first official release. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Date | Description | ++===================================+===================================================================================================================================================================================================================================================================================================================+ +| 2023-05-30 | Modified the following content: | +| | | +| | APIs added: :ref:`Querying DB Instances in the Recycle Bin `, :ref:`Querying the Recycling Policy of a DB Instance `, :ref:`Setting the Recycle Bin Policy `, :ref:`Configuring Cross-CIDR Access for a Replica Set ` and added support of DDS version 4.2 | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-10-30 | Modified the following content: | +| | | +| | - :ref:`Creating a DB Instance ` | +| | - :ref:`Modifying DB Instance Specifications ` | +| | - :ref:`Obtaining Links for Downloading Slow Query Logs ` | +| | - :ref:`Obtaining Links for Downloading Error Logs ` | +| | - :ref:`Restoring Data to a New DB Instance ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-04-29 | Added the following API: | +| | | +| | :ref:`Task Management ` | +| | | +| | 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. | +| | | +| | Added the following API: | +| | | +| | - :ref:`Querying Sessions of an Instance Node ` | +| | - :ref:`Killing Sessions of an Instance Node ` | +| | - :ref:`Querying the Number of Connections to an Instance Node ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-02-28 | Added the following content: | +| | | +| | - :ref:`Querying the Restoration Time Ranges ` | +| | - :ref:`Obtaining the List of Databases That Can Be Restored ` | +| | - :ref:`Obtaining the List of Database Collections That Can Be Restored ` | +| | - :ref:`Restoring Databases and Tables to a Point in Time ` | +| | - :ref:`Querying Database Slow Logs ` | +| | - :ref:`Obtaining Links for Downloading Slow Query Logs ` | +| | - :ref:`Querying Database Error Logs ` | +| | - :ref:`Obtaining Links for Downloading Error Logs ` | +| | - :ref:`Setting SQL Audit ` | +| | - :ref:`Querying SQL Audit Policy ` | +| | - :ref:`Obtaining the Audit Log List ` | +| | - :ref:`Obtaining Links for Downloading Audit Logs ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-08-30 | Modified the following content: | +| | | +| | - Modified the description in :ref:`Authentication `. | +| | - Modified the URI format in :ref:`Querying API Version Information `. | +| | - Modified the description of **target_type** in :ref:`Restarting a DB Instance `. | +| | - Modified the description **group_id** in :ref:`Scaling Up Storage Space `. | +| | - Modified the description of **size** in :ref:`Adding Nodes for a Cluster Instance `. | +| | | +| | Added the following content: | +| | | +| | :ref:`Restoring Data to a New DB Instance ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-04-16 | Modified the following content: | +| | | +| | - Modified the description of the **size** and **spec_code** parameters in :ref:`Creating a DB Instance `. | +| | | +| | Added the following content: | +| | | +| | - :ref:`Restarting a DB Instance ` | +| | - :ref:`Scaling Up Storage Space ` | +| | - :ref:`Adding Nodes for a Cluster Instance ` | +| | - :ref:`Modifying DB Instance Specifications ` | +| | - :ref:`Creating a Manual Backup ` | +| | - :ref:`Deleting a Manual Backup ` | +| | - :ref:`Querying the Backup List ` | +| | - :ref:`Querying an Automated Backup Policy ` | +| | - :ref:`Setting an Automated Backup Policy ` | +| | - :ref:`Querying Resources by Tag ` | +| | - :ref:`Adding or Deleting Resource Tags in Batches ` | +| | - :ref:`Querying Resource Tags ` | +| | - :ref:`Querying Tags in a Specified Project ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-01-15 | Modified the following content: | +| | | +| | - Modified the description of the **ram** parameter in :ref:`Querying Database Specifications `. | +| | - Modified the description of the **disk_encryption_id** parameter in :ref:`Querying Instances and Details `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-11-28 | Modified the following content: | +| | | +| | - Modified the value of **versions** in the response example in :ref:`Querying Database Version Information `. | +| | - Modified the description of the **type** parameter and added the response example for the single node instance in :ref:`Querying Database Specifications `. | +| | - Modified the description of the **num** parameter in :ref:`Creating a DB Instance `. | +| | - 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 `. | +| | | +| | - 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 `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-09-25 | Modified the following content: | +| | | +| | - Change the value of **spec_code** in the request and response examples in :ref:`Example `, :ref:`Querying Database Specifications `, :ref:`Creating a DB Instance `, and :ref:`Querying Instances and Details `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-08-19 | This issue is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+