查询频率控制规则列表
功能介绍
查询频率控制规则列表
调用方法
请参见如何调用API。
URI
GET /v2/aad/policies/waf/frequency-control-rule
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_name |
是 |
String |
域名 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
token |
Content-Type |
是 |
String |
Content-Type 缺省值:application/json;charset=utf8 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
total |
items |
Array of FrequencyControlRule objects |
items |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
id |
producer |
Integer |
判断是否是智能cc生成的规则 |
name |
String |
规则名称 |
url |
String |
规则应用的url |
limit_num |
String |
限速频率,单位为次,范围为1~2147483647 |
limit_period |
String |
限速周期,单位为秒,范围1~3600 |
lock_time |
String |
阻断时间,单位为秒,范围为0~65535 |
tag_type |
String |
限速模式:ip、cookie、header、other、policy、domain、url。 源限速:ip:IP限速,根据IP区分单个Web访问者。cookie:用户限速,根据Cookie键值区分单个Web访问者。header:用户限速,根据Header区分单个Web访问者。other:根据Referer(自定义请求访问的来源)字段区分单个Web访问者。-目的限速:policy: 策略限速、domain: 域名限速、url: url限速 |
tag_index |
String |
用户标识,当限速模式为用户限速(cookie或header)时 |
tag_condition |
TagCondition object |
用户标识,当限速模式为other时 |
action |
ActionInfo object |
请求次数限制到达后采取的动作 |
mode |
String |
cc规则防护模式,0:标准(老版本),只支持对域名的防护路径做限制。1:高级(新版本),支持对路径、IP、Cookie、Header、Params字段做限制。修改CC规则时必须传mode |
conditions |
Array of Condition objects |
cc规则防护规则限速条件 数组长度:1 - 30 |
unlock_num |
Integer |
放行频率,单位为次,范围为0~2147483647 最小值:0 最大值:2147483647 |
domain_aggregation |
Boolean |
域名聚合统计 |
region_aggregation |
Boolean |
全局计数 |
captcha_lock_time |
Integer |
锁定验证时间 最小值:0 最大值:3600 缺省值:0 |
grayscale_time |
Boolean |
是否灰度生效 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
动作类型:block:阻断,captcha:人机验证;log: 仅记录;dynamic_block:动态阻断 |
detail |
DetailInfo object |
阻断页面信息 |
参数 |
参数类型 |
描述 |
---|---|---|
category |
String |
字段类型 url:路径 ip:IPv4 ipv6:IPv6 params:Params cookie:Cookie header:Header response_code:Response Code |
contents |
Array of strings |
条件列表逻辑匹配内容。 当匹配逻辑为exist或not_exist时,contents必须为空,其他情况下contents必填且长度不超过2048 当category为response_code时,contents状态码为200~599,正则为 ^(?:[2-5]\d{2})$ 当匹配逻辑包含"len"时,contents必须为0~65535的整数;当匹配逻辑包含"num"时,contents必须为0~512的整数 |
index |
String |
子字段 当字段类型为ip或ipv6时,index必填且必须为:client-ip:客户端IP、x-forwarded-for:X-Forwarded-For、TCP连接IP: $remote_addr 当字段类型(category)选择“params”、“cookie”、“header”时,请根据实际需求配置子字段且该参数必填。 当匹配逻辑为num_greater、num_less、num_equal、num_not_equal时,子字段必须为空 当子字段不为空时,最大长度不超过2048 |
logic_operation |
String |
条件列表匹配逻辑。 如果字段类型category是url,匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 len_greater、 len_less、len_equal或者len_not_equal 如果字段类型category是ip、ipv6或response_code,匹配逻辑可以为: equal、not_equal 如果字段类型category是params、cookie或者header, 匹配逻辑可以为:contain、 not_contain、 equal、 not_equal、 prefix、 not_prefix、 suffix、 not_suffix、 len_greater、 len_less、len_equal、len_not_equal、num_greater、num_less、num_equal、num_not_equal、exist或者not_exist |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_description |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Error response |
错误码
请参见错误码。