Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Traffic Management/ Configuring SQL Throttling Rules
Updated on 2026-01-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Configuring SQL Throttling Rules

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:instance:setSqlFilterRules

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:param:modify

    -

URI

PUT /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

Request Parameters

Table 2 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
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

sql_filter_rules

Yes

Array of NodeSqlFilterRuleInfo objects

Definition

SQL throttling rules for nodes.

Constraints

N/A
Table 4 NodeSqlFilterRuleInfo

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

rules

Yes

Array of NodeSqlFilterRule objects

Definition

SQL throttling rules.

Constraints

The sql_type value must be unique.
Table 5 NodeSqlFilterRule

Parameter

Mandatory

Type

Description

sql_type

Yes

String

Definition

SQL statements.

Constraints

To set the value to INSERT, the kernel version must be later than 2.0.54.240600.

Range

  • SELECT

  • UPDATE

  • DELETE

  • INSERT

Default Value

N/A

patterns

Yes

Array of NodeSqlFilterRulePattern objects

Definition

SQL throttling rules.

Constraints

N/A
Table 6 NodeSqlFilterRulePattern

Parameter

Mandatory

Type

Description

pattern

Yes

String

Definition

SQL throttling rule.

Constraints

N/A

Range

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 (~).

Default Value

N/A

max_concurrency

Yes

Integer

Definition

Maximum number of concurrent SQL statements.

Constraints

N/A

Range

≥ 0

Default Value

N/A

Response Parameters

Status code: 200

Table 7 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for configuring SQL throttling rules.

Range

N/A

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 SQL throttling rules (SQL statements 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"
}

SDK Sample Code

The SDK sample code is as follows.

Configuring SQL throttling rules (SQL statements include SELECT, UPDATE, and DELETE.)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class SetSqlFilterRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        SetSqlFilterRuleRequest request = new SetSqlFilterRuleRequest();
        request.withInstanceId("{instance_id}");
        OperateSqlFilterRuleReq body = new OperateSqlFilterRuleReq();
        List<NodeSqlFilterRulePattern> listRulesPatterns = new ArrayList<>();
        listRulesPatterns.add(
            new NodeSqlFilterRulePattern()
                .withPattern("delete~t3~where~id")
                .withExpireAt(1752461737985L)
        );
        List<NodeSqlFilterRulePattern> listRulesPatterns1 = new ArrayList<>();
        listRulesPatterns1.add(
            new NodeSqlFilterRulePattern()
                .withPattern("select~from~t3~where~id")
                .withMaxConcurrency(10)
                .withExpireAt(1752461737985L)
        );
        List<NodeSqlFilterRule> listSqlFilterRulesRules = new ArrayList<>();
        listSqlFilterRulesRules.add(
            new NodeSqlFilterRule()
                .withSqlType("SELECT")
                .withPatterns(listRulesPatterns1)
        );
        listSqlFilterRulesRules.add(
            new NodeSqlFilterRule()
                .withSqlType("DELETE")
                .withPatterns(listRulesPatterns)
        );
        List<NodeSqlFilterRulePattern> listRulesPatterns2 = new ArrayList<>();
        listRulesPatterns2.add(
            new NodeSqlFilterRulePattern()
                .withPattern("update~t3~where~id")
                .withMaxConcurrency(10)
        );
        List<NodeSqlFilterRulePattern> listRulesPatterns3 = new ArrayList<>();
        listRulesPatterns3.add(
            new NodeSqlFilterRulePattern()
                .withPattern("select~from~t1")
                .withMaxConcurrency(0,)
        );
        listRulesPatterns3.add(
            new NodeSqlFilterRulePattern()
                .withPattern("select~from~t3~where~id")
                .withMaxConcurrency(10)
        );
        List<NodeSqlFilterRule> listSqlFilterRulesRules1 = new ArrayList<>();
        listSqlFilterRulesRules1.add(
            new NodeSqlFilterRule()
                .withSqlType("SELECT")
                .withPatterns(listRulesPatterns3)
        );
        listSqlFilterRulesRules1.add(
            new NodeSqlFilterRule()
                .withSqlType("UPDATE")
                .withPatterns(listRulesPatterns2)
        );
        List<NodeSqlFilterRuleInfo> listbodySqlFilterRules = new ArrayList<>();
        listbodySqlFilterRules.add(
            new NodeSqlFilterRuleInfo()
                .withNodeId("c01a5645eb2c4fb6a9373542f5366e50no07")
                .withRules(listSqlFilterRulesRules1)
        );
        listbodySqlFilterRules.add(
            new NodeSqlFilterRuleInfo()
                .withNodeId("b234a5645eb2c4ji3b9372342f5362397no07")
                .withRules(listSqlFilterRulesRules)
        );
        body.withSqlFilterRules(listbodySqlFilterRules);
        request.withBody(body);
        try {
            SetSqlFilterRuleResponse response = client.setSqlFilterRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Configuring SQL throttling rules (SQL statements include SELECT, UPDATE, and DELETE.)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SetSqlFilterRuleRequest()
        request.instance_id = "{instance_id}"
        listPatternsRules = [
            NodeSqlFilterRulePattern(
                pattern="delete~t3~where~id",
                expire_at=1752461737985
            )
        ]
        listPatternsRules1 = [
            NodeSqlFilterRulePattern(
                pattern="select~from~t3~where~id",
                max_concurrency=10,
                expire_at=1752461737985
            )
        ]
        listRulesSqlFilterRules = [
            NodeSqlFilterRule(
                sql_type="SELECT",
                patterns=listPatternsRules1
            ),
            NodeSqlFilterRule(
                sql_type="DELETE",
                patterns=listPatternsRules
            )
        ]
        listPatternsRules2 = [
            NodeSqlFilterRulePattern(
                pattern="update~t3~where~id",
                max_concurrency=10
            )
        ]
        listPatternsRules3 = [
            NodeSqlFilterRulePattern(
                pattern="select~from~t1",
                max_concurrency=0,
            ),
            NodeSqlFilterRulePattern(
                pattern="select~from~t3~where~id",
                max_concurrency=10
            )
        ]
        listRulesSqlFilterRules1 = [
            NodeSqlFilterRule(
                sql_type="SELECT",
                patterns=listPatternsRules3
            ),
            NodeSqlFilterRule(
                sql_type="UPDATE",
                patterns=listPatternsRules2
            )
        ]
        listSqlFilterRulesbody = [
            NodeSqlFilterRuleInfo(
                node_id="c01a5645eb2c4fb6a9373542f5366e50no07",
                rules=listRulesSqlFilterRules1
            ),
            NodeSqlFilterRuleInfo(
                node_id="b234a5645eb2c4ji3b9372342f5362397no07",
                rules=listRulesSqlFilterRules
            )
        ]
        request.body = OperateSqlFilterRuleReq(
            sql_filter_rules=listSqlFilterRulesbody
        )
        response = client.set_sql_filter_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Configuring SQL throttling rules (SQL statements include SELECT, UPDATE, and DELETE.)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetSqlFilterRuleRequest{}
	request.InstanceId = "{instance_id}"
	var listPatternsRules = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "delete~t3~where~id",
            ExpireAt: int64(1752461737985),
        },
    }
	var listPatternsRules1 = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "select~from~t3~where~id",
            MaxConcurrency: int32(10),
            ExpireAt: int64(1752461737985),
        },
    }
	var listRulesSqlFilterRules = []model.NodeSqlFilterRule{
        {
            SqlType: "SELECT",
            Patterns: listPatternsRules1,
        },
        {
            SqlType: "DELETE",
            Patterns: listPatternsRules,
        },
    }
	var listPatternsRules2 = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "update~t3~where~id",
            MaxConcurrency: int32(10),
        },
    }
	var listPatternsRules3 = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "select~from~t1",
            MaxConcurrency: int32(0,),
        },
        {
            Pattern: "select~from~t3~where~id",
            MaxConcurrency: int32(10),
        },
    }
	var listRulesSqlFilterRules1 = []model.NodeSqlFilterRule{
        {
            SqlType: "SELECT",
            Patterns: listPatternsRules3,
        },
        {
            SqlType: "UPDATE",
            Patterns: listPatternsRules2,
        },
    }
	var listSqlFilterRulesbody = []model.NodeSqlFilterRuleInfo{
        {
            NodeId: "c01a5645eb2c4fb6a9373542f5366e50no07",
            Rules: listRulesSqlFilterRules1,
        },
        {
            NodeId: "b234a5645eb2c4ji3b9372342f5362397no07",
            Rules: listRulesSqlFilterRules,
        },
    }
	request.Body = &model.OperateSqlFilterRuleReq{
		SqlFilterRules: listSqlFilterRulesbody,
	}
	response, err := client.SetSqlFilterRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Traffic Management