lboka/document-database-service
1
0
Fork 0
forked from docs/document-database-service
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-03-29 12:25:40 +00:00
parent 170aa8b37d
commit e9f8e63934
8 changed files with 385 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst
View File

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

46
api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst
View File

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

6
api-ref/source/apis_v3.0_recommended/db_instance_management/index.rst
View File

@ -21,6 +21,9 @@ DB Instance Management
- :ref:`Unbinding an EIP <dds_api_0057>` - :ref:`Unbinding an EIP <dds_api_0057>`
- :ref:`Changing a Private IP Address <dds_api_0058>` - :ref:`Changing a Private IP Address <dds_api_0058>`
- :ref:`Enabling Shard or Config IP Addresses <dds_api_0120>` - :ref:`Enabling Shard or Config IP Addresses <dds_api_0120>`
- :ref:`Setting the Recycle Bin Policy <dds_api_0138>`
- :ref:`Querying the Recycling Policy of a DB Instance <dds_api_0215>`
- :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -42,3 +45,6 @@ DB Instance Management
unbinding_an_eip unbinding_an_eip
changing_a_private_ip_address changing_a_private_ip_address
enabling_shard_or_config_ip_addresses 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

151
api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst Normal file
View File

File diff suppressed because it is too large Load Diff

87
api-ref/source/apis_v3.0_recommended/db_instance_management/querying_the_recycling_policy_of_a_db_instance.rst Normal file
View File

@ -0,0 +1,87 @@
:original_name: dds_api_0215.html
.. _dds_api_0215:
Querying the Recycling Policy of a DB Instance
==============================================
API Description
---------------
This API is used to query the recycling policy of a DB instance.
URI
---
- URI format
GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy
- Parameter description
.. table:: **Table 1** Request parameters
+--------------+-----------+--------+---------------------------------------------------+
| Name | Mandatory | Type | Description |
+==============+===========+========+===================================================+
| x-auth-token | Yes | String | User token. |
+--------------+-----------+--------+---------------------------------------------------+
| project_id | Yes | String | Specifies the project ID of a tenant in a region. |
+--------------+-----------+--------+---------------------------------------------------+
Requests
--------
- Example request
GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/recycle-policy
Responses
---------
- Parameter description
.. table:: **Table 2** Response body parameters
+----------------+-----------------------------------------------------------------+----------------------------+
| Name | Type | Description |
+================+=================================================================+============================+
| recycle_policy | :ref:`RecyclePolicy <dds_api_0215__table19191130122514>` object | Instance recycling policy. |
+----------------+-----------------------------------------------------------------+----------------------------+
.. _dds_api_0215__table19191130122514:
.. table:: **Table 3** RecyclePolicy
+--------------------------+-----------------------+------------------------------------------------------------------------------+
| Name | Type | Description |
+==========================+=======================+==============================================================================+
| enabled | Boolean | Whether to enable the recycling policy. |
| | | |
| | | - **true**: Enable the recycling policy. |
+--------------------------+-----------------------+------------------------------------------------------------------------------+
| retention_period_in_days | Integer | Policy retention period (1 to 7 days). The value must be a positive integer. |
+--------------------------+-----------------------+------------------------------------------------------------------------------+
- Response Example
.. code-block::
{
"recycle_policy" : {
"enabled" : true,
"retention_period_in_days" : 3
}
}
Status Code
-----------
Status Code:200.
For more information, see :ref:`Status Code <dds_status_code>`.
Error Code
----------
For more information, see :ref:`Error Code <dds_error_code>`.

93
api-ref/source/apis_v3.0_recommended/db_instance_management/setting_the_recycle_bin_policy.rst Normal file
View File

@ -0,0 +1,93 @@
:original_name: dds_api_0138.html
.. _dds_api_0138:
Setting the Recycle Bin Policy
==============================
API Description
---------------
This API is used to set the recycle bin policy for an instance.
URI
---
- URI format
PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy
- Parameter description
.. table:: **Table 1** Request parameters
+--------------+-----------+--------+---------------------------------------------------+
| Name | Mandatory | Type | Description |
+==============+===========+========+===================================================+
| x-auth-token | Yes | String | User token. |
+--------------+-----------+--------+---------------------------------------------------+
| project_id | Yes | String | Specifies the project ID of a tenant in a region. |
+--------------+-----------+--------+---------------------------------------------------+
Requests
--------
- Parameter description
.. table:: **Table 2** Request body parameters
+----------------+-----------+--------+-----------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+================+===========+========+===============================================================================================+
| recycle_policy | Yes | Object | Instance recycling policy. For details, see :ref:`Table 3 <dds_api_0138__table159257245612>`. |
+----------------+-----------+--------+-----------------------------------------------------------------------------------------------+
.. _dds_api_0138__table159257245612:
.. table:: **Table 3** RecyclePolicy
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+==========================+=================+=================+==========================================================================================================================================================+
| enabled | Yes | Boolean | The recycling policy is enabled and cannot be disabled. |
| | | | |
| | | | - **true**: The recycling policy is enabled. |
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| retention_period_in_days | No | Integer | Policy retention duration (1 to 7 days). The value is a positive integer. If this parameter is left blank, the policy is retained for 7 days by default. |
+--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
- Request example
.. code-block:: text
PUT https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy
{
"recycle_policy" : {
"enabled" : true,
"retention_period_in_days" : 3
}
}
Responses
---------
- Parameter description
None
- Response example
None
Status Code
-----------
Status Code:200.
For more information, see :ref:`Status Code <dds_status_code>`.
Error Code
----------
For more information, see :ref:`Error Code <dds_error_code>`.

4
api-ref/source/apis_v3.0_recommended/log_information_queries/obtaining_links_for_downloading_slow_query_logs.rst
View File

@ -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. 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 .. 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. 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 .. code-block:: text

26
api-ref/source/apis_v3.0_recommended/tag_management/querying_resources_by_tag.rst
View File

@ -69,19 +69,19 @@ Requests
.. table:: **Table 3** tags field data structure description .. table:: **Table 3** tags field data structure description
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+==================+============================================================================================================================================================================================================================+ +=================+=================+==================+=============================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. It contains a maximum of 36 Unicode characters. **key** cannot be empty, an empty string, or spaces. Before using **key**, delete spaces of single-byte character (SBC) before and after the value. | | key | Yes | String | Specifies the tag key. It contains a maximum of 36 Unicode characters. **key** cannot be empty, an empty string, or spaces. Before using **key**, delete spaces before and after the value. |
| | | | | | | | | |
| | | | .. note:: | | | | | .. note:: |
| | | | | | | | | |
| | | | The character set of this parameter is not verified in the search process. | | | | | The character set of this parameter is not verified in the search process. |
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Lists the tag values. Each value contains a maximum of 43 Unicode characters and cannot contain spaces. Before using **values**, delete SBC spaces before and after the value. | | values | Yes | Array of strings | Lists the tag values. Each value contains a maximum of 43 Unicode characters and cannot contain spaces. Before using **values**, delete spaces before and after the value. |
| | | | | | | | | |
| | | | If the values are null, it indicates querying any value. The values are in OR relationship. | | | | | If the values are null, it indicates querying any value. The values are in OR relationship. |
+-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0032__table86147511997: .. _dds_api_0032__table86147511997: