调用 DescribeWafUsageData 查询 WAF 的用量数据。
接口说明
数据最大存储时长：93 天
最大允许查询时间跨度：31 天
默认时间跨度：24 小时
所有时间均使用 UTC+0 时间表达。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| StartTime |
string |
否 |
获取数据的起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2022-08-10T00:00:00Z |
| EndTime |
string |
否 |
获取数据结束时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。 |
2022-08-10T23:59:59Z |
| SiteId |
integer |
否 |
站点 ID。通过调用 ListSites 接口获取站点 ID。 |
123456**** |
| SplitBy |
string |
否 |
分组键，可以指定为 domain。
|
domain |
| Interval |
string |
否 |
查询数据的时间粒度，单位为秒。 根据您指定 StartTime 和 EndTime 两者的时间跨度，该参数取值如下：
|
300 |
| RecordName |
string |
否 |
域名记录名称，通过调用 ListSites 接口获取域名记录名称。 |
test.example.com |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| EndTime |
string |
获取数据结束时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2022-08-10T23:59:59Z |
| StartTime |
string |
获取数据的起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2022-08-10T00:00:00Z |
| RequestId |
string |
请求 ID。 |
C370DAF1-C838-4288-A1A0-9A87633D2*** |
| UsageData |
array<object> |
返回数据。 |
|
|
object |
返回数据。 |
||
| ObserveCount |
integer |
观察的请求数。 |
123 |
| RecordName |
string |
域名记录名称。 |
test.example.com |
| BlockCount |
integer |
拦截的请求数。 |
123 |
| AccessCount |
integer |
正常访问的请求数。 |
123 |
| TimeStamp |
string |
时间片起始时刻。 |
2022-08-10T00:00:00Z |
示例
正常返回示例
JSON格式
{
"EndTime": "2022-08-10T23:59:59Z",
"StartTime": "2022-08-10T00:00:00Z",
"RequestId": "C370DAF1-C838-4288-A1A0-9A87633D2***",
"UsageData": [
{
"ObserveCount": 123,
"RecordName": "test.example.com",
"BlockCount": 123,
"AccessCount": 123,
"TimeStamp": "2022-08-10T00:00:00Z"
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | Parameter verification failed. Check your configurations and try again. | 输入的参数校验不通过，请您核对参数的正确性后重试。 |
| 400 | TooManyRequests | Too many requests.Please try again later. | 请求过于频繁，请稍后重试。 |
| 400 | QuotaCheckFailed.Function | The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature. | 您的套餐不含该功能，请升级套餐或联系商务添加。 |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 您填入的结束时间早于开始时间，请检查后重试。 |
| 400 | InvalidParameter.TimeRange | The specified time range exceeds the limit. Adjust it and try again. | 您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。 |
| 400 | InvalidParameter.Field | The specified Field is invalid. | 您的查询指标有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。 |
| 400 | InvalidTime.Malformed | Specified start time or end time is malformed. | 您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。