查询自定义规则列表 - ListCustomRuleConfigs

功能介绍

查询自定义规则列表

调用方法

请参见如何调用API。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/custom/rule/config

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。约束限制: 不涉及取值范围: 字符长度1-256位默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
rule_id	否	String	参数解释：规则ID 约束限制：不涉及取值范围：字符长度1-36位默认取值：不涉及
rule_name	否	String	参数解释：规则名称约束限制：不涉及取值范围：字符长度1-64位默认取值：不涉及
offset	否	Integer	参数解释: 偏移量：指定返回记录的开始位置约束限制: 不涉及取值范围: 最小值0，最大值2000000 默认取值: 默认为0
limit	否	Integer	参数解释: 每页显示个数约束限制: 不涉及取值范围: 取值10-200 默认取值: 10

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。约束限制: 不涉及取值范围: 字符长度1-32768位默认取值: 不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total_num	Integer	参数解释: 总数取值范围: 最小值0，最大值2147483647
data_list	Array of ListCustomRuleConfigResponse objects	参数解释: 自定义规则列表取值范围: 取值0-200个ListCustomRuleConfigResponse对象

表5 ListCustomRuleConfigResponse
参数	参数类型	描述
rule_id	String	参数解释：规则ID 取值范围：字符长度1-36位
host_num	Integer	参数解释: 防护主机数量。取值范围: 最小值1，最大值2000000
rule_name	String	参数解释：规则名称取值范围：字符长度1-64位
rule_status	Integer	参数解释：规则状态取值范围: 0：停用 1：启用
rule_type	String	参数解释：规则类型取值范围： black_hash：黑hash
auto_block	Integer	参数解释：是否自动阻断告警取值范围： 0：不自动阻断告警 1：自动阻断告警
hash_type	String	参数解释： hash类型取值范围： SHA-256：sha256sum MD5：md5sum SHA-1：sha1sum
is_all_host	Boolean	参数解释: 是否选择所有主机取值范围: true：是 false：否
create_time	Integer	参数解释：创建时间取值范围：最小值0，最大值9223372036854775807
update_time	Integer	参数解释：创建时间取值范围：最小值0，最大值9223372036854775807

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 3,
  "data_list" : [ {
    "host_num" : 1,
    "rule_name" : "rule_name1",
    "create_time" : 1764733845223,
    "update_time" : 1764733845223
  } ]
}