DescribeWebCCRulesV2 - 查询网站业务频率控制防护(CC防护)的自定义规则

查询网站业务频率控制防护(CC防护)的自定义规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-ddoscoo:DescribeWebCCRulesV2

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Domain

string

要接入 DDoS 高防进行防护的网站域名。

example.com

PageSize

string

分页大小,即每页显示多少个结果。最大值 20,默认值 20

20

Offset

string

开始索引位置,即从第几条结果开始显示。默认从 0 开始。

0

Owner

string

筛选规则来源。取值:

  • manual(默认):手动添加

  • clover:自动生成

manual

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

CF33B4C3-196E-4015-AADD-5CAD00057B80

TotalCount

string

频率控制规则总数。

12

Domain

string

网站业务的域名。

www.aliyun.com

WebCCRules

array<object>

频率控制(CC 防护)自定义规则。

object

频率控制(CC 防护)自定义规则。

Owner

string

规则来源。取值:

  • manual(默认):手动添加

  • clover:自动生成

manual

Expires

integer

规则有效期。单位:秒。规则的匹配动作为阻断时(action 为 block)生效,在规则有效期内阻断访问请求。0 表示永久生效。

0

Name

string

规则名称。

wq

RuleDetail

object

规则详情。

Mode

string

老规则格式,已废弃。

废弃

Count

integer

老规则格式,已废弃。

废弃

Name

string

规则名称。

ccauto14

Action

string

匹配动作。取值:

  • accept:放行

  • block:封禁

  • challenge:挑战

  • watch:观察

block

Interval

integer

老规则格式,已废弃。

60

Ttl

integer

老规则格式,已废弃。

300

Uri

string

老规则格式,已废弃。

/p3shijihao

RateLimit

object

频率统计。

SubKey

string

字段名称(仅当统计源为 header 时设置)。

action

Interval

integer

统计周期。单位:秒。

60

Threshold

integer

触发阈值。

20

Ttl

integer

封禁时长。单位:秒。

15

Target

string

统计源。取值:

  • ip:按照 IP 统计

  • header:按照 Header 统计

ip

Condition

array<object>

匹配条件列表。

object

匹配条件。

MatchMethod

string

匹配方法。

belong

Field

string

匹配字段。

ip

HeaderName

string

自定义 HTTP 头部字段名称。

说明

仅在 Fieldheader 时有效。

null

Content

string

匹配内容。

192.0.XX.XX

ContentList

string

匹配方法为等于多值之一时的匹配内容。

["2","3","ad"]

Statistics

object

去重统计,可缺省(缺省为不去重统计)。

Mode

string

去重模式。取值:

  • count:不去重统计

  • distinct:去重统计

count

Field

string

统计源。取值:

  • ip:按照 IP 统计

  • header:按照 Header 统计

  • uri:按照 uri 统计

uri

HeaderName

string

仅当统计源为 header 时设置。

hello

StatusCode

object

状态码。

Enabled

boolean

是否可用。取值:

  • true:开启。

  • false:关闭。

true

Code

integer

状态码。值范围 100~599

  • 200:表示成功。

  • 其它:表示错误码。

200

UseRatio

boolean

是否使用比率:

  • true:使用。

  • false:不使用。

true

CountThreshold

integer

不使用比率时,仅在对应状态码达到 CountThreshold 时触发处置动作,值范围 2~50000

10

RatioThreshold

integer

使用比率时,仅在对应状态码达到 RatioThreshold 时触发处置动作,值范围 1~100

10

示例

正常返回示例

JSON格式

{
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "TotalCount": "12",
  "Domain": "www.aliyun.com",
  "WebCCRules": [
    {
      "Owner": "manual",
      "Expires": 0,
      "Name": "wq",
      "RuleDetail": {
        "Mode": "废弃",
        "Count": 0,
        "Name": "ccauto14",
        "Action": "block",
        "Interval": 60,
        "Ttl": 300,
        "Uri": "/p3shijihao",
        "RateLimit": {
          "SubKey": "action",
          "Interval": 60,
          "Threshold": 20,
          "Ttl": 15,
          "Target": "ip"
        },
        "Condition": [
          {
            "MatchMethod": "belong",
            "Field": "ip",
            "HeaderName": "null",
            "Content": "192.0.XX.XX",
            "ContentList": "[\"2\",\"3\",\"ad\"]"
          }
        ],
        "Statistics": {
          "Mode": "count",
          "Field": "uri",
          "HeaderName": "hello"
        },
        "StatusCode": {
          "Enabled": true,
          "Code": 200,
          "UseRatio": true,
          "CountThreshold": 10,
          "RatioThreshold": 10
        }
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情