Domain name for API request: billing.tencentcloudapi.com.
This API is used to get the cost distribution over different tags.
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: DescribeBillSummaryByTag. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-09. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| BeginTime | Yes | String | The value must be of the same month as EndTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018. |
| EndTime | Yes | String | The value must be of the same month as BeginTime. Query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09, the data returned will be for the entire month of September 2018. |
| TagKey | Yes | String | Cost allocation tag key |
| PayerUin | No | String | Payer UIN |
| Parameter Name | Type | Description |
|---|---|---|
| Ready | Integer | Indicates whether or not the data is ready. 0: not ready; 1: ready. |
| SummaryOverview | Array of TagSummaryOverviewItem | Details about cost distribution over different tags Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://billing.tencentcloudapi.com/?Action=DescribeBillSummaryByTag
&BeginTime=2019-09
&EndTime=2019-09
&TagKey=province
&<Common request parameters>{
"Response": {
"Ready": 1,
"SummaryOverview": [
{
"TagValue": "",
"RealTotalCost": "0.30",
"RealTotalCostRatio": "17.08"
},
{
"TagValue": "shanghai",
"RealTotalCost": "0.26",
"RealTotalCostRatio": "15.21"
},
{
"TagValue": "beijing",
"RealTotalCost": "0.26",
"RealTotalCostRatio": "15.21"
},
{
"TagValue": "guangdong",
"RealTotalCost": "0.26",
"RealTotalCostRatio": "15.21"
},
{
"TagValue": "xiamen",
"RealTotalCost": "0.22",
"RealTotalCostRatio": "12.43"
},
{
"TagValue": "tianjin",
"RealTotalCost": "0.22",
"RealTotalCostRatio": "12.43"
},
{
"TagValue": "sichuan",
"RealTotalCost": "0.22",
"RealTotalCostRatio": "12.43"
}
],
"RequestId": "b7649c63-59e5-49d3-bbde-64292cc4174d"
}
}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.TagKeyNotExist | This cost allocation tag key does not exist. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
Was this page helpful?