查询带宽用量--视频点播-火山引擎

文档中心

立即注册

导航

查询带宽用量

最近更新时间：2024.07.22 21:53:07首次发布时间：2023.10.16 10:38:47

此接口用于在指定空间维度下，查询一定时间范围内的带宽用量。

注意事项

计费说明：带宽计费价格请参见按量计费
请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：1 天。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodDomainBandwidthData&Version=2023-07-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodDomainBandwidthData`	接口名称。当前 API 的名称为 `DescribeVodDomainBandwidthData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
DomainList	String	否	`www.test.com`	域名列表。多个域名之间用 `,` 隔开。您可以通过获取空间域名列表的接口获取。说明如果是 POST 请求，此参数类型为 Array of String。 `DomainList` 和 `DomainInSpaceList` 两个参数二选一，不能同时设置。
DomainInSpaceList	String	是	`vod-player-test:vod-player-test.volcvod.com`	点播空间名和域名列表。多个域名之间用 `,` 隔开。格式为`空间名:域名`。说明如果是 POST 请求，此参数类型为 Array of String。
StartTime	String	是	`2022-04-18T20:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	是	`2022-04-18T22:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明单次查询的时间跨度不可少于 5 分钟，不可超过 93 天。
Aggregation	Integer	否	`300`	聚合的时间粒度。单位为秒。取值如下： `300`：（默认）5 分钟 `1800`：30 分钟 `3600`：1 小时 `86400`：1 天
BandwidthType	String	否	`CDN`	带宽类型。取值如下：（默认）`CDN` `All`
Area	String	否	`CHN`	计费区域。默认返回所有区域的数据。取值如下： `CHN`：中国内地 `EU`：欧洲 `NA`：北美 `SA`：南美 `ME`：中东 `AP1`：亚太一区 `AP2`：亚太二区 `AP3`：亚太三区 `All`：全部区域 `OverSeas`：除中国内地外的区域说明亚太一区、二区、三区包含的国家和地区详见亚太计费区说明。
RegionList	String	否	`cn-north-1`	区域列表。默认全选，多个用英文逗号 `,` 连接。取值如下： `cn-north-1`：华北 `ap-southeast-1`：亚太东南（柔佛）说明如果是 POST 请求类型为 Array of String 。视频点播亚太东南（柔佛）地域邀测中，仅针对企业用户开放。如您有相关需求，请联系您的商务经理申请，申请通过后即可正常使用。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
DomainList	String[]	`["www.test.com"]`	域名列表。
DomainInSpaceList	String[]	`["vod-player-test:vod-player-test.volcvod.com"]`	域名空间列表。
StartTime	String	`2022-04-18T20:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	`2022-04-18T22:00:00Z`	查询结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Aggregation	Integer	`300`	聚合的时间粒度。单位为秒。取值如下： `300`：5 分钟 `1800`：30 分钟 `3600`：1 小时 `86400`：1 天
BandwidthType	String	`CDN`	带宽类型。取值如下： `CDN` `ALL`
Area	String	`CHN`	计费区域。取值如下： `CHN`：中国内地 `EU`：欧洲 `NA`：北美 `SA`：南美 `ME`：中东 `AP1`：亚太一区 `AP2`：亚太二区 `AP3`：亚太三区 `All`：全部区域 `OverSeas`：除中国内地外的区域说明亚太一区、二区、三区包含的国家和地区详见亚太计费区说明。
PeakBandwidth	Double	`1.1`	所选时间段的带宽峰值。单位为 bps。
PeakBandwidthTime	String	`2022-04-18T20:00:00Z`	带宽峰值出现的时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Peak95Bandwidth	Double	`1.1`	所选时间段的带宽 95 峰值，单位为 bps。
Peak95BandwidthTime	String	`2022-04-18T20:00:00Z`	带宽 95 峰值出现的时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
BandwidthDataList	Object[]	`-`	带宽用量详细数据。
Time	String	`2022-04-18T20:00:00Z`	数据所在时间区间的开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Bandwidth	Double	`1.1`	带宽，单位为 bps。
RegionList	String[]	`["cn-north-1"]`	区域列表。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodDomainBandwidthData&Version=2023-07-01&Aggregation=&Area=CHN&BandwidthType=CDN&DomainList=www.test.com&EndTime=2022-04-18T22:00:00Z&StartTime=2022-04-18T20:00:00Z&RegionList=cn-north-1

返回示例

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

{
  "ResponseMetadata": {
    "RequestId": "2020112416571***5107034080031B5",
    "Action": "DescribeVodDomainBandwidthData",
    "Version": "2023-07-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",
    "RegionList": ["cn-north-1"]
    "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 各语言调用的示例代码，请参考如下：