文档

DescribeVodDomainBpsData - 查询带宽

更新时间:

调用DescribeVodDomainBpsData查询加速域名的带宽数据,相比DescribeVodDomainRealTimeBpsData接口,本接口支持可查询的历史数据时间范围更长(最长可查询最近366天的数据),但其数据时间粒度更大(最小为5分钟),数据延迟更高。

接口说明

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

返回数据时间粒度

根据您指定StartTimeEndTime的时间跨度,且未同时设置Interval的情况下,默认返回的数据时间粒度,以及对应的可查询历史数据时间范围和数据延迟如下:

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

调试

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

授权信息

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

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

请求参数

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

要查询的加速域名。

  • 不传入该参数,则默认返回所有加速域名的合并数据。
  • 支持批量查询,多个域名之间用半角逗号(,)分隔,一次最多支持 500 个域名查询。
  • 您可以登录视频点播控制台,从左侧导航选择配置管理 > 分发加速配置 > 域名管理,查看您已接入到视频点播的加速域名,或者调用 DescribeVodUserDomains 接口查询加速域名列表。
example.com
StartTimestring

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

2015-12-10T13:00:00Z
EndTimestring

获取数据的结束时间点。

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

说明 结束时间需大于起始时间。
2015-12-10T14:00:00Z
Intervalstring

设置查询数据的时间粒度。单位:秒。取值:300360086400。不传和传的值不支持时,使用默认值。根据您指定的StartTimeEndTime的时间跨度,支持设置的时间粒度如下:

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

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

unicom
LocationNameEnstring

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

shanghai

返回参数

名称类型描述示例值
object

返回结果。

EndTimestring

数据的结束时间点。

2015-12-10T14:00:00Z
StartTimestring

数据的起始时间点。

2015-12-10T13:00:00Z
RequestIdstring

请求 ID。

3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F
IspNameEnstring

运营商英文名。

unicom
LocationNameEnstring

地域英文名。

shanghai
DomainNamestring

加速域名。

example.com
DataIntervalstring

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

300
BpsDataPerIntervalobject []

每个时间间隔的网络带宽数据列表。

HttpsDomesticValuestring

L1 节点 HTTPS 中国内地带宽。单位:bit/s。当按区域运营商查询时,此值为空。

11286111
Valuestring

总带宽数据。单位:bit/s。

11288111
OverseasValuestring

全球(不包含中国内地)带宽数据。当按区域运营商查询时,此值为空。单位:bit/s。

2000
HttpsValuestring

L1 节点 HTTPS 的带宽数据。单位:bit/s。

11288111
HttpsOverseasValuestring

L1 节点全球(不包含中国内地)HTTPS 带宽。当按区域运营商查询时,此值为空。。单位:bit/s。

2000
TimeStampstring

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

2015-12-10T13:00:00Z
DomesticValuestring

中国内地带宽。当按区域运营商查询时,此值为空。单位:bit/s。

11286111

示例

正常返回示例

JSON格式

{
  "EndTime": "2015-12-10T14:00:00Z",
  "StartTime": "2015-12-10T13:00:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-****-D47B3D92CF8F",
  "IspNameEn": "unicom",
  "LocationNameEn": "shanghai",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "11286111",
        "Value": "11288111",
        "OverseasValue": "2000",
        "HttpsValue": "11288111",
        "HttpsOverseasValue": "2000",
        "TimeStamp": "2015-12-10T13:00:00Z",
        "DomesticValue": "11286111"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更

接口错误码

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

错误代码错误信息HTTP 状态码说明
InvalidStartTime.MalformedSpecified StartTime is malformed.400StartTime 格式错误。
InvalidEndTime.MalformedSpecified EndTime is malformed.400EndTime 格式错误。
InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.400EndTime 和 StartTime 差值超过 90 天。
InvalidEndTime.MismatchSpecified EndTime does not math the specified StartTime.400EndTime 小于 StartTime。
  • 本页导读 (1)