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

使用说明

此接口支持批量域名查询，多个域名用英文逗号（,）分隔，最多一次可以查询100个域名。如果DomainName参数为空，则返回账号下所有域名的数据。（暂不支持查询单个域名下的某个地址用量数据）
此接口可以用作计费的用量数据参考。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDomainUsageData	系统规定参数。取值：DescribeDomainUsageData。
StartTime	String	是	2015-12-10T20:00:00Z	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime	String	是	2015-12-10T21:00:00Z	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。需大于起始时间，且与起始时间相差不能超过31天。
Field	String	是	traf	查询用量的数据类型。取值： bps：带宽。 traf：流量。
DomainName	String	否	example.com	播流域名。支持批量域名查询，多个域名用英文逗号（,）分隔。若参数为空，默认返回所有直播域名合并后的数据。
Area	String	否	CN	区域代号。支持： CN：中国内地。 OverSeas：海外大区。 AP1：亚太1区。 AP2：亚太2区。 AP3：亚太3区。 NA：北美。 SA：南美。 EU：欧洲。 MEAA：中东非洲。 all：全部。说明不传值则默认为中国内地。海外大区说明：亚太1区：中国香港、日本、中国台湾、中国澳门以及东南亚除越南和印尼之外的国家。亚太2区：印度、印尼、韩国、越南。亚太3区：澳大利亚、新西兰。北美：美国、加拿大。南美：巴西。欧洲：俄罗斯、乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。中东非洲：南非、阿曼、阿联酋、科威特。
Interval	String	否	300	查询数据的时间粒度。单位：秒。取值： 300 3600 86400 说明不传或传值不支持时，使用默认值300秒。如果不指定Interval，单次查询跨度最长为1个月。查询时间为1~3天，数据按小时粒度返回；查询时间大于3天，数据按天粒度返回。指定Interval为300时，单次查询时间跨度最长为3天。指定Interval为300时，最长可查询近半年的数据。指定Interval为3600或86400时，最长可查询近1年的数据。
Type	String	否	all	需要获取的用量类型。取值： rts：RTS带宽或流量。 all：全部。

说明

接口查询T时刻数据时，T+N时刻可获取到稳态数据，N为2小时。

示例：当您查询12月21日下午1点钟数据，可在12月21日下午3点钟获取到1点及1点前的稳态数据。

返回数据


名称	类型	示例值	描述
DomainName	String	example.com	播流域名。
DataInterval	String	300	每条记录的时间间隔。单位：秒。
UsageDataPerInterval	Array of DataModule		每条记录的流量数据。
DataModule
TimeStamp	String	2015-12-10T20:00:00Z	时间片起始时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Value	String	423304182	用量。当Field为traf时单位是字节（Byte）。当Field为bps的单位是bps。
RequestId	String	B955107D-E658-4E77-B913-E0AC3D31693E	请求ID。
StartTime	String	2015-12-10T20:00Z	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime	String	2015-12-10T21:00Z	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Area	String	CN	用量区域。
Field	String	traf	用量类型。取值： bps：带宽。 traf：流量。

示例

请求示例

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

正常返回示例

XML格式

<DescribeDomainUsageDataResponse>
  <DomainName>example.com</DomainName>
  <DataInterval>300</DataInterval>
  <UsageDataPerInterval>
        <DataModule>
              <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
              <Value>423304182</Value>
        </DataModule>
        <DataModule>
              <TimeStamp>2015-12-10T20:05:00Z</TimeStamp>
              <Value>454680793</Value>
        </DataModule>
        <DataModule>
              <TimeStamp>2015-12-10T20:10:00Z</TimeStamp>
              <Value>501718342</Value>
        </DataModule>
        <DataModule>
              <TimeStamp>2015-12-10T20:15:00Z</TimeStamp>
              <Value>434816025</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格式

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

错误码

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

特殊错误码


错误代码	描述	HTTP 状态码	语义
Throttling	Request was denied due to request throttling.	503	请求被流量控制限制
IllegalOperation	Illegal domain, operation is not permitted.	403	非法域名，无法操作
OperationDenied	Your account does not open Live service yet.	403	未开通Live服务
OperationDenied	Your Live service is suspended.	403	Live服务已被停止
InvalidDomain.NotFound	The domain provided does not belong to you.	404	域名不存在或不属于当前用户
InvalidDomain.Offline	The domain provided is offline.	404	域名已下线
ServiceBusy	The specified Domain is configuring, please retry later.	403	域名正在配置中，请稍后再试
InvalidDomain.Configure_failed	Failed to configure the provided domain.	500	域名配置失败
InvalidParameter	Invalid Parameter.	400	参数错误
InvalidParameterProduct	Invalid Parameter Product.	400	Product参数错误
InvalidParameterArea	Invalid Parameter Area.	400	Area参数错误
InvalidParameterField	Invalid Parameter Field.	400	Field参数错误
InvalidParameterStartTime	Invalid Parameter StartTime.	400	StartTime参数错误
InvalidParameterEndTime	Invalid Parameter EndTime.	400	EndTime参数错误
InvalidTimeRange	StartTime and EndTime range should less than 1 month.	400	SndTime和StartTime差值不能超过31天
InvalidParameterInterval	Invalid Parameter Interval.	400	Interval参数错误