文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> SQL限流> 设置SQL限流规则
更新时间：2024-02-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置SQL限流规则

功能介绍

设置SQL限流规则。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us

  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

sql_filter_rules

是

Array of NodeSqlFilterRuleInfo objects

节点级别的SQL限流规则。
表4 NodeSqlFilterRuleInfo

参数

是否必选

参数类型

描述

node_id

是

String

节点ID。

rules

是

Array of NodeSqlFilterRule objects

SQL限流规则。集合的sql_type值不能重复。
表5 NodeSqlFilterRule

参数

是否必选

参数类型

描述

sql_type

是

String

Sql限流类型。

取值范围：

  • SELECT

  • UPDATE

  • DELETE

patterns

是

Array of NodeSqlFilterRulePattern objects

SQL限流具体规则。
表6 NodeSqlFilterRulePattern

参数

是否必选

参数类型

描述

pattern

是

String

SQL限流规则，由一个或多个关键字（最多为128个关键字）组成，关键字之间通过"~"分隔符分开，如select~from~t1。规则中不能包含‘\’、中英文逗号、‘~~’，不能以‘~’结尾。

max_concurrency

是

Integer

最大并发数。取值范围：非负整数。

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

job_id

String

设置SQL限流规则任务ID。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置SQL限流规则，限流类型为SELECT、UPDATE、DELETE。

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

响应示例

状态码： 200

Success.

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

SDK代码示例

SDK代码示例如下。

设置SQL限流规则，限流类型为SELECT、UPDATE、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
 
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");

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

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        SetSqlFilterRuleRequest request = new SetSqlFilterRuleRequest();
        OperateSqlFilterRuleReq body = new OperateSqlFilterRuleReq();
        List<NodeSqlFilterRulePattern> listRulesPatterns = new ArrayList<>();
        listRulesPatterns.add(
            new NodeSqlFilterRulePattern()
                .withPattern("delete~t3~where~id")
                .withMaxConcurrency(10)
        );
        List<NodeSqlFilterRulePattern> listRulesPatterns1 = new ArrayList<>();
        listRulesPatterns1.add(
            new NodeSqlFilterRulePattern()
                .withPattern("select~from~t3~where~id")
                .withMaxConcurrency(10)
        );
        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());
        }
    }
}

设置SQL限流规则，限流类型为SELECT、UPDATE、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
 
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = SetSqlFilterRuleRequest()
        listPatternsRules = [
            NodeSqlFilterRulePattern(
                pattern="delete~t3~where~id",
                max_concurrency=10
            )
        ]
        listPatternsRules1 = [
            NodeSqlFilterRulePattern(
                pattern="select~from~t3~where~id",
                max_concurrency=10
            )
        ]
        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)

设置SQL限流规则，限流类型为SELECT、UPDATE、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
 
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")

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

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

    request := &model.SetSqlFilterRuleRequest{}
	var listPatternsRules = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "delete~t3~where~id",
            MaxConcurrency: int32(10),
        },
    }
	var listPatternsRules1 = []model.NodeSqlFilterRulePattern{
        {
            Pattern: "select~from~t3~where~id",
            MaxConcurrency: int32(10),
        },
    }
	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)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： SQL限流
分享：

    相关文档

    相关产品