接口描述:调用本接口查询域名的频率控制规则配置内容
请求方式:post
请求路径:/waf/access-rate-limit/query-access-rate-limit
使用说明:
- 查询前,您需要先开通安全加速产品;
- 单个用户一分钟限制调用10000次,并发不超过100;
请求参数说明(json):
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
domain | string | 是 | 域名 | 单次调用支持一个域名查询 |
pageSize | int | 否 | 查询每页的数量 | 不传默认10条 |
pageIndex | int | 否 | 查询的页数 | 不传默认第一页 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
data | list | 否 | 查询结果 |
1)data参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
results | 对象 | 是 | 响应码,返回数据 |
mod | String | 是 | 总开关; 1、ON:开启 2、CLOSE:关闭 |
total | int | 是 | 总数 |
2)results参数
参数名 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
ruleId | int | 是 | 规则Id |
domain | string | 是 | 域名 |
mod | string | 是 | 开关状态 1、开启 2、关闭 |
act | string | 否 | 处理动作 1、告警:LOG 2、拦截:BLOCK 3、人机跳转:CC 4、丢弃:DROP |
priority | int | 是 | 优先级 |
ruleName | string | 是 | 规则名 |
ruleDesc | string | 否 | 规则描述 |
noKey | string | 是 | 粒度缺失限速 |
limitTime | int | 是 | 触发条件时间,单位s |
maxNumber | int | 是 | 最多允许多少个请求 |
durationTime | int | 是 | 处理动作持续时间,单位s |
accessRateLimitCondition | List | 是 | 防护条件 |
countGranularity | list | 是 | 统计粒度 |
3)accessRateLimitCondition参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
equal | String | 是 | 判断条件 1、TRUE:包含 2、FALSE:不包含 |
id | integer | 是 | 防护条件id |
publicContent | string | 否 | 内容 |
zone | string | 是 | 粒度 |
keyName | string | 否 | key文本形式(当zone=HEADER、ARGS生效) 1、REGEX:正则 2、STR:字符串 |
keyContent | string | 否 | key内容(当zone=HEADER、ARGS生效) |
valueContent | string | 否 | value内容(当zone=HEADER、ARGS生效) |
valueName | string | 否 | value文本形式(当zone=HEADER、ARGS生效) 1、REGEX:正则 2、STR:字符串 |
operator | string | 否 | 当zone=IP_PORT、REQUEST_URI、CI、PROTOCOL时生效 1、REGEX:正则 2、STR:字符串 |
geoZone | List | 否 | geo地区对象(当zone=GEO生效) |
4)countGranularity参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
grading | List | 是 | 统计粒度 |
message | string | 否 | 防护条件id(当grading=HEADER、ARGS、COOKIE时生效) |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/waf/access-rate-limit/query-access-rate-limit
示例1:
请求参数:
{
"domainName":"www.ctyun.cn",
"pageSize":"10",
"pageIndex":"1"
},
返回结果:
{
"respone": {
"code": "100000",
"message": "success",
"data": {
"total": 1,
"mod": "ON",
"results": [
{
"durationTime": 3661,
"mod": "ON",
"countGranularity": {
"grading": [
"URL"
],
"message": ""
},
"priority": 1,
"limitTime": 3661,
"act": "LOG",
"maxNumber": 1,
"domain": "www.ctyun.cn",
"ruleDesc": "test",
"accessRateLimitCondition": [
{
"equal": "TRUE",
"publicContent": "",
"zone": "GEO",
"valueName": "",
"keyName": "",
"keyContent": "",
"valueContent": "",
"id": 23050,
"operator": "",
"geoZone": [
{
"subGeo": [
"EU",
"EU_DE"
]
},
{
"subGeo": [
"EU",
"EU_PT"
]
}
]
},
{
"equal": "TRUE",
"publicContent": "1.1.1.2",
"zone": "IP",
"valueName": "",
"keyName": "",
"keyContent": "",
"valueContent": "",
"id": 23051,
"operator": "",
"geoZone": []
}
],
"ruleName": "test-test",
"ruleId": 12671,
"noKey": "TRUE"
}
]
}
}
}
错误码请参考:API返回参数code和message含义