获取加速域名的网络流量监控数据,单位:byte。

说明
  • 支持域名批量查询,多个域名用半角逗号分隔。
  • 不指定StartTime和EndTime时,默认读取过去24小时的数据。
  • 也可以按指定的起止时间查询,必须同时指定StartTime和EndTime,最多可获取近90天的数据。

调试

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

请求参数

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

系统规定参数。取值:DescribeVodDomainTrafficData

DomainName String example.com

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

StartTime String 2019-01-20T13:59:58Z

获取数据起始时间点。

  • 日期格式按照ISO8601表示法,使用UTC时间。格式为:YYYY-MM-DDThh:mmZ
  • 最小数据粒度为5分钟,若为空,则默认读取最近24小时的数据。
EndTime String 2019-01-20T14:59:58Z

结束时间,需大于起始时间。

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

Interval String 300

查询数据的时间粒度,支持300360086400秒。不传和传的值不支持时,使用默认值。

  • 3天以内(不包含3天整)支持300(默认), 3600, 86400。
  • 3-31天(不包含31天整)支持3600(默认)和86400。
  • 31天以上支持86400(默认)。
IspNameEn String Alibaba

运营商英文名。默认为所有运营商。

LocationNameEn String cn-shanghai

区域英文名。默认为所有区域。

返回数据

名称 类型 示例值 描述
DataInterval String 3600

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

DomainName String example.com

加速域名信息。

EndTime String 2019-01-20T14:59:58Z

结束时间。

RequestId String D94E471F-1A27-442E-****-D4D2000CB492

请求ID。

StartTime String 2019-01-20T13:59:58Z

开始时间。

TrafficDataPerInterval Array of DataModule

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

DataModule
DomesticValue String 0

国内流量。

HttpsDomesticValue String 0

L1节点https国内流量。

HttpsOverseasValue String 0

L1节点https海外流量。

HttpsValue String 0

L1节点https总流量。

OverseasValue String 0

海外流量。

TimeStamp String 2019-01-15T19:00:00Z

时间片起始时刻。

Value String 0

总流量。

说明 下述请求示例中的“公共请求参数”详情,参见公共参数说明文档

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVodDomainTrafficData
&<公共请求参数>

正常返回示例

XML 格式

<DescribeVodDomainTrafficDataResponse>
      <RequestId>D94E471F-1A27-442E-****-D4D2000CB492</RequestId>
      <EndTime>2019-01-20T14:59:58Z</EndTime>
      <TrafficDataPerInterval>
            <DataModule>
                  <OverseasValue>0</OverseasValue>
                  <HttpsValue>0</HttpsValue>
                  <Value>0</Value>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
                  <TimeStamp>2019-01-15T14:00:00Z</TimeStamp>
                  <DomesticValue>0</DomesticValue>
            </DataModule>
            <DataModule>
                  <OverseasValue>0</OverseasValue>
                  <HttpsValue>0</HttpsValue>
                  <Value>0</Value>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
                  <TimeStamp>2019-01-15T14:00:00Z</TimeStamp>
                  <DomesticValue>0</DomesticValue>
            </DataModule>
      </TrafficDataPerInterval>
      <DomainName>example.com</DomainName>
      <DataInterval>3600</DataInterval>
      <StartTime>2019-01-15T13:59:59Z</StartTime>
</DescribeVodDomainTrafficDataResponse>

JSON 格式

{
    "RequestId":"D94E471F-1A27-442E-****-D4D2000CB492",
    "EndTime":"2019-01-20T14:59:58Z",
    "TrafficDataPerInterval":{
        "DataModule":[
            {
                "OverseasValue":0,
                "HttpsValue":0,
                "Value":0,
                "HttpsDomesticValue":0,
                "HttpsOverseasValue":0,
                "TimeStamp":"2019-01-15T14:00:00Z",
                "DomesticValue":0
            },
            {
                "OverseasValue":0,
                "HttpsValue":0,
                "Value":0,
                "HttpsDomesticValue":0,
                "HttpsOverseasValue":0,
                "TimeStamp":"2019-01-15T14:00:00Z",
                "DomesticValue":0
            }
        ]
    },
    "DomainName":"example.com",
    "DataInterval":3600,
    "StartTime":"2019-01-15T13:59:59Z"
}

错误码

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

接口错误码

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

错误代码

错误信息

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

域名配置失败。

MissingParameter

StartTime and EndTime can not be single.

400

StartTime和EndTime不能单独设置。

InvalidStartTime.Malformed

Specified start time is malformed.

400

StartTime格式错误。

InvalidEndTime.Malformed

Specified end time is malformed.

400

EndTime格式错误。

InvalidEndTime.Mismatch

Specified end time does not match the specified start time.

400

EndTime小于StartTime。

InvalidStartTime.ValueNotSupported

Specified end time does not match the specified start time.

400

EndTime和StartTime差值超过90天。