From 9c0208ed76627423241b41480b75fe377b1c1a02 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Wed, 1 Nov 2023 02:40:22 +0000 Subject: [PATCH] Update content --- ...0.png => en-us_image_0000001685146158.png} | Bin ...3.png => en-us_image_0000001733265073.png} | Bin ...5.jpg => en-us_image_0000001733265081.jpg} | Bin api-ref/source/api_overview.rst | 2 - .../managing_the_administrator_password.rst | 2 +- .../ddm_accounts/querying_ddm_accounts.rst | 4 +- ...nging_the_node_class_of_a_ddm_instance.rst | 31 ++-- .../ddm_instances/creating_a_ddm_instance.rst | 115 ++++++------ .../apis_recommended/ddm_instances/index.rst | 2 - .../ddm_instances/querying_ddm_instances.rst | 6 +- .../querying_details_of_a_ddm_instance.rst | 22 +-- ...uerying_details_of_a_ddm_instance_node.rst | 37 ++-- .../querying_nodes_of_a_ddm_instance.rst | 19 +- .../scaling_out_a_ddm_instance.rst | 2 + ...about_the_eip_bound_to_a_ddm_instance..rst | 167 ------------------ .../monitoring/monitoring_slow_query_logs.rst | 13 +- .../schemas/deleting_a_schema.rst | 2 +- .../schemas/querying_schemas.rst | 4 +- .../appendix/obtaining_a_project_id.rst | 2 +- .../source/appendix/status_description.rst | 49 +++-- api-ref/source/before_you_start/concepts.rst | 2 +- .../source/calling_apis/returned_values.rst | 2 +- api-ref/source/change_history.rst | 16 +- api-ref/source/conf.py | 11 ++ 24 files changed, 196 insertions(+), 314 deletions(-) rename api-ref/source/_static/images/{en-us_image_0000001460419110.png => en-us_image_0000001685146158.png} (100%) rename api-ref/source/_static/images/{en-us_image_0000001509858673.png => en-us_image_0000001733265073.png} (100%) rename api-ref/source/_static/images/{en-us_image_0000001509539765.jpg => en-us_image_0000001733265081.jpg} (100%) delete mode 100644 api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst diff --git a/api-ref/source/_static/images/en-us_image_0000001460419110.png b/api-ref/source/_static/images/en-us_image_0000001685146158.png similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001460419110.png rename to api-ref/source/_static/images/en-us_image_0000001685146158.png diff --git a/api-ref/source/_static/images/en-us_image_0000001509858673.png b/api-ref/source/_static/images/en-us_image_0000001733265073.png similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001509858673.png rename to api-ref/source/_static/images/en-us_image_0000001733265073.png diff --git a/api-ref/source/_static/images/en-us_image_0000001509539765.jpg b/api-ref/source/_static/images/en-us_image_0000001733265081.jpg similarity index 100% rename from api-ref/source/_static/images/en-us_image_0000001509539765.jpg rename to api-ref/source/_static/images/en-us_image_0000001733265081.jpg diff --git a/api-ref/source/api_overview.rst b/api-ref/source/api_overview.rst index 36afe0a..0393180 100644 --- a/api-ref/source/api_overview.rst +++ b/api-ref/source/api_overview.rst @@ -80,5 +80,3 @@ DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including +---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Monitoring | Monitoring slow query logs | This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range. | +---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Monitoring the read/write ratio (unavailable Soon) | This API is used to query reads and writes of a DDM instance in a specified time range. | - +---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst b/api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst index d0c35f6..228bfa9 100644 --- a/api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst +++ b/api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst @@ -88,7 +88,7 @@ Example Request .. code-block:: text - POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user + PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user { "name" : "root", 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 bf66d1e..57a727c 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 @@ -98,7 +98,7 @@ Response Parameters +-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | description | String | Description of the DDM account | +-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ - | created | String | Time when the DDM account is created. The format is yyyy-mm-ddThh:mm:ssZ. | + | created | Integer | Time when the DDM account is created | +-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | databases | Array of :ref:`GetUsersListdatabase ` objects | Associated schemas | +-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ @@ -158,7 +158,7 @@ OK "status" : "RUNNING", "base_authority" : [ "SELECT" ], "description" : "Account", - "created" : "2019-10-30T11:01:24+0800", + "created" : 1686904661709, "databases" : [ { "name" : "test", "description" : "Schema" 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 184a43b..fdbc200 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 @@ -46,13 +46,15 @@ Request Parameters .. 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. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 | The function has not been supported, and this field is reserved. | + +-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -61,11 +63,13 @@ Response Parameters .. table:: **Table 4** Response body parameters - ========= ====== ======================================= - Parameter Type Description - ========= ====== ======================================= - job_id String ID of the task for changing node class. - ========= ====== ======================================= + +-----------+--------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==================================================================+ + | job_id | String | ID of the task for changing node class. | + +-----------+--------+------------------------------------------------------------------+ + | order_id | String | The function has not been supported, and this field is reserved. | + +-----------+--------+------------------------------------------------------------------+ **Status code: 400** @@ -111,7 +115,8 @@ ok .. code-block:: { - "job_id" : "2x414788a5112333a02390e2eb0ea227" + "job_id" : "2x414788a5112333a02390e2eb0ea227", + "order_id" : "" } **Status code: 400** 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 f3241b9..c69604f 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 @@ -43,60 +43,60 @@ Request Parameters .. table:: **Table 3** Request body parameters - +-----------+-----------+--------------------------------------------------------------------------------+----------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+================================================================================+======================+ - | instance | Yes | :ref:`CreateInstanceDetail ` object | Instance information | - +-----------+-----------+--------------------------------------------------------------------------------+----------------------+ + +--------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+================================================================================+==================================================================+ + | instance | Yes | :ref:`CreateInstanceDetail ` object | Instance information | + +--------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------+ + | extend_param | No | object | The function has not been supported, and this field is reserved. | + +--------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------+ .. _ddm_04_0001__request_createinstancedetail: .. table:: **Table 4** CreateInstanceDetail - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+==================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | name | Yes | String | Name of a DDM instance, which: | - | | | | | - | | | | - Can include 4 to 64 characters. | - | | | | - Must start with a letter. | - | | | | - Can contain only letters, digits, and hyphens (-). | - | | | | | - | | | | Minimum length: 4 characters | - | | | | | - | | | | Maximum length: 64 characters | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_id | Yes | String | Class ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | node_num | Yes | Integer | Number of nodes | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Yes | String | Engine ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | available_zones | Yes | Array of strings | AZ code. The value cannot be empty. For details, see `Regions and Endpoints `__. | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | Yes | String | VPC ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | Yes | String | Security group ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | Yes | String | Subnet ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_group_id | No | String | Parameter group ID | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_zone | No | String | UTC time zone. The default value is **UTC**. The value can be **UTC**, **UTC-12:00**, **UTC-11:00**, **UTC-10:00**, **UTC-09:00**, **UTC-08:00**, **UTC-07:00**, **UTC-06:00**, **UTC-05:00**, **UTC-04:00**, **UTC-03:00**, **UTC-02:00**, **UTC-01:00**, **UTC+01:00**, **UTC+02:00**, **UTC+03:00**, **UTC+05:00**, **UTC+06:00**, **UTC+07:00**, **UTC+08:00**, **UTC+09:00**, **UTC+10:00**, **UTC+11:00**, and **UTC+12:00**. | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_user_name | No | 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 (_). | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_user_password | No | String | Password of the administrator. The password: | - | | | | | - | | | | - Can include 8 to 32 characters. | - | | | | - 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. | - +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+=================+==================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | Yes | String | Name of a DDM instance, which: | + | | | | | + | | | | - Can include 4 to 64 characters. | + | | | | - Must start with a letter. | + | | | | - Can contain only letters, digits, and hyphens (-). | + | | | | | + | | | | Minimum length: 4 characters | + | | | | | + | | | | Maximum length: 64 characters | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_id | Yes | String | Class ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_num | Yes | Integer | Number of nodes | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_id | Yes | String | Engine ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | available_zones | Yes | Array of strings | AZ code. The value cannot be empty. For details, see `Regions and Endpoints `__. | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | Yes | String | Security group ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | Yes | String | Subnet ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | param_group_id | No | String | Parameter group ID | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | No | String | UTC time zone. The default value is **UTC**. The value can be **UTC**, **UTC-12:00**, **UTC-11:00**, **UTC-10:00**, **UTC-09:00**, **UTC-08:00**, **UTC-07:00**, **UTC-06:00**, **UTC-05:00**, **UTC-04:00**, **UTC-03:00**, **UTC-02:00**, **UTC-01:00**, **UTC+01:00**, **UTC+02:00**, **UTC+03:00**, **UTC+05:00**, **UTC+06:00**, **UTC+07:00**, **UTC+08:00**, **UTC+09:00**, **UTC+10:00**, **UTC+11:00**, and **UTC+12:00**. | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_user_name | No | 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 (_). | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_user_password | No | String | Password of the administrator. The password: | + | | | | | + | | | | - Can include 8 to 32 characters. | + | | | | - 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. | + +---------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -105,11 +105,13 @@ Response Parameters .. table:: **Table 5** Response body parameters - ========= ====== ============ - Parameter Type Description - ========= ====== ============ - id String Instance ID. - ========= ====== ============ + +-----------+--------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==================================================================+ + | id | String | Instance ID. | + +-----------+--------+------------------------------------------------------------------+ + | order_id | String | The function has not been supported, and this field is reserved. | + +-----------+--------+------------------------------------------------------------------+ **Status code: 400** @@ -146,7 +148,7 @@ Example Request "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", @@ -165,7 +167,8 @@ OK .. code-block:: { - "id" : "" + "id" : "7191674e562d495d9e8e4b23ece6522ein09", + "order_id" : null } **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 c6d841b..97d331a 100644 --- a/api-ref/source/apis_recommended/ddm_instances/index.rst +++ b/api-ref/source/apis_recommended/ddm_instances/index.rst @@ -24,7 +24,6 @@ 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 @@ -49,4 +48,3 @@ 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/querying_ddm_instances.rst b/api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst index ce7c0a3..cecd13a 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 @@ -121,9 +121,7 @@ Response Parameters +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | error_msg | String | Response message. This parameter is not returned if no abnormality occurs. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | node_status | String | Node status | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | + | node_status | String | Node status For details, see :ref:`Status Description `. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Project ID of a tenant in a region | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ @@ -186,7 +184,7 @@ OK "core_count" : "2", "ram_capacity" : "4", "node_status" : "RUNNING", - "enterprise_project_id" : "0", + "project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c", "engine_version" : "3.0.8" } ], 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 c83bc39..e781b39 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 @@ -76,7 +76,7 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | access_port | String | Port for accessing the DDM instance | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - | node_status | String | Node status | + | node_status | String | Node status For details, see :ref:`Status Description `. | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | core_count | String | Number of CPUs | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ @@ -86,7 +86,7 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | project_id | String | Project ID | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | + | order_id | String | The function has not been supported, and this field is reserved. | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | engine_version | String | Engine version (core instance version) | +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ @@ -103,13 +103,15 @@ Response Parameters .. table:: **Table 4** GetDetailfNodesInfo - ========= ====== =================================== - Parameter Type Description - ========= ====== =================================== - status String Status of the DDM instance node - port String Port of the DDM instance node - ip String IP address of the DDM instance node - ========= ====== =================================== + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===============================================================================================+ + | status | String | Status of the DDM instance node For details, see :ref:`Status Description `. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | port | String | Port of the DDM instance node | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | ip | String | IP address of the DDM instance node | + +-----------+--------+-----------------------------------------------------------------------------------------------+ **Status code: 400** @@ -170,7 +172,7 @@ OK "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 336c545..b269ac6 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 @@ -50,20 +50,29 @@ Response Parameters .. table:: **Table 3** Response body parameters - =============== ====== ========================================== - Parameter Type Description - =============== ====== ========================================== - status String Node status - name String Node name - node_id String Node ID - private_ip String Private IP address of the node - floating_ip String Floating IP address of the node - server_id String VM ID - subnet_name String Subnet name - datavolume_id String Data disk ID - res_subnet_ip String IP address provided by the resource subnet - systemvolume_id String System disk ID - =============== ====== ========================================== + +-----------------+--------+---------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+===========================================================================+ + | status | String | Node status For details, see :ref:`Status Description `. | + +-----------------+--------+---------------------------------------------------------------------------+ + | name | String | Node name | + +-----------------+--------+---------------------------------------------------------------------------+ + | node_id | String | Node ID | + +-----------------+--------+---------------------------------------------------------------------------+ + | private_ip | String | Private IP address of the node | + +-----------------+--------+---------------------------------------------------------------------------+ + | floating_ip | String | Floating IP address of the node | + +-----------------+--------+---------------------------------------------------------------------------+ + | server_id | String | VM ID | + +-----------------+--------+---------------------------------------------------------------------------+ + | subnet_name | String | Subnet name | + +-----------------+--------+---------------------------------------------------------------------------+ + | datavolume_id | String | Data disk ID | + +-----------------+--------+---------------------------------------------------------------------------+ + | res_subnet_ip | String | IP address provided by the resource subnet | + +-----------------+--------+---------------------------------------------------------------------------+ + | systemvolume_id | String | System disk ID | + +-----------------+--------+---------------------------------------------------------------------------+ **Status code: 400** 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 9205c88..902cf59 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 @@ -83,14 +83,17 @@ Response Parameters .. table:: **Table 5** NodeList - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - port String Port - status String Node status - node_id String Node ID - ip String ip - ========= ====== =========== + +-----------+--------+---------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===========================================================================+ + | port | String | Port | + +-----------+--------+---------------------------------------------------------------------------+ + | status | String | Node status For details, see :ref:`Status Description `. | + +-----------+--------+---------------------------------------------------------------------------+ + | node_id | String | Node ID | + +-----------+--------+---------------------------------------------------------------------------+ + | ip | String | ip | + +-----------+--------+---------------------------------------------------------------------------+ **Status code: 400** 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 357b2cb..4657e2d 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 @@ -53,6 +53,8 @@ Request Parameters +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+ | 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 | The function has not been supported, and this field is reserved. | + +-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- 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 deleted file mode 100644 index 9219d2a..0000000 --- a/api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst +++ /dev/null @@ -1,167 +0,0 @@ -: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/monitoring/monitoring_slow_query_logs.rst b/api-ref/source/apis_recommended/monitoring/monitoring_slow_query_logs.rst index 0a84607..e2ef19b 100644 --- a/api-ref/source/apis_recommended/monitoring/monitoring_slow_query_logs.rst +++ b/api-ref/source/apis_recommended/monitoring/monitoring_slow_query_logs.rst @@ -34,18 +34,15 @@ GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==========================================================================================+ - | curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **0**. | + | curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **1**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ | perPage | Yes | String | Number of records displayed on each page | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ | startDate | Yes | String | Start time in UTC, accurate to milliseconds | - | | | | | - | | | | The format is yyyy-mm-ddThh:mm:ssZ. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ | endDate | Yes | String | End time in UTC, accurate to milliseconds | | | | | | - | | | | - The format is yyyy-mm-ddThh:mm:ssZ. | - | | | | - The interval between the start time and the end time must be no more than 7 days. | + | | | | The interval between the start time and the end time must be no more than 7 days. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ Request Parameters @@ -89,7 +86,7 @@ Response Parameters +--------------+--------+---------------------------------------------------------------------------------------------------------------+ | querySample | String | Syntax for executing the slow SQL statement | +--------------+--------+---------------------------------------------------------------------------------------------------------------+ - | logTime | String | Time when the slow SQL statement starts to be executed The format is yyyy-mm-ddThh:mm:ssZ. | + | logTime | String | Time when the slow SQL statement starts to be executed | +--------------+--------+---------------------------------------------------------------------------------------------------------------+ | time | String | Time for a SQL statement to execute, accurate to milliseconds | +--------------+--------+---------------------------------------------------------------------------------------------------------------+ @@ -125,9 +122,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage=0&perPage=10&startDate=1687078800000&endDate=1687165200000 + GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate} Example Response ---------------- diff --git a/api-ref/source/apis_recommended/schemas/deleting_a_schema.rst b/api-ref/source/apis_recommended/schemas/deleting_a_schema.rst index 9ca663a..8147738 100644 --- a/api-ref/source/apis_recommended/schemas/deleting_a_schema.rst +++ b/api-ref/source/apis_recommended/schemas/deleting_a_schema.rst @@ -18,7 +18,7 @@ None URI --- -DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname} +DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data} .. table:: **Table 1** Path parameters diff --git a/api-ref/source/apis_recommended/schemas/querying_schemas.rst b/api-ref/source/apis_recommended/schemas/querying_schemas.rst index 6080e63..557e542 100644 --- a/api-ref/source/apis_recommended/schemas/querying_schemas.rst +++ b/api-ref/source/apis_recommended/schemas/querying_schemas.rst @@ -40,7 +40,7 @@ GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={li | | | | | | | | | The value must be a positive integer. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | A maximum schemas to be queried. | + | limit | No | Integer | Maximum schemas to be queried. | | | | | | | | | | Value range: 1 to 128. | | | | | | @@ -93,7 +93,7 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ | status | String | Schema status. For details about this parameter value, see :ref:`Status Description `. | +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | created | String | Time when the schema is created | + | created | Integer | Time when the schema is created | +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ | used_rds | Array of :ref:`GetDatabaseUsedRds ` objects | RDS instances associated with the schema | +-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/obtaining_a_project_id.rst b/api-ref/source/appendix/obtaining_a_project_id.rst index 8efeac2..2a012db 100644 --- a/api-ref/source/appendix/obtaining_a_project_id.rst +++ b/api-ref/source/appendix/obtaining_a_project_id.rst @@ -60,7 +60,7 @@ Obtaining a Project ID from the Console On the displayed page, view project IDs in the project list. - .. figure:: /_static/images/en-us_image_0000001509539765.jpg + .. figure:: /_static/images/en-us_image_0000001733265081.jpg :alt: **Figure 1** Viewing project IDs **Figure 1** Viewing project IDs diff --git a/api-ref/source/appendix/status_description.rst b/api-ref/source/appendix/status_description.rst index 41dbf85..0ff6524 100644 --- a/api-ref/source/appendix/status_description.rst +++ b/api-ref/source/appendix/status_description.rst @@ -10,21 +10,22 @@ 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. - 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. - ============== ============================================= + ================= ============================================= + Status Description + ================= ============================================= + CREATE 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. + SET_CONFIGURATION The instance parameters are being updated. + ================= ============================================= DDM Schema Statuses ------------------- @@ -34,7 +35,7 @@ DDM Schema Statuses ================== ==================================== Status Description ================== ==================================== - CREATING The schema is being created. + CREATE The schema is being created. RUNNING The schema is running and available. CREATEFAILED The schema fails to be created. DELETING The schema is being deleted. @@ -42,3 +43,19 @@ DDM Schema Statuses Scaling out failed The schema fails to be scaled out. Rolling back The schema is being rolled back. ================== ==================================== + +DDM Node Statuses +----------------- + +.. table:: **Table 3** Node statuses + + =========== ======================================== + Status Description + =========== ======================================== + normal The node is running normally. + abnormal The node is abnormal. + creating The DDM instance is being created. + createfail The DDM instance fails to be created. + enlargefail The DDM instance fails to be scaled out. + resizing The node class is being changed. + =========== ======================================== diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index bfd9d2e..c293669 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -26,7 +26,7 @@ Concepts A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects. - .. figure:: /_static/images/en-us_image_0000001509858673.png + .. figure:: /_static/images/en-us_image_0000001733265073.png :alt: **Figure 1** Project isolating model **Figure 1** Project isolating model diff --git a/api-ref/source/calling_apis/returned_values.rst b/api-ref/source/calling_apis/returned_values.rst index 92f5449..825c596 100644 --- a/api-ref/source/calling_apis/returned_values.rst +++ b/api-ref/source/calling_apis/returned_values.rst @@ -23,7 +23,7 @@ Similar to a request, a response also has a header, for example, **Content-Type* .. _ddm_api_01_0012__fig4865141011511: -.. figure:: /_static/images/en-us_image_0000001460419110.png +.. figure:: /_static/images/en-us_image_0000001685146158.png :alt: **Figure 1** Header fields of the response to the request for obtaining a user token **Figure 1** Header fields of the response to the request for obtaining a user token diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index c31400f..185a7fd 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -7,8 +7,14 @@ Change History .. table:: **Table 1** Document change history - =========== ========================================= - Released On Description - =========== ========================================= - 2023-01-30 This issue is the first official release. - =========== ========================================= + +-----------------------------------+-----------------------------------------------------------------------------------------------+ + | Released On | Description | + +===================================+===============================================================================================+ + | 2023-10-20 | Modified the following content: | + | | | + | | Added the **SET_CONFIGURATION** status in :ref:`Status Description `. | + | | | + | | Changed the **CREATING** status to **CREATE** in :ref:`Status Description `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------+ + | 2023-01-30 | This issue is the first official release. | + +-----------------------------------+-----------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 7a4ef98..08fb5fb 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/distributed-database-middleware' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_type = 'gitea' +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = 'internal' +otcdocs_doc_link = '/distributed-database-middleware/api-ref/' +otcdocs_doc_title = 'API Reference' +otcdocs_doc_type = 'api-ref' +otcdocs_service_category = 'database' +otcdocs_service_title = 'Distributed Database Middleware' +otcdocs_service_type = 'ddm' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here.