dadrobna/gaussdb-mysql
1
0
Fork 0
forked from docs/gaussdb-mysql
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-06-01 01:55:40 +00:00
parent 684098bb12
commit 89d4a22a4d
55 changed files with 969 additions and 787 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
api-ref/source/api_overview.rst
View File

@ -7,24 +7,28 @@ API Overview
With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas. With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type | Description | | Type | Description |
+===============================+====================================================================================================================================================================================================================+ +===================================+====================================================================================================================================================================================================================+
| DB engine version query | Query the DB version information of a specified DB engine. | | 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 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. | | 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. | | Backup management | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies. |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter template management | Query parameter templates. | | Parameter template management | Query parameter templates. |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Quota management | Query, set, and modify resource quotas. | | 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. | | 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. | | 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. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0
api-ref/source/calling_apis/authentication.rst → api-ref/source/api_usage_guidelines/authentication.rst
View File

4
api-ref/source/calling_apis/index.rst → api-ref/source/api_usage_guidelines/index.rst
View File

@ -2,8 +2,8 @@
.. _gaussdb_03_0000: .. _gaussdb_03_0000:
Calling APIs API Usage Guidelines
============ ====================
- :ref:`Making an API Request <gaussdb_03_0005>` - :ref:`Making an API Request <gaussdb_03_0005>`
- :ref:`Authentication <gaussdb_03_0001>` - :ref:`Authentication <gaussdb_03_0001>`

0
api-ref/source/calling_apis/making_an_api_request.rst → api-ref/source/api_usage_guidelines/making_an_api_request.rst
View File

0
api-ref/source/calling_apis/response.rst → api-ref/source/api_usage_guidelines/response.rst
View File

10
api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst
View File

@ -36,7 +36,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -45,7 +45,7 @@ Request Parameters
+-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | 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 (_). | | 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 | | | | manual |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400** **Status code: 400**
@ -134,7 +134,7 @@ Example Request
Creating a Manual Backup Creating a Manual Backup
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create 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", "begin_time" : "2020-07-07T01:17:05+0800",
"status" : "BUILDING", "status" : "BUILDING",
"type" : "manual", "type" : "manual",
"instance_id" : "ef25188419f941309882d2986b2210b9in07" "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
}, },
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7" "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
} }

26
api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst
View File

@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters
@ -38,7 +38,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -54,9 +54,9 @@ Request Parameters
.. table:: **Table 4** MysqlBackupPolicy .. table:: **Table 4** MysqlBackupPolicy
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=============================+=================+=================+=============================================================================================================================================================================================================================+ +==============================+=================+=================+=============================================================================================================================================================================================================================+
| start_time | Yes | String | Backup time window. Automated backups will be triggered during the backup time window. | | 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 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. |
@ -67,22 +67,22 @@ Request Parameters
| | | | Example value: | | | | | Example value: |
| | | | | | | | | |
| | | | 21:00-22:00 | | | | | 21:00-22:00 |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| keep_days | Yes | Integer | Backup retention days. | | keep_days | Yes | Integer | Backup retention days. |
| | | | | | | | | |
| | | | Value: **1** to **732** | | | | | Value: **1** to **732** |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| period | Yes | String | Backup cycle configuration. Data will be automatically backed up on the selected days every week. | | 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. | | | | | 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. | | | | | 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: | | 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 | | | | | - 0 |
| | | | - 1 | | | | | - 1 |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters Response Parameters
------------------- -------------------
@ -95,8 +95,8 @@ Response Parameters
Parameter Type Description Parameter Type Description
============= ====== =================== ============= ====== ===================
status String Status information. status String Status information.
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** **Status code: 400**
@ -126,7 +126,7 @@ Example Request
Modifying a backup policy 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 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 | | | | - **COMPLETED**: Modification completed |
| | | - **FAILED**: Modification failed | | | | - **FAILED**: Modification failed |
+-----------------------+-----------------------+-------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-----------------------+-----------------------+-------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------+
| instance_name | String | DB instance name. | | instance_name | String | DB instance name. |
+-----------------------+-----------------------+-------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------+

2
api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst
View File

@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/backups/policy
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters

14
api-ref/source/apis_recommended/backup_management/querying_backups.rst
View File

@ -33,7 +33,7 @@ GET /v3/{project_id}/backups
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================================================================================================================================================================================================================================+ +=================+=================+=================+=======================================================================================================================================================================================================================================+
| instance_id | No | String | Instance ID. | | instance_id | No | String | DB instance ID. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| backup_id | No | String | Backup ID. | | backup_id | No | String | Backup ID. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -60,7 +60,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -124,7 +124,7 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| datastore | :ref:`MysqlDatastore <gaussdb_06_0004__response_mysqldatastore>` object | Database information. | | datastore | :ref:`MysqlDatastore <gaussdb_06_0004__response_mysqldatastore>` object | Database information. |
+-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Description of the backup file. | | description | String | Description of the backup file. |
+-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -183,10 +183,10 @@ Success.
{ {
"backups" : [ { "backups" : [ {
"id" : "1fe4feaab48f11e6654hfa163eba87e4b66u", "id" : "c0c9f155c7b7423a9d30f0175998b63bbr01",
"name" : "GaussDBforMySQL-gauss-e747-20200705185048266", "name" : "GaussDBforMySQL-gauss-e747-20200705185048266",
"begin_time" : "2018-08-06T12:41:14+0800", "begin_time" : "2020-07-06T10:41:14",
"end_time" : "2018-08-06T12:45:14+0800", "end_time" : "2020-07-16T10:41:14+0800",
"take_up_time" : 2, "take_up_time" : 2,
"status" : "COMPLETED", "status" : "COMPLETED",
"type" : "auto", "type" : "auto",
@ -195,7 +195,7 @@ Success.
"type" : "gaussdb-mysql", "type" : "gaussdb-mysql",
"version" : "8.0" "version" : "8.0"
}, },
"instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01" "instance_id" : "c0c9f155c7b7423a9d30f0175998b63bbr01"
} ], } ],
"total_count" : 1 "total_count" : 1

4
api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst
View File

@ -28,7 +28,7 @@ POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters
@ -91,7 +91,7 @@ Response Parameters
Example Request Example Request
--------------- ---------------
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge
{ {

4
api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst
View File

@ -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. | | 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. | | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. |
+-------------+-----------+--------+-------------------------------------------------------------+ +-------------+-----------+--------+-------------------------------------------------------------+
@ -101,7 +101,7 @@ Response Parameters
Example Request Example Request
--------------- ---------------
.. code-block:: text .. code-block::
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight
{ {

6
api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst
View File

@ -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 <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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. | | proxy_id | Yes | String | Database proxy ID, which is compliant with the UUID format. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
@ -90,11 +90,11 @@ Response Parameters
Example Request Example Request
--------------- ---------------
.. code-block:: text .. code-block::
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor 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 Example Response

2
api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst
View File

@ -28,7 +28,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/proxy
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters

20
api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst
View File

@ -28,7 +28,7 @@ POST /v3/{project_id}/instances/{instance_id}/proxy
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters
@ -45,24 +45,24 @@ Request Parameters
.. table:: **Table 3** Request body parameters .. table:: **Table 3** Request body parameters
+-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+===================+=================+==================================================================================+===========================================================================================================================================================================================================================================================+ +===================+=================+==================================================================================+==============================================================================================================================================================================================================================================================+
| flavor_ref | Yes | String | Proxy specification code. | | 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. | | 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_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**. | | proxy_mode | No | String | Proxy instance type. The default type is **readwrite**. |
| | | | | | | | | |
| | | | Valid value: | | | | | Valid value: |
| | | | | | | | | |
| | | | - **readwrite** | | | | | - **readwrite** |
| | | | - **readonly** | | | | | - **readonly** |
+-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nodes_read_weight | No | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node. | | nodes_read_weight | No | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node. |
+-------------------+-----------------+----------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _creategaussmysqlproxy__request_nodesweight: .. _creategaussmysqlproxy__request_nodesweight:
@ -114,7 +114,7 @@ Response Parameters
Example Request Example Request
--------------- ---------------
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy
{ {

16
api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst
View File

@ -28,7 +28,7 @@ GET /v3/{project_id}/instances/{instance_id}/proxies
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters
@ -49,7 +49,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -128,6 +128,8 @@ Response Parameters
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ +----------------------------+--------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| name | String | Proxy instance name. | | 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: .. _showgaussmysqlproxylist__en-us_topic_0000001216000914_response_mysqlproxynodes:
@ -158,7 +160,7 @@ Response Parameters
+===================+==================================================================================================================================+==========================+ +===================+==================================================================================================================================+==========================+
| id | String | Node ID. | | id | String | Node ID. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+
| status | String | Node status. | | status | String | Node status. |
+-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+ +-------------------+----------------------------------------------------------------------------------------------------------------------------------+--------------------------+
@ -237,15 +239,17 @@ Success.
"id" : "db53a238a02240c49365e72e284a4890pn01", "id" : "db53a238a02240c49365e72e284a4890pn01",
"name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0",
"role" : "master", "role" : "master",
"az_code" : "az1xahz", "az_code" : "az1",
"status" : "ACTIVE", "status" : "ACTIVE",
"frozen_flag" : 0 "frozen_flag" : 0
} ], } ],
"name" : "proxy-name" "name" : "proxy-name",
"flavor_ref":"gaussdb.proxy.large.x86.2",
"transaction_split":"OFF"
}, },
"master_node" : { "master_node" : {
"id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
"instance_id" : "7a871d6d494e4327ad2e326afb591108in07", "instance_id" : "096c0fc43e804757b59946b80dc27f8bin07",
"status" : "ACTIVE", "status" : "ACTIVE",
"name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01",
"weight" : 0, "weight" : 0,

14
api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst
View File

@ -28,7 +28,7 @@ GET /v3/{project_id}/instances/{instance_id}/proxy/flavors
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters
@ -39,7 +39,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -60,13 +60,13 @@ Response Parameters
.. table:: **Table 4** MysqlProxyFlavorGroups .. table:: **Table 4** MysqlProxyFlavorGroups
+---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+===============+================================================================================================================+=========================================================+ +===============+================================================================================================================+==============================================+
| group_type | String | Specification group type. It can be **x86** or **arm**. | | group_type | String | Specification group type. It can be **x86**. |
+---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+
| proxy_flavors | Array of :ref:`MysqlProxyComputeFlavor <showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor>` objects | Proxy specifications. | | proxy_flavors | Array of :ref:`MysqlProxyComputeFlavor <showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor>` objects | Proxy specifications. |
+---------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ +---------------+----------------------------------------------------------------------------------------------------------------+----------------------------------------------+
.. _showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor: .. _showgaussmysqlproxyflavors__response_mysqlproxycomputeflavor:

11
api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst
View File

@ -16,7 +16,7 @@ This API is used to query database error logs. Before using this API:
URI 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 .. 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 <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters
@ -69,7 +69,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -138,7 +138,7 @@ Example Request
.. code-block:: text .. 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 Example Response
---------------- ----------------
@ -155,7 +155,8 @@ Success.
"time" : "2022-07-17T07:34:33", "time" : "2022-07-17T07:34:33",
"level" : "ERROR", "level" : "ERROR",
"content" : "[MY013508] [Repl] do failed: 1" "content" : "[MY013508] [Repl] do failed: 1"
} ] } ],
"total_record":1
} }
Status Code Status Code

26
api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst
View File

@ -16,7 +16,7 @@ This API is used to query database slow logs. Before using this API:
URI 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 .. 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 <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters
@ -71,7 +71,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -149,9 +149,7 @@ Example Response
Success. Success.
- Example 1 .. code-block::
.. code-block::
{ {
"slow_log_list" : [ { "slow_log_list" : [ {
@ -165,25 +163,13 @@ Success.
"users" : "root", "users" : "root",
"query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);",
"type" : "INSERT", "type" : "INSERT",
"start_time" : "2121-03-25T10:55:16.000Z", "start_time" : "2022-07-11T00:00:00+0800",
"client_ip" : "192.*.*.1" "client_ip" : "192.*.*.1"
} ], } ],
"long_query_time" : 10, "long_query_time" : 10,
"total_record" : 15 "total_record" : 1
} }
- Example 2
.. code-block::
10
- Example 3
.. code-block::
15
Status Code Status Code
----------- -----------

22
api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst
View File

@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/name
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters
@ -38,17 +38,17 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
.. table:: **Table 3** Request body parameters .. table:: **Table 3** Request body parameters
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | 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 (_). | | 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 Response Parameters
------------------- -------------------
@ -57,11 +57,11 @@ Response Parameters
.. table:: **Table 4** Response body parameters .. table:: **Table 4** Response body parameters
========= ====== ====================================== ========= ====== ========================================
Parameter Type Description 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** **Status code: 400**
@ -90,7 +90,7 @@ Example Request
Changing a DB Instance Name 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 PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{ {

2
api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst
View File

@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/action
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters

4
api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst
View File

@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/monitor-policy
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters 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. 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 PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy
{ {

70
api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst → api-ref/source/apis_recommended/managing_db_instances/creating_a_db_instance.rst
View File

File diff suppressed because it is too large Load Diff

6
api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst
View File

@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters
@ -60,7 +60,7 @@ Response Parameters
+-----------------------+-----------------------+-----------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+=============================================================================+ +=======================+=======================+=============================================================================+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------+
| node_names | Array of strings | Node name list | | node_names | Array of strings | Node name list |
+-----------------------+-----------------------+-----------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------+
@ -96,7 +96,7 @@ Example Request
Creating a read replica 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 POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge
{ {

2
api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst
View File

@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id}
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters

4
api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst
View File

@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/nodes/{node_id}
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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. | | node_id | Yes | String | Node ID, which is compliant with the UUID format. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
@ -40,7 +40,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========

8
api-ref/source/apis_recommended/managing_db_instances/index.rst
View File

@ -5,8 +5,8 @@
Managing DB Instances Managing DB Instances
===================== =====================
- :ref:`Creating an Instance <gaussdb_04_0004>` - :ref:`Creating a DB Instance <gaussdb_04_0004>`
- :ref:`Querying Instances <gaussdb_04_0005>` - :ref:`Querying DB Instances <gaussdb_04_0005>`
- :ref:`Deleting a DB Instance <gaussdb_04_0007>` - :ref:`Deleting a DB Instance <gaussdb_04_0007>`
- :ref:`Querying Details of a DB Instance <gaussdb_04_0006>` - :ref:`Querying Details of a DB Instance <gaussdb_04_0006>`
- :ref:`Creating a Read Replica <gaussdb_04_0015>` - :ref:`Creating a Read Replica <gaussdb_04_0015>`
@ -21,8 +21,8 @@ Managing DB Instances
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
creating_an_instance creating_a_db_instance
querying_instances querying_db_instances
deleting_a_db_instance deleting_a_db_instance
querying_details_of_a_db_instance querying_details_of_a_db_instance
creating_a_read_replica creating_a_read_replica

123
api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst → api-ref/source/apis_recommended/managing_db_instances/querying_db_instances.rst
View File

File diff suppressed because it is too large Load Diff

168
api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst
View File

@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/monitor-policy
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters

10
api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst
View File

@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/password
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| 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 Request Parameters
@ -38,7 +38,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -80,7 +80,7 @@ Example Request
Resetting a database password Resetting a database password
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password
{ {
@ -90,6 +90,10 @@ Resetting a database password
Example Response Example Response
---------------- ----------------
**Status code: 200**
Success.
None None
Status Code Status Code

50
api-ref/source/apis_recommended/querying_database_specifications.rst
View File

File diff suppressed because it is too large Load Diff

35
api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst
View File

@ -52,22 +52,24 @@ Request Parameters
.. table:: **Table 4** setQuota .. table:: **Table 4** setQuota
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=======================+===========+=========+======================================================================================================================================================================================+ +=========================+===========+=========+=========================================================================================================================================================================================+
| enterprise_project_id | Yes | String | Enterprise project ID. | | 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.) | | enterprise_project_name | Yes | String | Enterprise project name. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.) | | 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.) |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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.) | | 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 Response Parameters
------------------- -------------------
**Status code: 200** **Status code: 201**
.. table:: **Table 5** Response body parameters .. table:: **Table 5** Response body parameters
@ -81,24 +83,26 @@ Response Parameters
.. table:: **Table 6** setQuota .. table:: **Table 6** setQuota
===================== ======= ================================== ======================= ======= ==================================
Parameter Type Description Parameter Type Description
===================== ======= ================================== ======================= ======= ==================================
enterprise_project_id String Enterprise project ID. enterprise_project_id String Enterprise project ID.
enterprise_project_name String Enterprise project name.
instance_quota Integer Quota of the DB instance quantity. instance_quota Integer Quota of the DB instance quantity.
vcpus_quota Integer Quota of vCPUs. vcpus_quota Integer Quota of vCPUs.
ram_quota Integer Memory quota in GB. ram_quota Integer Memory quota in GB.
===================== ======= ================================== ======================= ======= ==================================
Example Request Example Request
--------------- ---------------
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas
{ {
"quota_list" : [ { "quota_list" : [ {
"enterprise_project_id" : "0", "enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"instance_quota" : 20, "instance_quota" : 20,
"vcpus_quota" : 20, "vcpus_quota" : 20,
"ram_quota" : 40 "ram_quota" : 40
@ -108,7 +112,7 @@ Example Request
Example Response Example Response
---------------- ----------------
**Status code: 200** **Status code: 201**
Success. Success.
@ -117,6 +121,7 @@ Success.
{ {
"quota_list" : [ { "quota_list" : [ {
"enterprise_project_id" : "0", "enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"instance_quota" : 20, "instance_quota" : 20,
"vcpus_quota" : 20, "vcpus_quota" : 20,
"ram_quota" : 40 "ram_quota" : 40

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

@ -8,7 +8,7 @@ Quota Management
- :ref:`Querying Resource Quotas <gaussdb_04_0011>` - :ref:`Querying Resource Quotas <gaussdb_04_0011>`
- :ref:`Configuring Resource Quotas <gaussdb_04_0012>` - :ref:`Configuring Resource Quotas <gaussdb_04_0012>`
- :ref:`Modifying Resource Quotas <gaussdb_04_0013>` - :ref:`Modifying Resource Quotas <gaussdb_04_0013>`
- :ref:`Querying the Instance Quotas of a Tenant <showgaussmysqlprojectquotas>` - :ref:`Querying the DB Instance Quotas of a Tenant <showgaussmysqlprojectquotas>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -17,4 +17,4 @@ Quota Management
querying_resource_quotas querying_resource_quotas
configuring_resource_quotas configuring_resource_quotas
modifying_resource_quotas modifying_resource_quotas
querying_the_instance_quotas_of_a_tenant querying_the_db_instance_quotas_of_a_tenant

18
api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst → api-ref/source/apis_recommended/quota_management/querying_the_db_instance_quotas_of_a_tenant.rst
View File

@ -2,8 +2,8 @@
.. _ShowGaussMySqlProjectQuotas: .. _ShowGaussMySqlProjectQuotas:
Querying the Instance Quotas of a Tenant Querying the DB Instance Quotas of a Tenant
======================================== ===========================================
Function Function
-------- --------
@ -48,7 +48,7 @@ Request Parameters
============ ========= ====== =========== ============ ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
============ ========= ====== =========== ============ ========= ====== ===========
X-Auth-Token No String User token. X-Auth-Token Yes String User token.
X-Language No String Language. X-Language No String Language.
============ ========= ====== =========== ============ ========= ====== ===========
@ -79,21 +79,21 @@ Response Parameters
.. table:: **Table 6** resource .. table:: **Table 6** resource
+-----------------------+-----------------------+------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+================================================+ +=======================+=======================+===================================================+
| type | String | Quota of a specified type. | | type | String | Quota of a specified type. |
| | | | | | | |
| | | - **instance**: indicates the instance quota. | | | | - **instance**: indicates the DB instance quota. |
| | | | | | | |
| | | Valid value: | | | | Valid value: |
| | | | | | | |
| | | - **instance** | | | | - **instance** |
+-----------------------+-----------------------+------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------+
| used | Integer | Number of created resources. | | used | Integer | Number of created resources. |
+-----------------------+-----------------------+------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------+
| quota | Integer | Maximum resource quota. | | quota | Integer | Maximum resource quota. |
+-----------------------+-----------------------+------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------+
**Status code: 400** **Status code: 400**

4
api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst
View File

@ -27,7 +27,7 @@ PUT /v3/{project_id}/instances/{instance_id}/sql-filter/rules
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters
@ -132,7 +132,7 @@ Example Request
Configuring concurrency control rules of SQL statements 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 PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
{ {

2
api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst
View File

@ -27,7 +27,7 @@ DELETE /v3/{project_id}/instances/{instance_id}/sql-filter/rules
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters

2
api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst
View File

@ -5,6 +5,7 @@
SQL Statement Concurrency Control SQL Statement Concurrency Control
================================= =================================
- :ref:`Querying Whether SQL Statement Concurrency Control Is Enabled <showsqlfiltercontrol>`
- :ref:`Configuring Concurrency Control Rules of SQL Statements <setsqlfilterrule>` - :ref:`Configuring Concurrency Control Rules of SQL Statements <setsqlfilterrule>`
- :ref:`Querying Concurrency Control Rules of SQL Statements <showsqlfilterrule>` - :ref:`Querying Concurrency Control Rules of SQL Statements <showsqlfilterrule>`
- :ref:`Deleting Concurrency Control Rules of SQL Statements <deletesqlfilterrule>` - :ref:`Deleting Concurrency Control Rules of SQL Statements <deletesqlfilterrule>`
@ -13,6 +14,7 @@ SQL Statement Concurrency Control
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
querying_whether_sql_statement_concurrency_control_is_enabled
configuring_concurrency_control_rules_of_sql_statements configuring_concurrency_control_rules_of_sql_statements
querying_concurrency_control_rules_of_sql_statements querying_concurrency_control_rules_of_sql_statements
deleting_concurrency_control_rules_of_sql_statements deleting_concurrency_control_rules_of_sql_statements

4
api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst
View File

@ -16,7 +16,7 @@ This API is used to query concurrency control rules of SQL statements. Before ca
URI 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 .. 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 <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters

115
api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst Normal file
View File

File diff suppressed because it is too large Load Diff

10
api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst
View File

@ -27,7 +27,7 @@ POST /v3/{project_id}/instances/{instance_id}/tags/action
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
Request Parameters Request Parameters
@ -100,7 +100,7 @@ Example Request
- Adding tags - Adding tags
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{ {
@ -116,7 +116,7 @@ Example Request
- Deleting tags - Deleting tags
.. code-block:: text .. code-block::
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{ {
@ -132,6 +132,10 @@ Example Request
Example Response Example Response
---------------- ----------------
**Status code: 200**
Success.
None None
Status Code Status Code

2
api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst
View File

@ -27,7 +27,7 @@ GET /v3/{project_id}/instances/{instance_id}/tags
| | | | | | | | | |
| | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
| instance_id | Yes | String | Instance ID. | | instance_id | Yes | String | DB instance ID. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters .. table:: **Table 2** Query parameters

24
api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst
View File

@ -8,7 +8,7 @@ Obtaining Information About a Task with a Specified ID
Function 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 <gaussdb_03_0001>` it. - Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
- Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`. - Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
@ -22,7 +22,7 @@ Constraints
URI URI
--- ---
GET /v3/{project_id}/jobs GET /v3/{project_id}/jobs?id={id}
.. table:: **Table 1** URI parameters .. 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. | | 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. | | 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 <showgaussmysqljobinfo__response_getjobinstanceinfodetail>` object | Instance information of the task with the specified ID. | | instance | :ref:`GetJobInstanceInfoDetail <showgaussmysqljobinfo__response_getjobinstanceinfodetail>` object | DB instance information of the task with the specified ID. |
+-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| entities | Object | Displayed information varies depending on tasks. | | entities | Object | Displayed information varies depending on tasks. |
+-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -109,12 +113,12 @@ Response Parameters
.. table:: **Table 6** GetJobInstanceInfoDetail .. table:: **Table 6** GetJobInstanceInfoDetail
========= ====== ============== ========= ====== =================
Parameter Type Description Parameter Type Description
========= ====== ============== ========= ====== =================
id String Instance ID. id String DB instance ID.
name String Instance name. name String DB instance name.
========= ====== ============== ========= ====== =================
**Status code: 400** **Status code: 400**
@ -160,7 +164,7 @@ Success.
{ {
"job" : { "job" : {
"id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "id" : "a9767ede-fe0f-4888-9003-e843a4c90514",
"name" : "CreateMysqlInstance", "name" : "CreateMysqlInstance",
"status" : "Completed", "status" : "Completed",
"created" : "2018-08-06T10:41:14+0800", "created" : "2018-08-06T10:41:14+0800",

4
api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst
View File

@ -56,7 +56,7 @@ Request Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | 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. | | name | Yes | String | Backup name. |
| | | | | | | | | |
@ -108,7 +108,7 @@ Response Parameters
| | | | | | | |
| | | **manual**: manual full backup | | | | **manual**: manual full backup |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_id | String | Instance ID. | | instance_id | String | DB instance ID. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400** **Status code: 400**

4
api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst
View File

@ -109,9 +109,9 @@ Response Parameters
| | | - **COMPLETED**: Modification completed | | | | - **COMPLETED**: Modification completed |
| | | - **FAILED**: Modification failed | | | | - **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** **Status code: 400**

2
api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst
View File

@ -58,7 +58,7 @@ Request Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | 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. | | | | | Instances of the same type can have same names under the same tenant. |
| | | | | | | | | |

8
api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst
View File

@ -67,7 +67,7 @@ Request Parameters
+--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| datastore | Yes | :ref:`MysqlDatastore <gaussdb_11_0004__en-us_topic_0000001226682425_request_mysqldatastore>` object | Database information. | | datastore | Yes | :ref:`MysqlDatastore <gaussdb_11_0004__en-us_topic_0000001226682425_request_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 <gaussdb_11_0002>`. | | flavor_ref | Yes | String | Specification code. For details, see :ref:`Querying Database Specifications <gaussdb_11_0002>`. |
+--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -238,17 +238,17 @@ Response Parameters
+--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | 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. | | 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 (_). | | | | 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 <gaussdb_11_0004__en-us_topic_0000001226682425_response_mysqldatastore>` object | Database information. | | datastore | :ref:`MysqlDatastore <gaussdb_11_0004__en-us_topic_0000001226682425_response_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. | | configuration_id | String | Parameter template ID. |
+--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst
View File

@ -35,7 +35,7 @@ URI
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| 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 Request Parameters

2
api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst
View File

@ -35,7 +35,7 @@ URI
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| 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 Request Parameters

2
api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst
View File

@ -35,7 +35,7 @@ URI
| | | | | | | |
| | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. | | | | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+
| 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. | | node_id | Yes | Read-only node ID, which is compliant with the UUID format. |
+-----------------------+-----------------------+----------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------+

2
api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst
View File

@ -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. | | | | | 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. | | datastore_type | String | No | DB type. Currently, only gaussdb-mysql is supported. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Some files were not shown because too many files have changed in this diff Show More