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

使用说明

  • 单用户调用频率:10次/秒。
  • 支持查询的时间粒度:根据单次查询的最大时间跨度不同,请求参数Interval支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度

单次查询的最大时间跨度

可查询历史数据时间范围

数据延迟

5分钟

3天

93天

15分钟

1小时

31天

186天

4小时

1天

90天

366天

次日凌晨4点

调试

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

请求参数

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

系统规定参数。取值:DescribeDomainUsageData

Type String static

需要获取的用量类型。取值:

  • static:静态。
  • dynamic:动态。
  • all(默认):全部。
DataProtocol String all

需要获取的数据的协议。取值:

  • http:HTTP协议。
  • https:HTTPS协议。
  • quic:QUIC协议。
  • all(默认):以上全部协议。
DomainName String example.com

需要查询的加速域名。支持批量查询,多个域名用英文逗号(,)分隔,一次最多可以查询100个域名。

说明 如果参数为空,默认返回账号下所有加速域名合并后的数据。
StartTime String 2015-12-10T20:00:00Z

获取数据的起始时间点。

日期格式按照ISO 8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 查询数据时间粒度为5分钟。
EndTime String 2015-12-10T22:00:00Z

获取数据的结束时间点。

日期格式按照ISO 8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需晚于起始时间,且时间相差不能超过31天。
Area String CN

区域代号。取值:

  • CN(默认):中国内地。
  • OverSeas:全球(不包含中国内地)。
  • AP1:亚太1区。
  • AP2:亚太2区。
  • AP3:亚太3区。
  • NA:北美。
  • SA:南美。
  • EU:欧洲。
  • MEAA:中东、非洲。
  • all:以上全部区域。
Field String bps

请求的数据类型。取值:

  • bps:带宽。
  • traf:流量。
  • acc:请求数。
说明 acc不支持根据Area参数查询。
Interval String 300

强制指定获取指定时间粒度的数据,单位为秒。支持300(5分钟)、3600(1小时)和86400(1天)。

  • Interval=300:最长可查询最近半年的数据,单次查询的时间跨度最长为3天。
  • Interval=360086400:最长可查询最近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

动态QUIC请求数

quic

dynamic

acc

all

静态QUIC请求数

quic

static

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 300

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

UsageDataPerInterval Array of DataModule

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

DataModule
Value String 423304182

用量。

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

时间片起始时刻。

说明 返回数据中包含的多个TimeStamp称为时间片。
PeakTime String 2015-12-10T21:30:00Z

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

SpecialValue String 423304182

特殊用量。

说明 用来标记特殊情况下的用量值,没有特殊计费可忽略该参数。

示例

请求示例

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

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

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

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

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

正常返回示例

XML格式

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

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

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" : "423304182",
      "SpecialValue" : "423304182"
    }, {
      "TimeStamp" : "2015-12-10T21:00:00Z",
      "PeakTime" : "2015-12-10T21:30:00Z",
      "Value" : "454680793",
      "SpecialValue" : "423304182"
    } ]
  },
  "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime" : "2015-12-10T20:00Z",
  "EndTime" : "2015-12-10T21:00Z",
  "Area" : "CN",
  "Type" : "traf"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameterProduct Invalid Parameter Product. Product参数错误
400 InvalidTimeRange Invalid StartTime and EndTime range. 开始时间和结束时间范围无效。

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