From ae80d6b8e629c07a5e12623f42998a0090893238 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Thu, 20 Apr 2023 10:04:46 +0000 Subject: [PATCH] Update content --- .../querying_the_backup_list.rst | 18 ++-- .../restoring_data_to_a_new_db_instance.rst | 22 ++--- .../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 | 44 +++++----- .../enabling_shard_or_config_ip_addresses.rst | 2 +- .../db_instance_management/index.rst | 2 + ...erying_db_instances_in_the_recycle_bin.rst | 22 ++--- .../querying_database_specifications.rst | 2 +- .../querying_database_version_information.rst | 13 +-- 11 files changed, 151 insertions(+), 63 deletions(-) create mode 100644 api-ref/source/apis_v3.0_recommended/db_instance_management/configuring_cross-cidr_access_for_a_replica_set.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 250a84d..75291c0 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,17 +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.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**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+ + | 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, 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/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..58ed6fc 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..081790c 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 4ad31b7..3bf4bcf 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,17 +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.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**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+ + | 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, 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+ .. _dds_api_0020__table94791241013: @@ -452,17 +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.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**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------+ + | 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, 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/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..fb3008c 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 c67076c..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,7 @@ 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 ` @@ -45,6 +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 index a83a0b3..a42d135 100644 --- 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 @@ -102,17 +102,17 @@ Responses .. 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**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + | 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 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..f2cd246 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.4", "4.0", "4.2"} | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: 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" ] }