1. 接口描述
接口请求域名： vod.tencentcloudapi.com 。
该接口用于查询点播 CDN 的流量、带宽等统计数据。
- 可以查询最近365天内的 CDN 用量数据。
- 查询时间跨度不超过90天。
- 可以指定用量数据的时间粒度，支持5分钟、1小时、1天的时间粒度。
- 流量为查询时间粒度内的总流量，带宽为查询时间粒度内的峰值带宽。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCDNUsageData。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| StartTime | 是 | String | 起始日期，使用 ISO 日期格式。 示例值：2018-12-01T00:00:00+08:00 |
| EndTime | 是 | String | 结束日期，需大于开始日期，使用 ISO 日期格式。 示例值：2018-12-03T00:00:00+08:00 |
| DataType | 是 | String | CDN 统计数据类型，有效值： 示例值：Flux |
| SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。 示例值：1 |
| DataInterval | 否 | Integer | 用量数据的时间粒度，单位：分钟，取值有： 默认值为1440，返回天粒度的数据。 示例值：5 |
| DomainNames.N | 否 | Array of String | 域名列表。一次最多查询20个域名的用量数据。可以指定多个域名，查询这些域名叠加的用量数据。默认返回所有域名叠加的用量数据。 示例值：["myexample.com","myexample2.com"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataInterval | Integer | 时间粒度，单位：分钟。 示例值：1440 |
| Data | Array of StatDataItem | CDN 统计数据。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询点播 CDN 的流量数据
查询2018年12月1日（含）到2018年12月3日（含）的 CDN 流量数据。
输入示例
https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Flux
&<公共请求参数>输出示例
{
"Response": {
"DataInterval": 1440,
"Data": [
{
"Time": "2018-12-01T00:00:00+08:00",
"Value": 1000000
},
{
"Time": "2018-12-02T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-03T00:00:00+08:00",
"Value": 1500000
}
],
"RequestId": "requestId"
}
}示例2 管理员查询所有域名从2018-12-01到2018-12-07的带宽数据
输入示例
https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Bandwidth
&SubAppId=1
&<公共请求参数>输出示例
{
"Response": {
"DataInterval": 1440,
"Data": [
{
"Time": "2018-12-01T00:00:00+08:00",
"Value": 700000
},
{
"Time": "2018-12-01T05:00:00+08:00",
"Value": 800000
},
{
"Time": "2018-12-01T10:00:00+08:00",
"Value": 920000
}
],
"RequestId": "requestId"
}
}示例3 查询域名123.vod2.myqcloud.com和test.a.com从2018-12-01到2018-12-07的5分钟粒度的带宽数据
输入示例
https://vod.tencentcloudapi.com/?Action=DescribeCDNUsageData
&DomainNames.0=123.vod2.myqcloud.com
&DomainNames.1=test.a.com
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Bandwidth
&DataInterval=5
&<公共请求参数>输出示例
{
"Response": {
"DataInterval": 5,
"Data": [
{
"Time": "2018-12-01T00:00:00+08:00",
"Value": 100000
},
{
"Time": "2018-12-01T05:00:00+08:00",
"Value": 200000
},
{
"Time": "2018-12-01T10:00:00+08:00",
"Value": 350000
}
],
"RequestId": "requestId"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InvalidVodUser | 没有开通点播业务。 |
| FailedOperation.NetWorkError | 网络错误。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DataInterval | 参数值错误，时间粒度。 |
| InvalidParameterValue.DataType | 参数值错误，数据类型。 |
| InvalidParameterValue.DomainName | 参数错误：不存在的域名。 |
| InvalidParameterValue.DomainNames | 参数值，域名列表太大。 |
| InvalidParameterValue.EndTime | 参数值错误：EndTime 无效。 |
| InvalidParameterValue.StartTime | 参数值错误：StartTime 无效。 |
| UnauthorizedOperation | 未授权操作。 |
