查询域名在特定计费区域的用量数据 - 全站加速

使用说明

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

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


时间粒度	单次查询的最大时间跨度	可查询历史数据时间范围	数据延迟
5分钟	3天	93天	15分钟
1小时	31天	186天	4小时
1天	366天	366天	次日凌晨4点

调试

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

请求参数


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

参数组合说明

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


计费数据	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

返回数据


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

示例

请求示例

获取中国内地流量
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=traf
&Area=CN
&<公共请求参数>

获取EU大区的带宽
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=bps
&Area=EU
&<公共请求参数>

获取静态HTTPS请求数 
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Type=static
&DataProtocol=https
&Field=acc
&Area=all
&<公共请求参数>

获取动态HTTP请求数 
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Type=dynamic
&DataProtocol=http
&Field=acc
&Area=all
&<公共请求参数>

获取动态HTTPS请求数 
http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Type=dynamic
&DataProtocol=https
&Field=acc
&Area=all
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnDomainUsageDataResponse>
<DomainName>example.com</DomainName>
<UsageDataPerInterval>
    <DataModule>
        <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
        <PeakTime>2015-12-10T20:05:00Z</PeakTime>
        <Value>4233041**</Value>
        <SpecialValue>4233041**</SpecialValue>
    </DataModule>
    <DataModule>
        <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
        <PeakTime>2015-12-10T21:30:00Z</PeakTime>
        <Value>4546807**</Value>
        <SpecialValue>4233041**</SpecialValue>
    </DataModule>
</UsageDataPerInterval>
<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
<StartTime>2015-12-10T20:00Z</StartTime>
<EndTime>2015-12-10T21:00Z</EndTime>
<Area>CN</Area>
<Type>traf</Type>
</DescribeDcdnDomainUsageDataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	无效的参数值。
400	InvalidParameterProduct	The specified Product is invalid.	Product参数错误
400	InvalidParameterArea	The specified Area is invalid.	Area参数错误
400	InvalidParameterField	The specified Field is invalid.	Field参数错误
400	InvalidParameterStartTime	The specified StartTime is invalid.	StartTime参数错误
400	InvalidParameterEndTime	The specified EndTime is invalid.	EndTime参数错误
400	InvalidTimeRange	The time span between the StartTime and the EndTime cannot exceed 31 days.	EndTime和StartTime差值不能超过31天
400	InvalidParameterInterval	The specified Interval is invalid.	Interval参数错误

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