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

查询CC规则列表

功能介绍

查询某个策略下所有的CC规则列表。

URI

  • URI格式

    GET /v1/{project_id}/waf/policy/{policy_id}/cc?offset={offset}&limit={limit}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    用户操作的项目ID。

    policy_id

    是

    String

    策略ID。

    offset

    否

    Long

    指定返回的页数，取值范围为：[0, 65535]，默认值为0。

    limit

    否

    Long

    指定查询返回每页记录的最大条数，取值范围为：(0, 50]， 默认值为10。

请求消息

请求参数

无

响应消息

响应参数
表2 响应参数说明

名称

参数类型

说明

total

Integer

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

items

表3

CC规则对象列表。
表3 items

名称

参数类型

说明

id

String

CC规则ID。

policy_id

String

CC防护策略的策略ID。

path

String

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

  • 前缀匹配：以*结尾代表以该路径为前缀。

    例如，需要防护的路径为“/admin/test.php”或 “/adminabc”，则路径可以填写为“/admin*”。

  • 完全匹配：需要防护的路径需要与此处填写的路径完全相等。

    如果防护路径为“/admin”，该规则必须填写为“/admin”。

limit_num

Integer

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

limit_period

Integer

限速周期。

lock_time

Integer

锁定时长。取值范围为[0秒, 232秒)

tag_type

String

防护模式。

  • “ip”：IP限速，根据IP区分单个Web访问者。
  • “cookie”：用户限速，根据Cookie键值区分单个Web访问者。
  • “other”：根据Referer（自定义请求访问的来源）字段区分单个Web访问者。

tag_index

String

当“tag_type”为cookie时，该参数表示cookie name。

tag_condition

表4

Referer（自定义请求访问的来源）字段，当“tag_type”为“other”时，会返回该字段。

action

表5

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

timestamp

Long

创建CC规则的时间。

default

Boolean

是否为默认CC规则。

  • true：表示该规则是默认的CC规则，创建域名时默认创建的CC规则。
  • false：表示该规则不是默认的CC规则，用户自己创建的CC规则。
表4 tag_condition

名称

参数类型

说明

category

String

类别，取值为“Referer”。

contents

List

category的内容，例如“http://www.example.com”。
表5 action

名称

参数类型

说明

category

String

动作类型。

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

默认为“block”。

detail

表6

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

名称

参数类型

说明

response

表7

返回页面。
表7 response

名称

参数类型

说明

content_type

String

返回页面的内容类型。

固定值为“application/json”、“text/html”、“text/xml”。

content

String

返回页面的内容。

示例

以查询CC规则列表，返回记录条数为“2”为例。

响应样例 
{
  "total": 2,
  "items": [{
      "id": "3a9b5c0f96784ec8abd8ba61a98064ef",
      "policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
      "path": "/abc1",
      "limit_num": 10,
      "limit_period": 60,
      "lock_time": 10,
      "tag_type": "cookie",
      "tag_index": "sesssionid",
      "action": {
        "category": "block",
        "detail": {
          "response": {
              "content_type": "application/json",
              "content": "{\"error\":\"forbidden\"}"
          }
        }
      },
      "timestamp": 1499817600,
      "default": true
    }, {
      "id": "3d7bea768b10480984f98c6b69d43d0f",
      "policy_id": "9tre832yf96784ec8abd8ba61a98064ef",
      "path": "/efgh",
      "limit_num": 10,
      "limit_period": 60,
      "lock_time": 5,
      "tag_type": "other",
      "tag_condition":{
          "category": "referer",
         "contents": ["http://www.example.com"]
       }
      "action": {
        "category": "block",
      },
      "timestamp": 1499817600,
      "default": true
    }
  ]
}

状态码

表8描述的是API返回的正常状态码。
表8 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码，请参见状态码。

父主题： CC规则