Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query CDN bandwidth, traffic volume and stats of on-demand 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 Params. The value used for this API: DescribeCDNStatDetails. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Metric | Yes | String | Query metric. Valid values: |
| StartTime | Yes | String | Start time. Use the ISO date format. |
| EndTime | Yes | String | End time. Use the ISO date format. |
| 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). |
| DomainNames.N | No | Array of String | Domain name list. Up to 20 domain names can be queried for data. Default returns the overlaid usage data of all domains. |
| Area | No | String | Service area. Valid values: Default is Chinese mainland. |
| Districts.N | No | Array of String | When the user's located region is Chinese Mainland, value is the following region information. When Area has other values, ignore the Districts parameter. |
| Isps.N | No | Array of String | User's Operator Information. When Area is Chinese Mainland, value is the following carrier information. When Area is other values, ignore the Isps parameter. |
| DataInterval | No | Integer | Time granularity of each data entry. Unit: minute. Valid values: When the duration between StartTime and EndTime is more than 24 hours, DataInterval defaults to 1440. |
| Parameter Name | Type | Description |
|---|---|---|
| DataInterval | Integer | Time granularity of each data entry. Measurement unit: minute. |
| Data | Array of StatDataItem | CDN usage data. |
| 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. |
Query the traffic data of domain name example.com in the Chinese mainland.
https://vod.intl.tencentcloudapi.com/?Action=DescribeCDNStatDetails
&DomainNames.0=example.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 | Incorrect 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 | Parameter error: Invalid metric. |
| InvalidParameterValue.StartTime | Incorrect parameter value: invalid StartTime. |
文档反馈