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

查询SQL限流规则

功能介绍

查询SQL限流规则

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。
表2 Query参数

参数

是否必选

参数类型

描述

node_id

是

String

节点ID。

sql_type

否

String

SQL限流类型，不区分大小写，若不传则默认查询所有类型的限流规则。

取值范围：

  • SELECT：SELECT语句。
  • UPDATE：UPDATE语句。
  • DELETE：DELETE语句。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

node_id

String

节点ID。

sql_filter_rules

Array of SqlFilterRule objects

SQL限流规则。
表5 SqlFilterRule

参数

参数类型

描述

sql_type

String

SQL限流类型。

取值范围：

  • SELECT：SELECT语句。
  • UPDATE：UPDATE语句。
  • DELETE：DELETE语句。

patterns

Array of SqlFilterRulePattern objects

SQL限流具体规则。
表6 SqlFilterRulePattern

参数

参数类型

描述

pattern

String

SQL限流规则。

max_concurrency

Integer

最大并发数。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询SQL限流规则。

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

响应示例

状态码： 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
    } ]
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： SQL限流