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

说明

  • 支持批量域名查询,多个域名用逗号(,)分隔,最多可以一次查询100个域名。如果为空则返回账号下所有域名的数据。
  • 用量数据包括流量、带宽和请求数三类,单位分别为byte、bps和次。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDomainUsageData

操作接口名,系统规定参数。取值:DescribeDomainUsageData

EndTime String 2015-12-10T22:00:00Z

获取数据结束时间。结束时间需大于起始时间,不能相差超过31天。

日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

Field String bps

请求的数据类型。包括:bpstrafacc。其中acc不支持area参数。

StartTime String 2015-12-10T20:00:00Z

获取数据起始时间点。

日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。最小数据粒度为5分钟。

Area String CN

区域代号。包括:CNOverSeasAP1AP2AP3NASAEUMEAAall

不传为CN:中国大陆。

DataProtocol String all

需要获取的数据的协议。包括httpshttpall。默认为all

DomainName String example.com

如果参数为空,默认返回所有加速域名合并后数据。

可以输入需要查询的加速域名,支持批量域名查询,多个域名用逗号(,)分隔。

Interval String 300

强制指定获取指定时间粒度的数据。支持300360086400,分别代表5分钟、1小时和1天。

说明
  • 如果指定Interval为300,最长可查询近半年的数据,单次查询时间跨度最长为3天。
  • 如果指定Interval为3600或86400,最长可查询近1年的数据。
  • 如果不指定Interval,单次查询跨度最长为1个月。当查询时间为1-3天时,数据按小时粒度返回;当查询时间大于4天时,数据按天粒度返回。

计费数据和参数取值的对应关系如下表。

计费数据

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

返回数据

名称 类型 示例值 描述
Area String CN

用量区域。

DataInterval String 300

每条记录的时间间隔,以秒为单位。

DomainName String example.com

加速域名。

EndTime String 2015-12-10T22:00:00Z

结束时间。

RequestId String B955107D-E658-4E77-B913-E0AC3D31693E

请求ID。

StartTime String 2015-12-10T20:00:00Z

开始时间。

Type String static

用量类型。

UsageDataPerInterval

每个时间间隔的流量数据。

PeakTime String 2015-12-10T21:30:00Z

Fieldbps时,该值为峰值带宽时刻,否则值和TimeStamp相同。

SpecialValue String xxxx

特殊用量。

TimeStamp String 2015-12-10T21:30:00Z

时间片起始时刻。

Value String 423304182

用量。单位:byte

示例

请求示例

http://cdn.aliyuncs.com?Action=DescribeDomainUsageData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=traf
&Area=CN
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDomainUsageDataResponse>
	  <DomainName>example.com</DomainName>
	  <DataInterval>300</DataInterval>
	  <UsageDataPerInterval>
		    <DataModule>
			      <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
			      <PeakTime>2015-12-10T20:05:00Z</PeakTime>
			      <Value>423304182</Value>
		    </DataModule>
		    <DataModule>
			      <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
			      <PeakTime>2015-12-10T21:30:00Z</PeakTime>
			      <Value>454680793</Value>
		    </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>
</DescribeDomainUsageDataResponse>

JSON 格式

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

错误码

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