首页 >视频点播 >API参考指南 >API目录 >点播CDN >数据监控 >DescribeVodDomainTrafficData - 查询加速域名的流量数据

DescribeVodDomainTrafficData - 查询加速域名的流量数据

调用DescribeVodDomainTrafficData获取加速域名的网络流量监控数据。

接口说明

使用说明

  • 支持批量查询。
  • 不指定StartTime和EndTime时,默认读取过去24小时的数据。也可以按指定的起止时间查询,必须同时指定StartTime和EndTime,最多可获取近90天的数据。

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DomainNamestring

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

example.com
StartTimestring

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

说明最小数据粒度为5分钟。若为空,则默认读取最近24小时的数据。
2019-01-20T13:59:58Z
EndTimestring

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

2019-01-20T14:59:58Z
Intervalstring

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

  • 3天以内(不包含3天整)支持:300(默认)、360086400
  • 3-31天(不包含31天整)支持:3600(默认)和86400
  • 31天以上支持:86400(默认)。
300
IspNameEnstring

运营商英文名。不传入该参数,默认查询所有运营商。

Alibaba
LocationNameEnstring

地域英文名。不传入该参数,默认查询所有地域。目前仅支持上海地域。

cn-shanghai

返回参数

名称类型描述示例值
object

返回结果。

EndTimestring

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

2019-01-20T14:59:58Z
StartTimestring

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

2019-01-20T13:59:58Z
RequestIdstring

请求ID。

D94E471F-1A27-442E-552D-D4D2000C****
DomainNamestring

加速域名信息。

example.com
TotalTrafficstring

总流量。

5906662826
DataIntervalstring

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

3600
TrafficDataPerIntervalarray

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

object

流量数据详情。

HttpsDomesticValuestring

L1节点的HTTPS流量(中国内地)。单位:byte。

0
Valuestring

总流量。单位:byte。

0
OverseasValuestring

全球(不包含中国内地)流量。单位:byte。

0
HttpsValuestring

L1节点的HTTPS总流量。单位:byte。

0
HttpsOverseasValuestring

L1节点的HTTPS流量(全球(不包含中国内地))。单位:byte。

0
TimeStampstring

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

2019-01-15T19:00:00Z
DomesticValuestring

中国内地流量。单位:byte。

0

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=DescribeVodDomainTrafficData
&DomainName=example.com
&StartTime=2019-01-20T13:59:58Z
&EndTime=2019-01-20T14:59:58Z
&Interval=300
&IspNameEn=Alibaba
&LocationNameEn=cn-shanghai
&<公共请求参数>

正常返回示例

JSON格式

{
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "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"
}

XML格式

<DescribeVodDomainTrafficDataResponse>
    <RequestId>D94E471F-1A27-442E-552D-D4D2000C****</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>

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
IllegalOperationIllegal domain, operation is not permitted.403非法域名, 无法操作。
OperationDeniedYour account does not open CDN service yet.403未开通CDN服务。
OperationDeniedYour CDN service is suspended.403CDN服务已被停止。
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。
InvalidDomain.OfflineThe domain provided is offline.404域名已下线。
ServiceBusyThe specified Domain is configuring, please retry later.403域名正在配置中, 请稍后再试。
InvalidDomain.Configure_failedFailed to configure the provided domain.500域名配置失败。
MissingParameterStartTime and EndTime can not be single.400StartTime和EndTime不能单独设置。
InvalidStartTime.MalformedSpecified start time is malformed.400StartTime格式错误。
InvalidEndTime.MalformedSpecified end time is malformed.400EndTime格式错误。
InvalidEndTime.MismatchSpecified end time does not match the specified start time.400EndTime小于StartTime。
InvalidStartTime.ValueNotSupportedSpecified end time does not match the specified start time.400EndTime和StartTime差值超过90天。
阿里云首页 视频点播 相关技术圈