文档首页/ Web应用防火墙 WAF/ API参考/ API/ 策略规则管理/ 查询所有策略威胁情报控制规则
更新时间:2025-09-19 GMT+08:00
分享

查询所有策略威胁情报控制规则

功能介绍

查询所有策略威胁情报控制规则

调用方法

请参见如何调用API

URI

GET /v1/{projectid}/waf/rule/ip-reputation

表1 路径参数

参数

是否必选

参数类型

描述

projectid

String

参数解释:

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

policyids

String

参数解释:

域名id。

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

enterprise_project_id

String

参数解释:

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

约束限制:

不涉及

取值范围:

  • 0:代表default企业项目

  • all_granted_eps:代表所有企业项目

  • 其它企业项目ID:长度为36个字符

默认取值:

0

page

Integer

参数解释:

分页查询的起始位置,表示从第几条记录开始返回(从1开始计数)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

1

pagesize

Integer

参数解释:

分页查询时,每页包含多少条结果。

约束限制:

不涉及

默认取值:

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

Number of rules in the policy

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

items

Array of IpReputationRulesListInfo objects

参数解释:

Array of IpReputation rules

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 IpReputationRulesListInfo

参数

参数类型

描述

name

String

参数解释:

规则名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

id

String

参数解释:

Rule ID.

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

policyid

String

参数解释:

Policy ID.

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

String

参数解释:

信誉类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

规则描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tags

Array of strings

参数解释:

信誉类型的IDC数据中心

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

status

Integer

参数解释:

规则状态,0:关闭,1:开启

约束限制:

不涉及

取值范围:

0:关闭,1:开启

默认取值:

不涉及

action

action object

参数解释:

请求次数限制到达后采取的防护动作

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 action

参数

参数类型

描述

category

String

参数解释:

动作类型:

  • pass:放行

  • block:阻断。

  • log: 仅记录

  • pass:放行

  • block:阻断。

  • log: 仅记录

约束限制:

不涉及

取值范围:

默认取值:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询所有策略威胁情报控制规则

GET https://{endpoint}/v1/{projectid}/waf/rule/ip-reputation?enterprise_project_id=0

响应示例

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档