You need to enable JavaScript to run this app.
导航

查询流量用量

最近更新时间2024.01.16 20:28:07

首次发布时间2023.10.16 10:38:47

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

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 权限说明:当使用子账号请求接口时,接口会按照子账号进行权限校验,只返回该子账号有权限的数据。详见给子账号添加项目权限说明。
  • 数据延迟:1 天

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringDescribeVodDomainTrafficData接口名称。当前 API 的名称为 DescribeVodDomainTrafficData
VersionString2023-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.co

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

说明

如果是 POST 请求,此参数类型为 Array of String。

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

EndTime

String

2022-04-19T20:00:00Z

查询的结束时间。日期格式要求符合 RFC3339 规范。

说明

单次查询的时间跨度不可超过 93 天。

Aggregation

Integer

300

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

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

TrafficType

String

CDN

流量类型。默认为 CDN。取值如下:

  • CDN
  • ALL
  • ECDN

返回参数

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

参数类型示例值描述
DomainListArray of String["www.test.com"]域名列表。
StartTimeString2022-04-18T20:00:00Z查询的起始时间。
EndTimeString2022-04-18T22:00:00Z查询的结束时间。

Aggregation

Integer

300

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

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

TrafficType

String

CDN

流量类型。取值如下:

  • CDN
  • ALL
  • ECDN
TotalTrafficDouble1.1所选时间段的总流量,单位为 B。
TrafficDataListArray of TrafficDataList-流量详细数据。

TrafficDataList

参数类型示例值描述
TimeString2022-04-18T20:00:00Z时间。日期格式要求符合 RFC3339 规范,时区为 0 时区。
TrafficDouble1.1流量,单位为 B。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodDomainTrafficData&Version=2023-07-01&Aggregation=300&DomainInSpaceList=vod-player-test%3Avod-player-test.volcvod.com&DomainList=%5B%22www.test.com%22%5D&EndTime=2022-04-18T22%3A00%3A00Z&StartTime=2022-04-18T20%3A00%3A00Z&TrafficType=CDN

返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "201806041104***00100232280022D30",
        "Action": "DescribeVodDomainTrafficData",
        "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": "AP1",
       "TrafficType": "CDN",
       "TotalTraffic": 1.1,
       "TrafficDataList": [
        {
            "Time": "2022-04-18T20:00:00Z",
            "Traffic": 1.1
        }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码

服务端 SDK

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