Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ SQL Statement Concurrency Control/ Querying Concurrency Control Rules of SQL Statements
Updated on 2023-10-18 GMT+08:00

Querying Concurrency Control Rules of SQL Statements

Function

This API is used to query concurrency control rules of SQL statements. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules

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 Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

node_id

Yes

String

Node ID.

sql_type

No

String

SQL statement type. The value is case-insensitive. If this parameter is not specified, concurrency control rules of all types of statements are queried.

Value:

  • SELECT
  • UPDATE
  • DELETE

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

node_id

String

Node ID.

sql_filter_rules

Array of SqlFilterRule objects

Concurrency control rules of SQL statements.

Table 5 SqlFilterRule

Parameter

Type

Description

sql_type

String

SQL statement type.

Value:

  • SELECT
  • UPDATE
  • DELETE

patterns

Array of SqlFilterRulePattern objects

Concurrency control rules of SQL statements.

Table 6 SqlFilterRulePattern

Parameter

Type

Description

pattern

String

A concurrency control rule of SQL statements.

max_concurrency

Integer

Maximum number of concurrent SQL statements.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying concurrency control rules of SQL statements

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules?node_id=c01a5645eb2c4fb6a9373542f5366e50no07

Example Response

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
    } ]
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.