Compare commits
20 Commits
propose-dd
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| b3ecf9fc5b | |||
| bab39dfb01 | |||
| 08efb2938c | |||
| da6cbcc3a5 | |||
| 40e37c8637 | |||
| 45c9ba0e77 | |||
| 8951b1eb57 | |||
| 0283a84ece | |||
| cd8423fd25 | |||
| 6422890d45 | |||
| b773d784ea | |||
| 66e5d4252c | |||
| 8893a01ea1 | |||
| 264dadb4c1 | |||
| e69dfc5805 | |||
| d78b9de5cd | |||
| e6d9c5f271 | |||
| 21f552005d | |||
| 0b6e64f33f | |||
| 170aa8b37d |
@ -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, 4.2, or 4.4. The value is **3.2**, **3.4**, **4.0**, **4.2**, or **4.4**. |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ Requests
|
||||
| | | | |
|
||||
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
|
||||
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. |
|
||||
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
|
||||
| | | | |
|
||||
| | | | If this parameter is not transferred, disk encryption is not performed. |
|
||||
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -333,7 +333,7 @@ Responses
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| name | String | which is the same as the request parameter. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| datastore | Object | Indicates the database information, which is the same as the request parameter. For more information, see :ref:`Table 7 <dds_api_0038__table149461548134>`. |
|
||||
| datastore | Object | Indicates the database information, which is the same as the request parameter. For more information, see :ref:`Table 7 <dds_api_0038__table228903751753>`. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created | String | Indicates the creation time in the following format: yyyy-mm-dd hh:mm:ss. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -364,22 +364,22 @@ Responses
|
||||
| ssl_option | String | Indicates whether to enable SSL, which functions the same as the request parameter. |
|
||||
+-----------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0038__table149461548134:
|
||||
.. _dds_api_0038__table228903751753:
|
||||
|
||||
.. table:: **Table 7** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+============================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0038__table119482048538:
|
||||
|
||||
@ -479,7 +479,7 @@ Responses
|
||||
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "Sharding",
|
||||
"flavor": [
|
||||
{
|
||||
@ -528,7 +528,7 @@ Responses
|
||||
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "ReplicaSet",
|
||||
"flavor": [
|
||||
{
|
||||
@ -566,7 +566,7 @@ Responses
|
||||
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "Single",
|
||||
"flavor": [
|
||||
{
|
||||
|
||||
@ -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, 4.2, and 4.4 instances are supported.
|
||||
- Inactive sessions cannot be terminated.
|
||||
|
||||
URI
|
||||
|
||||
@ -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, 4.2, and 4.4 instances are supported.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
@ -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>`.
|
||||
@ -78,7 +78,7 @@ Requests
|
||||
| | | | |
|
||||
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
|
||||
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| disk_encryption_id | No | String | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. |
|
||||
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. |
|
||||
| | | | |
|
||||
| | | | If this parameter is not transferred, disk encryption is not performed. |
|
||||
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -120,18 +120,18 @@ Requests
|
||||
|
||||
.. table:: **Table 3** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+============================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0020__table94791241013:
|
||||
|
||||
@ -453,18 +453,18 @@ Responses
|
||||
|
||||
.. table:: **Table 8** datastore field data structure description
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+==========================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.2, 4.0, and 3.4 are supported. The value can be **4.2**, **4.0**, or **3.4**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=================+=================+=================+============================================================================================================================================+
|
||||
| type | Yes | String | Specifies the database type. The value is **DDS-Community**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| version | Yes | String | Specifies the database version. Versions 4.4, 4.2, 4.0, 3.4 and 3.2 are supported. The value can be **4.4, 4.2, 4.0,** **3.4** or **3.2**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| storage_engine | Yes | String | Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines. |
|
||||
| | | | |
|
||||
| | | | - If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is **rocksDB**. |
|
||||
| | | | - If the database version is 4.0, 3.4 or 3.2 and the storage engine is WiredTiger, the value is **wiredTiger**. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dds_api_0020__table119482048538:
|
||||
|
||||
@ -583,7 +583,7 @@ Responses
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"port": 8365,
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "Sharding",
|
||||
"flavor": [
|
||||
{
|
||||
@ -637,7 +637,7 @@ Responses
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"port": 8365,
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "ReplicaSet",
|
||||
"flavor": [
|
||||
{
|
||||
@ -680,7 +680,7 @@ Responses
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
|
||||
"port": 8365,
|
||||
"disk_encryption_id": "",
|
||||
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
|
||||
"mode": "Single",
|
||||
"flavor": [
|
||||
{
|
||||
|
||||
@ -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, 4.2 and 4.4 are supported.
|
||||
- This function cannot be disabled after being enabled.
|
||||
|
||||
URI
|
||||
|
||||
@ -21,6 +21,10 @@ DB Instance Management
|
||||
- :ref:`Unbinding an EIP <dds_api_0057>`
|
||||
- :ref:`Changing a Private IP Address <dds_api_0058>`
|
||||
- :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:`Querying the Recycling Policy of a DB Instance <dds_api_0215>`
|
||||
- :ref:`Querying DB Instances in the Recycle Bin <dds_api_021>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -42,3 +46,7 @@ DB Instance Management
|
||||
unbinding_an_eip
|
||||
changing_a_private_ip_address
|
||||
enabling_shard_or_config_ip_addresses
|
||||
configuring_cross-cidr_access_for_a_replica_set
|
||||
setting_the_recycle_bin_policy
|
||||
querying_the_recycling_policy_of_a_db_instance
|
||||
querying_db_instances_in_the_recycle_bin
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -168,7 +168,7 @@ Responses
|
||||
| | | |
|
||||
| | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| disk_encryption_id | String | Indicates the disk encryption key ID. This parameter is returned only when the instance disk is encrypted. |
|
||||
| disk_encryption_id | String | The disk encryption key ID. This parameter is returned only when the instance disk is encrypted. |
|
||||
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | Indicates the enterprise project ID. |
|
||||
| | | |
|
||||
|
||||
@ -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>`.
|
||||
@ -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>`.
|
||||
@ -14,6 +14,7 @@ APIs V3.0 (Recommended)
|
||||
- :ref:`Backup and Restoration <dds_backup_restore>`
|
||||
- :ref:`Log Information Queries <dds_api_0092>`
|
||||
- :ref:`Tag Management <dds_tag_mgmt>`
|
||||
- :ref:`Managing Databases and Users <dds_api_0070>`
|
||||
- :ref:`Task Management <dds_api_0117>`
|
||||
|
||||
.. toctree::
|
||||
@ -29,4 +30,5 @@ APIs V3.0 (Recommended)
|
||||
backup_and_restoration/index
|
||||
log_information_queries/index
|
||||
tag_management/index
|
||||
managing_databases_and_users/index
|
||||
task_management/index
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -0,0 +1,87 @@
|
||||
:original_name: dds_api_0075.html
|
||||
|
||||
.. _dds_api_0075:
|
||||
|
||||
Changing the Password of a Database User
|
||||
========================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to change the password of a database user
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
This operation cannot be performed on frozen or abnormal instances.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
- URI format
|
||||
|
||||
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reset-password
|
||||
|
||||
- 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 |
|
||||
+=================+=================+=================+=========================================================================================================================================================================================+
|
||||
| user_name | No | String | Specifies the database username. The default value is **"rwuser"**. |
|
||||
| | | | |
|
||||
| | | | The value must be 1 to 64 characters and can contain only letters (from A to Z or from a to z), digits (from 0 to 9), hyphens (-), and periods (.). |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| user_pwd | Yes | String | Specifies the database password. |
|
||||
| | | | |
|
||||
| | | | - The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ``~!@#%^*-_=+?`` |
|
||||
| | | | - Enter a strong password to improve security, preventing security risks such as brute force cracking. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| db_name | No | String | Specifies the database name. The default value is **"admin"**. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Request example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
{
|
||||
"user_name": "rwuser",
|
||||
"user_pwd": "******"
|
||||
}
|
||||
|
||||
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>`.
|
||||
@ -0,0 +1,14 @@
|
||||
:original_name: dds_api_0070.html
|
||||
|
||||
.. _dds_api_0070:
|
||||
|
||||
Managing Databases and Users
|
||||
============================
|
||||
|
||||
- :ref:`Changing the Password of a Database User <dds_api_0075>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
changing_the_password_of_a_database_user
|
||||
File diff suppressed because it is too large
Load Diff
@ -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, 4.2, and 4.4 are supported. |
|
||||
+----------+------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Response example
|
||||
|
||||
@ -57,7 +57,9 @@ Responses
|
||||
"versions": [
|
||||
"3.2",
|
||||
"3.4",
|
||||
"4.0"
|
||||
"4.0",
|
||||
"4.2",
|
||||
"4.4"
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -18,7 +18,7 @@ import os
|
||||
import sys
|
||||
|
||||
extensions = [
|
||||
'otcdocstheme'
|
||||
'otcdocstheme',
|
||||
]
|
||||
|
||||
otcdocs_auto_name = False
|
||||
@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/document-database-service'
|
||||
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
|
||||
otcdocs_git_type = 'gitea'
|
||||
|
||||
# Those variables are needed for indexing into OpenSearch
|
||||
otcdocs_doc_environment = 'internal'
|
||||
otcdocs_doc_link = '/document-database-service/api-ref/'
|
||||
otcdocs_doc_title = 'API Reference'
|
||||
otcdocs_doc_type = 'api-ref'
|
||||
otcdocs_service_category = 'database'
|
||||
otcdocs_service_title = 'Document Database Service'
|
||||
otcdocs_service_type = 'dds'
|
||||
otcdocs_search_environment = 'hc_de'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
@ -98,4 +109,9 @@ html_static_path = ['_static']
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = []
|
||||
latex_documents = [
|
||||
('index',
|
||||
'None.tex',
|
||||
u'Document Database Service - API Reference',
|
||||
u'OpenTelekomCloud', 'manual'),
|
||||
]
|
||||
|
||||
0
doc/best-practice/source/_static/.placeholder
Normal file
0
doc/best-practice/source/_static/.placeholder
Normal file
117
doc/best-practice/source/conf.py
Normal file
117
doc/best-practice/source/conf.py
Normal file
File diff suppressed because it is too large
Load Diff
2
doc/best-practice/source/docutils.conf
Normal file
2
doc/best-practice/source/docutils.conf
Normal file
@ -0,0 +1,2 @@
|
||||
[html writers]
|
||||
table-style: table, caption-top
|
||||
4
doc/best-practice/source/index.rst
Normal file
4
doc/best-practice/source/index.rst
Normal file
@ -0,0 +1,4 @@
|
||||
=========================================
|
||||
Document Database Service - Best Practice
|
||||
=========================================
|
||||
|
||||
@ -1,4 +1,11 @@
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
|
||||
otcdocstheme # Apache-2.0
|
||||
|
||||
# releasenotes
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
|
||||
otc-sphinx-directives>=0.1.0
|
||||
sphinx-minify>=0.0.1 # Apache-2.0
|
||||
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
|
||||
setuptools
|
||||
0
doc/source/_static/placeholder
Normal file
0
doc/source/_static/placeholder
Normal file
113
doc/source/conf.py
Normal file
113
doc/source/conf.py
Normal file
File diff suppressed because it is too large
Load Diff
14
doc/source/index.rst
Normal file
14
doc/source/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
Document Database Service
|
||||
=========================
|
||||
|
||||
Document Database Service (DDS) is a cloud computing-based NoSQL database featuring high performance storage, high availability architecture, and disaster recovery failover, along with online scaling, backup, and restoration capabilities. It has a mature performance monitoring system, a multi-level security protection mechanism, and a professional database management platform.
|
||||
|
||||
.. directive_wrapper::
|
||||
:class: container-sbv
|
||||
|
||||
.. service_card::
|
||||
:service_type: dds
|
||||
:environment: internal
|
||||
:umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
|
||||
:api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.
|
||||
:best-practice: To use Document Database Service more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
Before Width: | Height: | Size: 214 B After Width: | Height: | Size: 214 B |
BIN
umn/source/_static/images/en-us_image_0000001095974034.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001095974034.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
umn/source/_static/images/en-us_image_0000001095974038.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001095974038.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
umn/source/_static/images/en-us_image_0000001095974050.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001095974050.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 540 B After Width: | Height: | Size: 540 B |
|
Before Width: | Height: | Size: 540 B After Width: | Height: | Size: 540 B |
BIN
umn/source/_static/images/en-us_image_0000001095974104.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001095974104.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
umn/source/_static/images/en-us_image_0000001095974106.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001095974106.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 93 KiB |
BIN
umn/source/_static/images/en-us_image_0000001096133860.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001096133860.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 214 B After Width: | Height: | Size: 214 B |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 540 B After Width: | Height: | Size: 540 B |
BIN
umn/source/_static/images/en-us_image_0000001096133894.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001096133894.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
BIN
umn/source/_static/images/en-us_image_0000001096133896.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001096133896.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
umn/source/_static/images/en-us_image_0000001096133902.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001096133902.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 214 B |
|
Before Width: | Height: | Size: 190 B After Width: | Height: | Size: 190 B |
|
Before Width: | Height: | Size: 295 B After Width: | Height: | Size: 295 B |
|
Before Width: | Height: | Size: 214 B After Width: | Height: | Size: 214 B |
|
Before Width: | Height: | Size: 1004 B After Width: | Height: | Size: 1004 B |
BIN
umn/source/_static/images/en-us_image_0000001096133932.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001096133932.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user