查询所有策略指定类型的防护规则 - ListPolicyProtectRules

功能介绍

查询所有策略指定类型的防护规则

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/waf/policy/{rule_type}/rules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。约束限制：不涉及取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及
rule_type	是	String	参数解释：需要查询的规则类型约束限制：不涉及取值范围： cc CC防护 custom 精准防护 whiteblackip 黑白名单 geoip 地理位置防护 ip-reputation 威胁情报 antitamper 防篡改 antileakage 防敏感信息泄露 ignore 全局白名单(原误报屏蔽) privacy 隐私屏蔽默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
policyids	否	String	参数解释：策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取，多个策略之间用“,”隔开约束限制：不涉及取值范围：不涉及默认取值：不涉及
enterprise_project_id	否	String	参数解释：您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。约束限制：不涉及取值范围： 0：代表default企业项目 all_granted_eps：代表所有企业项目其它企业项目ID：长度为36个字符默认取值： 0
page	否	Integer	参数解释：分页查询时，返回第几页数据约束限制：不涉及取值范围： page参数的实际有效范围取决于总数据量和pagesize的取值，不能大于总页数默认取值： 1
pagesize	否	Integer	参数解释：分页查询时，每页包含的结果条数约束限制：不涉及取值范围： [0, 总数据量] 默认取值： 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	策略总数
items	Array of objects	参数解释：单个策略下特定类型防护规则列表约束限制：具体类型取决于参数rule_type 取值范围：具体返回值参考接口： cc CC防护 ListCcPolicyRules custom 精准防护 ListCustomPolicyRules whiteblackip 黑白名单 ListWhiteblackipPolicyRules geoip 地理位置防护 ListGeoIpPolicyRules ip-reputation 威胁情报 ListIpReputationPolicyRules antitamper 防篡改 ListAntiTamperPolicyRules antileakage 防敏感信息泄露 ListAntileakagePolicyRules ignore 全局白名单(原误报屏蔽) ListIgnorePolicyRules privacy 隐私屏蔽 ListPrivacyPolicyRules 默认取值：不涉及

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
encoded_authorization_message	String	编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。
details	Array of IAM5ErrorDetails objects	调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

表6 IAM5ErrorDetails
参数	参数类型	描述
error_code	String	下游服务错误码
error_msg	String	下游服务报错信息

状态码：401

表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	下游服务报错信息

状态码：500

表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	下游服务报错信息

请求示例

查询所有策略下的CC规则

GET https://{endpoint}/v1/{project_id}/waf/policy/cc/rules?enterprise_project_id=0

响应示例

状态码：200

请求成功

{
  "total" : 1,
  "items" : [ {
    "id" : "f88c5eabff9b4ff9ba6e7dd8e38128ba",
    "policyid" : "d471eef691684f1c8d7784532fd8f4bd",
    "name" : "test",
    "timestamp" : 1678873040603,
    "description" : "",
    "status" : 1,
    "mode" : 1,
    "conditions" : [ {
      "category" : "url",
      "contents" : [ "/url" ],
      "logic_operation" : "contain"
    } ],
    "action" : {
      "category" : "captcha"
    },
    "producer" : 1,
    "unaggregation" : false,
    "total_num" : 0,
    "limit_num" : 10,
    "limit_period" : 60,
    "lock_time" : 0,
    "tag_type" : "ip",
    "aging_time" : 0,
    "region_aggregation" : false,
    "domain_aggregation" : false
  } ]
}