文档

DescribeVodDomainRealTimeTrafficData - 查询实时流量

更新时间:

调用DescribeVodDomainRealTimeTrafficData查询加速域名的流量数据,相比DescribeVodDomainTrafficData接口,本接口支持查询的数据时间粒度更小(最小为1分钟),数据延迟更低(最少为5分钟),但可查询的历史数据时间范围更短(最长可查询最近186天的数据)。

接口说明

  • 目前该接口服务地址仅支持:华东 2(上海)
  • 支持批量查询,一次最多查询 100 个域名数据。
  • 如果您不指定StartTimeEndTime,该接口默认返回过去 1 小时的数据;指定StartTimeEndTime,该接口返回指定时间段的数据。

返回数据时间粒度

根据您指定StartTimeEndTime时间跨度,会返回不同的数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度单次查询的时间跨度可查询历史数据时间范围数据延迟
1 分钟单次查询的时间跨度 ≤ 1 小时7 天5 分钟
5 分钟1 小时 < 单次查询的时间跨度 < 3 天93 天15 分钟
1 小时3 天 ≤ 单次查询的时间跨度 <31 天186 天一般延迟 3-4 小时

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:DescribeVodDomainRealTimeTrafficDataRead
  • 全部资源
    *

请求参数

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

要查询的加速域名。

  • 多个域名用半角逗号(,)分隔,一次最多支持 100 个域名查询。
  • 查询多个域名时,返回的数据为各域名合并后的数据值。
  • 您可以登录视频点播控制台,从左侧导航选择配置管理 > 分发加速配置 > 域名管理,查看您已接入到视频点播的加速域名,或者调用 DescribeVodUserDomains 接口查询加速域名列表。
example.com
StartTimestring

获取数据的起始时间点。

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

2019-12-10T20:00:00Z
EndTimestring

获取数据的结束时间点。

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

说明 结束时间需大于起始时间。
2019-12-10T20:01:00Z
IspNameEnstring

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

telecom
LocationNameEnstring

地域英文名。不传该参数默认查询所有地域。

shanghai

返回参数

名称类型描述示例值
object
EndTimestring

数据的结束时间点。

2019-12-10T20:01:00Z
StartTimestring

数据的起始时间点。

2019-12-10T20:00:00Z
RequestIdstring

请求 ID。

A666D44F-19D6-490E-97CF-1A64AB962C57
DomainNamestring

加速域名。

example.com
DataIntervalstring

每条数据的时间间隔,即数据的时间粒度,单位:秒。

根据单次查询的时间跨度不同,该参数固定返回 60(1 分钟)、300(5 分钟)或 3600(1 小时),具体请参见接口说明中的返回数据时间粒度

60
RealTimeTrafficDataPerIntervalobject []

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

Valuestring

流量数据,单位:Byte。

0
TimeStampstring

数据时间戳。日期格式按照 ISO8601 表示法,并使用 UTC 时间。

2019-12-10T20:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2019-12-10T20:01:00Z",
  "StartTime": "2019-12-10T20:00:00Z",
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeTrafficDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2019-12-10T20:00:00Z"
      }
    ]
  }
}

错误码

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

  • 本页导读 (1)