Domain name for API request: vod.tencentcloudapi.com.
This API is used to query the CDN statistics of VOD such as traffic and bandwidth.
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 in ISO date format. |
EndTime | Yes | String | End date in ISO date format. The end date must be after the start date. |
DataType | Yes | String | CDN statistics type. Valid values: |
SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
DataInterval | No | Integer | Time granularity of usage data in minutes. Valid values: Default value: 1440. Data at 1-day granularity will be returned. |
DomainNames.N | No | Array of String | List of domain names. The usage data of up to 20 domain names can be queried at a time. You can specify multiple domain names and query their combined usage data. The usage data of all domain names will be returned by default. |
Parameter Name | Type | Description |
---|---|---|
DataInterval | Integer | Time granularity in minutes. |
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. |
This example shows you how to query CDN traffic statistics between December 1, 2018 (inclusive) and December 3, 2018 (inclusive).
https://vod.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"
}
}
123.vod2.myqcloud.com
and test.a.com
between December 1, 2018 and December 3, 2018.This example shows you how to query CDN traffic statistics between December 1, 2018 (inclusive) and December 3, 2018 (inclusive).
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
&<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"
}
}
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
&<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 | Incorrect parameter value. |
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. |
Was this page helpful?