diff --git a/api-ref/source/api_overview.rst b/api-ref/source/api_overview.rst index 507cc9d..bf739b6 100644 --- a/api-ref/source/api_overview.rst +++ b/api-ref/source/api_overview.rst @@ -7,24 +7,28 @@ API Overview With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Type | Description | -+===============================+====================================================================================================================================================================================================================+ -| DB engine version query | Query the DB version information of a specified DB engine. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| DB specifications query | Query the DB specifications of a specified DB engine version. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| DB instance management | Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Backup management | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter template management | Query parameter templates. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Quota management | Query, set, and modify resource quotas. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Task information query | Obtain task information about the task center. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Database proxy | Query database proxy information and specifications, and enable or disable database proxy. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Log management | Obtain log information, including database error logs and slow logs. | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Type | Description | ++===================================+====================================================================================================================================================================================================================+ +| DB engine version query | Query the DB version information of a specified DB engine. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DB specifications query | Query the DB specifications of a specified DB engine version. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DB instance management | Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Backup management | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Parameter template management | Query parameter templates. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Quota management | Query, set, and modify resource quotas. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Database proxy | Query database proxy information and specifications, and enable or disable database proxy. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Log management | Obtain log information, including database error logs and slow logs. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Tag management | Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SQL statement concurrency control | Query, configure and delete concurrency control rules of SQL statements. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Task center | Obtain task information about the task center. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/calling_apis/authentication.rst b/api-ref/source/api_usage_guidelines/authentication.rst similarity index 100% rename from api-ref/source/calling_apis/authentication.rst rename to api-ref/source/api_usage_guidelines/authentication.rst diff --git a/api-ref/source/calling_apis/index.rst b/api-ref/source/api_usage_guidelines/index.rst similarity index 87% rename from api-ref/source/calling_apis/index.rst rename to api-ref/source/api_usage_guidelines/index.rst index 308827b..99b0e49 100644 --- a/api-ref/source/calling_apis/index.rst +++ b/api-ref/source/api_usage_guidelines/index.rst @@ -2,8 +2,8 @@ .. _gaussdb_03_0000: -Calling APIs -============ +API Usage Guidelines +==================== - :ref:`Making an API Request ` - :ref:`Authentication ` diff --git a/api-ref/source/calling_apis/making_an_api_request.rst b/api-ref/source/api_usage_guidelines/making_an_api_request.rst similarity index 100% rename from api-ref/source/calling_apis/making_an_api_request.rst rename to api-ref/source/api_usage_guidelines/making_an_api_request.rst diff --git a/api-ref/source/calling_apis/response.rst b/api-ref/source/api_usage_guidelines/response.rst similarity index 100% rename from api-ref/source/calling_apis/response.rst rename to api-ref/source/api_usage_guidelines/response.rst diff --git a/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst index 139ee48..19e172b 100644 --- a/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst +++ b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst @@ -36,7 +36,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -45,7 +45,7 @@ Request Parameters +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=============+===========+========+===================================================================================================================================================================================+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Yes | String | Backup name. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,7 +104,7 @@ Response Parameters | | | | | | | manual | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** @@ -134,7 +134,7 @@ Example Request Creating a Manual Backup -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create { @@ -160,7 +160,7 @@ Success. "begin_time" : "2020-07-07T01:17:05+0800", "status" : "BUILDING", "type" : "manual", - "instance_id" : "ef25188419f941309882d2986b2210b9in07" + "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07" }, "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7" } diff --git a/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst index c769ea5..9ca2450 100644 --- a/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst +++ b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst @@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -38,7 +38,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -54,35 +54,35 @@ Request Parameters .. table:: **Table 4** MysqlBackupPolicy - +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+=============================================================================================================================================================================================================================+ - | start_time | Yes | String | Backup time window. Automated backups will be triggered during the backup time window. | - | | | | | - | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | - | | | | | - | | | | - The **HH** value must be 1 greater than the **hh** value. | - | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | - | | | | | - | | | | Example value: | - | | | | | - | | | | 21:00-22:00 | - +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | keep_days | Yes | Integer | Backup retention days. | - | | | | | - | | | | Value: **1** to **732** | - +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | period | Yes | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | - | | | | | - | | | | Value range: The value is a number separated by commas (,), indicating the days of the week. | - | | | | | - | | | | For example, the value **1,2,3,4** indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday. | - +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | retention_num_backup_level1 | No | Integer | Number of retained level-1 backups. The default value is **0**. This parameter is mandatory when the level-1 backup function is enabled. This parameter is unavailable when the level-1 backup function is disabled. Value: | - | | | | | - | | | | - 0 | - | | | | - 1 | - +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============================+=================+=================+=============================================================================================================================================================================================================================+ + | start_time | Yes | String | Backup time window. Automated backups will be triggered during the backup time window. | + | | | | | + | | | | The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + | | | | | + | | | | - The **HH** value must be 1 greater than the **hh** value. | + | | | | - The values of **mm** and **MM** must be the same and must be set to **00**. | + | | | | | + | | | | Example value: | + | | | | | + | | | | 21:00-22:00 | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keep_days | Yes | Integer | Backup retention days. | + | | | | | + | | | | Value: **1** to **732** | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | Yes | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | + | | | | | + | | | | Value range: The value is a number separated by commas (,), indicating the days of the week. | + | | | | | + | | | | For example, the value **1,2,3,4** indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday. | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | retention_num_backup_level-1 | No | Integer | Number of retained level-1 backups. The default value is **0**. This parameter is mandatory when the level-1 backup function is enabled. This parameter is unavailable when the level-1 backup function is disabled. Value: | + | | | | | + | | | | - 0 | + | | | | - 1 | + +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -95,8 +95,8 @@ Response Parameters Parameter Type Description ============= ====== =================== status String Status information. - instance_id String Instance ID. - instance_name String Instance name. + instance_id String DB instance ID. + instance_name String DB instance name. ============= ====== =================== **Status code: 400** @@ -126,7 +126,7 @@ Example Request Modifying a backup policy -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update { @@ -168,7 +168,7 @@ Response | | | - **COMPLETED**: Modification completed | | | | - **FAILED**: Modification failed | +-----------------------+-----------------------+-------------------------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-----------------------+-------------------------------------------+ | instance_name | String | DB instance name. | +-----------------------+-----------------------+-------------------------------------------+ diff --git a/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst index bb7b55b..96e073f 100644 --- a/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst +++ b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/backups/policy | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/backup_management/querying_backups.rst b/api-ref/source/apis_recommended/backup_management/querying_backups.rst index 1934497..ae1db6c 100644 --- a/api-ref/source/apis_recommended/backup_management/querying_backups.rst +++ b/api-ref/source/apis_recommended/backup_management/querying_backups.rst @@ -33,7 +33,7 @@ GET /v3/{project_id}/backups +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+=======================================================================================================================================================================================================================================+ - | instance_id | No | String | Instance ID. | + | instance_id | No | String | DB instance ID. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | backup_id | No | String | Backup ID. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -60,7 +60,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -124,7 +124,7 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | :ref:`MysqlDatastore ` object | Database information. | +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | Description of the backup file. | +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -183,10 +183,10 @@ Success. { "backups" : [ { - "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", + "id" : "c0c9f155c7b7423a9d30f0175998b63bbr01", "name" : "GaussDBforMySQL-gauss-e747-20200705185048266", - "begin_time" : "2018-08-06T12:41:14+0800", - "end_time" : "2018-08-06T12:45:14+0800", + "begin_time" : "2020-07-06T10:41:14", + "end_time" : "2020-07-16T10:41:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", @@ -195,7 +195,7 @@ Success. "type" : "gaussdb-mysql", "version" : "8.0" }, - "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01" + "instance_id" : "c0c9f155c7b7423a9d30f0175998b63bbr01" } ], "total_count" : 1 diff --git a/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst index ddd69b2..4853e25 100644 --- a/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst +++ b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst @@ -28,7 +28,7 @@ POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -91,7 +91,7 @@ Response Parameters Example Request --------------- -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge { diff --git a/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst index 55b4dc1..1600b44 100644 --- a/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst +++ b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst @@ -25,7 +25,7 @@ PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight +=============+===========+========+=============================================================+ | project_id | Yes | String | Project ID of a tenant in a region. | +-------------+-----------+--------+-------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-------------+-----------+--------+-------------------------------------------------------------+ | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. | +-------------+-----------+--------+-------------------------------------------------------------+ @@ -101,7 +101,7 @@ Response Parameters Example Request --------------- -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight { diff --git a/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst index 91a7cbd..165a93d 100644 --- a/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst +++ b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst @@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/flavor | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ @@ -90,11 +90,11 @@ Response Parameters Example Request --------------- -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor { - "flavor_ref" : "gaussdb.proxy.xlarge.arm.2" + "flavor_ref" :gaussdb.proxy.xlarge.x86.2 } Example Response diff --git a/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst index 2ebcd84..13ab39e 100644 --- a/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst +++ b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst @@ -28,7 +28,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/proxy | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst index 6be5cd8..2e1d326 100644 --- a/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst +++ b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst @@ -28,7 +28,7 @@ POST /v3/{project_id}/instances/{instance_id}/proxy | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -45,24 +45,24 @@ Request Parameters .. table:: **Table 3** Request body parameters - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+==================================================================================+===========================================================================================================================================================================================================================================================+ - | flavor_ref | Yes | String | Proxy specification code. | - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | node_num | Yes | Integer | Number of proxy instance nodes. The value is an integer from 2 to 32. | - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | proxy_name | No | String | Proxy instance name. Instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | proxy_mode | No | String | Proxy instance type. The default type is **readwrite**. | - | | | | | - | | | | Valid value: | - | | | | | - | | | | - **readwrite** | - | | | | - **readonly** | - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodes_read_weight | No | Array of :ref:`NodesWeight ` objects | Read weight of the node. | - +-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===================+=================+==================================================================================+==============================================================================================================================================================================================================================================================+ + | flavor_ref | Yes | String | Proxy specification code. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_num | Yes | Integer | Number of proxy instance nodes. The value is an integer from 2 to 32. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxy_name | No | String | Proxy instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxy_mode | No | String | Proxy instance type. The default type is **readwrite**. | + | | | | | + | | | | Valid value: | + | | | | | + | | | | - **readwrite** | + | | | | - **readonly** | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes_read_weight | No | Array of :ref:`NodesWeight ` objects | Read weight of the node. | + +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _creategaussmysqlproxy__request_nodesweight: @@ -114,7 +114,7 @@ Response Parameters Example Request --------------- -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy { diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst index 979d11d..67097d4 100644 --- a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst @@ -28,7 +28,7 @@ GET /v3/{project_id}/instances/{instance_id}/proxies | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ .. table:: **Table 2** Query parameters @@ -49,7 +49,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -128,6 +128,8 @@ Response Parameters +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | name | String | Proxy instance name. | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | transaction_split | String | Whether the proxy transaction splitting is enabled. Value: **ON** or **OFF**. | + +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxynodes: @@ -158,7 +160,7 @@ Response Parameters +===================+==================================================================================================================================+==========================+ | id | String | Node ID. | +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ | status | String | Node status. | +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ @@ -237,15 +239,17 @@ Success. "id" : "db53a238a02240c49365e72e284a4890pn01", "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", "role" : "master", - "az_code" : "az1xahz", + "az_code" : "az1", "status" : "ACTIVE", "frozen_flag" : 0 } ], - "name" : "proxy-name" + "name" : "proxy-name", + "flavor_ref":"gaussdb.proxy.large.x86.2", + "transaction_split":"OFF" }, "master_node" : { "id" : "c01a5645eb2c4fb6a9373542f5366e50no07", - "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", + "instance_id" : "096c0fc43e804757b59946b80dc27f8bin07", "status" : "ACTIVE", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", "weight" : 0, diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst index b16469a..a4f4cb1 100644 --- a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst @@ -28,7 +28,7 @@ GET /v3/{project_id}/instances/{instance_id}/proxy/flavors | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -39,7 +39,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -60,13 +60,13 @@ Response Parameters .. table:: **Table 4** MysqlProxyFlavorGroups - +---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ - | Parameter | Type | Description | - +===============+================================================================================================================+=========================================================+ - | group_type | String | Specification group type. It can be **x86** or **arm**. | - +---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ - | proxy_flavors | Array of :ref:`MysqlProxyComputeFlavor ` objects | Proxy specifications. | - +---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | Parameter | Type | Description | + +===============+================================================================================================================+==============================================+ + | group_type | String | Specification group type. It can be **x86**. | + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ + | proxy_flavors | Array of :ref:`MysqlProxyComputeFlavor ` objects | Proxy specifications. | + +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+ .. _showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor: diff --git a/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst index ba5cd11..d51bb09 100644 --- a/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst +++ b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst @@ -16,7 +16,7 @@ This API is used to query database error logs. Before using this API: URI --- -GET /v3/{project_id}/instances/{instance_id}/errorlog +GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date}&node_id={node_id} .. table:: **Table 1** URI parameters @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/errorlog | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ .. table:: **Table 2** Query parameters @@ -69,7 +69,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -138,7 +138,7 @@ Example Request .. code-block:: text - GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ALL&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/errorlog?offset=0&limit=1&level=ERROR&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07 Example Response ---------------- @@ -155,7 +155,8 @@ Success. "time" : "2022-07-17T07:34:33", "level" : "ERROR", "content" : "[MY013508] [Repl] do failed: 1" - } ] + } ], + "total_record":1 } Status Code diff --git a/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst index 9546345..e0c4338 100644 --- a/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst +++ b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst @@ -16,7 +16,7 @@ This API is used to query database slow logs. Before using this API: URI --- -GET /v3/{project_id}/instances/{instance_id}/slowlog +GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date}&node_id={node_id} .. table:: **Table 1** URI parameters @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/slowlog | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ .. table:: **Table 2** Query parameters @@ -71,7 +71,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -149,40 +149,26 @@ Example Response Success. -- Example 1 +.. code-block:: - .. code-block:: - - { - "slow_log_list" : [ { - "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", - "count" : 1, - "time" : "1.04899 s", - "lock_time" : "0.00003 s", - "rows_sent" : 0, - "rows_examined" : 0, - "database" : "gaussdb-mysql", - "users" : "root", - "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", - "type" : "INSERT", - "start_time" : "2121-03-25T10:55:16.000Z", - "client_ip" : "192.*.*.1" - } ], - "long_query_time" : 10, - "total_record" : 15 - } - -- Example 2 - - .. code-block:: - - 10 - -- Example 3 - - .. code-block:: - - 15 + { + "slow_log_list" : [ { + "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", + "count" : 1, + "time" : "1.04899 s", + "lock_time" : "0.00003 s", + "rows_sent" : 0, + "rows_examined" : 0, + "database" : "gaussdb-mysql", + "users" : "root", + "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", + "type" : "INSERT", + "start_time" : "2022-07-11T00:00:00+0800", + "client_ip" : "192.*.*.1" + } ], + "long_query_time" : 10, + "total_record" : 1 + } Status Code ----------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst index 433768c..70a91cd 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst @@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/name | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -38,17 +38,17 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== .. table:: **Table 3** Request body parameters - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=====================================================================================================================================================================================================================================================+ - | name | Yes | String | Instance name. Instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+===========================================================================================================================================================================================================================================================+ + | name | Yes | String | DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -57,11 +57,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - ========= ====== ====================================== + ========= ====== ======================================== Parameter Type Description - ========= ====== ====================================== - job_id String Task ID for changing an instance name. - ========= ====== ====================================== + ========= ====== ======================================== + job_id String Task ID for changing a DB instance name. + ========= ====== ======================================== **Status code: 400** @@ -90,7 +90,7 @@ Example Request Changing a DB Instance Name -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name { diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst index d904bf6..72cb569 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst @@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/action | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst index 016eec7..63cd326 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst @@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/monitor-policy | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -99,7 +99,7 @@ Example Request Modifying the collection period of Monitoring by Seconds for an instance. The current collection period to 1s. -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy { diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst similarity index 95% rename from api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst rename to api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst index 4323790..9041838 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst @@ -2,13 +2,13 @@ .. _gaussdb_04_0004: -Creating an Instance -==================== +Creating a DB Instance +====================== Function -------- -This API is used to create a GaussDB(for MySQL) DB instance. Before calling this API: +This API is used to create a GaussDB(for MySQL) instance. Before calling this API: - Learn how to :ref:`authorize and authenticate ` it. - Obtain the required :ref:`region and endpoint `. @@ -53,13 +53,13 @@ Request Parameters +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Yes | String | DB instance name. | | | | | | - | | | | Instances of the same type can have same names under the same tenant. | + | | | | DB instances of the same type can have same names under the same tenant. | | | | | | - | | | | The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_). | + | | | | The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | Yes | :ref:`MysqlDatastore ` object | Database information. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | Yes | String | Instance type. Currently, only the cluster type is supported. | + | mode | Yes | String | DB instance type. Its value is **Cluster**. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | flavor_ref | Yes | String | Specification code. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -97,12 +97,12 @@ Request Parameters +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | slave_count | Yes | Integer | Number of read replicas. A maximum of nine read replicas can be created at a time. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`MysqlTags ` objects | Tag list. Instances are created based on tag keys and values. | + | tags | No | Array of :ref:`MysqlTags ` objects | Tag list. DB instances are created based on tag keys and values. | | | | | | | | | | - *{key}* indicates the tag key. It must be unique and cannot be empty. | | | | | - *{value}* indicates the tag value, which can be empty. | | | | | | - | | | | To create instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added. | + | | | | To create DB instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory when the enterprise project is enabled. | +--------------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -186,7 +186,7 @@ Response Parameters +-----------+---------------------------------------------------------------------------------------+-------------------------------+ | Parameter | Type | Description | +===========+=======================================================================================+===============================+ - | instance | :ref:`MysqlInstanceResponse ` object | Instance information. | + | instance | :ref:`MysqlInstanceResponse ` object | DB instance information. | +-----------+---------------------------------------------------------------------------------------+-------------------------------+ | job_id | String | DB instance creation task ID. | +-----------+---------------------------------------------------------------------------------------+-------------------------------+ @@ -195,41 +195,41 @@ Response Parameters .. table:: **Table 9** MysqlInstanceResponse - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+===================================================================================+=======================================================================================================================================================================================================================================================+ - | id | String | Instance ID. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. Instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | :ref:`MysqlDatastore ` object | Database information. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | DB instance type. Currently, only the cluster type is supported. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configuration_id | String | Parameter template ID. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Database port. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | String | Region ID, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_mode | String | AZ mode, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | master_availability_zone | String | Primary AZ ID. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Subnet ID, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Specification code, which is the same as the request parameter. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | :ref:`MysqlChargeInfo ` object | Billing mode. | - +--------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+===================================================================================+==========================================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mode | String | DB instance type. Its value is **Cluster**. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | Parameter template ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_mode | String | AZ mode, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_availability_zone | String | Primary AZ ID. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code, which is the same as the request parameter. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlChargeInfo ` object | Billing mode. | + +--------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _gaussdb_04_0004__response_mysqldatastore: @@ -301,9 +301,9 @@ Example Request The value of **region** is used as an example. -Creating an instance +Creating a DB instance -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances { @@ -317,12 +317,12 @@ Creating an instance "version" : "8.0" }, "mode" : "Cluster", - "flavor_ref" : "taurus.large.4", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", - "password" : "Hu2wei@13", + "password" : "****", "backup_strategy" : { "start_time" : "08:00-09:00" }, @@ -357,7 +357,7 @@ Success. "version" : "8.0" }, "mode" : "Cluster", - "flavor_ref" : "taurus.large.4", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst index 7030432..70acdc7 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst @@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -60,7 +60,7 @@ Response Parameters +-----------------------+-----------------------+-----------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+=============================================================================+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-----------------------+-----------------------------------------------------------------------------+ | node_names | Array of strings | Node name list | +-----------------------+-----------------------+-----------------------------------------------------------------------------+ @@ -96,7 +96,7 @@ Example Request Creating a read replica -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge { diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst index 3012772..f29d1de 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst @@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id} | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst index dd24974..3e67b9b 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst @@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/nodes/{node_id} | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ | node_id | Yes | String | Node ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== diff --git a/api-ref/source/apis_recommended/managing_db_instances/index.rst b/api-ref/source/apis_recommended/managing_db_instances/index.rst index e7966fb..5801d8b 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/index.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/index.rst @@ -5,8 +5,8 @@ Managing DB Instances ===================== -- :ref:`Creating an Instance ` -- :ref:`Querying Instances ` +- :ref:`Creating a DB Instance ` +- :ref:`Querying DB Instances ` - :ref:`Deleting a DB Instance ` - :ref:`Querying Details of a DB Instance ` - :ref:`Creating a Read Replica ` @@ -21,8 +21,8 @@ Managing DB Instances :maxdepth: 1 :hidden: - creating_an_instance - querying_instances + creating_a_db_instance + querying_db_instances deleting_a_db_instance querying_details_of_a_db_instance creating_a_read_replica diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst similarity index 86% rename from api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst rename to api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst index 994ed44..3fad33b 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst @@ -2,8 +2,8 @@ .. _gaussdb_04_0005: -Querying Instances -================== +Querying DB Instances +===================== Function -------- @@ -30,35 +30,35 @@ GET /v3/{project_id}/instances .. table:: **Table 2** Query parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================================================================================================================================================+ - | id | No | String | Instance ID. The asterisk (``*``) is reserved for the system. If the instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (``*``). | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Instance type to be queried. Currently, only the cluster type is supported. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | VPC ID. | - | | | | | - | | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. | - | | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | No | String | Network ID of the subnet. | - | | | | | - | | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | - | | | | - Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | private_ip | No | String | Private IP address. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | String | Query based on the instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================+ + | id | No | String | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | String | DB instance type to be queried. Currently, its value can only be **Cluster**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore_type | No | String | DB type. Currently, only gaussdb-mysql is supported. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | VPC ID. | + | | | | | + | | | | - Method 1: Log in to VPC console and view the VPC ID in the VPC details. | + | | | | - Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | No | String | Network ID of the subnet. | + | | | | | + | | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page. | + | | | | - Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip | No | String | Private IP address. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | String | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -79,65 +79,65 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-------------+-------------------------------------------------------------------------------------------------+----------------------------+ - | Parameter | Type | Description | - +=============+=================================================================================================+============================+ - | instances | Array of :ref:`MysqlInstanceListInfo ` objects | Instance list information. | - +-------------+-------------------------------------------------------------------------------------------------+----------------------------+ - | total_count | Integer | Total number of records. | - +-------------+-------------------------------------------------------------------------------------------------+----------------------------+ + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ + | Parameter | Type | Description | + +=============+=================================================================================================+===============================+ + | instances | Array of :ref:`MysqlInstanceListInfo ` objects | DB instance list information. | + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ + | total_count | Integer | Total number of records. | + +-------------+-------------------------------------------------------------------------------------------------+-------------------------------+ .. _gaussdb_04_0005__response_mysqlinstancelistinfo: .. table:: **Table 5** MysqlInstanceListInfo - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=====================================================================================+=====================================================================================================================================================================================================================================+ - | id | String | Instance ID. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | private_ips | Array of strings | Private IP address for write. It is a blank string until an ECS is created. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ips | Array of strings | Public IP addresses. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Database port. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | DB instance type. The value is **Cluster**. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region | String | Region where the DB instance is deployed. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | :ref:`MysqlDatastore ` object | Database information. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the instance creation is complete. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the instance creation is complete. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Network ID of the subnet. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Specification code. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_info | :ref:`MysqlFlavorInfo ` object | Flavor information. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume | :ref:`MysqlVolumeInfo ` object | Storage disk information. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`InstanceTagItem ` objects | Tag list. | - +-----------------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ips | Array of strings | Private IP address for write. It is a blank string until an ECS is created. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ips | Array of strings | Public IP addresses. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region | String | Region where the DB instance is deployed. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_info | :ref:`MysqlFlavorInfo ` object | Flavor information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | volume | :ref:`MysqlVolumeInfo ` object | Storage disk information. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`InstanceTagItem ` objects | Tag list. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _gaussdb_04_0005__response_mysqldatastore: @@ -152,6 +152,8 @@ Response Parameters | | | | | | | To obtain details about supported DB engine versions, call the API for querying the DB engine versions. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | kernel_version | String | Database kernel version. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ .. _gaussdb_04_0005__response_mysqlflavorinfo: @@ -228,11 +230,11 @@ Response Parameters Example Request --------------- -Querying instances +Querying DB instances .. code-block:: text - GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=d738399de028480fabb2b8120d4e01a4in07&name=gaussdb-mysql-instance01&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&private_ip=192.168.0.142&offset=0&limit=10&tags=Key1=Value1 Example Response ---------------- @@ -261,7 +263,7 @@ Success. "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", - "kernel_version" : "2.0.29.1" + "kernel_version" : "2.0.28.7" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", @@ -272,10 +274,10 @@ Success. "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", - "flavor_ref" : "gaussdb.mysql.c3.small.4", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "flavor_info" : { "vcpus" : 8, - "ram" : 16 + "ram" : 64 }, "backup_strategy" : { "start_time" : "19:00-20:00", @@ -286,7 +288,10 @@ Success. }, "enterprise_project_id" : 0, "time_zone" : "UTC", - "tags" : [ ] + "tags": [{ + "key":"Key", + "value":"Value1" + }] } ] } diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst index 5549be4..2dba82e 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id} | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -49,107 +49,107 @@ Response Parameters .. table:: **Table 3** Response body parameters - +-----------+-------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Type | Description | - +===========+===========================================================================================+=======================+ - | instance | :ref:`MysqlInstanceInfoDetail ` object | Instance information. | - +-----------+-------------------------------------------------------------------------------------------+-----------------------+ + +-----------+-------------------------------------------------------------------------------------------+--------------------------+ + | Parameter | Type | Description | + +===========+===========================================================================================+==========================+ + | instance | :ref:`MysqlInstanceInfoDetail ` object | DB instance information. | + +-----------+-------------------------------------------------------------------------------------------+--------------------------+ .. _gaussdb_04_0006__response_mysqlinstanceinfodetail: .. table:: **Table 4** MysqlInstanceInfoDetail - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=================================================================================================+=====================================================================================================================================================================================================================================+ - | id | String | Instance ID. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | DB instance name. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of a tenant in a region. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. | - | | | | - | | | Valid value: | - | | | | - | | | If the value is **BUILD**, the DB instance is being created. | - | | | | - | | | If the value is **ACTIVE**, the DB instance is normal. | - | | | | - | | | If the value is **FAILED**, the DB instance is abnormal. | - | | | | - | | | If the value is **FROZEN**, the DB instance is frozen. | - | | | | - | | | If the value is **MODIFYING**, the DB instance is being scaled up. | - | | | | - | | | If the value is **REBOOTING**, the DB instance is being rebooted. | - | | | | - | | | If the value is **RESTORING**, the DB instance is being restored. | - | | | | - | | | If the value is **MODIFYING INSTANCE TYPE**, the DB instance is changing from primary to standby. | - | | | | - | | | If the value is **SWITCHOVER**, the primary/standby switchover is being performed. | - | | | | - | | | If the value is **MIGRATING**, the DB instance is being migrated. | - | | | | - | | | If the value is **BACKING UP**, the DB instance is being backed up. | - | | | | - | | | If the value is **MODIFYING DATABASE PORT**, the database port is being changed. | - | | | | - | | | If the value is **STORAGE FULL**, the instance storage space is full. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | String | Database port. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | alias | String | Instance remarks. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Instance type. The value is **Cluster**. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_info | :ref:`MysqlInstanceChargeInfo ` object | Billing mode, which is yearly/monthly or pay-per-use (default setting). | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | node_count | Integer | Number of nodes. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | datastore | :ref:`MysqlDatastore ` object | Database information. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_used_space | Double | Used backup space in GB. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the instance creation is complete. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the instance creation is complete. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | private_write_ips | Array of strings | Private IP address for write. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ips | String | Public IP address of the instance. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | db_user_name | String | Default username. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC ID. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Network ID of the subnet. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group ID. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configuration_id | String | ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodes | Array of :ref:`MysqlInstanceNodeInfo ` objects | Node information. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_zone | String | Time zone. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | az_mode | String | AZ type. It can be **single** or **multi**. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | master_az_code | String | Primary AZ. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | maintenance_window | String | Maintenance window in the UTC format. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`MysqlTags ` objects | Tags for managing instances. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | proxies | Array of :ref:`MysqlProxyInfo ` objects | Proxy information. | - +-----------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=================================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | DB instance name. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of a tenant in a region. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DB instance status. | + | | | | + | | | Valid value: | + | | | | + | | | If the value is **BUILD**, the DB instance is being created. | + | | | | + | | | If the value is **ACTIVE**, the DB instance is normal. | + | | | | + | | | If the value is **FAILED**, the DB instance is abnormal. | + | | | | + | | | If the value is **FROZEN**, the DB instance is frozen. | + | | | | + | | | If the value is **MODIFYING**, the DB instance is being scaled up. | + | | | | + | | | If the value is **REBOOTING**, the DB instance is being rebooted. | + | | | | + | | | If the value is **RESTORING**, the DB instance is being restored. | + | | | | + | | | If the value is **MODIFYING INSTANCE TYPE**, the DB instance is changing from primary to standby. | + | | | | + | | | If the value is **SWITCHOVER**, the primary/standby switchover is being performed. | + | | | | + | | | If the value is **MIGRATING**, the DB instance is being migrated. | + | | | | + | | | If the value is **BACKING UP**, the DB instance is being backed up. | + | | | | + | | | If the value is **MODIFYING DATABASE PORT**, the database port is being changed. | + | | | | + | | | If the value is **STORAGE FULL**, the DB instance storage space is full. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | String | Database port. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | DB instance remarks. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | DB instance type. The value is **Cluster**. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`MysqlInstanceChargeInfo ` object | Billing mode, which is yearly/monthly or pay-per-use (default setting). | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_count | Integer | Number of nodes. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | datastore | :ref:`MysqlDatastore ` object | Database information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_used_space | Double | Used backup space in GB. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_write_ips | Array of strings | Private IP address for write. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ips | String | Public IP address of the DB instance. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_user_name | String | Default username. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Network ID of the subnet. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | configuration_id | String | ID of the parameter template used for creating a DB instance or ID of the latest parameter template that is applied to an instance. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_strategy | :ref:`MysqlBackupStrategy ` object | Automated backup policy. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes | Array of :ref:`MysqlInstanceNodeInfo ` objects | Node information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | time_zone | String | Time zone. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_mode | String | AZ type. It can be **single** or **multi**. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | master_az_code | String | Primary AZ. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintenance_window | String | Maintenance window in the UTC format. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`MysqlTags ` objects | Tags for managing DB instances. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dedicated_resource_id | String | Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | proxies | Array of :ref:`MysqlProxyInfo ` objects | Proxy information. | + +-----------------------+-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _gaussdb_04_0006__response_mysqlinstancechargeinfo: @@ -197,57 +197,57 @@ Response Parameters .. table:: **Table 8** MysqlInstanceNodeInfo - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+===================================================================================================+=====================================================================================================================================================================================================================================+ - | id | String | Instance ID. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Node name. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Node type, which can be **master** or **slave**. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Node status. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | Integer | Database port. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | private_read_ips | Array of strings | Private IP address for read of the node. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume | :ref:`MysqlInstanceNodeVolumeInfo ` object | Storage disk information. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | az_code | String | AZ. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_code | String | Region where the instance is located. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the instance creation is complete. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the instance creation is complete. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_id | String | Specification ID. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Specification code. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | max_connections | String | Maximum number of connections. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vcpus | String | Number of vCPUs. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ram | String | Memory size in GB. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | need_restart | Boolean | Whether to reboot the instance for the parameter modifications to take effect. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | priority | Integer | Failover priority. | - +------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================================================+========================================================================================================================================================================================================================================+ + | id | String | DB instance ID. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Node name. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Node type, which can be **master** or **slave**. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Node status. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Integer | Database port. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_read_ips | Array of strings | Private IP address for read of the node. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | volume | :ref:`MysqlInstanceNodeVolumeInfo ` object | Storage disk information. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_code | String | AZ. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_code | String | Region where the DB instance is located. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. The value is empty unless the DB instance creation is complete. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated | String | Update time. The format is the same as that of the **created** field. The value is empty unless the DB instance creation is complete. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_id | String | Specification ID. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor_ref | String | Specification code. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_connections | String | Maximum number of connections. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus | String | Number of vCPUs. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | need_restart | Boolean | Whether to reboot the DB instance for the parameter modifications to take effect. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | priority | Integer | Failover priority. | + +------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _gaussdb_04_0006__response_mysqlinstancenodevolumeinfo: .. table:: **Table 9** MysqlInstanceNodeVolumeInfo - ========= ====== ============================================== + ========= ====== ================================================= Parameter Type Description - ========= ====== ============================================== + ========= ====== ================================================= type String Disk type. used String Used disk size in GB. - size Long Disk size of the yearly/monthly instance in GB - ========= ====== ============================================== + size Long Disk size of the yearly/monthly DB instance in GB + ========= ====== ================================================= .. _gaussdb_04_0006__response_mysqltags: @@ -319,11 +319,11 @@ Success. { "instance" : { - "id" : "d738399de028480fabb2b8120d4e01a4in07", + "id" : "436aaafb689c4250a9a5bb33cb271e8cin07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "ACTIVE", - "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628", + "project_id" : "97b026aa9cc4417888c14c84a1ad9860", "enterprise_project_id" : 0, "type" : "Cluster", "charge_info" : { @@ -360,10 +360,10 @@ Success. "type" : "POOL", "used" : 0.07 }, - "az_code" : "az1xahz", - "region_code" : "cn-xianhz-1", + "az_code" : "az1", + "region_code" : "br-iaas-odin1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "flavor_ref" : "gaussdb.mysql.base.medium.x86.2.ha", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, @@ -382,10 +382,10 @@ Success. "type" : "POOL", "used" : 0.07 }, - "az_code" : "az1xahz", - "region_code" : "cn-xianhz-1", + "az_code" : "az1", + "region_code" : "br-iaas-odin1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "flavor_ref" : "gaussdb.mysql.base.medium.x86.2.ha", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst index 26c3e9d..8bea6d8 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/monitor-policy | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst index 1866d4a..4bdab7e 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst @@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/password | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -38,7 +38,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -80,7 +80,7 @@ Example Request Resetting a database password -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password { @@ -90,6 +90,10 @@ Resetting a database password Example Response ---------------- +**Status code: 200** + +Success. + None Status Code diff --git a/api-ref/source/apis_recommended/querying_database_specifications.rst b/api-ref/source/apis_recommended/querying_database_specifications.rst index f19d1e6..af8a9fa 100644 --- a/api-ref/source/apis_recommended/querying_database_specifications.rst +++ b/api-ref/source/apis_recommended/querying_database_specifications.rst @@ -16,7 +16,7 @@ This API is used to query the database specifications of a specified DB engine v URI --- -GET /v3/{project_id}/flavors/{database_name} +GET /v3/{project_id}/flavors/{database_name}?availability_zone_mode={availability_zone_mode} .. table:: **Table 1** URI parameters @@ -59,43 +59,43 @@ Request Parameters Response Parameters ------------------- -**Status code: 202** +**Status code: 200** .. table:: **Table 4** Response body parameters - +-----------+---------------------------------------------------------------------------------------+--------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================================+==========================+ - | flavors | Array of :ref:`MysqlFlavorsInfo ` objects | Instance specifications. | - +-----------+---------------------------------------------------------------------------------------+--------------------------+ + +-----------+---------------------------------------------------------------------------------------+-----------------------------+ + | Parameter | Type | Description | + +===========+=======================================================================================+=============================+ + | flavors | Array of :ref:`MysqlFlavorsInfo ` objects | DB instance specifications. | + +-----------+---------------------------------------------------------------------------------------+-----------------------------+ .. _gaussdb_04_0002__response_mysqlflavorsinfo: .. table:: **Table 5** MysqlFlavorsInfo - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=========================================================================================================================+ - | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | ram | String | Memory size in GB. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | type | String | Specification type. The value can be **arm** or **x86**. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specification ID. The value must be unique. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | spec_code | String | Resource specification code. Its value is same as the value of **flavor_ref**. For example: gaussdb.mysql.xlarge.x86.4. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | DB version number. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | instance_mode | String | DB instance type. Currently, only the cluster type is supported. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ - | az_status | Map | Status of the AZ to which the DB instance specifications belong. Its value can be any of the following: | - | | | | - | | | - **normal**: on sale | - | | | - **unsupported**: not supported | - | | | - **sellout**: sold out | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================+ + | vcpus | String | Number of vCPUs. For example, the value **1** indicates 1 vCPU. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | ram | String | Memory size in GB. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | type | String | Specification type. The value can be **arm**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specification ID. The value must be unique. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | Resource specification code. Its value is same as the value of **flavor_ref**. For example: gaussdb.mysql.xlarge.arm.8 | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | version_name | String | DB version number. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | instance_mode | String | DB instance type. Currently, its value can only be **Cluster**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ + | az_status | Map | Status of the AZ to which the DB instance specifications belong. Its value can be any of the following: | + | | | | + | | | - **normal**: on sale | + | | | - **unsupported**: not supported | + | | | - **sellout**: sold out | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** @@ -124,12 +124,12 @@ Example Request .. code-block:: text - GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.arm.8&availability_zone_mode=single Example Response ---------------- -**Status code: 202** +**Status code: 200** Success. @@ -138,15 +138,15 @@ Success. { "flavors" : [ { "vcpus" : "4", - "ram" : "16", - "type" : "x86", + "ram" : "32", + "type" : "arm", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", - "spec_code" : "gaussdb.mysql.xlarge.x86.4", + "spec_code" : "gaussdb.mysql.xlarge.arm.8", "instance_mode" : "Cluster", "version_name" : "8.0", "az_status" : { "az1" : "normal", - "az2" : "normal" + "az2" : "unsupported" } } ] } diff --git a/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst index 6b46481..e56ecd4 100644 --- a/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst +++ b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst @@ -52,22 +52,24 @@ Request Parameters .. table:: **Table 4** setQuota - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+======================================================================================================================================================================================+ - | enterprise_project_id | Yes | String | Enterprise project ID. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_quota | Yes | Integer | Quota of the DB instance quantity. Value: **0** to **100000**. (If there are already instances created, this parameter value must be greater than the number of existing instances.) | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **2147483646**. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.) | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **2147483646**. (If there are already instances created, this parameter value must be greater than the used memory size.) | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+===========+=========+=========================================================================================================================================================================================+ + | enterprise_project_id | Yes | String | Enterprise project ID. | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | Yes | String | Enterprise project name. | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_quota | Yes | Integer | Quota of the DB instance quantity. Value: **0** to **100000**. (If there are already DB instances created, this parameter value must be greater than the number of existing instances.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vcpus_quota | Yes | Integer | Quota of vCPUs. Value: **0** to **2147483646**. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ram_quota | Yes | Integer | Memory quota in GB. Value: **0** to **2147483646**. (If there are already DB instances created, this parameter value must be greater than the used memory size.) | + +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- -**Status code: 200** +**Status code: 201** .. table:: **Table 5** Response body parameters @@ -81,24 +83,26 @@ Response Parameters .. table:: **Table 6** setQuota - ===================== ======= ================================== - Parameter Type Description - ===================== ======= ================================== - enterprise_project_id String Enterprise project ID. - instance_quota Integer Quota of the DB instance quantity. - vcpus_quota Integer Quota of vCPUs. - ram_quota Integer Memory quota in GB. - ===================== ======= ================================== + ======================= ======= ================================== + Parameter Type Description + ======================= ======= ================================== + enterprise_project_id String Enterprise project ID. + enterprise_project_name String Enterprise project name. + instance_quota Integer Quota of the DB instance quantity. + vcpus_quota Integer Quota of vCPUs. + ram_quota Integer Memory quota in GB. + ======================= ======= ================================== Example Request --------------- -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas { "quota_list" : [ { "enterprise_project_id" : "0", + "enterprise_project_name" : "default", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 @@ -108,7 +112,7 @@ Example Request Example Response ---------------- -**Status code: 200** +**Status code: 201** Success. @@ -117,6 +121,7 @@ Success. { "quota_list" : [ { "enterprise_project_id" : "0", + "enterprise_project_name" : "default", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 diff --git a/api-ref/source/apis_recommended/quota_management/index.rst b/api-ref/source/apis_recommended/quota_management/index.rst index 26e94fa..038fcae 100644 --- a/api-ref/source/apis_recommended/quota_management/index.rst +++ b/api-ref/source/apis_recommended/quota_management/index.rst @@ -8,7 +8,7 @@ Quota Management - :ref:`Querying Resource Quotas ` - :ref:`Configuring Resource Quotas ` - :ref:`Modifying Resource Quotas ` -- :ref:`Querying the Instance Quotas of a Tenant ` +- :ref:`Querying the DB Instance Quotas of a Tenant ` .. toctree:: :maxdepth: 1 @@ -17,4 +17,4 @@ Quota Management querying_resource_quotas configuring_resource_quotas modifying_resource_quotas - querying_the_instance_quotas_of_a_tenant + querying_the_db_instance_quotas_of_a_tenant diff --git a/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst b/api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst similarity index 89% rename from api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst rename to api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst index 72e42cd..6f2815a 100644 --- a/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst +++ b/api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst @@ -2,8 +2,8 @@ .. _ShowGaussMySqlProjectQuotas: -Querying the Instance Quotas of a Tenant -======================================== +Querying the DB Instance Quotas of a Tenant +=========================================== Function -------- @@ -48,7 +48,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -79,21 +79,21 @@ Response Parameters .. table:: **Table 6** resource - +-----------------------+-----------------------+------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+================================================+ - | type | String | Quota of a specified type. | - | | | | - | | | - **instance**: indicates the instance quota. | - | | | | - | | | Valid value: | - | | | | - | | | - **instance** | - +-----------------------+-----------------------+------------------------------------------------+ - | used | Integer | Number of created resources. | - +-----------------------+-----------------------+------------------------------------------------+ - | quota | Integer | Maximum resource quota. | - +-----------------------+-----------------------+------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================+ + | type | String | Quota of a specified type. | + | | | | + | | | - **instance**: indicates the DB instance quota. | + | | | | + | | | Valid value: | + | | | | + | | | - **instance** | + +-----------------------+-----------------------+---------------------------------------------------+ + | used | Integer | Number of created resources. | + +-----------------------+-----------------------+---------------------------------------------------+ + | quota | Integer | Maximum resource quota. | + +-----------------------+-----------------------+---------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst index 3a44061..a61e574 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst @@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/sql-filter/rules | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -132,7 +132,7 @@ Example Request Configuring concurrency control rules of SQL statements -.. code-block:: text +.. code-block:: PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules { diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst index 884cf79..6702b08 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst @@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/sql-filter/rules | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst index a6f0a54..c6eddbf 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst @@ -5,6 +5,7 @@ SQL Statement Concurrency Control ================================= +- :ref:`Querying Whether SQL Statement Concurrency Control Is Enabled ` - :ref:`Configuring Concurrency Control Rules of SQL Statements ` - :ref:`Querying Concurrency Control Rules of SQL Statements ` - :ref:`Deleting Concurrency Control Rules of SQL Statements ` @@ -13,6 +14,7 @@ SQL Statement Concurrency Control :maxdepth: 1 :hidden: + querying_whether_sql_statement_concurrency_control_is_enabled configuring_concurrency_control_rules_of_sql_statements querying_concurrency_control_rules_of_sql_statements deleting_concurrency_control_rules_of_sql_statements diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst index 9625c53..c2a9c1c 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst @@ -16,7 +16,7 @@ This API is used to query concurrency control rules of SQL statements. Before ca URI --- -GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules +GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules?node_id={node_id} .. table:: **Table 1** URI parameters @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ .. table:: **Table 2** Query parameters diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst new file mode 100644 index 0000000..e96366e --- /dev/null +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst @@ -0,0 +1,115 @@ +:original_name: ShowSqlFilterControl.html + +.. _ShowSqlFilterControl: + +Querying Whether SQL Statement Concurrency Control Is Enabled +============================================================= + +Function +-------- + +This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +GET /v3/{project_id}/instances/{instance_id}/sql-filter/switch + +.. table:: **Table 1** URI parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================+ + | project_id | Yes | String | Project ID of a tenant in a region. | + | | | | | + | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | DB instance ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + x-auth-token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================+ + | switch_status | String | Whether SQL Statement Concurrency Control is enabled. | + | | | | + | | | Valid value: | + | | | | + | | | - **ON**: enabled | + | | | - **OFF:** disabled | + +-----------------------+-----------------------+-------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +Querying whether SQL Statement Concurrency Control is enabled + +.. code-block:: text + + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "switch_status" : "ON" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst index 6185d3a..e6ec89f 100644 --- a/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst +++ b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst @@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/tags/action | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ Request Parameters @@ -100,7 +100,7 @@ Example Request - Adding tags - .. code-block:: text + .. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action { @@ -116,7 +116,7 @@ Example Request - Deleting tags - .. code-block:: text + .. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action { @@ -132,6 +132,10 @@ Example Request Example Response ---------------- +**Status code: 200** + +Success. + None Status Code diff --git a/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst index d9bb0c0..c1b13d7 100644 --- a/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst +++ b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst @@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/tags | | | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | + | instance_id | Yes | String | DB instance ID. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ .. table:: **Table 2** Query parameters diff --git a/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst index 47e413e..53cfc64 100644 --- a/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst +++ b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst @@ -8,7 +8,7 @@ Obtaining Information About a Task with a Specified ID Function -------- -This API is used to obtain task information from the task center. Before using this API: +This API is used to obtain task information from the task center. Before calling this API: - Learn how to :ref:`authorize and authenticate ` it. - Obtain the required :ref:`region and endpoint `. @@ -22,7 +22,7 @@ Constraints URI --- -GET /v3/{project_id}/jobs +GET /v3/{project_id}/jobs?id={id} .. table:: **Table 1** URI parameters @@ -94,11 +94,15 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | created | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | | | | | - | | | The value is empty unless the instance creation is complete. | + | | | The value is empty unless the DB instance creation is complete. | + +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ended | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the time zone offset. | + | | | | + | | | The value is empty unless the DB instance creation is complete. | +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | process | String | Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, **""** is returned. | +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance | :ref:`GetJobInstanceInfoDetail ` object | Instance information of the task with the specified ID. | + | instance | :ref:`GetJobInstanceInfoDetail ` object | DB instance information of the task with the specified ID. | +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | entities | Object | Displayed information varies depending on tasks. | +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -109,12 +113,12 @@ Response Parameters .. table:: **Table 6** GetJobInstanceInfoDetail - ========= ====== ============== + ========= ====== ================= Parameter Type Description - ========= ====== ============== - id String Instance ID. - name String Instance name. - ========= ====== ============== + ========= ====== ================= + id String DB instance ID. + name String DB instance name. + ========= ====== ================= **Status code: 400** @@ -160,7 +164,7 @@ Success. { "job" : { - "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886", + "id" : "a9767ede-fe0f-4888-9003-e843a4c90514", "name" : "CreateMysqlInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", diff --git a/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst index 7dc3232..a0ee939 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst @@ -56,7 +56,7 @@ Request Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==============================================================================================================================================================+ - | instance_id | Yes | String | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | String | DB instance ID, which is compliant with the UUID format. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Yes | String | Backup name. | | | | | | @@ -108,7 +108,7 @@ Response Parameters | | | | | | | **manual**: manual full backup | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst index 7aa0397..adc5344 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst @@ -109,9 +109,9 @@ Response Parameters | | | - **COMPLETED**: Modification completed | | | | - **FAILED**: Modification failed | +-----------------------+-----------------------+-------------------------------------------+ - | instance_id | String | Instance ID. | + | instance_id | String | DB instance ID. | +-----------------------+-----------------------+-------------------------------------------+ - | instance_name | String | Instance name. | + | instance_name | String | DB instance name. | +-----------------------+-----------------------+-------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst index 6f743d0..6ca3c6c 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst @@ -58,7 +58,7 @@ Request Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==============================================================================================================================================================+ - | name | Yes | String | Instance name. | + | name | Yes | String | DB instance name. | | | | | | | | | | Instances of the same type can have same names under the same tenant. | | | | | | diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst index 74d7ab8..ee3740c 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst @@ -67,7 +67,7 @@ Request Parameters +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | Yes | :ref:`MysqlDatastore ` object | Database information. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | Yes | String | DB instance type, which is case-insensitive. Currently, only the cluster type is supported. | + | mode | Yes | String | DB instance type, which is case-insensitive. Its value is **Cluster**. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | flavor_ref | Yes | String | Specification code. For details, see :ref:`Querying Database Specifications `. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -238,17 +238,17 @@ Response Parameters +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +==========================+================================================================================================================+===============================================================================================================================================================+ - | id | String | Instance ID. | + | id | String | DB instance ID. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | DB instance name. Instances of the same type can have same names under the same tenant. | | | | | | | | The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. Value: **creating**. | + | status | String | DB instance status. Value: **creating**. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | :ref:`MysqlDatastore ` object | Database information. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | DB instance type. Currently, only the cluster type is supported. | + | mode | String | DB instance type. Currently, Its value is **Cluster**. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | configuration_id | String | Parameter template ID. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst index eb146fe..84d45b8 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst @@ -35,7 +35,7 @@ URI | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | instance_id | Yes | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst index 843855a..6aa9c6d 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst @@ -35,7 +35,7 @@ URI | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | instance_id | Yes | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst index a3ff11c..4988d7c 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst @@ -35,7 +35,7 @@ URI | | | | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ - | instance_id | Yes | Instance ID, which is compliant with the UUID format. | + | instance_id | Yes | DB instance ID, which is compliant with the UUID format. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ | node_id | Yes | Read-only node ID, which is compliant with the UUID format. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst index 7688d9a..a567180 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst @@ -43,7 +43,7 @@ URI | | | | | | | | | The asterisk (``*``) is reserved for the system. If the instance name starts with an asterisk (``*``), the value following asterisk (``*``) is used for fuzzy matching. Otherwise, the instance name is used for exact matching. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | No | DB instance type to be queried. Currently, only the cluster type is supported. | + | type | String | No | DB instance type to be queried. Its value is **Cluster**. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore_type | String | No | DB type. Currently, only gaussdb-mysql is supported. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst index 92d5b52..f513987 100644 --- a/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst +++ b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst @@ -97,7 +97,7 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ | version_name | String | DB version number. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | instance_mode | String | DB instance type. Currently, only the cluster type is supported. | + | instance_mode | String | DB instance type. Its value is **Cluster**. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ | az_status | Map | Status of the AZ where the specification belongs. Its value can be any of the following: | | | | | diff --git a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst index ce184ee..70af3da 100644 --- a/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst +++ b/api-ref/source/appendix/gaussdbfor_mysql_monitoring_metrics.rst @@ -20,207 +20,255 @@ Monitoring Metrics .. table:: **Table 1** Monitoring metrics - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | Metric | Name | Description | Value Range | Remarks | - +====================================================+================================================+=============================================================================================================================================================+==================+======================================================+ - | gaussdb_mysql001_cpu_util | CPU Usage | CPU usage of the monitored object | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql002_mem_util | Memory Usage | Memory usage of the monitored object | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql004_bytes_in | Network Input Throughput | Incoming traffic in bytes per second | >=0 Bytes/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql005_bytes_out | Network Output Throughput | Outgoing traffic in bytes per second | >=0 Bytes/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql006_conn_count | Total Connections | Total number of connections that connect to the MySQL server | >=0 Connections | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql007_conn_active_count | Current Active Connections | Number of active connections | >=0 Connections | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql008_qps | QPS | Query times of SQL statements (including DDL, DML, SHOW, SET statements and storage procedures) per second | >=0 Times/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql009_tps | TPS | Execution times of submitted and rollback transactions per second | >=0 Times/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql010_innodb_buf_usage | Buffer Pool Usage | Ratio of used pages to total pages in the InnoDB buffer | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql011_innodb_buf_hit | Buffer Pool Hit Ratio | Ratio of read hits to read requests in the InnoDB buffer | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql012_innodb_buf_dirty | Buffer Pool Dirty Block Ratio | Ratio of dirty data to all data in the InnoDB buffer | 0-100% | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql013_innodb_reads | InnoDB Read Throughput | Number of read bytes per second in the InnoDB buffer | >=0 Bytes/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql014_innodb_writes | InnoDB Write Throughput | Number of write bytes per second in the InnoDB buffer | >=0 Bytes/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql017_innodb_log_write_req_count | InnoDB Log Write Requests per Second | Number of InnoDB log write requests per second | >=0 Requests/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql020_temp_tbl_count | Temporary Tables | Number of temporary tables automatically created on hard disks when MySQL statements are executed | >=0 Tables | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql028_comdml_del_count | DELETE Statements per Second | Number of DELETE statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql029_comdml_ins_count | INSERT Statements per Second | Number of INSERT statements executed per second | >=0 Statements/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql030_comdml_ins_sel_count | INSERT_SELECT Statements per Second | Number of INSERT_SELECT statements executed per second | >=0 Statements/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql031_comdml_rep_count | REPLACE Statements per Second | Number of REPLACE statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql032_comdml_rep_sel_count | REPLACE_SELECTION Statements per Second | Number of REPLACE_SELECTION statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql033_comdml_sel_count | SELECT Statements per Second | Number of SELECT statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql034_comdml_upd_count | UPDATE Statements per Second | Number of UPDATE statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql035_innodb_del_row_count | Row Delete Frequency | Number of rows deleted from the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql036_innodb_ins_row_count | Row Insert Frequency | Number of rows inserted into the InnoDB table per second | >=0 Rows/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql037_innodb_read_row_count | Row Read Frequency | Number of rows read from the InnoDB table per second | >=0 Rows/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql038_innodb_upd_row_count | Row Update Frequency | Number of rows updated into the InnoDB table per second | >=0 Rows/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql048_disk_used_size | Used Storage Space | Used storage space of the monitored object | 0 GB-128 TB | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql072_conn_usage | Connection Usage | Percent of used MySQL connections to the total number of connections | 0-100% | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql074_slow_queries | Slow Query Logs | Number of MySQL slow query logs generated per minute | >=0 Queries/min | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql077_replication_delay | Replication Delay | Data replication delay between the primary node and read replicas | >= 0s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql104_dfv_write_delay | Storage Write Latency | Average latency of writing data to the storage layer in a specified period | >=0 ms | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql105_dfv_read_delay | Storage Read Latency | Average latency of reading data from the storage layer in a specified period | >=0 ms | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql106_innodb_row_lock_current_waits | InnoDB Row Locks | Number of row locks being waited by operations on the InnoDB table | >=0 Locks | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql107_comdml_ins_and_ins_sel_count | INSERT and INSERT_SELECT Statements per Second | Number of INSERT and INSERT_SELECT statements executed per second | >=0 Statements/s | Monitored object: ECS | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql108_com_commit_count | COMMIT Statements per Second | Number of COMMIT statements executed per second | >=0 Statements/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql109_com_rollback_count | ROLLBACK Statements per Second | Number of ROLLBACK statements executed per second | >=0 Statements/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql110_innodb_bufpool_reads | InnoDB Storage Layer Read Requests per Second | Number of times that InnoDB reads data from the storage layer per second | >=0 Times/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql111_innodb_bufpool_read_requests | InnoDB Read Requests per Second | Number of InnoDB read requests per second | >=0 Requests/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql114_innodb_bufpool_read_ahead | InnoDB Bufpool Read Ahead | Number of pages read into the InnoDB buffer pool by the read-ahead background thread | >=0 Pages | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql115_innodb_bufpool_read_ahead_evicted | InnoDB Bufpool Read Ahead Evicted | Number of pages read into the InnoDB buffer pool by the read-ahead background thread that were subsequently evicted without having been accessed by queries | >=0 Pages | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql116_innodb_bufpool_read_ahead_rnd | InnoDB Bufpool Read Ahead Rnd | Number of random read-aheads initiated by InnoDB | >=0 Read-aheads | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql117_innodb_pages_read | InnoDB Pages Read | Number of pages read from the InnoDB buffer pool by operations on InnoDB tables | >=0 Pages | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql118_innodb_pages_written | InnoDB Pages Written | Number of pages written by operations on InnoDB tables | >=0 Pages | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql019_innodb_log_writess | InnoDB Log Writes | Number of physical writes to the InnoDB redo log file | >=0 Writes | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql342_iostat_iops_write | I/O Write IOPS | Number of disk writes per second | >=0 Operations/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql344_iostat_iops_read | I/O Read IOPS | Number of disk reads per second | >=0 Operations/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql346_iostat_throughput_write | I/O Write Bandwidth | Disk write bandwidth per second | >=0 Bytes/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql348_iostat_throughput_read | I/O Read Bandwidth | Disk read bandwidth per second | >=0 Bytes/s | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ - | gaussdb_mysql119_disk_used_ratio | Disk Usage | Disk usage of the monitored object | 0-100% | Monitored object: database | - | | | | | | - | | | | | Monitored instance type: GaussDB(for MySQL) instance | - | | | | | | - | | | | | 1 minute | - +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+------------------------------------------------------+ + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | Metric | Name | Description | Value Range | Remarks | + +====================================================+================================================+=============================================================================================================================================================+=================+======================================================+ + | gaussdb_mysql001_cpu_util | CPU Usage | CPU usage of the monitored object | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql002_mem_util | Memory Usage | Memory usage of the monitored object | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql004_bytes_in | Network Input Throughput | Incoming traffic in bytes per second | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql005_bytes_out | Network Output Throughput | Outgoing traffic in bytes per second | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql006_conn_count | Total Connections | Total number of connections that connect to the MySQL server | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql007_conn_active_count | Current Active Connections | Number of active connections | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql008_qps | QPS | Query times of SQL statements (including DDL, DML, SHOW, SET statements and storage procedures) per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql009_tps | TPS | Execution times of submitted and rollback transactions per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql010_innodb_buf_usage | Buffer Pool Usage | Ratio of used pages to total pages in the InnoDB buffer | 0-1 | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql011_innodb_buf_hit | Buffer Pool Hit Ratio | Ratio of read hits to read requests in the InnoDB buffer | 0-1 | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql012_innodb_buf_dirty | Buffer Pool Dirty Block Ratio | Ratio of dirty data to all data in the InnoDB buffer | 0-1 | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql013_innodb_reads | InnoDB Read Throughput | Number of read bytes per second in the InnoDB buffer | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql014_innodb_writes | InnoDB Write Throughput | Number of write bytes per second in the InnoDB buffer | >=0 bytes/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql017_innodb_log_write_req_count | InnoDB Log Write Requests per Second | Number of InnoDB log write requests per second | >=0 times/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql020_temp_tbl_count | Temporary Tables | Number of temporary tables automatically created on hard disks when MySQL statements are executed | >= 0 counts | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql028_comdml_del_count | DELETE Statements per Second | Number of DELETE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql029_comdml_ins_count | INSERT Statements per Second | Number of INSERT statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql030_comdml_ins_sel_count | INSERT_SELECT Statements per Second | Number of INSERT_SELECT statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql031_comdml_rep_count | REPLACE Statements per Second | Number of REPLACE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql032_comdml_rep_sel_count | REPLACE_SELECTION Statements per Second | Number of REPLACE_SELECTION statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql033_comdml_sel_count | SELECT Statements per Second | Number of SELECT statements executed per second | >=0 Counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql034_comdml_upd_count | UPDATE Statements per Second | Number of UPDATE statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql035_innodb_del_row_count | Row Delete Frequency | Number of rows deleted from the InnoDB table per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql036_innodb_ins_row_count | Row Insert Frequency | Number of rows inserted into the InnoDB table per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql037_innodb_read_row_count | Row Read Frequency | Number of rows read from the InnoDB table per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql038_innodb_upd_row_count | Row Update Frequency | Number of rows updated into the InnoDB table per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql048_disk_used_size | Used Storage Space | Used storage space of the monitored object | 0 GB-128 TB | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql072_conn_usage | Connection Usage | Percent of used MySQL connections to the total number of connections | 0-100% | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql074_slow_queries | Slow Query Logs | Number of MySQL slow query logs generated per minute | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql077_replication_delay | Replication Delay | Data replication delay between the primary node and read replicas | >=0 ms | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql104_dfv_write_delay | Storage Write Latency | Average latency of writing data to the storage layer in a specified period | >=0 ms | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql105_dfv_read_delay | Storage Read Latency | Average latency of reading data from the storage layer in a specified period | >=0 ms | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql106_innodb_row_lock_current_waits | InnoDB Row Locks | Number of row locks being waited by operations on the InnoDB table | >= 0 counts | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql107_comdml_ins_and_ins_sel_count | INSERT and INSERT_SELECT Statements per Second | Number of INSERT and INSERT_SELECT statements executed per second | >= 0 counts/s | Monitored object: ECS | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql108_com_commit_count | COMMIT Statements per Second | Number of COMMIT statements executed per second | >=0 Counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql109_com_rollback_count | ROLLBACK Statements per Second | Number of ROLLBACK statements executed per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql110_innodb_bufpool_reads | InnoDB Storage Layer Read Requests per Second | Number of times that InnoDB reads data from the storage layer per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql111_innodb_bufpool_read_requests | InnoDB Read Requests per Second | Number of InnoDB read requests per second | >= 0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql114_innodb_bufpool_read_ahead | InnoDB Bufpool Read Ahead | Number of pages read into the InnoDB buffer pool by the read-ahead background thread | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql115_innodb_bufpool_read_ahead_evicted | InnoDB Bufpool Read Ahead Evicted | Number of pages read into the InnoDB buffer pool by the read-ahead background thread that were subsequently evicted without having been accessed by queries | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql116_innodb_bufpool_read_ahead_rnd | InnoDB Bufpool Read Ahead Rnd | Number of random read-aheads initiated by InnoDB | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql117_innodb_pages_read | InnoDB Pages Read | Number of pages read from the InnoDB buffer pool by operations on InnoDB tables | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql118_innodb_pages_written | InnoDB Pages Written | Number of pages written by operations on InnoDB tables | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql019_innodb_log_writess | InnoDB Log Writes | Number of physical writes to the InnoDB redo log file | >=0 counts | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql342_iostat_iops_write | I/O Write IOPS | Number of disk writes per second | >=0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql344_iostat_iops_read | I/O Read IOPS | Number of disk reads per second | >=0 counts/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql346_iostat_throughput_write | I/O Write Bandwidth | Disk write bandwidth per second | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql348_iostat_throughput_read | I/O Read Bandwidth | Disk read bandwidth per second | >=0 bytes/s | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql119_disk_used_ratio | Disk Usage | Disk usage of the monitored object | 0-100% | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql120_innodb_buffer_pool_bytes_data | Total Bytes of Buffer Pool | Total number of bytes in the InnoDB buffer pool containing data | >=0 bytes | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql121_innodb_row_lock_time | Row Lock Time | Total time spent in acquiring row locks for InnoDB tables | >=0 ms | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql122_innodb_row_lock_waits | Row Lock Waits | Number of times operations on InnoDB tables had to wait for a row lock | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql123_sort_range | Sorts Using Ranges | Number of sorts that were done using ranges | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql124_sort_rows | Sorted Rows | Number of sorted rows | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql125_sort_scan | Sorts by Scanning Tables | Number of sorts that were done by scanning tables. | >=0 Counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql126_table_open_cache_hits | Hits for Open Tables Cache Lookups | Number of hits for open tables cache lookups | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ + | gaussdb_mysql127_table_open_cache_misses | Misses for Open Tables Cache Lookups | Number of misses for open tables cache lookups | >= 0 counts/min | Monitored object: database | + | | | | | | + | | | | | Monitored instance type: GaussDB(for MySQL) instance | + | | | | | | + | | | | | 1 minute | + +----------------------------------------------------+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+------------------------------------------------------+ Dimension --------- diff --git a/api-ref/source/before_you_start/api_calling.rst b/api-ref/source/before_you_start/api_calling.rst index d5add04..e6feb4a 100644 --- a/api-ref/source/before_you_start/api_calling.rst +++ b/api-ref/source/before_you_start/api_calling.rst @@ -5,4 +5,4 @@ API Calling =========== -GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs `. +GaussDB(for MySQL) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`API Usage Guidelines `. diff --git a/api-ref/source/before_you_start/overview.rst b/api-ref/source/before_you_start/overview.rst index 220c0c5..d0ab13a 100644 --- a/api-ref/source/before_you_start/overview.rst +++ b/api-ref/source/before_you_start/overview.rst @@ -13,4 +13,4 @@ GaussDB(for MySQL) is a MySQL-compatible, enterprise-grade distributed database This document describes how to use application programming interfaces (APIs) to perform operations on DB instances. For details about all supported operations, see :ref:`API Overview `. -If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see "Introduction" in the *GaussDB(for MySQL) User Guide*. +If you plan to access GaussDB(for MySQL) through an API, ensure that you are familiar with GaussDB(for MySQL) concepts. For details, see `Introduction `__ in *GaussDB(for MySQL) User Guide*. diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index e1812ad..1242e47 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -7,7 +7,7 @@ GaussDB (for MySQL) - API Reference before_you_start/index api_overview - calling_apis/index + api_usage_guidelines/index apis_recommended/index apis_unavailable_soon/index appendix/index