调用DescribeDcdnWafUsageData查询WAF用量数据_边缘安全加速(ESA)-阿里云帮助中心

调用DescribeDcdnWafUsageData查询WAF用量数据。

接口说明

说明

单用户调用频率： 10 次/秒
支持查询的最小时间粒度为 5 分钟；查询的最大时间跨度为 31 天；可查询最大历史数据时间范围为 90 天。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dcdn:DescribeDcdnWafUsageData

get

*Domain

acs:dcdn:*:{#accountId}:domain/{#DomainName}

无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	查询域名。若参数为空，默认返回所有加速域名。	example.com
StartTime	string	否	获取数据起始时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2018-09-30T16:00:00Z
EndTime	string	否	获取数据结束时间。日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需大于起始时间。	2018-10-01T16:00:00Z
Interval	string	否	查询数据的时间粒度，单位为秒。根据单次查询的最大时间跨度不同，该参数支持 300（5 分钟）、3600（1 小时）和 86400（1 天）取值。	300
SplitBy	string	否	查询结果分组方式。取值： domain：按加速域名分组。参数为空（默认）：查询结果不分组。	domain

返回参数

名称	类型	描述	示例值
	object
EndTime	string	结束时间。	2018-10-01T16:00:00Z
StartTime	string	开始时间。	2018-09-30T16:00:00Z
RequestId	string	请求 ID。	CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
WafUsageData	object
WafUsageDataItem	array<object>	加速域名使用 WAF 信息。
	object
ObserveCnt	integer	观察的请求数。	300
Domain	string	加速域名。	example.com
BlockCnt	integer	拦截的请求数。	300
AccessCnt	integer	正常访问的请求数。	600
TimeStamp	string	时间片起始时刻。	2018-09-30T16:00:00Z
SecCu	integer	产生的 SeCU 计量单元数。	50

示例

正常返回示例

JSON格式

{
  "EndTime": "2018-10-01T16:00:00Z",
  "StartTime": "2018-09-30T16:00:00Z",
  "RequestId": "CB1A380B-09F0-41BB-802B-72F8FD6DA2FE",
  "WafUsageData": {
    "WafUsageDataItem": [
      {
        "ObserveCnt": 300,
        "Domain": "example.com",
        "BlockCnt": 300,
        "AccessCnt": 600,
        "TimeStamp": "2018-09-30T16:00:00Z",
        "SecCu": 50
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	请同时提供开始时间和结束时间。
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	请提供正确的开始时间格式。日期格式按照ISO8601表示法，并使用UTC时间，格式为：yyyy-MM-ddTHH:mm:ssZ。
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	请提供正确的结束时间格式。日期格式按照ISO8601表示法，并使用UTC时间。格式为：yyyy-MM-ddTHH:mm:ssZ。
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	开始时间或结束时间格式错误。日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	结束时间早于开始时间，请检查。
400	InvalidTimeSpan	The time span exceeds the limit.	时间跨度超过限制，请参照接口文档，配置合理查询跨度。
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	不支持该开始时间，请重新填写。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。