1. API Description
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeBillSummaryByTag. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required. |
| 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, which can be customized. |
| PayerUin | No | String | Payer UIN |
| TagValue | No | String | Resource tag value |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Ready | Integer | Indicates whether the data is ready. 0: Not ready. 1: Ready. If Ready is 0, it indicates that the current UIN is initializing billing for the first time. Wait for 5-10 minutes and try again. |
| 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. |
| SummaryTotal | SummaryTotal | Total cost Note: this field may return null, indicating that no valid values can be obtained. |
| 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. |
4. Example
Example1 Getting bill data summarized by tag
This example shows you how to get bill data summarized by tag.
Input Example
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummaryByTag
<Common request parameters>
{
"TagKey": "province",
"EndTime": "2019-09",
"BeginTime": "2019-09"
}
Output Example
{
"Response": {
"Ready": 1,
"SummaryOverview": [
{
"TagValue": "",
"RealTotalCost": "3081.26707105",
"TotalCost": "5026.37707609",
"RealTotalCostRatio": "99.88",
"CashPayAmount": "3081.26707105",
"IncentivePayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000"
},
{
"TagValue": "kCH0vYyI",
"RealTotalCost": "3.77264000",
"TotalCost": "4.71580000",
"RealTotalCostRatio": "0.12",
"CashPayAmount": "3.77264000",
"IncentivePayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000"
}
],
"SummaryTotal": {
"RealTotalCost": "3085.03971105",
"TotalCost": "5031.09287609"
},
"RequestId": "0cdd9b57-4597-4e78-a60b-0e72f7637a3a"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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. |
| InternalError.GatewayError | Gateway error. |
| InternalError.UnknownError | Undefined exception. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
Yes
No
Was this page helpful?