diff --git a/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst index 65d9be2..139ee48 100644 --- a/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst +++ b/api-ref/source/apis_recommended/backup_management/creating_a_manual_backup.rst @@ -134,9 +134,9 @@ Example Request Creating a Manual Backup -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create { "instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07", "name" : "backup-1", diff --git a/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst index 7f5dd4a..c769ea5 100644 --- a/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst +++ b/api-ref/source/apis_recommended/backup_management/modifying_an_automated_backup_policy.rst @@ -126,9 +126,9 @@ Example Request Modifying a backup policy -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update { "backup_policy" : { "keep_days" : 7, diff --git a/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst index 2b26d81..bb7b55b 100644 --- a/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst +++ b/api-ref/source/apis_recommended/backup_management/querying_an_automated_backup_policy.rst @@ -59,25 +59,23 @@ Response Parameters .. table:: **Table 4** BackupPolicy - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+=====================================================================================================+ - | keep_days | Integer | Backup retention days. Value: **1** to **732** | - | | | | - | | | Minimum value: **1** | - | | | | - | | | Maximum value: **732** | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | - | | | | - | | | The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | period | 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. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | retention_num_backup_level1 | Integer | Number of retained level-1 backups. This parameter is returned when level-1 backup is enabled. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================+ + | keep_days | Integer | Backup retention days. Value: **1** to **732** | + | | | | + | | | Minimum value: **1** | + | | | | + | | | Maximum value: **732** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | start_time | String | Backup time window. Automated backups will be triggered during the backup time window. | + | | | | + | | | The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ + | period | 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. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ **Status code: 400** @@ -106,7 +104,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy Example Response ---------------- @@ -121,9 +119,8 @@ Success. "backup_policy" : { "keep_days" : "7,", "start_time" : "19:00-20:00", - "period" : "1,2", - "retention_num_backup_level1" : 1 - } + "period" : "1,2" + } } Status Code diff --git a/api-ref/source/apis_recommended/backup_management/querying_backups.rst b/api-ref/source/apis_recommended/backup_management/querying_backups.rst index 191feba..39d3658 100644 --- a/api-ref/source/apis_recommended/backup_management/querying_backups.rst +++ b/api-ref/source/apis_recommended/backup_management/querying_backups.rst @@ -184,7 +184,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst index 5bff186..ddd69b2 100644 --- a/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst +++ b/api-ref/source/apis_recommended/database_proxy/adding_database_proxy_nodes.rst @@ -91,9 +91,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge { "node_num" : 2, "proxy_id" : "151c14381ac14ecfb9703a745b992677po01" diff --git a/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst index 19f7995..55b4dc1 100644 --- a/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst +++ b/api-ref/source/apis_recommended/database_proxy/assigning_read_weights.rst @@ -101,9 +101,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight { "master_weight" : 100 } diff --git a/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst index b508ce7..91a7cbd 100644 --- a/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst +++ b/api-ref/source/apis_recommended/database_proxy/changing_specifications_of_a_database_proxy_instance.rst @@ -90,9 +90,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/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" } diff --git a/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst index 50226d6..2ebcd84 100644 --- a/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst +++ b/api-ref/source/apis_recommended/database_proxy/disabling_database_proxy.rst @@ -89,9 +89,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - DELETE https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy { "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ] } diff --git a/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst index 2b7857c..6be5cd8 100644 --- a/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst +++ b/api-ref/source/apis_recommended/database_proxy/enabling_database_proxy.rst @@ -114,9 +114,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/43e4feaab48f11e89039fa163ebaa7e4br01/proxy { "flavor_ref" : "gaussdb.mysql.large.x86.4", "node_num" : 2, diff --git a/api-ref/source/apis_recommended/database_proxy/index.rst b/api-ref/source/apis_recommended/database_proxy/index.rst index d2df1e5..8b9e7d9 100644 --- a/api-ref/source/apis_recommended/database_proxy/index.rst +++ b/api-ref/source/apis_recommended/database_proxy/index.rst @@ -9,7 +9,6 @@ Database Proxy - :ref:`Disabling Database Proxy ` - :ref:`Querying Database Proxy Instances ` - :ref:`Querying Database Proxy Specifications ` -- :ref:`Querying Database Proxy Information ` - :ref:`Adding Database Proxy Nodes ` - :ref:`Changing Specifications of a Database Proxy Instance ` - :ref:`Assigning Read Weights ` @@ -22,7 +21,6 @@ Database Proxy disabling_database_proxy querying_database_proxy_instances querying_database_proxy_specifications - querying_database_proxy_information adding_database_proxy_nodes changing_specifications_of_a_database_proxy_instance assigning_read_weights diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_information.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_information.rst deleted file mode 100644 index 2d00ddb..0000000 --- a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_information.rst +++ /dev/null @@ -1,248 +0,0 @@ -:original_name: ShowGaussMySqlProxy.html - -.. _ShowGaussMySqlProxy: - -Querying Database Proxy Information -=================================== - -Function --------- - -This API is used to query database proxy information. Before using this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. -- Database proxy is unavailable for DB instances in a DeC. - -URI ---- - -GET /v3/{project_id}/instances/{instance_id}/proxy - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token No String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +----------------+---------------------------------------------------------------------------------------+-----------------------------+ - | Parameter | Type | Description | - +================+=======================================================================================+=============================+ - | proxy | :ref:`MysqlProxy ` object | Proxy instance information. | - +----------------+---------------------------------------------------------------------------------------+-----------------------------+ - | master_node | :ref:`MysqlProxyNode ` object | Primary node information. | - +----------------+---------------------------------------------------------------------------------------+-----------------------------+ - | readonly_nodes | Array of :ref:`MysqlProxyNode ` objects | Read replica information. | - +----------------+---------------------------------------------------------------------------------------+-----------------------------+ - -.. _showgaussmysqlproxy__response_mysqlproxy: - -.. table:: **Table 4** MysqlProxy - - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+=========================================================================================+=====================================================================================================================+ - | pool_id | String | Proxy instance ID. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | status | String | Operating status of the proxy instance. | - | | | | - | | | Value: **closed**, **open**, **frozen**, **opening**, **closing**, **enlarging**, **freezing**, and **unfreezing**. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | address | String | Proxy read/write splitting address. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | port | Integer | Proxy port information. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | pool_status | String | Proxy instance status. Value: **ACTIVE**, **BUILD**, **FAILED**, or **DELETED**. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | delay_threshold_in_seconds | Integer | Delay threshold in seconds. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | elb_vip | String | Virtual IP address in ELB mode. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | eip | String | EIP information. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | vcpus | String | Number of vCPUs of the proxy instance. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | ram | String | Memory size of the proxy instance. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | node_num | Integer | Number of proxy nodes. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | mode | String | Primary/standby proxy. The value is **Cluster**. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | nodes | Array of :ref:`MysqlProxyNodes ` objects | Proxy node information. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | flavor_ref | String | Proxy specifications. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | name | String | Proxy instance name. | - +----------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - -.. _showgaussmysqlproxy__response_mysqlproxynodes: - -.. table:: **Table 5** MysqlProxyNodes - - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+======================================================================================================================+ - | id | String | Proxy node ID. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | status | String | Proxy node status. Value: **normal**, **abnormal**, **creating**, or **deleted**. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | name | String | Proxy node name. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | role | String | Role of the proxy node. It can be **master** or **slave**. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | az_code | String | AZ. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | frozen_flag | Integer | Whether the proxy node is frozen. It can be **0** (unfrozen), **1** (frozen), or **2** (deleted after being frozen). | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - -.. _showgaussmysqlproxy__response_mysqlproxynode: - -.. table:: **Table 6** MysqlProxyNode - - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | Parameter | Type | Description | - +=================+=================================================================================================+==========================+ - | id | String | Node ID. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | instance_id | String | Instance ID. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | status | String | Node status. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | name | String | Node name. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | weight | Integer | Read weight of the node. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - | available_zones | Array of :ref:`MysqlProxyAvailable ` objects | AZ information. | - +-----------------+-------------------------------------------------------------------------------------------------+--------------------------+ - -.. _showgaussmysqlproxy__response_mysqlproxyavailable: - -.. table:: **Table 7** MysqlProxyAvailable - - =========== ====== =============== - Parameter Type Description - =========== ====== =============== - code String AZ code. - description String AZ description. - =========== ====== =============== - -**Status code: 400** - -.. table:: **Table 8** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 9** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -.. code-block:: text - - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "proxy" : { - "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01", - "status" : "open", - "address" : "192.168.125.69", - "port" : 3306, - "pool_status" : "ACTIVE", - "delay_threshold_in_seconds" : 30, - "elb_vip" : "192.168.125.60", - "eip" : "192.168.125.50", - "vcpus" : 4, - "ram" : 8, - "node_num" : 2, - "mode" : "Cluster", - "nodes" : { - "id" : "db53a238a02240c49365e72e284a4890pn01", - "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0", - "role" : "master", - "az_code" : "az1xahz", - "status" : "ACTIVE", - "frozen_flag" : 0 - }, - "name" : "proxy-name" - }, - "master_node" : { - "id" : "5ee8010ab992460d8d9cffcc5edabb59no07", - "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", - "status" : "ACTIVE", - "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01", - "weight" : 0, - "available_zones" : { - "code" : "az1xahz", - "description": "AZ1" - } - }, - "readonly_nodes" : { - "id" : "d23535333138462880bfa1838fdfced2no07", - "instance_id" : "7a871d6d494e4327ad2e326afb591108in07", - "status" : "ACTIVE", - "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02", - "weight" : 100, - "available_zones" : { - "code" : "az1xahz", - "description": "AZ1" - } - } - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst index 828bedb..979d11d 100644 --- a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_instances.rst @@ -207,7 +207,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst index d1d897a..b16469a 100644 --- a/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst +++ b/api-ref/source/apis_recommended/database_proxy/querying_database_proxy_specifications.rst @@ -115,7 +115,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy/flavors + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy/flavors Example Response ---------------- diff --git a/api-ref/source/apis_recommended/log_management/enabling_or_disabling_sql_explorer.rst b/api-ref/source/apis_recommended/log_management/enabling_or_disabling_sql_explorer.rst deleted file mode 100644 index 8e2f3f7..0000000 --- a/api-ref/source/apis_recommended/log_management/enabling_or_disabling_sql_explorer.rst +++ /dev/null @@ -1,124 +0,0 @@ -:original_name: UpdateAuditLog.html - -.. _UpdateAuditLog: - -Enabling or Disabling SQL Explorer -================================== - -Function --------- - -This API is used to enable or disable SQL Explorer. Before calling this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -POST /v3/{project_id}/instance/{instance_id}/audit-log/switch - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -.. table:: **Table 3** Request body parameters - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================+ - | switch_status | Yes | String | Whether the audit log function is enabled. It can be either of the following: | - | | | | | - | | | | - ON | - | | | | - OFF | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+--------+--------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================+ - | result | String | Returned results for enabling or disabling the audit log function. | - +-----------+--------+--------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 5** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 6** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -Enabling audit log - -.. code-block:: - - POST https://gaussdb-mysql.br-iaas-odin1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/status - { - "switch_status" : "ON" - } - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "result" : "success" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/log_management/index.rst b/api-ref/source/apis_recommended/log_management/index.rst index c377789..24ddd34 100644 --- a/api-ref/source/apis_recommended/log_management/index.rst +++ b/api-ref/source/apis_recommended/log_management/index.rst @@ -7,8 +7,6 @@ Log Management - :ref:`Querying Database Error Logs ` - :ref:`Querying Database Slow Logs ` -- :ref:`Enabling or Disabling SQL Explorer ` -- :ref:`Querying Whether SQL Explorer Is Enabled ` .. toctree:: :maxdepth: 1 @@ -16,5 +14,3 @@ Log Management querying_database_error_logs querying_database_slow_logs - enabling_or_disabling_sql_explorer - querying_whether_sql_explorer_is_enabled diff --git a/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst index a3b399c..ba5cd11 100644 --- a/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst +++ b/api-ref/source/apis_recommended/log_management/querying_database_error_logs.rst @@ -138,7 +138,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/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=ALL&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst index 81a39f1..9546345 100644 --- a/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst +++ b/api-ref/source/apis_recommended/log_management/querying_database_slow_logs.rst @@ -140,7 +140,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/slowlog?offset=0&limit=1&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07&type=INSERT + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/slowlog?offset=0&limit=1&start_date=2022-07-10T00:00:00+0800&end_date=2022-07-19T00:00:00+0800&node_id=cc07c60e94ec4575989840e648fb4f66no07&type=INSERT Example Response ---------------- diff --git a/api-ref/source/apis_recommended/log_management/querying_whether_sql_explorer_is_enabled.rst b/api-ref/source/apis_recommended/log_management/querying_whether_sql_explorer_is_enabled.rst deleted file mode 100644 index 58c5013..0000000 --- a/api-ref/source/apis_recommended/log_management/querying_whether_sql_explorer_is_enabled.rst +++ /dev/null @@ -1,113 +0,0 @@ -:original_name: ShowAuditLog.html - -.. _ShowAuditLog: - -Querying Whether SQL Explorer Is Enabled -======================================== - -Function --------- - -This API is used to query whether SQL Explorer is enabled. Before calling this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -GET /v3/{project_id}/instance/{instance_id}/audit-log/switch-status - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================+ - | switch_status | String | Whether the audit log function is enabled. It can be either of the following: | - | | | | - | | | - ON | - | | | - OFF | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 4** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 5** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -Querying whether the audit log function is enabled - -.. code-block:: text - - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/switch-status - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "switch_status" : "ON" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst index 131924a..433768c 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_a_db_instance_name.rst @@ -90,9 +90,9 @@ Example Request Changing a DB Instance Name -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name { "name" : "gaussdb-name" } diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst index 8b3d843..d904bf6 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_db_instance_specifications.rst @@ -100,9 +100,9 @@ Example Request Changing instance specifications -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action { "resize_flavor" : { "spec_code" : "taurus.large.4" diff --git a/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst index e9bed53..016eec7 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/changing_the_collection_period_of_monitoring_by_seconds.rst @@ -99,9 +99,9 @@ Example Request Modifying the collection period of Monitoring by Seconds for an instance. The current collection period to 1s. -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy { "monitor_switch" : true, "period" : 1 diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst index 140d56a..7030432 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_a_read_replica.rst @@ -96,9 +96,9 @@ Example Request Creating a read replica -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge { "priorities" : [ 1, 2 ] } diff --git a/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst index 3d4fe47..4323790 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/creating_an_instance.rst @@ -305,7 +305,7 @@ Creating an instance .. code-block:: text - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance1", "region" : "br-iaas-odin1", diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst index d25f354..3012772 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_db_instance.rst @@ -82,7 +82,7 @@ Example Request .. code-block:: text - DELETE https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst index c999e19..dd24974 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/deleting_a_read_replica.rst @@ -84,7 +84,7 @@ Example Request .. code-block:: text - DELETE https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/nodes/096c0fc43e804757b59946b80dc27f8bin07 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/index.rst b/api-ref/source/apis_recommended/managing_db_instances/index.rst index 705f7ef..e7966fb 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/index.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/index.rst @@ -14,8 +14,6 @@ Managing DB Instances - :ref:`Changing a DB Instance Name ` - :ref:`Resetting a Database Password ` - :ref:`Changing DB Instance Specifications ` -- :ref:`Querying Dedicated Resource Pools ` -- :ref:`Querying Dedicated Resources ` - :ref:`Changing the Collection Period of Monitoring by Seconds ` - :ref:`Querying the Collection Period of Monitoring by Seconds ` @@ -32,7 +30,5 @@ Managing DB Instances changing_a_db_instance_name resetting_a_database_password changing_db_instance_specifications - querying_dedicated_resource_pools - querying_dedicated_resources changing_the_collection_period_of_monitoring_by_seconds querying_the_collection_period_of_monitoring_by_seconds diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst deleted file mode 100644 index aae40bf..0000000 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resource_pools.rst +++ /dev/null @@ -1,171 +0,0 @@ -:original_name: ListGaussMySqlDedicatedResources.html - -.. _ListGaussMySqlDedicatedResources: - -Querying Dedicated Resource Pools -================================= - -Function --------- - -This API is used to obtain information about all dedicated resource pools you created. Before calling this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -GET /v3/{project_id}/dedicated-resources - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+=======================================================================================================================================================================================================================================+ - | offset | No | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | Parameter | Type | Description | - +=============+=======================================================================================================================================+======================================+ - | resources | Array of :ref:`DedicatedResource ` objects | Dedicated resource pool information. | - +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | total_count | Integer | Number of dedicated resource pools. | - +-------------+---------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - -.. _listgaussmysqldedicatedresources__en-us_topic_0000001244880767_response_dedicatedresource: - -.. table:: **Table 5** DedicatedResource - - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================================================================================+===================================================+ - | id | String | ID of the dedicated resource pool. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | resource_name | String | Name of the dedicated resource pool. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | engine_name | String | DB engine. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | architecture | String | CPU architecture. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | status | String | Status of the dedicated resource pool. | - | | | | - | | | Valid value: | - | | | | - | | | - **NORMAL** | - | | | - **BUILDING** | - | | | - **EXTENDING** | - | | | - **DELETED** | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | capacity | :ref:`DedicatedResourceCapacity ` object | Capacity of the dedicated resource pool. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | availability_zone | Array of strings | AZ where the dedicated resource pool is deployed. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listgaussmysqldedicatedresources__en-us_topic_0000001244880767_response_dedicatedresourcecapacity: - -.. table:: **Table 6** DedicatedResourceCapacity - - ========= ======= ==================== - Parameter Type Description - ========= ======= ==================== - ram Integer Memory size in GB. - volume Long Disk capacity in GB. - vcpus Integer Number of vCPUs. - ========= ======= ==================== - -**Status code: 400** - -.. table:: **Table 7** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 8** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -.. code-block:: - - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dedicated-resources - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "resources" : [ { - "id" : "1d07f7ba-f140-46a7-b002-58ba22ee6ff3", - "resource_name" : "testdcc", - "engine_name" : "gaussdb-mysql", - "architecture" : "ARM", - "status" : "NORMAL", - "capacity" : { - "ram" : 256, - "volume" : 10000000, - "vcpus" : 64 - }, - "availability_zone" : [ "az1xahz" ] - } ] - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resources.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resources.rst deleted file mode 100644 index 51a9c9c..0000000 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_dedicated_resources.rst +++ /dev/null @@ -1,169 +0,0 @@ -:original_name: ShowDedicatedResourceInfo.html - -.. _ShowDedicatedResourceInfo: - -Querying Dedicated Resources -============================ - -Function --------- - -This API is used to query dedicated resources. Before using this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id} - -.. table:: **Table 1** URI parameters - - +-----------------------+-----------+--------+------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+====================================+ - | project_id | Yes | String | Project ID. | - +-----------------------+-----------+--------+------------------------------------+ - | dedicated_resource_id | Yes | String | ID of the dedicated resource pool. | - +-----------------------+-----------+--------+------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +========================+============================================================================================================================+========================================+ - | id | String | ID of the dedicated resource pool. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | name | String | Name of the dedicated resource pool. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | engine_name | String | Engine name. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | availability_zone_ids | Array of strings | AZ. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | architecture | String | CPU architecture. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | status | String | Status of the dedicated resource pool. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | dedicated_compute_info | :ref:`DedicatedComputeInfo ` object | Compute resource information. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - | dedicated_storage_info | :ref:`DedicatedStorageInfo ` object | Storage resource information. | - +------------------------+----------------------------------------------------------------------------------------------------------------------------+----------------------------------------+ - -.. _showdedicatedresourceinfo__en-us_topic_0000001309882618_response_dedicatedcomputeinfo: - -.. table:: **Table 4** DedicatedComputeInfo - - +-------------+---------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+=====================================================================+ - | vcpus_total | Integer | Total number of vCPUs in the dedicated resource pool. | - +-------------+---------+---------------------------------------------------------------------+ - | vcpus_used | Integer | Number of used vCPUs in the dedicated resource pool. | - +-------------+---------+---------------------------------------------------------------------+ - | ram_total | Integer | Total memory size of the dedicated resource pool, in GB. | - +-------------+---------+---------------------------------------------------------------------+ - | ram_used | Integer | Used memory size of the dedicated resource pool, in GB. | - +-------------+---------+---------------------------------------------------------------------+ - | spec_code | String | Compute resource specification code of the dedicated resource pool. | - +-------------+---------+---------------------------------------------------------------------+ - | host_num | Integer | Number of compute hosts in the dedicated resource pool. | - +-------------+---------+---------------------------------------------------------------------+ - -.. _showdedicatedresourceinfo__en-us_topic_0000001309882618_response_dedicatedstorageinfo: - -.. table:: **Table 5** DedicatedStorageInfo - - +-----------+---------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+=====================================================================+ - | spec_code | String | Storage resource specification code of the dedicated resource pool. | - +-----------+---------+---------------------------------------------------------------------+ - | host_num | Integer | Number of storage hosts in the dedicated resource pool. | - +-----------+---------+---------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 6** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 7** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -.. code-block:: text - - GET https://{Endpoint}/v3/058497e1c100d3eb2f3cc01160616934/dedicated-resource/6e097c33-d6b9-4ca5-83cb-6cc79dcf4f06 - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "id" : "e097c33-d6b9-4ca5-83cb-6cc79dcf4f06", - "name" : "test_dcc", - "engine_name" : "taurus", - "availability_zone_ids" : [ "az1xahz", "az2xahz" ], - "architecture" : "ARM", - "status" : "normal", - "dedicated_compute_info" : { - "vcpus_total" : 128, - "vcpus_used" : 64, - "ram_total" : 512, - "ram_used" : 256, - "spec_code" : "gaussdb.mysql.c6.host", - "host_num" : 1 - }, - "dedicated_storage_info" : { - "spec_code" : "gaussdb.mysql.dfvpool.30tb.host", - "host_num" : 1 - } - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst index 3ca1d8e..5549be4 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_details_of_a_db_instance.rst @@ -302,7 +302,7 @@ Querying instance details .. code-block:: text - GET https://{Endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst index b549945..994ed44 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_instances.rst @@ -232,7 +232,7 @@ Querying instances .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst index 599ae01..26c3e9d 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/querying_the_collection_period_of_monitoring_by_seconds.rst @@ -89,7 +89,7 @@ Querying the collection period of Monitoring by Seconds for an instance .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy Example Response ---------------- diff --git a/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst index 8be3b0e..1866d4a 100644 --- a/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst +++ b/api-ref/source/apis_recommended/managing_db_instances/resetting_a_database_password.rst @@ -80,9 +80,9 @@ Example Request Resetting a database password -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password { "password" : "Test_345612" } diff --git a/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst b/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst index 7ef44b7..c9b080c 100644 --- a/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst +++ b/api-ref/source/apis_recommended/parameter_template_management/querying_parameter_templates.rst @@ -123,7 +123,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/configurations Example Response ---------------- diff --git a/api-ref/source/apis_recommended/querying_database_specifications.rst b/api-ref/source/apis_recommended/querying_database_specifications.rst index cc3d6b0..f19d1e6 100644 --- a/api-ref/source/apis_recommended/querying_database_specifications.rst +++ b/api-ref/source/apis_recommended/querying_database_specifications.rst @@ -124,7 +124,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single Example Response ---------------- diff --git a/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst b/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst index 4fb5441..551cfa5 100644 --- a/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst +++ b/api-ref/source/apis_recommended/querying_version_information_about_a_db_engine.rst @@ -94,7 +94,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql Example Response ---------------- diff --git a/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst index 92b90af..6b46481 100644 --- a/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst +++ b/api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst @@ -93,9 +93,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas { "quota_list" : [ { "enterprise_project_id" : "0", diff --git a/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst index 49f7be2..6e8dcc6 100644 --- a/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst +++ b/api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst @@ -115,9 +115,9 @@ Response Parameters Example Request --------------- -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas { "quota_list" : [ { "enterprise_project_id" : "0", diff --git a/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst b/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst index 79b1b44..626c043 100644 --- a/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst +++ b/api-ref/source/apis_recommended/quota_management/querying_resource_quotas.rst @@ -111,7 +111,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas Example Response ---------------- diff --git a/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst b/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst index b876173..72e42cd 100644 --- a/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst +++ b/api-ref/source/apis_recommended/quota_management/querying_the_instance_quotas_of_a_tenant.rst @@ -122,7 +122,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance Example Response ---------------- diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst index 5b41ff1..3a44061 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/configuring_concurrency_control_rules_of_sql_statements.rst @@ -132,9 +132,9 @@ Example Request Configuring concurrency control rules of SQL statements -.. code-block:: +.. code-block:: text - PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules { "sql_filter_rules" : [ { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst index 1ab783a..884cf79 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/deleting_concurrency_control_rules_of_sql_statements.rst @@ -120,9 +120,9 @@ Example Request Deleting concurrency control rules of SQL statements -.. code-block:: +.. code-block:: text - DELETE https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules { "sql_filter_rules" : [ { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/enabling_or_disabling_sql_statement_concurrency_control.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/enabling_or_disabling_sql_statement_concurrency_control.rst deleted file mode 100644 index 196fe94..0000000 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/enabling_or_disabling_sql_statement_concurrency_control.rst +++ /dev/null @@ -1,133 +0,0 @@ -:original_name: UpdateSqlFilterControl.html - -.. _UpdateSqlFilterControl: - -Enabling or Disabling SQL Statement Concurrency Control -======================================================= - -Function --------- - -This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -POST /v3/{project_id}/instances/{instance_id}/sql-filter/switch - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - X-Auth-Token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -.. table:: **Table 3** Request body parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================+ - | switch_status | Yes | String | Whether SQL Statement Concurrency Control is enabled. It can be either of the following: | - | | | | | - | | | | - ON | - | | | | - OFF | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+--------+-----------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=============================================================================+ - | job_id | String | ID of the task for enabling or disabling SQL Statement Concurrency Control. | - +-----------+--------+-----------------------------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 5** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 6** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -- Enabling SQL Statement Concurrency Control - - .. code-block:: - - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch - { - "switch_status" : "ON" - } - -- Disabling SQL Statement Concurrency Control - - .. code-block:: - - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch - { - "switch_status" : "OFF" - } - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst index 3d1e191..a6f0a54 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/index.rst @@ -5,8 +5,6 @@ SQL Statement Concurrency Control ================================= -- :ref:`Enabling or Disabling SQL Statement Concurrency Control ` -- :ref:`Querying Whether SQL Statement Concurrency Control Is Enabled ` - :ref:`Configuring Concurrency Control Rules of SQL Statements ` - :ref:`Querying Concurrency Control Rules of SQL Statements ` - :ref:`Deleting Concurrency Control Rules of SQL Statements ` @@ -15,8 +13,6 @@ SQL Statement Concurrency Control :maxdepth: 1 :hidden: - enabling_or_disabling_sql_statement_concurrency_control - querying_whether_sql_statement_concurrency_control_is_enabled configuring_concurrency_control_rules_of_sql_statements querying_concurrency_control_rules_of_sql_statements deleting_concurrency_control_rules_of_sql_statements diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst index e341882..9625c53 100644 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst +++ b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_concurrency_control_rules_of_sql_statements.rst @@ -125,7 +125,7 @@ Querying concurrency control rules of SQL statements .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst b/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst deleted file mode 100644 index 269b893..0000000 --- a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_whether_sql_statement_concurrency_control_is_enabled.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: ShowSqlFilterControl.html - -.. _ShowSqlFilterControl: - -Querying Whether SQL Statement Concurrency Control Is Enabled -============================================================= - -Function --------- - -This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API: - -- Learn how to :ref:`authorize and authenticate ` it. -- Obtain the required :ref:`region and endpoint `. - -URI ---- - -GET /v3/{project_id}/instances/{instance_id}/sql-filter/switch - -.. table:: **Table 1** URI parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================+ - | project_id | Yes | String | Project ID of a tenant in a region. | - | | | | | - | | | | To obtain this value, see :ref:`Obtaining a Project ID `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - x-auth-token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-----------------------+-------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================+ - | switch_status | String | Whether SQL Statement Concurrency Control is enabled. | - | | | | - | | | Valid value: | - | | | | - | | | - **ON**: enabled | - | | | - **OFF:** disabled | - +-----------------------+-----------------------+-------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 4** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 5** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -Querying whether SQL Statement Concurrency Control is enabled - -.. code-block:: text - - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "switch_status" : "ON" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst index ae0ca19..6185d3a 100644 --- a/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst +++ b/api-ref/source/apis_recommended/tag_management/adding_or_deleting_tags_in_batches.rst @@ -100,9 +100,9 @@ Example Request - Adding tags - .. code-block:: + .. code-block:: text - POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action { "action" : "create", "tags" : [ { @@ -116,9 +116,9 @@ Example Request - Deleting tags - .. code-block:: + .. code-block:: text - POST https://gaussdb-mysql.br-iaas-odin1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action { "action" : "delete", "tags" : [ { diff --git a/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst b/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst index 210781a..56dd91b 100644 --- a/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst +++ b/api-ref/source/apis_recommended/tag_management/querying_project_tags.rst @@ -105,7 +105,7 @@ Querying tags in a specified project .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst index b36e58d..d9bb0c0 100644 --- a/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst +++ b/api-ref/source/apis_recommended/tag_management/querying_resource_tags.rst @@ -107,7 +107,7 @@ Querying resource tags .. code-block:: text - GET https://gaussdb-mysql.br-iaas-odin1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2 Example Response ---------------- diff --git a/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst index d00bb6a..47e413e 100644 --- a/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst +++ b/api-ref/source/apis_recommended/task_center/obtaining_information_about_a_task_with_a_specified_id.rst @@ -143,7 +143,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst index a06d86a..7dc3232 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/creating_a_manual_backup.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/backups/create + POST https://{endpoint}/mysql/v3/{project_id}/backups/create - Example - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create - Parameter description @@ -140,8 +140,7 @@ Creating a Manual Backup .. code-block:: text - POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "name": "backup-1", diff --git a/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst index 94afc0b..7aa0397 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/modifying_the_backup_policy.rst @@ -18,11 +18,11 @@ URI - URI format - PUT https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update + PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update - Example - PUT https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy/update - Parameter description @@ -143,8 +143,7 @@ Modifying the backup policy .. code-block:: text - POST https://{Endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update { "backup_policy" : { "keep_days" : 7, diff --git a/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst b/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst index 2e611c8..bb64c8d 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/querying_an_automated_backup_policy.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy + GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/backups/policy - Example - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/backups/policy - Parameter description @@ -109,7 +109,7 @@ Example Request .. code-block:: - get https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy + get https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst b/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst index ef36b66..95c0b76 100644 --- a/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst +++ b/api-ref/source/apis_unavailable_soon/backup_management/querying_backups.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin \_time}&end_time={end_time} + GET https://{endpoint}/mysql/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin \_time}&end_time={end_time} - Example - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800 - Parameter description @@ -174,7 +174,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=ba62a0b83a1b42bfab275829d86ac0fdin07&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0200&end_time=2020-07-16T10:41:14+0200 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=ba62a0b83a1b42bfab275829d86ac0fdin07&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0200&end_time=2020-07-16T10:41:14+0200 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst index 409a520..6f743d0 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/changing_a_db_instance_name.rst @@ -18,11 +18,11 @@ URI - URI format - PUT https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/name + PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name - Example - PUT https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name - Parameter description @@ -107,8 +107,7 @@ Changing a DB Instance Name .. code-block:: text - POST https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name { "name" : "gaussdb-name" } diff --git a/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst b/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst index 0aea99a..eebfc69 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/changing_db_instance_specifications.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/action + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/action - Example - POST https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action + POST https://gaussdb-mysql.eu-de.otc.t-systems.commysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/action - Parameter description @@ -115,8 +115,7 @@ Changing instance specifications .. code-block:: text - POST https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action { "resize_flavor" : { "spec_code" : "taurus.large.4" diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst index 943bf29..74d7ab8 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/instances + POST https://{endpoint}/mysql/v3/{project_id}/instances - Example - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances - Parameter description @@ -354,8 +354,7 @@ Creating a DB instance .. code-block:: text - POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name" : "gaussdb-mysql-instance1", "region" : "cn-cmcc1", diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst index 4c18fad..eb146fe 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_read_replica.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge - Example - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/enlarge - Parameter description @@ -111,8 +111,7 @@ Creating a read replica .. code-block:: text - POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge { "priorities" : [ 1, 2 ] } diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst index a97e735..843855a 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_db_instance.rst @@ -18,11 +18,11 @@ URI - URI format - DELETE https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id} + DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id} - Example - DELETE https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 - Parameter description @@ -93,7 +93,7 @@ Example Request .. code-block:: text - DELETE https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst index 050de0a..a3ff11c 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/deleting_a_read_replica.rst @@ -18,11 +18,11 @@ URI - URI format - DELETE https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} + DELETE https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} - Example - DELETE https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/nodes/d11ae66fsfdsaer3w3ino9 - Parameter description @@ -95,7 +95,7 @@ Example Request .. code-block:: text - DELETE https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01/nodes/ss62c18799854a919bab633874c159dfin55 + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/3d39c18788b54a919bab633874c159dfin01/nodes/ss62c18799854a919bab633874c159dfin55 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst index 9850cd0..7688d9a 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/querying_db_instances.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} + GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} - Example - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 - Parameter description @@ -256,7 +256,7 @@ Querying DB Instances .. code-block:: text - GET https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 Example Response ---------------- @@ -281,7 +281,7 @@ Success. "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "db_user_name" : "root", - "region" : "cn-cmcc1""cn-north-4", + "region" : "br-iaas-odin1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" diff --git a/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst index 90afc75..f7dbd86 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/querying_details_of_a_db_instance.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id} + GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id} - Example - GET https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07 - Parameter description @@ -274,7 +274,7 @@ Querying details of a DB instance .. code-block:: text - GET https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst b/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst index b24685a..f1188db 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/resetting_a_database_password.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}/password + POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/password - Example - POST https://{*Endpoint*}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/password - Parameter description @@ -99,7 +99,7 @@ Resetting a database password .. code-block:: text - POST https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/password { "password" : "Test_345612" } diff --git a/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst b/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst index e4b5dbc..8a69f4f 100644 --- a/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst +++ b/api-ref/source/apis_unavailable_soon/obtaining_information_about_a_task_with_a_specified_id.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/jobs?id={id} + GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id} - Example - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 - Parameter description @@ -191,7 +191,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514 Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst b/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst index 9021590..71a4b1c 100644 --- a/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst +++ b/api-ref/source/apis_unavailable_soon/parameter_template_management/querying_parameter_templates.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{*project_id*}/configurations?offset={offset}&limit={limit} + GET https://{endpoint}/mysql/v3/{*project_id*}/configurations?offset={offset}&limit={limit} - Example - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations?offset=0&limit=100 + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations?offset=0&limit=100 - Parameter description @@ -128,7 +128,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/configurations Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst index 594f6ec..92d5b52 100644 --- a/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst +++ b/api-ref/source/apis_unavailable_soon/querying_database_specifications.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode} + GET https://{endpoint}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode} - Example - GET https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql - Parameter description @@ -133,8 +133,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql - GET https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst b/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst index d93e81b..555133c 100644 --- a/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst +++ b/api-ref/source/apis_unavailable_soon/querying_version_information_about_a_db_engine.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/datastores/{database_name} + GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name} - Example - GET https://{*Endpoint*}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql - Parameter description @@ -105,7 +105,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql Example Response ---------------- diff --git a/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst index 6e3d600..c1aebdf 100644 --- a/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst +++ b/api-ref/source/apis_unavailable_soon/quota_management/configuring_enterprise_project_resource_quotas_of_a_tenant.rst @@ -18,11 +18,11 @@ URI - URI format - POST https://{*Endpoint*}/mysql/v3/{project_id}/quotas + POST https://{endpoint}/mysql/v3/{project_id}/quotas - Example - POST https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas - Parameter description diff --git a/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst index 00bcd50..992085f 100644 --- a/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst +++ b/api-ref/source/apis_unavailable_soon/quota_management/modifying_enterprise_project_resource_quotas_of_a_tenant.rst @@ -18,11 +18,11 @@ URI - URI format - PUT https://{*Endpoint*}/mysql/v3/{project_id}/quotas + PUT https://{endpoint}/mysql/v3/{project_id}/quotas - Example - PUT https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas + PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas - Parameter description @@ -128,8 +128,7 @@ Example Request .. code-block:: text - POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas - + POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas { "quota_list" : [ { "enterprise_project_id" : "0", diff --git a/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst b/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst index af40c8b..82e8e24 100644 --- a/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst +++ b/api-ref/source/apis_unavailable_soon/quota_management/querying_enterprise_project_resource_quotas_of_a_tenant.rst @@ -18,11 +18,11 @@ URI - URI format - GET https://{*Endpoint*}/mysql/v3/{project_id}/quotas + GET https://{endpoint}/mysql/v3/{project_id}/quotas - Example - GET https://{*Endpoint*}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas - Parameter description @@ -116,7 +116,7 @@ Example Request .. code-block:: text - GET https://{Endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas + GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/quotas Example Response ---------------- diff --git a/api-ref/source/before_you_start/endpoints.rst b/api-ref/source/before_you_start/endpoints.rst index 6084bd2..e8b9513 100644 --- a/api-ref/source/before_you_start/endpoints.rst +++ b/api-ref/source/before_you_start/endpoints.rst @@ -6,5 +6,3 @@ Endpoints ========= An endpoint is the **request address** for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see `Regions and Endpoints `__. - -GaussDB(for MySQL) endpoint: https://gaussdb-mysql{{url}}/v3/{{project_id}} diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 8ef7a6d..b5ea5b0 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -13,7 +13,6 @@ Change History | | - Added :ref:`Querying Database Proxy Specifications `. | | | - Added :ref:`Enabling Database Proxy `. | | | - Added :ref:`Disabling Database Proxy `. | -| | - Added :ref:`Querying Database Proxy Information `. | | | - Added :ref:`Adding Database Proxy Nodes `. | | | - Added :ref:`Querying Database Proxy Instances `. | | | - Added :ref:`Changing Specifications of a Database Proxy Instance `. |