You need to enable JavaScript to run this app.
导航
查询带宽用量
最近更新时间:2023.11.02 10:20:29首次发布时间:2022.04.28 18:02:35

此接口用于查询指定时间范围内的带宽用量。

请求说明

  • 接口名称:DescribeVodDomainBandwidthData
  • 接口地址:http://vod.volcengineapi.com/?Action=DescribeVodDomainBandwidthData&Version=2020-08-01
  • 请求频率:单用户请求频率限制为 10 次/秒
  • 数据延迟:1 天

请求参数

参数

类型

是否必选

描述

Action

String

接口名称。当前接口取值为 DescribeVodDomainBandwidthData

Version

String

接口版本。当前接口取值为 2020-08-01

DomainList

Array of String

域名列表。

说明

  • 如果是 GET 请求,此参数类型为 String,多个域名之间用 , 隔开。
  • DomainListDomainInSpaceList 两个参数二选一,不能同时设置。

DomainInSpaceList

Array of String

点播空间名和域名列表。格式为空间:域名,例如 vod-player-test:vod-player-test.volcvod.com

说明

如果是 GET 请求,此参数类型为 String,多个域名之间用 , 隔开。

StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

EndTime

String

查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T22:00:00Z

说明

单次查询的时间跨度不可少于 5 分钟,不可超过 93 天。

Aggregation

Integer

聚合的时间粒度。单位为秒。取值如下:

  • 300:(默认)5 分钟
  • 1800:30 分钟
  • 3600:1 小时
  • 86400:1 天

BandwidthType

String

带宽类型。默认值为 CDN。取值如下:

  • CDN
  • All
  • ECDN

Area

String

计费区域。默认返回所有区域的数据。取值如下:

  • CHN:中国内地
  • EU:欧洲
  • NA:北美
  • SA:南美
  • ME:中东
  • AP1:亚太一区
  • AP2:亚太二区
  • AP3:亚太三区
  • All:全部区域
  • OverSeas:除中国内地外的区域

说明

亚太一区、二区、三区包含的国家和地区详见亚太计费区说明

返回参数

参数

类型

描述

ResponseMetadata

ResponseMetadata

响应通用信息

Result

VodDescribeVodDomainBandwidthDataResult

响应结果

ResponseMetadata

参数

类型

描述

RequestId

String

请求 ID

Action

String

请求接口

Version

String

版本

Service

String

服务

Region

String

区域

Error

ResponseError

异常信息

ResponseError

参数

类型

描述

Code

String

错误码

Message

String

详细错误信息

VodDescribeVodDomainBandwidthDataResult

参数

类型

描述

DomainList

Array of String

域名列表。

DomainInSpaceListArray of String点播空间名和域名列表。

StartTime

String

查询起始时间。

EndTime

String

查询结束时间。

Aggregation

Integer

聚合的时间粒度。单位为秒。取值如下:

  • 300:5 分钟
  • 1800:30 分钟
  • 3600:1 小时
  • 86400:1 天

Area

String

计费区域。 取值如下:

  • CHN:中国内地
  • EU:欧洲
  • NA:北美
  • SA:南美
  • ME:中东
  • AP1:亚太一区
  • AP2:亚太二区
  • AP3:亚太三区
  • All:全部区域
  • OverSeas:除中国内地外的区域

说明

亚太一区、二区、三区包含的国家和地区详见亚太计费区说明

BandwidthType

String

带宽类型。取值如下:

  • CDN
  • ALL
  • ECDN
PeakBandwidthDouble所选时间段的带宽峰值。单位为 Mbps。

PeakBandwidthTime

String

带宽峰值出现的时间。日期格式要求符合 RFC3339 规范,时区为 0 时区。

Peak95Bandwidth

Float

所选时间段的带宽 95 峰值,单位为 Mbps。

Peak95BandwidthTimeString带宽 95 峰值出现的时间。日期格式要求符合 RFC3339 规范,时区为 0 时区。
BandwidthDataListArray of BandwidthData带宽用量详细数据。

BandwidthData

参数

类型

描述

Time

String

时间。日期格式要求符合 RFC3339 规范,时区为 0 时区。

Bandwidth

Double

带宽,单位为 Mbps。

示例

请求示例

如果用 POST 方式发起请求,示例如下:

POST https://vod.volcengineapi.com?Action=DescribeVodDomainBandwidthData&Version=2020-08-01 HTTP/1.1
Content-Type: application/json

{
  "DomainList": ["www.test.com"],
  "StartTime":   "2022-04-18T20:00:00Z",
  "EndTime":     "2022-04-18T22:00:00Z",
  "BandwidthType": "CDN",
  "Area":"CHN"
}

如果用 GET 方式发起请求,示例如下:

GET https://vod.volcengineapi.com?Action=DescribeVodDomainBandwidthData&Version=2020-08-01&DomainList=www.test.com&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3A00Z&BandwidthType=CDN&Area=CHN HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata": 
  {
    "RequestId": "2020112416571***5107034080031B5",
    "Action": "DescribeVodDomainBandwidthData",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": 
  {
    "DomainList": ["www.test.com"],
    "DomainInSpaceList": ["test:www.test.com"],// 与 DomainList 二选一
    "StartTime":   "2022-04-18T20:00:00Z",
    "EndTime":     "2022-04-18T22:00:00Z",
    "Aggregation": 300,
    "Area": "CHN",
    "BandwidthType": "CDN",
    "PeakBandwidth": 1.1,
    "PeakBandwidthTime": "2022-04-18T20:00:00Z",
    "Peak95Bandwidth": 1.1,
    "Peak95BandwidthTime": "2022-04-18T20:00:00Z",
    "BandwidthDataList": [
        {
            "Time": "2022-04-18T20:00:00Z",
            "Bandwidth": 1.1
        }
    ]
  }
}

错误码

详见视频点播公共错误码

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: