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..250a84d 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 @@ -368,18 +368,17 @@ Responses .. 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.0 and 3.4 are supported. The value can be **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.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ .. _dds_api_0038__table119482048538: 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..4ad31b7 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,17 @@ 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.0 and 3.4 are supported. The value can be **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.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ .. _dds_api_0020__table94791241013: @@ -453,18 +452,17 @@ 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.0 and 3.4 are supported. The value can be **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.0 or 3.4 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/index.rst b/api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst index 30952b8..c67076c 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,9 @@ DB Instance Management - :ref:`Unbinding an EIP ` - :ref:`Changing a Private IP Address ` - :ref:`Enabling Shard or Config IP Addresses ` +- :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 +45,6 @@ DB Instance Management unbinding_an_eip changing_a_private_ip_address enabling_shard_or_config_ip_addresses + 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..a83a0b3 --- /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 and 4.0 are supported. The value can be **3.4** or **4.0**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ + +- 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/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: