文档中心 API文档 查询WAF防护策略详情

查询WAF防护策略详情

更新时间:2023-01-12 18:37:00

适用产品

WEB应用防火墙

接口描述

查询WAF防护策略详情。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称描述
*domainsList
域名,数组。
*startTimeString
开始时间,yyyy-MM-dd HH:mm:ss。
*endTimeString
结束时间,yyyy-MM-dd HH:mm:ss。
*ruleIdString
规则ID。
policysList
触发策略类型,数组。[protocol:协议合规检测, webShell:后门识别, other:其他防护规则, access:访问控制/限速, rule:Web规则防护]
timeZoneString
时区,默认GMT+8,即“GMT+8”。
actsList
处理动作,默认1和2。 1:拦截 2:监控

返回参数

Body 参数

参数名称描述
codeString
0状态码表示请求成功,其他状态码说明请参见《错误码》。
messageString
错误信息或Success。
dataString
返回值。
attackTimeString
最近攻击时间。
attackTypeString
攻击类型。
attackTypeNameString
攻击类型中文名称。
attackTypeNameEnString
攻击类型英文名称。
totalCountLong
攻击次数。
ruleIdString
规则ID。
ruleNameString
规则名称。
ipsList
攻击IP。
countLong
攻击IP记录数。
listList
攻击IP数组。
nameString
攻击IP。
attackTimeString
最近攻击时间。
totalCountLong
攻击次数。
urlsList
受攻击URL。
countLong
受攻击URL记录数。
listList
受攻击URL数组。
nameString
URL
attackTimeString
最近防护时间。
totalCountLong
攻击次数。

错误码

错误代码(code)描述(message)HTTP状态码语义
22992000ERROR_SYSTEM200系统错误
22992001ERROR_PARAM200参数错误
22992002ERROR_HEADER200请求头参数错误
22992003ERROR_ZONE200时区参数异常,请以GMT开头
22992004ERROR_TIME_ZONE200时区转换异常

示例

JSON
JSON
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
# Note that this must be a single quote to avoid the special $ character
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`

curl -i --url "https://open.chinanetcenter.com/api/waf/report/query-last-attack-info" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
   "domains":["example.xxx.xxx"],
    "startTime":"2021-09-06 00:00:00",
    "endTime":"2021-10-05 00:00:00",
    "timeZone":"GMT+8",
    "ruleId": "4000"
}'
返回示例
复制代码 复制成功
{
    "code": "0",
    "message": "Success",
    "data": {
        "attackTime": null,
        "attackType": "WAF_FORCE_CRACKING",
        "attackTypeName": "Rate Limiting",
        "attackTypeNameEn": "Rate Limiting",
        "totalCount": 11595,
        "ruleId": "4000",
        "ruleName": "cracking",
        "ips": {
            "count": 0,
            "list": []
        },
        "urls": {
            "count": 0,
            "list": []
        }
    }
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!