最近更新时间:2024.04.01 18:01:10
首次发布时间:2023.10.16 10:38:47
此接口用于查询指定时间范围内的流量。
请求地址:https://vod.volcengineapi.com?Action=DescribeVodDomainTrafficData&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVodDomainTrafficData | 接口名称。当前 API 的名称为 DescribeVodDomainTrafficData 。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01 。 |
DomainList | String | 否 |
| 域名列表。多个域名之间用英文逗号 说明
|
DomainInSpaceList | String | 是 |
| 点播空间名和域名列表。多个域名之间用 说明 如果是 POST 请求,此参数类型为 Array of String。 |
StartTime | String | 是 |
| 查询的起始时间。日期格式要求符合 RFC3339 规范。 说明 开始时间最早不早于当前时间的 366 天。 |
EndTime | String | 是 |
| 查询的结束时间。日期格式要求符合 RFC3339 规范。 说明 单次查询的时间跨度不可超过 93 天。 |
Aggregation | Integer | 否 |
| 聚合的时间粒度。单位为秒。取值如下:
|
TrafficType | String | 否 |
| 流量类型。默认为
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["www.test.com"] | 域名列表。 |
StartTime | String | 2022-04-18T20:00:00Z | 查询的起始时间。 |
EndTime | String | 2022-04-18T22:00:00Z | 查询的结束时间。 |
Aggregation | Integer |
| 聚合的时间粒度。单位为秒。取值如下:
|
TrafficType | String |
| 流量类型。取值如下:
|
TotalTraffic | Double | 1.1 | 所选时间段的总流量,单位为 B。 |
TrafficDataList | Array of TrafficDataList | - | 流量详细数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | String | 2022-04-18T20:00:00Z | 时间。日期格式要求符合 RFC3339 规范,时区为 0 时区。 |
Traffic | Double | 1.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 } ] } }
本接口无特有的错误码。更多信息请见公共错误码。
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: