Updated on 2026-03-16 GMT+08:00

Querying SQL Throttling Rules

Function

This API is used to query SQL throttling rules. Before calling this API:

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

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition Node ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default Value N/A
sql_type	No	String	Definition SQL statements. Constraints N/A Range SELECT UPDATE DELETE INSERT Default Value If this parameter is not specified, SQL throttling rules of all the statements are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
node_id	String	Definition Node ID. Range The value is the same as the node ID in the request.
sql_filter_rules	Array of SqlFilterRule objects	Definition SQL throttling rules.

**Table 5** SqlFilterRule
Parameter	Type	Description
sql_type	String	Definition SQL statements. Range SELECT UPDATE DELETE INSERT
patterns	Array of SqlFilterRulePattern objects	Definition SQL throttling rules.

**Table 6** SqlFilterRulePattern
Parameter	Type	Description
pattern	String	Definition SQL throttling rule. Range N/A
max_concurrency	Integer	Definition Maximum number of concurrent SQL statements. Range N/A

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 SQL throttling rules

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" : "UPDATE",
    "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.

Parent topic: SQL Throttling