查詢頻率控制策略
更新時間 2023-11-13 18:33:44
最近更新時間: 2023-11-13 18:33:44
分享文章
接口描述:調用本接口查詢域名的頻率控制規則配置內容
請求方式: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時生效) |
示例:
請求路徑://cdnapi-global.ctapi.daliqc.cn/waf/access-rate-limit/query-access-rate-limit
示例1:
請求參數:
{
"domainName":"www.daliqc.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.daliqc.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含義