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

调用DescribeDcdnDomainUsageData查询域名在特定计费区域的用量数据。

接口说明

单用户调用频率：10 次/秒
用量数据包括流量、带宽和请求数三大类，单位分别为 Byte、bps 和次数。

支持查询的时间粒度：

根据单次查询的最大时间跨度不同，请求参数 Interval 支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：

时间粒度	单次查询的最大时间跨度	可查询历史数据时间范围	数据延迟
5 分钟	3 天	93 天	15 分钟
1 小时	31 天	186 天	一般延迟 3-4 小时
1 天	366 天	366 天	一般延迟 4 小时，最长不超过 24 小时

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	需要查询的加速域名。支持批量查询，一次最多可以查询 100 个域名，多个域名用英文逗号（,）分隔。说明如果不传该参数，默认返回所有加速域名合并后的数据。	example.com
StartTime	string	是	获取数据的起始时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：yyyy-MM-ddTHH:mm:ssZ。说明查询数据的最小粒度为 5 分钟。	2015-12-10T20:00:00Z
EndTime	string	是	获取数据的结束时间点，日期格式按照 ISO8601 表示法，并使用 UTC 时间。格式为：yyyy-MM-ddTHH:mm:ssZ 说明结束时间需大于起始时间，且时间相差不能超过 31 天。	2015-12-10T22:00:00Z
Field	string	是	请求的数据类型。取值： bps：带宽。 traf：流量。 acc：请求数。说明 acc 不支持根据 Area 参数查询。	bps
Type	string	否	请求数类型，取值： static：静态。 dynamic：动态。 all：全部。默认为 all。	dynamic
DataProtocol	string	否	需要获取的数据的协议。取值： quic：QUIC 协议。 https：HTTPS 协议。 http：HTTP 协议。 all：以上全部协议。默认为 all。	all
Area	string	否	区域代号。取值： CN：中国内地。 OverSeas：全球（不包含中国内地）。 AP1：亚太 1 区。 AP2：亚太 2 区。 AP3：亚太 3 区。 NA：北美。 SA：南美。 EU：欧洲。 MEAA：中东、非洲。 all：以上全部区域。默认为 CN。	CN
Interval	string	否	强制指定获取指定时间粒度的数据，单位为秒。根据单次查询的最大时间跨度不同，该参数支持 300（5 分钟）、3600（1 小时）和 86400（1 天）取值，具体请参见使用说明中支持查询的时间粒度。	300

参数组合说明

计费数据和参数取值的对应关系如下表，具体调用方法请参见请求示例。

计费数据	DataProtocol 参数取值	Type 参数取值	Field 参数取值	Area 参数取值
流量	all 或不传	all 或不传	traf	CN OverSeas AP1 AP2 AP3 NA SA EU MEAA
带宽	all 或不传	all 或不传	bps	CN OverSeas AP1 AP2 AP3 NA SA EU MEAA
静态 HTTPS 请求数	https	static	acc	all
动态 HTTP 请求数	http	dynamic	acc	all
动态 HTTPS 请求数	https	dynamic	acc	all

返回参数

名称	类型	描述	示例值
	object
DomainName	string	查询到的加速域名。	example.com
EndTime	string	查询数据的结束时间。	2015-12-10T22:00:00Z
StartTime	string	查询数据的开始时间。	2015-12-10T20:00:00Z
Type	string	返回的用量类型。	bps
Area	string	返回的用量区域。	CN
RequestId	string	请求 ID。	B955107D-E658-4E77-B913-E0AC3D31693E
DataInterval	string	每条记录的时间间隔，单位为秒。	/
UsageDataPerInterval	array<object>	每个时间间隔的流量数据。
DataModule	object
TimeStamp	string	时间片起始时刻。	2015-12-10T21:30:00Z
PeakTime	string	当 Field 为 bps 时，该值为峰值带宽时刻，否则值和 TimeStamp 相同。	2015-12-10T21:30:00Z
Value	string	用量。	4233041**
SpecialValue	string	特殊用量。说明用来标记特殊情况下的用量值，没有特殊计费可忽略该参数。	4233041**

示例

正常返回示例

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2015-12-10T22:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "Type": "bps",
  "Area": "CN",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DataInterval": "/",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "Value": "4233041**",
        "SpecialValue": "4233041**"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	参数错误
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	InvalidParameterField	The specified Field is invalid.	Field参数错误
400	InvalidParameterType	The specified Type is invalid.	Type参数错误，请确认后输入
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	结束时间早于开始时间，请检查。
400	InvalidTimeSpan	The time span exceeds the limit.	时间跨度超过限制，请参照接口文档，配置合理查询跨度。
400	InvalidParameterInterval	The specified Interval is invalid.	Interval参数错误

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史