dadrobna/distributed-database-middleware
1
0
Fork 0
forked from docs/distributed-database-middleware
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-06-28 11:07:58 +00:00
parent f7b22806e6
commit bf5acdcb39
22 changed files with 587 additions and 561 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst
View File

@ -31,19 +31,21 @@ GET /v1/{project_id}/instances/{instance_id}/users
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum of DDM accounts to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 accounts are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -53,7 +55,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+

27
api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst
View File

@ -39,22 +39,20 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| x-auth-token | Yes | String | User token |
| x-auth-token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request body parameters
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+=========+==================================================================================================================================================================================================================================================================================================+
+===========+===========+========+=================================================================================================================================================================================================================================================+
| spec_code | Yes | String | Resource specification code of the new node class |
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| group_id | No | String | This parameter is not required if the instance has only one node group. Each instance has one node group by default. If you need to create multiple node groups, set this parameter to the ID of the group whose node class you want to change. |
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_auto_pay | No | Boolean | Whether the order is automatically paid. This parameter does not affect the billing mode of automatic renewal. **true**: indicates that the order is automatically paid from the account. **false**: indicates that the order is manually paid from the account. The default value is **false**. |
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -63,13 +61,11 @@ Response Parameters
.. table:: **Table 4** Response body parameters
+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+==================================================================================================================================+
| job_id | String | ID of the task of changing node class. This parameter is returned only when you change the node class of a pay-per-use instance. |
+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------+
| order_id | String | Order ID. This parameter is returned only when you change the node class of a yearly/monthly instance. |
+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------+
========= ====== =======================================
Parameter Type Description
========= ====== =======================================
job_id String ID of the task for changing node class.
========= ====== =======================================
**Status code: default**
@ -91,8 +87,7 @@ Example Request
{
"spec_code" : "ddm.c6.4xlarge.2",
"group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09",
"is_auto_pay" : false
"group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09"
}
Example Response

130
api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst
View File

File diff suppressed because it is too large Load Diff

4
api-ref/source/apis_recommended/ddm_instances/index.rst
View File

@ -14,7 +14,7 @@ DDM Instances
- :ref:`Restarting a DDM Instance <ddm_api_01_0023>`
- :ref:`Reloading Table Data <ddm_api_01_0024>`
- :ref:`Scaling Out a DDM Instance <ddm_api_01_0025>`
- :ref:`Scaling in a DDM instance <ddm_api_01_0026>`
- :ref:`Scaling In a DDM instance <ddm_api_01_0026>`
- :ref:`Modifying the Read Policy of the Associated DB Instance <ddm_api_01_0080>`
- :ref:`Synchronizing Data Node Information <ddm_api_01_0081>`
- :ref:`Querying Nodes of a DDM Instance <ddm_api_01_0082>`
@ -24,6 +24,7 @@ DDM Instances
- :ref:`Querying DDM Engine Information <ddm_api_01_0015>`
- :ref:`Querying DDM Node Classes Available in an AZ <ddm_api_01_0016>`
- :ref:`Changing the Node Class of a DDM Instance <ddm_api_01_0017>`
- :ref:`This API is used to obtain information about the EIP bound to a DDM instance. <ddm_api_01_0092>`
.. toctree::
:maxdepth: 1
@ -48,3 +49,4 @@ DDM Instances
querying_ddm_engine_information
querying_ddm_node_classes_available_in_an_az
changing_the_node_class_of_a_ddm_instance
this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance.

2
api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst
View File

@ -37,7 +37,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+

42
api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst
View File

@ -8,7 +8,7 @@ Querying DDM Engine Information
Function
--------
This API is used to query information about DDM engine.
This API is used to query engines that DDM supports.
Constraints
-----------
@ -30,19 +30,21 @@ GET /v2/{project_id}/engines
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum of engines to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 engines are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -52,7 +54,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -144,21 +146,21 @@ OK
{
"engineGroups" : [ {
"id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c,",
"name" : "ddm,",
"version" : "3.0.8,",
"id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c",
"name" : "ddm",
"version" : "3.0.8",
"supportAzs" : [ {
"code" : "az1xahz,",
"name" : "az1xahz,",
"code" : "az1xahz",
"name" : "az1xahz",
"favored" : false
}, {
"code" : "az2xahz,",
"name" : "az2xahz,",
"code" : "az2xahz",
"name" : "az2xahz",
"favored" : true
} ]
} ],
"offset" : "0,",
"limit" : "128,",
"offset" : "0",
"limit" : "128",
"total" : 1
}

60
api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst
View File

@ -30,19 +30,21 @@ GET /v1/{project_id}/instances
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **10**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum of instances to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 DDM instances are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -52,7 +54,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -89,7 +91,7 @@ Response Parameters
+=======================+=======================+=======================================================================================================================================+
| id | String | DDM instance ID |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| status | String | DDM instance status |
| status | String | DDM instance status. For details about this parameter value, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Name of the created DDM instance |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
@ -125,9 +127,7 @@ Response Parameters
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of a tenant in a region |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| engine_version | String | Engine version (core version) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| order_id | String | Order ID, which is returned if the DDM instance is billed on a yearly/monthly basis |
| engine_version | String | Engine version (core instance version) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**
@ -171,23 +171,23 @@ OK
{
"instance_num" : 26,
"instances" : [ {
"id" : "73f27bb0b26d4a79a9b0c58a4c700c4fin09,",
"status" : "RUNNING,",
"name" : "ddm-36c7,",
"created" : "2021-12-14T07:46:22+0000,",
"updated" : "2021-12-14T10:11:22+0000,",
"available_zone" : "az1xahz,",
"vpc_id" : "1d9441c5-1a4b-431d-9edb-bf3564a83e74,",
"subnet_id" : "20c2d83c-755b-42a2-846a-4688eb35d1a7,",
"security_group_id" : "fbdff89d-32fe-45a4-832b-115ac4bfaac9,",
"node_count" : "1,",
"id" : "73f27bb0b26d4a79a9b0c58a4c700c4fin09",
"status" : "RUNNING",
"name" : "ddm-36c7",
"created" : "2021-12-14T07:46:22+0000",
"updated" : "2021-12-14T10:11:22+0000",
"available_zone" : "az1xahz",
"vpc_id" : "1d9441c5-1a4b-431d-9edb-bf3564a83e74",
"subnet_id" : "20c2d83c-755b-42a2-846a-4688eb35d1a7",
"security_group_id" : "fbdff89d-32fe-45a4-832b-115ac4bfaac9",
"node_count" : 1,
"access_ip" : "192.168.23.143",
"access_port" : "5066,",
"core_count" : "2,",
"ram_capacity" : "4,",
"node_status" : "RUNNING,",
"enterprise_project_id" : "0,",
"project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c,",
"access_port" : "5066",
"core_count" : "2",
"ram_capacity" : "4",
"node_status" : "RUNNING",
"enterprise_project_id" : "0",
"project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"engine_version" : "3.0.8"
} ],
"page_size" : 1,

102
api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst
View File

File diff suppressed because it is too large Load Diff

90
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst
View File

File diff suppressed because it is too large Load Diff

18
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst
View File

@ -38,7 +38,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -104,14 +104,14 @@ OK
.. code-block::
{
"status" : "normal,",
"name" : "BUG-ddm2-lixingqiao-test_node_01,",
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09,",
"private_ip" : "192.168.0.160,",
"floating_ip" : "100.65.78.158,",
"server_id" : "8bd4d0bd-f63e-489a-95b6-50351f9657e6,",
"datavolume_id" : "30ade9fb-26de-4d1f-af08-c376974b9d86,",
"res_subnet_ip" : "172.16.15.224,",
"status" : "normal",
"name" : "ddm2-test_node_01",
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
"private_ip" : "192.168.0.160",
"floating_ip" : "100.65.78.158",
"server_id" : "8bd4d0bd-f63e-489a-95b6-50351f9657e6",
"datavolume_id" : "30ade9fb-26de-4d1f-af08-c376974b9d86",
"res_subnet_ip" : "172.16.15.224",
"systemvolume_id" : "88d7de55-f886-4929-ae7c-04d842959700"
}

28
api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst
View File

@ -31,19 +31,21 @@ GET /v1/{project_id}/instances/{instance_id}/nodes
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum of nodes to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 nodes are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -53,7 +55,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -130,9 +132,9 @@ OK
{
"nodes" : [ {
"port" : "5066,",
"status" : "normal,",
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09,",
"port" : "5066",
"status" : "normal",
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
"ip" : "192.168.0.160"
} ],
"offset" : "DBS.280001",

38
api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst
View File

@ -31,19 +31,21 @@ GET /v3/{project_id}/instances/{instance_id}/configurations
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum of parameters to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 parameters are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -55,7 +57,7 @@ Request Parameters
+=================+=================+=================+======================================================================================================================+
| X-Language | No | String | Language. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -138,16 +140,16 @@ OK
{
"updated" : "2021-11-09 03:26:52",
"configuration_parameter" : [ {
"name" : "temp_table_size_limit,",
"value" : "1000000,",
"need_restart" : "0,",
"read_only" : "0,",
"value_range" : "500000-2000000000,",
"data_type" : "integer,",
"name" : "temp_table_size_limit",
"value" : "1000000",
"need_restart" : "0",
"read_only" : "0",
"value_range" : "500000-2000000000",
"data_type" : "integer",
"description" : "Maximum size of the temporary table."
} ],
"offset" : "0,",
"limit" : "128,",
"offset" : "0",
"limit" : "128",
"total" : 22
}

4
api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst
View File

@ -37,7 +37,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -129,7 +129,7 @@ ok
{
"instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
"instanceName" : "BUG-ddm-fb88-test",
"instanceName" : "ddm-fb88-test",
"jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

10
api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst
View File

@ -2,7 +2,7 @@
.. _ddm_api_01_0026:
Scaling in a DDM instance
Scaling In a DDM instance
=========================
Function
@ -13,7 +13,7 @@ This API is used to remove nodes from a specified DDM instance.
Constraints
-----------
Make sure that the associated RDS instances are available and not undergoing other operations. Yearly/Monthly instances do not support this operation.
Make sure that the associated RDS instances are available and not undergoing other operations.
URI
---
@ -37,7 +37,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -92,7 +92,7 @@ Response Parameters
Example Request
---------------
- Example request 1
- Example request
.. code-block:: text
@ -102,7 +102,7 @@ Example Request
"node_number" : 2
}
- Example request 2 where the DDM instance has more than one group
- Example request where the DDM instance has more than one group
.. code-block:: text

30
api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst
View File

@ -37,24 +37,22 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request body parameters
+-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+=========+====================================================================================================================================================================================================================================================================================================+
+=============+===========+=========+======================================================================================================================================+
| flavor_id | Yes | String | Flavor ID of the VM for deploying the DDM instance that is to be scaled out |
+-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
| node_number | Yes | Integer | Number of nodes to be added |
+-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
| group_id | No | String | Group ID, which specifies the node group that is scaled out. This parameter must be specified if there are more than one node group. |
+-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_auto_pay | No | Boolean | Whether the order is automatically paid. This parameter does not affect the billing mode of automatic renewal. **true**: indicates that the order is automatically paid from your account. **false**: indicates that the order is manually paid from your account. The default value is **false**. |
+-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -96,7 +94,7 @@ Response Parameters
Example Request
---------------
- Example request 1
- Example request
.. code-block:: text
@ -107,7 +105,7 @@ Example Request
"node_number" : 1
}
- Example request 2: Scaling out a DDM instance that has more than one group
- Example request where the DDM instance has more than one group
.. code-block:: text
@ -119,18 +117,6 @@ Example Request
"node_number" : 1
}
- Example request 3: Scaling out a yearly/monthly instance for which parameter **is_auto_pay** is set to **true**
.. code-block:: text
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge
{
"flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
"node_number" : 1,
"is_auto_pay" : true
}
Example Response
----------------

4
api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst
View File

@ -37,7 +37,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -85,8 +85,6 @@ Example Request
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds/sync
None
Example Response
----------------

167
api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst Normal file
View File

File diff suppressed because it is too large Load Diff

22
api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst
View File

@ -31,19 +31,21 @@ GET /v1/{project_id}/instances/{instance_id}/rds
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+========================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **1000**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Maximum records to be queried. |
| | | | |
| | | | Maximum value: **1000** |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 is used by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -53,7 +55,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+

28
api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst
View File

@ -40,7 +40,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -62,32 +62,32 @@ Response Parameters
.. table:: **Table 4** GetDatabaseResponseBean
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+===========================================================================================+================================================================+
+=======================+===========================================================================================+=========================================================================================================+
| name | String | Schema name |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| created | String | Time when the schema is created |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| status | String | Schema status |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| status | String | Schema status. For details about this parameter value, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| updated | String | Time when the DDM instance is last updated |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| databases | Array of :ref:`GetDatabases <ddm_api_01_0030__response_getdatabases>` objects | Sharding information of the schema |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_mode | String | Sharding mode of the schema |
| | | |
| | | - **cluster**: indicates that the schema is in sharded mode. |
| | | - **single**: indicates that the schema is in unsharded mode. |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_number | Integer | Number of shards in the same working mode |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_unit | Integer | Number of shards per RDS instance |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| dataVips | Array of strings | IP address and port number for connecting to the schema |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| used_rds | Array of :ref:`GetDatabaseUsedRds <ddm_api_01_0030__response_getdatabaseusedrds>` objects | Associated RDS instances |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
.. _ddm_api_01_0030__response_getdatabases:

54
api-ref/source/apis_recommended/schemas/querying_schemas.rst
View File

@ -31,19 +31,21 @@ GET /v1/{project_id}/instances/{instance_id}/databases
.. table:: **Table 2** Query parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================+
| offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. |
+=================+=================+=================+========================================================================================================+
| offset | No | Integer | Index offset. |
| | | | |
| | | | Minimum value: **0** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Number of records displayed on each page. The value is greater than **0** and not greater than **128**. The default value is **128**. |
| | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. |
| | | | |
| | | | Minimum value: **1** |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum schemas to be queried. |
| | | | |
| | | | Maximum value: **128** |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| | | | Value range: 1 to 128. |
| | | | |
| | | | If the parameter value is not specified, 10 schemas are queried by default. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -53,7 +55,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -77,26 +79,26 @@ Response Parameters
.. table:: **Table 5** GetDatabaseInfo
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+===========================================================================================+================================================================+
+=======================+===========================================================================================+=========================================================================================================+
| name | String | Schema name |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_mode | String | Sharding mode of the schema |
| | | |
| | | - **cluster**: indicates that the schema is in sharded mode. |
| | | - **single**: indicates that the schema is in unsharded mode. |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_number | Integer | Number of shards in the same working mode |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| status | String | Schema status |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| status | String | Schema status. For details about this parameter value, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| created | String | Time when the schema is created |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| used_rds | Array of :ref:`GetDatabaseUsedRds <ddm_api_01_0029__response_getdatabaseusedrds>` objects | RDS instances associated with the schema |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| shard_unit | Integer | Number of shards per RDS instance |
+-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
.. _ddm_api_01_0029__response_getdatabaseusedrds:
@ -154,12 +156,12 @@ OK
{
"databases" : [ {
"status" : "RUNNING,",
"created" : "1642063713625,",
"name" : "mytestdb170,",
"shard_mode" : "cluster,",
"shard_number" : "8,",
"shard_unit" : "8,",
"status" : "RUNNING",
"created" : "1642063713625",
"name" : "mytestdb170",
"shard_mode" : "cluster",
"shard_number" : "8",
"shard_unit" : "8",
"used_rds" : [ {
"id" : "c6f68fed9e74478c8679479a07d7d568in01",
"status" : "normal",

52
api-ref/source/appendix/status_description.rst
View File

@ -10,43 +10,21 @@ DDM Instance Statuses
.. table:: **Table 1** DDM instance statuses
+--------------------------+--------------------------------------------------------------------------+
| Status | Description |
+==========================+==========================================================================+
| CREATING | The DDM instance is being created. |
+--------------------------+--------------------------------------------------------------------------+
| CREATEFAILED | The DDM instance fails to be created. |
+--------------------------+--------------------------------------------------------------------------+
| RUNNING | The DDM instance is running and available. |
+--------------------------+--------------------------------------------------------------------------+
| ERROR | The DDM instance is faulty. |
+--------------------------+--------------------------------------------------------------------------+
| RESTARTING | The DDM instance is being restarted. |
+--------------------------+--------------------------------------------------------------------------+
| FREEZING | The DDM instance is being frozen. |
+--------------------------+--------------------------------------------------------------------------+
| FROZEN | The DDM instance is frozen. |
+--------------------------+--------------------------------------------------------------------------+
| UNFREEZING | The DDM instance is being unfrozen. |
+--------------------------+--------------------------------------------------------------------------+
| RESIZING | Class of the DDM instance fail to be changed. |
+--------------------------+--------------------------------------------------------------------------+
| UPGRADE_VERSION_INSTANCE | The version is being upgraded. |
+--------------------------+--------------------------------------------------------------------------+
| GROWING | A DDM instance is being scaled out. |
+--------------------------+--------------------------------------------------------------------------+
| REDUCING | A DDM instance is being scaled in. |
+--------------------------+--------------------------------------------------------------------------+
| data_disk_full | Disk space is full. |
+--------------------------+--------------------------------------------------------------------------+
| RESTORE | A DDM instance is being restored. |
+--------------------------+--------------------------------------------------------------------------+
| BACKUP | A DDM instance is being backed up. |
+--------------------------+--------------------------------------------------------------------------+
| ONDEMAND_TO_PERIOD | The billing mode of the DDM instance is being changed to yearly/monthly. |
+--------------------------+--------------------------------------------------------------------------+
| PERIOD_RESOURCE_SPEC_CHG | The change to the yearly/monthly DDM instance is being verified. |
+--------------------------+--------------------------------------------------------------------------+
============== =============================================
Status Description
============== =============================================
CREATING The DDM instance is being created.
CREATEFAILED The DDM instance fails to be created.
RUNNING The DDM instance is running and available.
ERROR The DDM instance is faulty.
RESTARTING The DDM instance is being restarted.
RESIZING Class of the DDM instance fail to be changed.
GROWING A DDM instance is being scaled out.
REDUCING A DDM instance is being scaled in.
data_disk_full Disk space is full.
RESTORE A DDM instance is being restored.
BACKUP A DDM instance is being backed up.
============== =============================================
DDM Schema Statuses
-------------------

2
api-ref/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys
extensions = [
'otcdocstheme'
'otcdocstheme',
]
otcdocs_auto_name = False