DescribeVodDomainRealTimeByteHitRateData - 查询实时字节命中率

调用本接口查询加速域名的字节命中率数据。本接口支持查询的数据时间粒度最小为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:DescribeVodDomainRealTimeByteHitRateData

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DomainName

string

要查询的加速域名。

  • 多个域名用半角逗号(,)分隔,一次最多支持 100 个域名查询。

  • 查询多个域名时,返回的数据为各域名合并后的数据值。

  • 您可以登录视频点播控制台,从左侧导航选择配置管理 > 分发加速配置 > 域名管理,查看您已接入到视频点播的加速域名,或者调用 DescribeVodUserDomains 接口查询加速域名列表。

example.com

StartTime

string

获取数据的起始时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

2020-05-15T09:13:00Z

EndTime

string

获取数据的结束时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

说明

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

2020-05-15T09:15:00Z

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

70A26B11-3673-479C-AEA8-E03FC5D3496D

Data

object

ByteHitRateDataModel

array<object>

返回数据详情。

object

ByteHitRate

number

字节命中率(百分比数据)。

0.8956940476262277

TimeStamp

string

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

2020-05-15T09:13:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "70A26B11-3673-479C-AEA8-E03FC5D3496D",
  "Data": {
    "ByteHitRateDataModel": [
      {
        "ByteHitRate": 0.8956940476262277,
        "TimeStamp": "2020-05-15T09:13:00Z"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidTime.Malformed Specified StartTime or EndTime is malformed.
400 InvalidDomainName.Malformed Specified domain name is malformed.
400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间格式错误。
400 InvalidParameterType The specified Type is invalid. 指定的Type参数错误,请根据文档修改传入的Type参数。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 InvalidParameter Invalid input parameter. 输入参数错误。

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

变更历史

更多信息,参考变更详情