更新时间:2025-08-06 GMT+08:00

批量获取SQL拦截规则

功能介绍

该API用于批量获取SQL拦截规则。

URI

GET /v1/{project_id}/sql-defend-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号,用于资源隔离。获取方式请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

queue_name

String

队列名称。

rule_name

String

规则名称。

offset

Integer

分页偏移量。

limit

Integer

分页个数。

请求参数

响应参数

状态码: 201

表3 响应Body参数

参数

参数类型

描述

rules

Array of SqlDefendRuleDto objects

用户自定义规则信息。

total_count

Integer

总个数。

表4 SqlDefendRuleDto

参数

参数类型

描述

rule_uuid

String

规则唯一标识。

最大长度:64

project_id

String

项目编号,用于资源隔离。

最大长度:64

rule_name

String

规则名称。

最小长度:1

最大长度:32

rule_id

String

规则类型。

枚举值:

  • static_0001
  • static_0002
  • static_0003
  • static_0004
  • static_0005
  • static_0006
  • static_0007
  • dynamic_0001
  • dynamic_0002
  • running_0002
  • running_0003
  • running_0004

category

String

规则状态类型。

枚举值:

  • static
  • dynamic
  • running

engine_rules

Object

规则详情。

queue_names

Array of strings

队列名称。

desc

String

用户规则描述。

最大长度:2000

sys_desc

String

系统规则描述。

create_time

Long

规则创建时间。

update_time

Long

规则更新时间。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

请求示例

响应示例

状态码

状态码

描述

201

获取规则成功

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码