Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query traffic, bandwidth and stats of video-on-demand (VOD) CDN.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeCDNUsageData. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| StartTime | Yes | String | Start date. Use the ISO date format. |
| EndTime | Yes | String | End date, which must be greater than the start date. Use the ISO date format. |
| DataType | Yes | String | CDN statistics data type. Valid value: |
| SubAppId | No | Integer | On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created). |
| DataInterval | No | Integer | Time granularity of usage data, unit: minute. Valid values: The default value is 1440, which returns data with day granularity. |
| DomainNames.N | No | Array of String | Domain name list. Up to 20 domain names can be queried for usage data. Multiple values can be specified to query the superimposed usage data of these domains. Default returns the overlaid usage data of all domains. |
| Parameter Name | Type | Description |
|---|---|---|
| DataInterval | Integer | Time granularity, unit: minute. |
| Data | Array of StatDataItem | CDN statistics. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNUsageData
&DomainNames.0=example1.com
&DomainNames.1=example2.com
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Bandwidth
&DataInterval=5
&<Common request parameters>
{
"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"
}
}
Query the CDN traffic data from December 1, 2018 (inclusive) to December 3, 2018 (inclusive).
https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNUsageData
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Flux
&<Common request parameters>
{
"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"
}
}
https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNUsageData
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&DataType=Bandwidth
&SubAppId=1
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| FailedOperation.NetWorkError | Network error. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.DataInterval | Incorrect parameter value: time granularity. |
| InvalidParameterValue.DataType | Incorrect parameter value: data type. |
| InvalidParameterValue.DomainName | Invalid parameter: the domain name does not exist. |
| InvalidParameterValue.DomainNames | Parameter value. The domain name list is too large. |
| InvalidParameterValue.EndTime | Incorrect parameter value: invalid EndTime. |
| InvalidParameterValue.StartTime | Incorrect parameter value: invalid StartTime. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈