Domain name for API request: cdn.tencentcloudapi.com.
This API is used to query billing data details.
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: DescribeBillingData. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-06-06. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| StartTime | Yes | Timestamp | Query start time, e.g., 2018-09-04 10:40:00. The returned result will be later than or equal to the specified time The time will be rounded forward based on the granularity parameter Interval. For example, if the query start time is 2018-09-04 10:40:00 and the query time granularity is 1-hour, the time for the first returned entry will be 2018-09-04 10:00:00The range between the start time and end time should be less than or equal to 90 days |
| EndTime | Yes | Timestamp | Query end time, e.g. 2018-09-04 10:40:00. The returned result will be earlier than or equal to the specified time The time will be rounded forward based on the granularity parameter Interval. For example, if the query end time is 2018-09-04 10:40:00 and the query time granularity is 1-hour, the time for the last returned entry will be 2018-09-04 10:00:00The range between the start time and end time should be less than or equal to 90 days |
| Interval | No | String | Time granularity, which can be: min: 1-minute. The query range should be less than or equal to 24 hours 5min: 5-minute. The query range should be less than or equal to 31 days hour: 1-hour. The query range should be less than or equal to 31 days day: 1-day. The query period should be greater than 31 days Currently, data query at 1-minute granularity is not supported if the Area field is overseas |
| Domain | No | String | Domain name whose billing data is to be queried |
| Project | No | Integer | Project ID, which can be viewed here If the Domain parameter is populated with specific domain name information, then the billing data of this domain name instead of the specified project will be returned |
| Area | No | String | Acceleration region whose billing data is to be queried: mainland: in the mainland of China overseas: outside the mainland of China If this parameter is left empty, mainland will be used by default |
| District | No | Integer | Country/region to be queried if Area is overseasFor district or country/region codes, please see District Code Mappings If this parameter is left empty, all countries/regions will be queried |
| Metric | No | String | Billing statistics type flux: bill-by-traffic bandwidth: bill-by-bandwidth Default value: bandwidth |
| Parameter Name | Type | Description |
|---|---|---|
| Interval | String | Time granularity, which is specified by the parameter passed in during the query: min: 1-minute 5min: 5-minute hour: 1-hour day: 1-day |
| Data | Array of ResourceBillingData | Data details |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdn.tencentcloudapi.com/?Action=DescribeBillingData
&StartTime=2018-09-04 00:00:00
&EndTime=2018-09-04 12:00:00
&<Common request parameter>{
"Response": {
"RequestId": "123",
"Data": [
{
"Resource": "all",
"CdnData": [
{
"Metric": "flux",
"DetailData": [
{
"Time": "2018-09-03 00:00:00",
"Value": 10
},
{
"Time": "2018-09-03 00:05:00",
"Value": 20
}
],
"SummarizedData": {
"Name": "sum",
"Value": 30
}
}
]
}
],
"Interval": "5min"
}
}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 |
|---|---|
| InternalError.CdnConfigError | Failed to update the domain name configuration. |
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InternalError.DataSystemError | Error with the data query. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnHostInvalidParam | Invalid domain name format. Please check and try again. |
| InvalidParameter.CdnInterfaceError | Internal API error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| InvalidParameter.CdnStatInvalidDate | Invalid date. Please see the sample date in the documentation. |
| InvalidParameter.CdnStatInvalidMetric | Invalid statistical type. Please see the sample statistical analysis in the documentation. |
| InvalidParameter.CdnStatInvalidProjectId | Incorrect project ID. Please check and try again. |
| ResourceNotFound.CdnHostNotExists | This domain name does not exist under the account. Please check and try again. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| UnauthorizedOperation.CdnAccountUnauthorized | The sub-account is unauthorized to query full data. |
| UnauthorizedOperation.CdnCamUnauthorized | No CAM policy is configured for the sub-account. |
| UnauthorizedOperation.CdnHostUnauthorized | The sub-account has no access to the CDN-accelerated domain name. |
| UnauthorizedOperation.CdnProjectUnauthorized | The sub-account has no access to the project. |
| UnauthorizedOperation.CdnTagUnauthorized | The sub-account has no access to the tag. |
| UnauthorizedOperation.CdnUserIsSuspended | The CDN service has been suspended. Please restart it and try again. |
| UnauthorizedOperation.CdnUserNoWhitelist | You are not in the beta whitelist and thus have no permission to use this function. |
Was this page helpful?