You need to enable JavaScript to run this app.
导航
查询流量用量
最近更新时间:2023.08.03 14:29:11首次发布时间:2022.08.03 11:15:32

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

请求说明

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

请求参数

参数

类型

是否必选

描述

Action

String

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

Version

String

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

DomainList

Array of String

域名列表。

说明

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

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-18T20:00:00Z

说明

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

Aggregation

Integer

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

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

TrafficType

String

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

  • CDN
  • ALL
  • ECDN

返回参数

参数

类型

描述

ResponseMetadata

ResponseMetadata

响应通用信息

Result

VodDescribeVodDomainTrafficDataResult

响应结果

ResponseMetadata

参数

类型

描述

RequestId

String

请求 ID

Action

String

请求接口

Version

String

版本

Service

String

服务

Region

String

区域

Error

ResponseError

异常信息

ResponseError

参数

类型

描述

Code

string

错误码

Message

string

详细错误信息

VodDescribeVodDomainTrafficDataResult

参数

类型

描述

DomainList

Array of String

域名列表。

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

StartTime

String

查询起始时间。

EndTime

String

查询结束时间。

Aggregation

Integer

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

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

TrafficType

String

流量类型。取值如下:

  • CDN
  • ALL
  • ECDN
TotalTrafficFloat所选时间段的总流量,单位为 GB。

TrafficDataList

Array of VodTrafficData

流量详细数据。

VodTrafficData

参数

类型

描述

Time

String

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

Traffic

Float

流量,单位为 GB。

示例

请求示例

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

POST https://vod.volcengineapi.com?Action=DescribeVodDomainTrafficData&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",
  "TrafficType": "CDN"
}

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

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

返回示例

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

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

错误码

详见视频点播公共错误码

服务端 SDK

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