Domain name for API request: vod.tencentcloudapi.com.
This API is used to query CDN bandwidth, traffic, and other data of VOD domain names.
A maximum of 20 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 parameter. The value used for this API: DescribeCDNStatDetails. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Metric | Yes | String | Metrics to query. Valid values: |
| StartTime | Yes | String | Start time in ISO date format. |
| EndTime | Yes | String | End time in ISO date format. |
| 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. The usage data of all domain names is returned by default. |
| Area | No | String | Service region. Valid values: Default value: Chinese Mainland |
| Districts.N | No | Array of String | District where users are located. When Area is Chinese Mainland, valid values for Districts are as follows. Otherwise, Districts can be ignored. |
| Isps.N | No | Array of String | ISP of users. When Area is Chinese Mainland, valid values for Isps are as follows. Otherwise, Isps can be ignored. |
| DataInterval | No | Integer | Time granularity of every piece of data in minutes. Valid values: If the difference between StartTime and EndTime is larger than 24 hours, the default value of DataInterval is 1440. |
| SubAppId | No | Integer | VOD subapplication ID. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| Parameter Name | Type | Description |
|---|---|---|
| DataInterval | Integer | Time granularity of every piece of data in minutes. |
| Data | Array of StatDataItem | CDN usage statistics. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
123.vod2.com in Chinese mainlandhttps://vod.tencentcloudapi.com/?Action=DescribeCDNStatDetails
&DomainNames.0=123.vod2.myqcloud.com
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-03T00:00:00+08:00
&Area=Chinese Mainland
&Metric=Traffic
&<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"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.InvalidAccount | User account exception. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError.DBError | Internal error. Failed to access DB. |
| InvalidParameterValue.Area | Invalid Area. |
| InvalidParameterValue.Districts | |
| InvalidParameterValue.DomainNames | Parameter value. The domain name list is too large. |
| InvalidParameterValue.EndTime | Incorrect parameter value: invalid EndTime. |
| InvalidParameterValue.Isps | Invalid Isps. |
| InvalidParameterValue.Metric | Invalid Metric. |
| InvalidParameterValue.StartTime | Incorrect parameter value: invalid StartTime. |
Was this page helpful?