diff --git a/api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst b/api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst index 6d5581c..cf85516 100644 --- a/api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst +++ b/api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of DDM accounts to be queried. | + | | | | | + | | | | 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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst index e60ff83..a9a81e1 100644 --- a/api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst @@ -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**. | - +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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,9 +87,8 @@ Example Request { "spec_code" : "ddm.c6.4xlarge.2", - "group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09", - "is_auto_pay" : false - } + "group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09" + } Example Response ---------------- diff --git a/api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst index a60a9dc..f3241b9 100644 --- a/api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst @@ -13,7 +13,7 @@ This API is used to create a DDM instance. Constraints ----------- -DDM runs in VPCs. Before you buy a DDM instance, ensure that a VPC is available and a subnet and security group have been configured. +DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been configured. URI --- @@ -36,20 +36,18 @@ 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 | - +==============+===========+==========================================================================================+======================+ - | instance | Yes | :ref:`CreateInstanceDetail ` object | Instance information | - +--------------+-----------+------------------------------------------------------------------------------------------+----------------------+ - | extend_param | No | :ref:`CreateInstanceExtendParam ` object | Extended parameter | - +--------------+-----------+------------------------------------------------------------------------------------------+----------------------+ + +-----------+-----------+--------------------------------------------------------------------------------+----------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+================================================================================+======================+ + | instance | Yes | :ref:`CreateInstanceDetail ` object | Instance information | + +-----------+-----------+--------------------------------------------------------------------------------+----------------------+ .. _ddm_04_0001__request_createinstancedetail: @@ -100,78 +98,22 @@ Request Parameters | | | | - Must be a combination of uppercase letters, lowercase letters, digits, and the following special characters: ``~!@#%^*-_=+?`` Must be a strong password to improve security and prevent security risks such as brute force cracking. | +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _ddm_04_0001__request_createinstanceextendparam: - -.. table:: **Table 5** CreateInstanceExtendParam - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================================================================================================================================+ - | charge_mode | No | String | Billing mode. The value can be: | - | | | | | - | | | | - **prePaid**: indicates the prepayment method. | - | | | | - **postPaid**: indicates the post-payment method. Default value: **postPaid** | - | | | | | - | | | | Default value: **postPaid** | - | | | | | - | | | | Enumerated values: | - | | | | | - | | | | - **prePaid** | - | | | | - **postPaid** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | period_type | No | String | Subscription period. The value can be: | - | | | | | - | | | | - **month**: indicates the subscription time unit is month. | - | | | | - **year**: indicates the subscription time unit is year. This parameter is valid and mandatory if **charge_mode** is set to **prePaid**. | - | | | | | - | | | | Enumerated values: | - | | | | | - | | | | - **month** | - | | | | - **year** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | period_num | No | Integer | Subscription duration. | - | | | | | - | | | | - If **period_type** is set to **month**, the value ranges from **1** to **9**. | - | | | | - If **period_type** is set to **year**, the value is **1**. This parameter is valid and mandatory if **charge_mode** is set to **prePaid**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_auto_renew | No | String | Whether the instance is automatically renewed when it expires. The value can be: | - | | | | | - | | | | - **true**: The instance is automatically renewed when it expires. | - | | | | - **false**: The instance is not automatically renewed when it expires. This parameter is valid when **charge_mode** is set to **prePaid**. The instance is not automatically renewed by default if no value is specified. " | - | | | | | - | | | | Enumerated values: | - | | | | | - | | | | - **true** | - | | | | - **false** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_auto_pay | No | String | Whether the order is paid from the customer's account balance. The value can be: | - | | | | | - | | | | - **true**: indicates that the order is automatically paid from the customer's account balance. | - | | | | - **false**: indicates that the order needs to be paid manually. This parameter is available if **charge_mode** is set to **prePaid**. The order needs to be paid manually by default if no value is specified. " | - | | | | | - | | | | Enumerated values: | - | | | | | - | | | | - **true** | - | | | | - **false** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Response Parameters ------------------- **Status code: 200** -.. table:: **Table 6** Response body parameters +.. table:: **Table 5** Response body parameters ========= ====== ============ Parameter Type Description ========= ====== ============ id String Instance ID. - order_id String Order ID. ========= ====== ============ **Status code: 400** -.. table:: **Table 7** Response body parameters +.. table:: **Table 6** Response body parameters =============== ====== ================== Parameter Type Description @@ -182,7 +124,7 @@ Response Parameters **Status code: 500** -.. table:: **Table 8** Response body parameters +.. table:: **Table 7** Response body parameters =============== ====== ================== Parameter Type Description @@ -194,77 +136,24 @@ Response Parameters Example Request --------------- -- Example request (without extended parameters) +.. code-block:: text - .. code-block:: text + POST https://{endpoint}/v1/{project_id}/instances - POST https://{endpoint}/v1/{project_id}/instances - - { - "instance" : { - "name" : "ddm-test-001", - "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", - "node_num" : "4,", - "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437", - "enterprise_project_id" : "0", - "available_zones" : [ "az1xahz" ], - "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172", - "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", - "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx", - "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx" - } - } - -- Example request (with extended parameters) - - .. code-block:: text - - POST https://{endpoint}/v1/{project_id}/instances - - { - "instance" : { - "name" : "ddm-test-002", - "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", - "node_num" : 4, - "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437", - "enterprise_project_id" : "0", - "available_zones" : [ "az1xahz" ], - "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172", - "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", - "subnet_id" : "f942f970-1a02-4eee-8927-e8670ce5a882" - }, - "extend_param" : { - "charge_mode" : "postPaid" - } - } - -- Example request - - .. code-block:: text - - POST https://{endpoint}/v1/{project_id}/instances - - { - "instance" : { - "name" : "ddm-test-003", - "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", - "node_num" : "4,", - "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437", - "enterprise_project_id" : "0", - "available_zones" : [ "az1xahz" ], - "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172", - "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", - "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx", - "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx" - }, - "extend_param" : { - "charge_mode" : "prePaid", - "period_type" : "month", - "period_num" : 1, - "is_auto_renew" : "true", - "is_auto_pay" : "true" - } - } + { + "instance" : { + "name" : "ddm-test-001", + "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", + "node_num" : "4,", + "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437", + "enterprise_project_id" : "0", + "available_zones" : [ "az1xahz" ], + "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172", + "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e", + "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx", + "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx" + } + } Example Response ---------------- @@ -276,8 +165,7 @@ OK .. code-block:: { - "id" : "", - "order_id" : "CS1810251738L8VVD" + "id" : "" } **Status code: 400** diff --git a/api-ref/source/apis_recommended/ddm_instances/index.rst b/api-ref/source/apis_recommended/ddm_instances/index.rst index 2e092c2..c6d841b 100644 --- a/api-ref/source/apis_recommended/ddm_instances/index.rst +++ b/api-ref/source/apis_recommended/ddm_instances/index.rst @@ -14,7 +14,7 @@ DDM Instances - :ref:`Restarting a DDM Instance ` - :ref:`Reloading Table Data ` - :ref:`Scaling Out a DDM Instance ` -- :ref:`Scaling in a DDM instance ` +- :ref:`Scaling In a DDM instance ` - :ref:`Modifying the Read Policy of the Associated DB Instance ` - :ref:`Synchronizing Data Node Information ` - :ref:`Querying Nodes of a DDM Instance ` @@ -24,6 +24,7 @@ DDM Instances - :ref:`Querying DDM Engine Information ` - :ref:`Querying DDM Node Classes Available in an AZ ` - :ref:`Changing the Node Class of a DDM Instance ` +- :ref:`This API is used to obtain information about the EIP bound to a DDM instance. ` .. 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. diff --git a/api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst index 73b52be..c0a5e3a 100644 --- a/api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst @@ -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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst index 46d33f7..eed337d 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of engines to be queried. | + | | | | | + | | | | 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 } diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst index cdaf2c1..d3fef08 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of instances to be queried. | + | | | | | + | | | | 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 `. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | 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, diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst index ea6bd20..5c0aa62 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst @@ -30,21 +30,23 @@ GET /v2/{project_id}/flavors .. table:: **Table 2** Query parameters - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================+ - | engine_id | Yes | String | Engine ID, which can be obtained by calling the API for querying DDM engine information. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Which page the server starts returning items. The start value cannot be less than **0**. The default value is **0**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | engine_id | Yes | String | Engine ID, which can be obtained by calling the API for querying DDM engine information. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of node classes to be queried. | + | | | | | + | | | | Value range: 1 to 128. | + | | | | | + | | | | If the parameter value is not specified, 10 node classes are queried by default. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -54,7 +56,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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ @@ -166,59 +168,59 @@ OK { "computeFlavorGroups" : [ { - "offset" : "0,", - "limit" : "128,", - "total" : "6,", - "groupType" : "X86,", + "offset" : "0", + "limit" : "128", + "total" : "6", + "groupType" : "X86", "computeFlavors" : [ { - "id" : "8f2e696c-a9c1-30bd-af90-25522bc67606,", - "typeCode" : "cloudtype.resource.type.ddm,", - "code" : "ddm.c3.large.2,", - "iaasCode" : "c3.large.2,", - "cpu" : "2,", - "mem" : "4,", - "maxConnections" : "null,", - "serverType" : "KVM,", - "architecture" : "X86,", + "id" : "8f2e696c-a9c1-30bd-af90-25522bc67606", + "typeCode" : "cloudtype.resource.type.ddm", + "code" : "ddm.c3.large.2", + "iaasCode" : "c3.large.2", + "cpu" : "2", + "mem" : "4", + "maxConnections" : "null", + "serverType" : "KVM", + "architecture" : "X86", "azStatus" : { - "az2.dc0" : "unsupported,", - "az3xahz" : "normal,", - "az2xahz" : "normal,", + "az2.dc0" : "unsupported", + "az3xahz" : "normal", + "az2xahz" : "normal", "az1xahz" : "normal" }, - "regionStatus" : "normal,", - "dbType" : "DDM,", + "regionStatus" : "normal", + "dbType" : "DDM", "extendFields" : { - "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz,", + "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz", "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz" } } ] }, { - "offset" : "0,", - "limit" : "128,", - "total" : "3,", - "groupType" : "ARM,", + "offset" : "0", + "limit" : "128", + "total" : "3", + "groupType" : "ARM", "computeFlavors" : [ { - "id" : "87a6cb8b-0c56-3e16-a91d-9b680a1f8b7f,", - "typeCode" : "cloudtype.resource.type.ddm,", - "code" : "ddm.rc6.large.2,", - "iaasCode" : "kc1.xlarge.2,", - "cpu" : "4,", - "mem" : "8,", - "maxConnections" : "null,", - "serverType" : "KVM,", - "architecture" : "ARM,", + "id" : "87a6cb8b-0c56-3e16-a91d-9b680a1f8b7f", + "typeCode" : "cloudtype.resource.type.ddm", + "code" : "ddm.rc6.large.2", + "iaasCode" : "kc1.xlarge.2", + "cpu" : "4", + "mem" : "8", + "maxConnections" : "null", + "serverType" : "KVM", + "architecture" : "ARM", "azStatus" : { - "az2.dc0" : "unsupported,", - "az3xahz" : "normal,", - "az2xahz" : "normal,", + "az2.dc0" : "unsupported", + "az3xahz" : "normal", + "az2xahz" : "normal", "az1xahz" : "normal" }, - "regionStatus" : "normal,", - "groupType" : "null,", - "dbType" : "DDM,", + "regionStatus" : "normal", + "groupType" : "null", + "dbType" : "DDM", "extendFields" : { - "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz,", + "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz", "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz" } } ] diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst index c76e9ab..4facfc2 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst @@ -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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ @@ -49,57 +49,55 @@ Response Parameters .. table:: **Table 3** Response body parameters - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================================+============================================================================+ - | id | String | DDM instance ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | status | String | DDM instance status | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | name | String | DDM instance name | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | created | String | Time when the DDM instance is created | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | updated | String | Time when the DDM instance is last updated | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | available_zone | String | Name of the AZ where the DDM instance is located | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | vpc_id | String | VPC ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | security_group_id | String | Security group ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | node_count | Integer | Number of nodes | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | access_ip | String | Address for accessing the DDM instance | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | access_port | String | Port for accessing the DDM instance | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | node_status | String | Node status | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | core_count | String | Number of CPUs | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | ram_capacity | String | Memory size in GB | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | error_msg | String | Response message. This parameter is not returned if no abnormality occurs. | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | order_id | String | Order ID. No value is returned when a pay-per-use instance is created. | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | engine_version | String | Engine version (core version) | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | nodes | Array of :ref:`GetDetailfNodesInfo ` objects | Node information | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | admin_user_name | String | Username of the administrator. The username: | - | | | | - | | | - Can include 1 to 32 characters. | - | | | - Must start with a letter. | - | | | - Can contain only letters, digits, and underscores (_). | - +-----------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=============================================================================================+===============================================================================================================+ + | id | String | DDM instance ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | status | String | DDM instance status. For details about this parameter value, see :ref:`Status Description `. | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | name | String | DDM instance name | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | created | String | Time when the DDM instance is created | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | updated | String | Time when the DDM instance is last updated | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | available_zone | String | Name of the AZ where the DDM instance is located | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | node_count | Integer | Number of nodes | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | access_ip | String | Address for accessing the DDM instance | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | access_port | String | Port for accessing the DDM instance | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | node_status | String | Node status | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | core_count | String | Number of CPUs | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | ram_capacity | String | Memory size in GB | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | error_msg | String | Response message. This parameter is not returned if no abnormality occurs. | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | engine_version | String | Engine version (core instance version) | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | nodes | Array of :ref:`GetDetailfNodesInfo ` objects | Node information | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | admin_user_name | String | Username of the administrator. The username: | + | | | | + | | | - Can include 1 to 32 characters. | + | | | - Must start with a letter. | + | | | - Can contain only letters, digits, and underscores (_). | + +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ .. _ddm_api_01_0019__response_getdetailfnodesinfo: @@ -154,26 +152,26 @@ OK { "nodes" : [ { "status" : "RUNNING", - "port" : 5066, + "port" : "5066", "ip" : "192.168.0.160" } ], - "id" : "1f5c9fd6cd984056ba89c8c87cc03278in09,", - "status" : "RUNNING,", - "name" : "BUG-ddm2-lixingqiao-test,", - "created" : "2021-11-09T03:30:01+0000,", - "updated" : "2021-12-15T09:12:58+0000,", - "available_zone" : "az1xahz,", - "vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb,", - "subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93,", - "security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6,", - "node_count" : "1,", - "access_ip" : "192.168.0.160,", - "access_port" : "5066,", - "core_count" : "2,", - "ram_capacity" : "8,", - "node_status" : "RUNNING,", - "enterprise_project_id" : "0,", - "project_id" : "070c071d8e80d58c2f42c0121b10cf9f,", + "id" : "1f5c9fd6cd984056ba89c8c87cc03278in09", + "status" : "RUNNING", + "name" : "ddm2-test", + "created" : "2021-11-09T03:30:01+0000", + "updated" : "2021-12-15T09:12:58+0000", + "available_zone" : "az1xahz", + "vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb", + "subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93", + "security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6", + "node_count" : 1, + "access_ip" : "192.168.0.160", + "access_port" : "5066", + "core_count" : "2", + "ram_capacity" : "8", + "node_status" : "RUNNING", + "enterprise_project_id" : "0", + "project_id" : "070c071d8e80d58c2f42c0121b10cf9f", "engine_version" : "3.0.6", "admin_user_name" : "root" } diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst b/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst index df116df..336c545 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst @@ -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" } diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst index 6253ef3..3196839 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of nodes to be queried. | + | | | | | + | | | | 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", diff --git a/api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst index 2965844..114b90d 100644 --- a/api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum of parameters to be queried. | + | | | | | + | | | | 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 } diff --git a/api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst index bad4f3b..9c98b57 100644 --- a/api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst @@ -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" } diff --git a/api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst index 7b4c172..9ddb9f8 100644 --- a/api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst @@ -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 diff --git a/api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst b/api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst index 7a35ec3..357b2cb 100644 --- a/api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst +++ b/api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst @@ -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**. | - +-------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+ 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 ---------------- diff --git a/api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst b/api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst index c84a4b7..eb79572 100644 --- a/api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst +++ b/api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst @@ -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 ---------------- diff --git a/api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst b/api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst new file mode 100644 index 0000000..9219d2a --- /dev/null +++ b/api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst @@ -0,0 +1,167 @@ +:original_name: ddm_api_01_0092.html + +.. _ddm_api_01_0092: + +This API is used to obtain information about the EIP bound to a DDM instance. +============================================================================= + +Function +-------- + +This API is used to obtain information about the EIP bound to a DDM instance. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/public-ips + +.. table:: **Table 1** Path parameters + + =========== ========= ====== =============== + Parameter Mandatory Type Description + =========== ========= ====== =============== + project_id Yes String Project ID + instance_id Yes String DDM instance ID + =========== ========= ====== =============== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+==================================================================================================================================+ + | 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. | + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +----------------+---------------------------------------------------------------------+-----------------+ + | Parameter | Type | Description | + +================+=====================================================================+=================+ + | public_ip_list | :ref:`PublicIpInfo ` object | EIP Information | + +----------------+---------------------------------------------------------------------+-----------------+ + +.. _ddm_api_01_0092__response_publicipinfo: + +.. table:: **Table 4** PublicIpInfo + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================+ + | id | String | ID of the EIP, which uniquely identifies the EIP. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | type | String | EIP type. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **5_bgp**: dynamic BGP | + | | | - **5_sbgp**: static BGP | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | public_ip | String | EIP | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | private_ip | String | Private IP address bound to the EIP | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | binding_entity_id | String | ID of the entity that the EIP is bound to | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | binding_entity_name | String | Name of the entity that the EIP is bound to | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + | binding_entity_type | String | Type of the entity that the EIP is bound to. DDM supports EIPs only for instance nodes. | + | | | | + | | | Enumerated values: | + | | | | + | | | - **node**: indicates that EIPs can be bound to nodes. | + | | | - **node_group**: indicates that EIPs can be bound to node groups. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============= + Parameter Type Description + ========== ====== ============= + error_code String Error code + error_msg String Error message + ========== ====== ============= + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + ========== ====== ============= + Parameter Type Description + ========== ====== ============= + error_code String Error code + error_msg String Error message + ========== ====== ============= + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Successful execution + +.. code-block:: + + { + "public_ip_list" : [ { + "id" : "243a21f1-2e34-4240-b0aa-53236badb84a", + "type" : "5_bgp", + "public_ip" : "10.154.217.126", + "private_ip" : "172.16.0.147", + "binding_entity_id" : "b25495e4cbc14fa4a3869bb7f9c8ff58no09", + "binding_entity_name" : "ddm-test_node_01", + "binding_entity_type" : "node" + } ] + } + +**Status code: 400** + +bad request + +.. code-block:: + + { + "error_code" : "DBS.280001", + "error_msg" : "Parameter error." + } + +**Status code: 500** + +server error + +.. code-block:: + + { + "error_code" : "DBS.280001", + "error_msg" : "Parameter error." + } + +Status Codes +------------ + +=========== ============ +Status Code Description +=========== ============ +200 OK +400 bad request +500 server error +=========== ============ + +Error Codes +----------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst b/api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst index 248823e..d215a28 100644 --- a/api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst +++ b/api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **1000** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Maximum records to be queried. | + | | | | | + | | | | 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. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst b/api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst index c346db1..0e9636d 100644 --- a/api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst +++ b/api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst @@ -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 | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ - | updated | String | Time when the DDM instance is last updated | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ - | databases | Array of :ref:`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 ` objects | Associated RDS instances | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===========================================================================================+=========================================================================================================+ + | name | String | Schema name | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | created | String | Time when the schema is created | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | status | String | Schema status. For details about this parameter value, see :ref:`Status Description `. | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | updated | String | Time when the DDM instance is last updated | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | databases | Array of :ref:`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 ` objects | Associated RDS instances | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ .. _ddm_api_01_0030__response_getdatabases: diff --git a/api-ref/source/apis_recommended/schemas/querying_schemas.rst b/api-ref/source/apis_recommended/schemas/querying_schemas.rst index 2206fcc..089e459 100644 --- a/api-ref/source/apis_recommended/schemas/querying_schemas.rst +++ b/api-ref/source/apis_recommended/schemas/querying_schemas.rst @@ -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**. | - | | | | | - | | | | 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**. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================+ + | offset | No | Integer | Index offset. | + | | | | | + | | | | The query starts from the next piece of data indexed by this parameter. The value is **0** by default. | + | | | | | + | | | | The value must be a positive integer. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | A maximum schemas to be queried. | + | | | | | + | | | | 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 | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ - | created | String | Time when the schema is created | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ - | used_rds | Array of :ref:`GetDatabaseUsedRds ` objects | RDS instances associated with the schema | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ - | shard_unit | Integer | Number of shards per RDS instance | - +-----------------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | 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. For details about this parameter value, see :ref:`Status Description `. | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | created | String | Time when the schema is created | + +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | used_rds | Array of :ref:`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", diff --git a/api-ref/source/appendix/status_description.rst b/api-ref/source/appendix/status_description.rst index 555b130..41dbf85 100644 --- a/api-ref/source/appendix/status_description.rst +++ b/api-ref/source/appendix/status_description.rst @@ -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 ------------------- diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index f820a15..7a4ef98 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -18,7 +18,7 @@ import os import sys extensions = [ - 'otcdocstheme' + 'otcdocstheme', ] otcdocs_auto_name = False