接口描述:调用本接口新增域名的频率控制规则配置内容
请求方式:post
请求路径:/waf/access-rate-limit/create-access-rate-limit
使用说明:
- 查询前,您需要先开通安全加速产品;
- 单个用户一分钟限制调用10000次,并发不超过100;
请求参数说明(json):
参数名 | 类型 | 是否必填 | 名称 | 说明 |
---|---|---|---|---|
domain | string | 是 | 域名 | 单次调用支持新增一个域名 |
accessRateLimitInfoList | list | 否 | 访问限速 |
1)accessRateLimitInfoList参数
参数名 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
mod | string | 是 | 开关状态 1、开启:ON 2、关闭:CLOSE |
act | string | 是 | mod=ON时为必填; 处理动作 1、告警:LOG 2、拦截:BLOCK 3、人机跳转:CC 4、丢弃:DROP |
ruleName | string | 是 | 规则名 |
ruleDesc | string | 否 | 规则描述 |
accessRateLimitCondition | List | 是 | 防护条件 |
countGranularity | List | 是 | 统计粒度 |
noKey | string | 是 | 粒度缺失限速 |
limitTime | int | 是 | 触发条件时间,单位s |
maxNumber | int | 是 | 统计周期内,最多允许多少个请求 |
durationTime | int | 是 | 处理动作持续时间,单位s |
2)accessRateLimitCondition参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
equal | String | 是 | 1、包含:TRUE 2、不包含:FALSE |
zone | String | 是 | 粒度(PATH、GEO、ARGS、CI、IP、REQUEST_URI、METHOD、IPR、HEADER、IPS、URI) |
publicContent | String | 非必须 | 输入多个时用分号隔开; URI、PATH最多十个; IP最多三百个; 当ZONE不为GEO、ARGS、HEADER时,为必填项 |
operator | String | 非必须 | 当ZONE=IP_PORT、URI、REQUEST_URI、PROTOCOL时生效 1、正则:REGEX 2、字符串:STR |
geoZone | List | 非必须 | geo地区对象,当ZONE=GEO生效 |
keyName | string | 非必须 | key名称(当zone为args和header时必须); 1、正则:REGEX 2、字符串:STR |
keyContent | string | 非必须 | key内容(当zone为args和header时必须) |
valueName | string | 非必须 | value名称(当zone为args和header时必须) 1、正则:REGEX 2、字符串:STR |
valueContent | string | 非必须 | value内容(当zone为args和header时必须) |
3)geoZone参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
subGeo | List | 非必须 | geo地区 |
4)countGranularity参数
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
grading | List | 是 | 统计粒度; IP、UA、CI、COOKIE、HEADER、ARGS、URL(ARGS、HEADER、COOKIE只能同时存在一个); 最多支持两个粒度,不区分大小写; |
message | string | 否 | 统计粒度选择ARGS、HEADER、COOKIE时必填 |
返回参数说明:
参数 | 类型 | 是否必传 | 名称及描述 |
---|---|---|---|
code | int | 是 | 状态码,成功100000 |
message | string | 是 | 描述信息,成功返回success,其他返回异常信息描述 |
data | list | 否 | 查询结果 |
示例:
请求路径:https://cdnapi-global.ctapi.ctyun.cn/waf/access-rate-limit/create-access-rate-limit
示例1:
请求参数:
{
"domain": "www.ctyun.cn",
"accessRateLimitInfoList":[ {
"mod": "ON",
"countGranularity": {
"grading": [
"URL"
],
"message": ""
},
"act": "LOG",
"ruleName": "uutest",
"ruleDesc": "123",
"noKey": "TRUE",
"limitTime": 3661,
"maxNumber": 1,
"durationTime": 3661,
"accessRateLimitCondition": [{
"zone": "GEO",
"equal": "TRUE",
"operator": "",
"publicContent": "",
"geoZone": [{
"subGeo": ["EU", "EU_DE"]
}, {
"subGeo": ["EU", "EU_PT"]
}]
}, {
"zone": "IP",
"equal": "TRUE",
"operator": "",
"publicContent": "1.1.1.2",
"geoZone": []
}]
}]
}
返回结果:
{
"code": 100000,
"message": "success",
"request_id": "53ssa889"
}
错误码请参考:API返回参数code和message含义