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-04-20 10:04:46 +00:00
parent e9f8e63934
commit ae80d6b8e6
11 changed files with 151 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api-ref/source/apis_v3.0_recommended/backup_and_restoration/querying_the_backup_list.rst
View File

@ -128,15 +128,15 @@ Responses
.. table:: **Table 4** datastore field data structure description .. table:: **Table 4** datastore field data structure description
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+================================================================================================+ +=======================+=======================+==============================================================================================================+
| type | String | Indicates the DB engine. | | type | String | Indicates the DB engine. |
| | | | | | | |
| | | Valid value: **DDS-Community**. | | | | Valid value: **DDS-Community**. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
| version | String | Indicates the database of version 3.2, 3.4, or 4.0. The value is **3.2**, **3.4**, or **4.0**. | | version | String | Indicates the database of version 3.2, 3.4, 4.0, or 4.2. The value is **3.2**, **3.4**, **4.0**, or **4.2**. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------+
- Response example - Response example

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

@ -368,17 +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.0 and 3.4 are supported. The value can be **4.0** or **3.4**. | | 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. | | 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**. | | | | | - If the database version is 4.2, 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0038__table119482048538: .. _dds_api_0038__table119482048538:

2
api-ref/source/apis_v3.0_recommended/connection_management/killing_sessions_of_an_instance_node.rst
View File

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

2
api-ref/source/apis_v3.0_recommended/connection_management/querying_sessions_of_an_instance_node.rst
View File

@ -13,7 +13,7 @@ This API is used to query sessions of instance nodes.
Constraints Constraints
----------- -----------
Community Edition 3.4 and 4.0 instances are supported. Community Edition 3.4, 4.0, and 4.2 instances are supported.
URI URI
--- ---

85
api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.rst Normal file
View File

@ -0,0 +1,85 @@
:original_name: dds_api_0104.html
.. _dds_api_0104:
Configuring Cross-CIDR Access for a Replica Set
===============================================
Function
--------
This API is used to configure cross-CIDR access for a replica set instance.
Constraints
-----------
Only replica set instances are supported.
URI
---
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network
- Parameter description
.. table:: **Table 1** Parameter description
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Description |
+=============+===========+=================================================================================================================================================================================+
| project_id | Yes | Specifies the project ID of a tenant in a region. |
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_id | Yes | Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance. |
+-------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Requests
--------
- Parameter description
.. table:: **Table 2** Parameter description
+-----------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=======================+=================+==================+=========================================================================================================================================================================================================================================================================================================================================================================================+
| client_network_ranges | Yes | Array of strings | CIDR block where the client is located |
| | | | |
| | | | .. note:: |
| | | | |
| | | | - Cross-CIDR access is required only when the CIDR blocks of the client and the replica set instance are different. For example, if the client CIDR block is 192.168.0.0/16 and the replica set instance's CIDR block is 172.16.0.0/24, add the CIDR block 192.168.0.0/16 so that the client can access the replica set instance. This function is available only for replica sets. |
| | | | - For example, if the source network segment is 192.168.0.0/*xx*, the value of *xx* must range from **8** to **32**. |
| | | | - To ensure the ECS and the instance can communicate with each other, configure the connection by referring to VPC Peering Connection Overview. |
+-----------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Request example
POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/client-network
.. code-block:: text
{
"client_network_ranges":["192.168.0.0/16"]
}
Responses
---------
- Response example
.. code-block:: text
{}
Status Code
-----------
Status Code:200.
For more information, see :ref:`Status Code <dds_status_code>`.
Error Code
----------
For more information, see :ref:`Error Code <dds_error_code>`.

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

@ -120,17 +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.0 and 3.4 are supported. The value can be **4.0** or **3.4**. | | 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. | | 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**. | | | | | - If the database version is 4.2, 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table94791241013: .. _dds_api_0020__table94791241013:
@ -452,17 +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.0 and 3.4 are supported. The value can be **4.0** or **3.4**. | | 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. | | 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**. | | | | | - If the database version is 4.2, 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+
.. _dds_api_0020__table119482048538: .. _dds_api_0020__table119482048538:

2
api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst
View File

@ -16,7 +16,7 @@ Constraints
- Frozen instances do not support this operation. - Frozen instances do not support this operation.
- DB instances associated with the IPv6 subnet 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. - 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. - This function cannot be disabled after being enabled.
URI URI

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

@ -21,6 +21,7 @@ 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:`Configuring Cross-CIDR Access for a Replica Set <dds_api_0104>`
- :ref:`Setting the Recycle Bin Policy <dds_api_0138>` - :ref:`Setting the Recycle Bin Policy <dds_api_0138>`
- :ref:`Querying the Recycling Policy of a DB Instance <dds_api_0215>` - :ref:`Querying the Recycling Policy of a DB Instance <dds_api_0215>`
- :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>` - :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>`
@ -45,6 +46,7 @@ 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
configuring_cross-cidr_access_for_a_replica_set
setting_the_recycle_bin_policy setting_the_recycle_bin_policy
querying_the_recycling_policy_of_a_db_instance querying_the_recycling_policy_of_a_db_instance
querying_db_instances_in_the_recycle_bin querying_db_instances_in_the_recycle_bin

10
api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst
View File

@ -102,17 +102,17 @@ Responses
.. table:: **Table 5** RecycleDatastore .. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+============================================================================================+ +=======================+=======================+========================================================================================================+
| type | String | Database type. The value is **DDS-Community**. | | type | String | Database type. The value is **DDS-Community**. |
| | | | | | | |
| | | Enumerated values: | | | | Enumerated values: |
| | | | | | | |
| | | - DDS-Community | | | | - DDS-Community |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| version | String | Database version. Versions 3.4 and 4.0 are supported. The value can be **3.4** or **4.0**. | | 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 - Response Example

2
api-ref/source/apis_v3.0_recommended/querying_database_specifications.rst
View File

@ -107,7 +107,7 @@ Responses
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| engine_versions | Array of strings | Database versions | | engine_versions | Array of strings | Database versions |
| | | | | | | |
| | | For example, DDS mongos node, {"3.4", "4.0"} | | | | For example, DDS mongos node, {"3.4", "4.0", "4.2"} |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note:: .. note::

11
api-ref/source/apis_v3.0_recommended/querying_database_version_information.rst
View File

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