This API is used to delete concurrency control rules of SQL statements. Before calling this API:
+DELETE /v3/{project_id}/instances/{instance_id}/sql-filter/rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. +To obtain this value, see Obtaining a Project ID. + |
+
instance_id + |
+Yes + |
+String + |
+Instance ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
sql_filter_rules + |
+Yes + |
+Array of DeleteNodeSqlFilterRuleInfo objects + |
+Concurrency control rules of SQL statements for nodes. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
node_id + |
+Yes + |
+String + |
+Node ID. + |
+
rules + |
+Yes + |
+Array of DeleteNodeSqlFilterRule objects + |
+Concurrency control rules of SQL statements. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+ID of the task for deleting concurrency control rules of SQL statements. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Deleting concurrency control rules of SQL statements
+
+DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
+{
+ "sql_filter_rules" : [ {
+ "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+ "rules" : [ {
+ "sql_type" : "SELECT",
+ "patterns" : [ "select~from~t1", "select~from~t2" ]
+ }, {
+ "sql_type" : "UPDATE",
+ "patterns" : [ "udpate~t3~where~id" ]
+ } ]
+ }, {
+ "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07",
+ "rules" : [ {
+ "sql_type" : "SELECT",
+ "patterns" : [ "select~from~t1", "select~from~t2" ]
+ }, {
+ "sql_type" : "DELETE",
+ "patterns" : [ "delete~t3~where~id" ]
+ } ]
+ } ]
+}
+Status code: 200
+Success.
+{
+ "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+For details, see Status Codes.
+For details, see Error Codes.
+This API is used to configure concurrency control rules of SQL statements. Before calling this API:
+PUT /v3/{project_id}/instances/{instance_id}/sql-filter/rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. +To obtain this value, see Obtaining a Project ID. + |
+
instance_id + |
+Yes + |
+String + |
+DB instance ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
sql_filter_rules + |
+Yes + |
+Array of NodeSqlFilterRuleInfo objects + |
+Concurrency control rules of SQL statements for nodes. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
node_id + |
+Yes + |
+String + |
+Node ID. + |
+
rules + |
+Yes + |
+Array of NodeSqlFilterRule objects + |
+Concurrency control rules of SQL statements. The sql_type value must be unique. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
sql_type + |
+Yes + |
+String + |
+SQL statement type. +Valid value: +
|
+
patterns + |
+Yes + |
+Array of NodeSqlFilterRulePattern objects + |
+Concurrency control rules of SQL statements. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
pattern + |
+Yes + |
+String + |
+A concurrency control rule of SQL statements. A rule can consist of up to 128 keywords. The keywords are separated by tildes (~), for example, select~from~t1. The rule cannot contain backslashes (\), commas (,), or double tildes (~~). It cannot end with tildes (~). + |
+
max_concurrency + |
+Yes + |
+Integer + |
+Maximum number of concurrent SQL statements. Value: a non-negative integer. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+ID of the task for configuring concurrency control rules of SQL statements. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Configuring concurrency control rules of SQL statements
+
+PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules
+{
+ "sql_filter_rules" : [ {
+ "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+ "rules" : [ {
+ "sql_type" : "SELECT",
+ "patterns" : [ {
+ "pattern" : "select~from~t1",
+ "max_concurrency" : 0
+ }, {
+ "pattern" : "select~from~t3~where~id",
+ "max_concurrency" : 10
+ } ]
+ }, {
+ "sql_type" : "UPDATE",
+ "patterns" : [ {
+ "pattern" : "update~t3~where~id",
+ "max_concurrency" : 10
+ } ]
+ } ]
+ }, {
+ "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07",
+ "rules" : [ {
+ "sql_type" : "SELECT",
+ "patterns" : [ {
+ "pattern" : "select~from~t3~where~id",
+ "max_concurrency" : 10
+ } ]
+ }, {
+ "sql_type" : "DELETE",
+ "patterns" : [ {
+ "pattern" : "delete~t3~where~id",
+ "max_concurrency" : 10
+ } ]
+ } ]
+ } ]
+}
+Status code: 200
+Success.
+{
+ "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+For details, see Status Codes.
+For details, see Error Codes.
+This API is used to query whether SQL Statement Concurrency Control is enabled. Before calling this API:
+GET /v3/{project_id}/instances/{instance_id}/sql-filter/switch
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. +To obtain this value, see Obtaining a Project ID. + |
+
instance_id + |
+Yes + |
+String + |
+Instance ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
x-auth-token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
switch_status + |
+String + |
+Whether SQL Statement Concurrency Control is enabled. +Value: +
|
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Querying whether SQL Statement Concurrency Control is enabled
+GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch+
Status code: 200
+Success.
+{
+ "switch_status" : "ON"
+}
+For details, see Status Codes.
+For details, see Error Codes.
+This API is used to query concurrency control rules of SQL statements. Before calling this API:
+GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules?node_id={node_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. +To obtain this value, see Obtaining a Project ID. + |
+
instance_id + |
+Yes + |
+String + |
+DB instance ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
node_id + |
+Yes + |
+String + |
+Node ID. + |
+
type + |
+No + |
+String + |
+SQL statement type. The value can be SELECT, UPDATE, and DELETE (case-insensitive). If this parameter is not specified, concurrency control rules of all types of statements are queried. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
node_id + |
+String + |
+Node ID. + |
+
sql_filter_rules + |
+Array of SqlFilterRule objects + |
+Concurrency control rules of SQL statements. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
sql_type + |
+String + |
+SQL statement type. +Valid value: +
|
+
patterns + |
+Array of SqlFilterRulePattern objects + |
+Concurrency control rules of SQL statements. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
pattern + |
+String + |
+A concurrency control rule of SQL statements. + |
+
max_concurrency + |
+Integer + |
+Maximum number of concurrent SQL statements. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Querying concurrency control rules of SQL statements
+GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07+
Status code: 200
+Success.
+{
+ "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
+ "sql_filter_rules" : [ {
+ "sql_type" : "SELECT",
+ "patterns" : [ {
+ "pattern" : "select~from~t1",
+ "max_concurrency" : 0
+ }, {
+ "pattern" : "select~from~t2~where~id",
+ "max_concurrency" : 10
+ } ]
+ }, {
+ "sql_type" : "UDPATE",
+ "patterns" : [ {
+ "pattern" : "update~t1",
+ "max_concurrency" : 0
+ }, {
+ "pattern" : "update~t2~where~id",
+ "max_concurrency" : 10
+ } ]
+ }, {
+ "sql_type" : "DELETE",
+ "patterns" : [ {
+ "pattern" : "delete~from",
+ "max_concurrency" : 0
+ } ]
+ } ]
+}
+For details, see Status Codes.
+For details, see Error Codes.
+This API is used to change the database port of a DB instance. Before calling this API:
+PUT /v3/{project_id}/instances/{instance_id}/port
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. + |
+
instance_id + |
+Yes + |
+String + |
+Instance ID of a tenant in a project. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
port + |
+Yes + |
+Integer + |
+Port number. +Value range: 1024 to 65535, excluding 5342 to 5345, 12017, 20000, 20201, 20202, and 33062. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Task ID. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/port
+
+{
+ "port" : 8836
+}
+Status code: 200
+Success.
+{
+ "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
+}
+For details, see Status Codes.
+For details, see Error Codes.
+This API is used to enable or disable SQL Statement Concurrency Control. Before calling this API:
+POST /v3/{project_id}/instances/{instance_id}/sql-filter/switch
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID of a tenant in a region. +To obtain this value, see Obtaining a Project ID. + |
+
instance_id + |
+Yes + |
+String + |
+Instance ID. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+User token. + |
+
X-Language + |
+No + |
+String + |
+Language. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
switch_status + |
+Yes + |
+String + |
+Whether SQL Statement Concurrency Control is enabled. Value: +
|
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+ID of the task for enabling or disabling SQL Statement Concurrency Control. + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
error_code + |
+String + |
+Error code. + |
+
error_msg + |
+String + |
+Error message. + |
+
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
+{
+ "switch_status" : "ON"
+}
+POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
+{
+ "switch_status" : "OFF"
+}
+Status code: 200
+Success.
+{
+ "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
+}
+For details, see Status Codes.
+For details, see Error Codes.
+2024-02-28
+2024-04-15
+Added the following content:
+ +2024-02-28
Modified the following content:
Added precautions in Configuring Resource Quotas and Modifying Resource Quotas.
diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html index afd61492..b107aa07 100644 --- a/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0000.html @@ -22,6 +22,8 @@+