调用DescribeVodDomainUsageData查询加速流量或带宽用量数据。

说明
  • 目前服务地址仅支持:华东2(上海)
  • 支持批量域名查询,多个域名用逗号半角(,)分隔,最多可以一次查询100个域名。如果为空则返回账号下所有域名的数据。
  • 最长可查询近1年的数据,单次查询跨度最长为3个月,查询时间为1-3天时,数据按小时粒度返回,查询时间大于4天,数据按天粒度返回。

调试

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

请求参数

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

系统规定参数。取值:DescribeVodDomainUsageData

DomainName String example.com

加速域名。若参数为空,默认返回所有加速域名合并后数据。支持批量查询,多个用半角逗号(,)分隔。

StartTime String 2015-12-10T10:20:00Z

获取数据起始时间点。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime String 2015-12-10T12:20:00Z

获取数据结束时间点,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Type String static

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

  • static:静态。
  • dynamic:动态。
  • all:全部。
Area String CN

地域代号。默认为CN中国大陆。取值:

  • CN:中国大陆。
  • OverSeas:海外区域。
Field String bps

数据类型。取值:

  • bps:带宽。
  • traf:流量。

返回数据

名称 类型 示例值 描述
EndTime String 2015-12-10T12:20:00Z

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Type String static

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

  • static:静态。
  • dynamic:动态。
  • all:全部。
StartTime String 2015-12-10T10:20:00Z

开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

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

请求ID。

Area String CN

用量区域。

DomainName String example.com

加速域名信息。

DataInterval String 300

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

UsageDataPerInterval Array of DataModule

流量或带宽用量数据。

DataModule
Value String 2592.3920000000003

流量或带宽用量。单位:bit/second。

TimeStamp String 2015-12-10T10:00:00Z

时间片起始时刻。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribeVodDomainUsageData
&EndTime=2015-12-10T12:20:00Z
&Field=bps
&StartTime=2015-12-10T10:20:00Z
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeVodDomainUsageDataResponse>
    <RequestId>B955107D-E658-4E77-****-E0AC3D31693E</RequestId>
    <StartTime>2015-12-10T10:20:00Z</StartTime>
    <EndTime>2015-12-10T12:21:00Z</EndTime>
    <Area>CN</Area>
    <Type>static</Type>
    <DomainName>example.com</DomainName>
    <DataInterval>300</DataInterval>
    <UsageDataPerInterval>
        <UsageData>
            <TimeStamp>2015-12-10T11:00:00Z</TimeStamp>
            <Value>2592.3920000000003</Value>
        </UsageData>
        <UsageData>
            <TimeStamp>2015-12-10T11:05:00Z</TimeStamp>
            <Value>2592.3920000000003</Value>
        </UsageData>
    </UsageDataPerInterval>
</DescribeVodDomainUsageDataResponse>

JSON格式

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

{
  "DescribeVodDomainUsageDataResponse" : {
    "RequestId" : "B955107D-E658-4E77-****-E0AC3D31693E",
    "StartTime" : "2015-12-10T10:20:00Z",
    "EndTime" : "2015-12-10T12:21:00Z",
    "Area" : "CN",
    "Type" : "static",
    "DomainName" : "example.com",
    "DataInterval" : 300,
    "UsageDataPerInterval" : {
      "UsageData" : [ {
        "TimeStamp" : "2015-12-10T11:00:00Z",
        "Value" : 2592.3920000000003
      }, {
        "TimeStamp" : "2015-12-10T11:05:00Z",
        "Value" : 2592.3920000000003
      } ]
    }
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

Throttling

Request was denied due to request throttling.

503

请求被流量控制限制。

IllegalOperation

Illegal domain, operation is not permitted.

403

非法域名, 无法操作。

OperationDenied

Your account does not open CDN service yet.

403

未开通CDN服务。

OperationDenied

Your CDN service is suspended.

403

CDN服务已被停止。

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

EndTime和StartTime差值不能超过31天。

InvalidParameterInterval

Invalid Parameter Interval.

400

Interval参数错误。

.