Configuring Concurrency Control Rules of SQL Statements

Function

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

PUT /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, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
sql_filter_rules	Yes	Array of NodeSqlFilterRuleInfo objects	Concurrency control rules of SQL statements for nodes.

**Table 4** NodeSqlFilterRuleInfo
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.

**Table 5** NodeSqlFilterRule
Parameter	Mandatory	Type	Description
sql_type	Yes	String	SQL statement type. Values: SELECT UPDATE DELETE
patterns	Yes	Array of NodeSqlFilterRulePattern objects	Concurrency control rules of SQL statements.

**Table 6** NodeSqlFilterRulePattern
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.

Response Parameters

Status code: 200

**Table 7** Response body parameter
Parameter	Type	Description
job_id	String	ID of the task for configuring concurrency control rules of SQL statements.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Configuring concurrency control rules of SQL statements (SQL statement types include SELECT, UPDATE, and DELETE.)

PUT https://{endpoint}/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
      } ]
    } ]
  } ]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: SQL Statement Concurrency Control

Previous topic: Querying Whether SQL Statement Concurrency Control Is Enabled

Next topic: Querying Concurrency Control Rules of SQL Statements

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot