文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 流量管理/ 查询历史SQL限流规则 - ShowHistoricalSqlFilterRule
更新时间：2025-11-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询历史SQL限流规则 - ShowHistoricalSqlFilterRule

功能介绍

查询历史SQL限流规则。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:getSqlFilterRule

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:param:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

node_id

是

String

参数解释：

节点ID，此参数是节点的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为no07，长度为36个字符。

默认取值：

不涉及。

sql_type

否

String

参数解释：

SQL限流类型。

约束限制：

不涉及。

取值范围：

  • SELECT：查询语句。

  • UPDATE：更新语句。

  • DELETE：删除语句。

  • INSERT：插入语句。

默认取值：

不传则默认查询所有类型的限流规则。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

sql_filter_rules

Array of HistoricalSqlFilterRule objects

参数解释：

历史SQL限流规则。
表5 HistoricalSqlFilterRule

参数

参数类型

描述

instance_id

String

参数解释：

实例ID，此参数是实例的唯一标识。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

node_id

String

参数解释：

节点ID。

取值范围：

与入参中的节点ID一致。

默认取值：

不涉及。

pattern

String

参数解释：

SQL限流规则。

取值范围：

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

默认取值：

不涉及

sql_type

String

参数解释：

SQL限流类型。

取值范围：

  • SELECT：查询语句。

  • UPDATE：更新语句。

  • DELETE：删除语句。

  • INSERT：插入语句。

默认取值：

不涉及。

max_concurrency

Integer

参数解释：

最大并发数。

取值范围：

不涉及。

默认取值：

不涉及

create_at

Long

参数解释：

SQL限流规则创建时间。

取值范围：

0 - 9223372036854775807。

默认取值：

不涉及

expire_at

Long

参数解释：

SQL限流规则失效时间。

取值范围：

0 - 9223372036854775807。

默认取值：

不涉及

delete_at

Long

参数解释：

SQL限流规则删除时间。

取值范围：

0 - 9223372036854775807。

默认取值：

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询历史Sql限流规则。

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

响应示例

状态码：200

Success.

{
  "sql_filter_rules" : [ {
    "sql_type" : "SELECT",
    "pattern" : "select~from~t1",
    "max_concurrency" : 0,
    "create_at" : 1753254294,
    "expire_at" : 1753254294,
    "delete_at" : 1753254394,
    "instance_id" : "af315b8e6aaa41799bd9a31f2de15abcin07",
    "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07"
  }, {
    "sql_type" : "SELECT",
    "pattern" : "select~from~t2",
    "max_concurrency" : 1,
    "create_at" : 1753254294,
    "expire_at" : 1753254294,
    "delete_at" : 1753254394,
    "instance_id" : "af315b8e6aaa41799bd9a31f2de15abcin07",
    "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 流量管理

相关文档