文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 独享模式/ CC规则管理/ 查询CC规则列表
更新时间：2024-07-25 GMT+08:00
查看PDF
分享

查询CC规则列表

功能介绍

查询CC规则列表

URI

GET /v1/{project_id}/waf/policy/{policy_id}/cc

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户操作的项目id

policy_id

是

String

防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id
表2 Query参数

参数

是否必选

参数类型

描述

page

否

Integer

分页查询时，返回第几页数据。范围0-100000，默认值为1，表示返回第1页数据。

缺省值：1

pagesize

否

Integer

分页查询时，每页包含多少条结果。范围1-100，默认值为10，表示每页包含10条结果。

缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型

缺省值：application/json;charset=utf8

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

该策略下CC防护规则总数量

items

Array of CcrulesListInfo objects

cc规则对象列表
表5 CcrulesListInfo

参数

参数类型

描述

id

String

CC规则ID

policyid

String

CC防护策略的策略ID

url

String

规则应用的URL链接，不包含域名：

  • 前缀匹配：以结尾代表以该路径为前缀。例如，需要防护的路径为“/admin/test.php”或 “/adminabc”，则路径可以填写为“/admin”。

  • 完全匹配：需要防护的路径需要与此处填写的路径完全相等。如果防护路径为“/admin”，该规则必须填写为“/admin”。

limit_num

String

单个用户的周期内请求次数（单用户限速）

limit_period

String

限速周期。

lock_time

String

锁定时长。取值范围为[0秒, 2^32秒)

tag_type

String

防护模式：

  • “ip”：IP限速，根据IP区分单个Web访问者。

  • “cookie”：用户限速，根据Cookie键值区分单个Web访问者。

  • “other”：根据Referer（自定义请求访问的来源）字段区分单个Web访问者。

tag_index

String

防护模式标签，当“tag_type”为cookie时，该参数表示cookie name。

action

action object

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

timestamp

Long

创建规则时间戳
表6 action

参数

参数类型

描述

category

String

动作类型：

  • “block”：阻断

  • “captcha”：人机验证，阻断后用户需要输入正确的验证码，恢复正确的访问页面。

  • 当“tag_type”为“other”时，只能取值“block”。

detail

String

动作详情，动作详情，detail为null时表示默认阻断页面。

  • 当“category”为“captcha”时，不能传此字段；

  • “category”为“block”时，需要传此字段。
表7 detail

参数

参数类型

描述

redirect_url

String

返回页面重定向的url

response

response object

返回页面
表8 response

参数

参数类型

描述

content_type

String

内容类型，固定值为“application/json”、“text/html”、“text/xml”。

content

String

内容

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/cc?enterprise_project_id=0

响应示例

状态码： 200

ok

{
  "total" : 1,
  "items" : [ {
    "aging_time" : 0,
    "description" : "",
    "id" : "a5f3fd28db564696b199228f0ac346b2",
    "limit_num" : 10,
    "limit_period" : 60,
    "lock_time" : 0,
    "mode" : 0,
    "policyid" : "1f016cde588646aca3fb19f277c44d03",
    "prefix" : false,
    "producer" : 1,
    "status" : 1,
    "tag_type" : "ip",
    "timestamp" : 1656494435686,
    "total_num" : 0,
    "unaggregation" : false,
    "url" : "/path"
  } ]
}

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： CC规则管理