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 165a93d..b2646c4 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 @@ -94,7 +94,7 @@ Example Request PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor { - "flavor_ref" :gaussdb.proxy.xlarge.x86.2 + "flavor_ref" :"gaussdb.proxy.xlarge.x86.2" } Example Response 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 72cb569..c27ddbd 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 @@ -38,7 +38,7 @@ Request Parameters ============ ========= ====== =========== Parameter Mandatory Type Description ============ ========= ====== =========== - X-Auth-Token No String User token. + X-Auth-Token Yes String User token. X-Language No String Language. ============ ========= ====== =========== @@ -100,12 +100,12 @@ Example Request Changing instance specifications -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action { "resize_flavor" : { - "spec_code" : "taurus.large.4" + "spec_code" : "gaussdb.mysql.xlarge.arm.8" } } 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 c6eddbf..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,7 +5,6 @@ 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 ` @@ -14,7 +13,6 @@ SQL Statement Concurrency Control :maxdepth: 1 :hidden: - querying_whether_sql_statement_concurrency_control_is_enabled configuring_concurrency_control_rules_of_sql_statements querying_concurrency_control_rules_of_sql_statements deleting_concurrency_control_rules_of_sql_statements diff --git a/api-ref/source/apis_recommended/sql_statement_concurrency_control/querying_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 e96366e..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 | DB instance ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request header parameters - - ============ ========= ====== =========== - Parameter Mandatory Type Description - ============ ========= ====== =========== - x-auth-token Yes String User token. - X-Language No String Language. - ============ ========= ====== =========== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-----------------------+-------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================+ - | switch_status | String | Whether SQL Statement Concurrency Control is enabled. | - | | | | - | | | Valid value: | - | | | | - | | | - **ON**: enabled | - | | | - **OFF:** disabled | - +-----------------------+-----------------------+-------------------------------------------------------+ - -**Status code: 400** - -.. table:: **Table 4** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -**Status code: 500** - -.. table:: **Table 5** Response body parameters - - ========== ====== ============== - Parameter Type Description - ========== ====== ============== - error_code String Error code. - error_msg String Error message. - ========== ====== ============== - -Example Request ---------------- - -Querying whether SQL Statement Concurrency Control is enabled - -.. code-block:: text - - GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch - -Example Response ----------------- - -**Status code: 200** - -Success. - -.. code-block:: - - { - "switch_status" : "ON" - } - -Status Code ------------ - -For details, see :ref:`Status Codes `. - -Error Code ----------- - -For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst index ee3740c..b3dc44f 100644 --- a/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst +++ b/api-ref/source/apis_unavailable_soon/instance_management/creating_a_db_instance.rst @@ -67,7 +67,7 @@ Request Parameters +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | Yes | :ref:`MysqlDatastore ` object | Database information. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | Yes | String | DB instance type, which is case-insensitive. Its value is **Cluster**. | + | mode | Yes | String | DB instance type, which is case-insensitive. Currently, only the cluster type is supported. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | flavor_ref | Yes | String | Specification code. For details, see :ref:`Querying Database Specifications `. | +--------------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -238,17 +238,17 @@ Response Parameters +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +==========================+================================================================================================================+===============================================================================================================================================================+ - | id | String | DB instance ID. | + | id | String | Instance ID. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | DB instance name. Instances of the same type can have same names under the same tenant. | | | | | | | | The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | DB instance status. Value: **creating**. | + | status | String | Instance status. Value: **creating**. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | datastore | :ref:`MysqlDatastore ` object | Database information. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mode | String | DB instance type. Currently, Its value is **Cluster**. | + | mode | String | DB instance type. Currently, only the cluster type is supported. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | configuration_id | String | Parameter template ID. | +--------------------------+----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -352,12 +352,13 @@ Example Request Creating a DB instance -.. code-block:: text +.. code-block:: POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances + { "name" : "gaussdb-mysql-instance1", - "region" : "cn-cmcc1", + "region" : "xxxx", "charge_info" : { "charge_mode" : "postPaid" }, @@ -366,12 +367,12 @@ Creating a DB instance "version" : "8.0" }, "mode" : "Cluster", - "flavor_ref" : "taurus.large.4", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", - "password" : "Hu2wei@13", + "password" : "xxxxx", "backup_strategy" : { "start_time" : "08:00-09:00" }, @@ -397,7 +398,7 @@ Success. "instance" : { "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", "name" : "gaussdb-mysql-instance1", - "region" : "cn-cmcc1", + "region" : "xxxx", "charge_info" : { "charge_mode" : "postPaid" }, @@ -406,7 +407,7 @@ Success. "version" : "8.0" }, "mode" : "Cluster", - "flavor_ref" : "taurus.large.4", + "flavor_ref" : "gaussdb.mysql.xlarge.arm.8", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a5da4ab..490dc68 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -10,11 +10,29 @@ Change History +===================================+===========================================================================================================================+ | 2023-04-06 | Modified the following content: | | | | -| | - Deleted the parameter **backup_level** in :ref:`Querying Backups `. | -| | - Deleted the parameter **retention_num_backup_level1** in :ref:`Querying an Automated Backup Policy `. | +| | - Deleted the **backup_level** parameter in :ref:`Querying Backups `. | +| | - Deleted the **retention_num_backup_level1** parameter in :ref:`Querying an Automated Backup Policy `. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | 2022-11-30 | Modified the following content: | | | | +| | - Added :ref:`Querying Version Information About a DB Engine `. | +| | - Added :ref:`Querying Database Specifications `. | +| | - Added :ref:`Deleting a DB Instance `. | +| | - Added :ref:`Querying Details of a DB Instance `. | +| | - Added :ref:`Creating a Read Replica `. | +| | - Added :ref:`Deleting a Read Replica `. | +| | - Added :ref:`Changing a DB Instance Name `. | +| | - Added :ref:`Resetting a Database Password `. | +| | - Added :ref:`Changing DB Instance Specifications `. | +| | - Added :ref:`Creating a Manual Backup `. | +| | - Added :ref:`Querying Backups `. | +| | - Added :ref:`Querying an Automated Backup Policy `. | +| | - Added :ref:`Modifying an Automated Backup Policy `. | +| | - Added :ref:`Querying Parameter Templates `. | +| | - Added :ref:`Querying Resource Quotas `. | +| | - Added :ref:`Configuring Resource Quotas `. | +| | - Added :ref:`Modifying Resource Quotas `. | +| | - Added :ref:`Querying the DB Instance Quotas of a Tenant `. | | | - Added :ref:`Querying Database Proxy Specifications `. | | | - Added :ref:`Enabling Database Proxy `. | | | - Added :ref:`Disabling Database Proxy `. | @@ -22,12 +40,21 @@ Change History | | - Added :ref:`Querying Database Proxy Instances `. | | | - Added :ref:`Changing Specifications of a Database Proxy Instance `. | | | - Added :ref:`Assigning Read Weights `. | +| | - Added :ref:`Querying Database Error Logs `. | +| | - Added :ref:`Querying Database Slow Logs `. | +| | - Added :ref:`Querying Resource Tags `. | +| | - Added :ref:`Querying Project Tags `. | +| | - Added :ref:`Adding or Deleting Tags in Batches `. | +| | - Added :ref:`Configuring Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Querying Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Deleting Concurrency Control Rules of SQL Statements `. | +| | - Added :ref:`Obtaining Information About a Task with a Specified ID `. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | 2020-12-09 | Modified the following content: | | | | | | Optimized the content for API usage. | | | | -| | Modified the **spec_code description** in :ref:`Querying Database Specifications `. | +| | Modified the **spec_code description** parameter in :ref:`Querying Database Specifications `. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | 2020-05-30 | This issue is the first official release. | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------+