Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to query the daily overview of a cost allocation bill.
A maximum of 50 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: DescribeAllocationOverview. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required. |
| Limit | Yes | Integer | Quantity, with the maximum value of 1,000 |
| Offset | Yes | Integer | Pagination offset. If offset is 0, it indicates the first page. If limit is 100, then offset is 100, it indicates the second page; if offset is 200, it indicates the third page, and so on |
| Month | No | String | Bill month, in the format of 2024-02, which is the current month by default if not provided |
| PeriodType | No | String | Statistical period, with the enumerated values as follows: month - Month day - Day |
| TreeNodeUniqKeys.N | No | Array of String | Unique identifier of a billing unit, used for filtering |
| Sort | No | String | Sorting field, with the enumerated values as follows: GatherCashPayAmount - Collected fees (cash) GatherVoucherPayAmount - Collected fees (voucher) GatherIncentivePayAmount - Collected fees (free credit) GatherTransferPayAmount - Collected fees (royalty amount) AllocateCashPayAmount - Allocated fees (cash) AllocateVoucherPayAmount - Allocated fees (voucher) AllocateIncentivePayAmount - Allocated fees (free credit) AllocateTransferPayAmount - Allocated fees (royalty amount) TotalCashPayAmount - Total fees (cash) TotalVoucherPayAmount - Total fees (voucher) TotalIncentivePayAmount - Total fees (free credit) TotalTransferPayAmount - Total fees (royalty amount) GatherRealCost - Collected fees (discounted total) AllocateRealCost - Allocated fees (discounted total) RealTotalCost - Total fees (discounted total) Ratio - Proportion (discounted total) |
| SortType | No | String | Sorting type, with the enumerated values as follows: asc - Ascending desc - Descending |
| BillDates.N | No | Array of String | Date, used for filtering |
| Parameter Name | Type | Description |
|---|---|---|
| RecordNum | Integer | Total quantity. |
| Total | AllocationOverviewTotal | Total amount of a cost allocation bill |
| Detail | Array of AllocationOverviewDetail | Details of the cost allocation overview |
| 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. |
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAllocationOverview
<Common request parameters>
{
"Limit": 30,
"Month": "2022-11-01 00:00:00",
"Offset": 0,
"PeriodType": "month"
}
{
"Response": {
"Detail": [
{
"TreeNodeUniqKey": "700000384179-6376f0b3ada52",
"GatherCashPayAmount": "8072.80000000",
"GatherVoucherPayAmount": "0.00000000",
"GatherIncentivePayAmount": "0.00000000",
"GatherTransferPayAmount": "0.00000000",
"AllocateCashPayAmount": "0.00000000",
"AllocateVoucherPayAmount": "0.00000000",
"AllocateIncentivePayAmount": "0.00000000",
"AllocateTransferPayAmount": "0.00000000",
"TotalCashPayAmount": "0.00000000",
"TotalVoucherPayAmount": "0.00000000",
"TotalIncentivePayAmount": "0.00000000",
"TotalTransferPayAmount": "0.00000000",
"GatherRealCost": "8072.80000000",
"AllocateRealCost": "0.00000000",
"RealTotalCost": "8072.80000000",
"TreeNodeUniqKeyName": "HR Products",
"Ratio": "99.65",
"Trend": null,
"TrendType": "none",
"BillDate": null
},
{
"TreeNodeUniqKey": "700000384179-63733abacc8b8",
"GatherCashPayAmount": "0.00000000",
"GatherVoucherPayAmount": "0.00000000",
"GatherIncentivePayAmount": "0.00000000",
"GatherTransferPayAmount": "0.00000000",
"AllocateCashPayAmount": "14.16000000",
"AllocateVoucherPayAmount": "0.00000000",
"AllocateIncentivePayAmount": "0.00000000",
"AllocateTransferPayAmount": "0.00000000",
"TotalCashPayAmount": "0.00000000",
"TotalVoucherPayAmount": "0.00000000",
"TotalIncentivePayAmount": "0.00000000",
"TotalTransferPayAmount": "0.00000000",
"GatherRealCost": "0.00000000",
"AllocateRealCost": "14.16000000",
"RealTotalCost": "14.16000000",
"TreeNodeUniqKeyName": "Temporary Billing Items",
"Ratio": "0.17",
"Trend": null,
"TrendType": "none",
"BillDate": null
},
{
"TreeNodeUniqKey": "700000384179-63733ac7e46ff",
"GatherCashPayAmount": "0.00000000",
"GatherVoucherPayAmount": "0.00000000",
"GatherIncentivePayAmount": "0.00000000",
"GatherTransferPayAmount": "0.00000000",
"AllocateCashPayAmount": "14.16000000",
"AllocateVoucherPayAmount": "0.00000000",
"AllocateIncentivePayAmount": "0.00000000",
"AllocateTransferPayAmount": "0.00000000",
"TotalCashPayAmount": "0.00000000",
"TotalVoucherPayAmount": "0.00000000",
"TotalIncentivePayAmount": "0.00000000",
"TotalTransferPayAmount": "0.00000000",
"GatherRealCost": "0.00000000",
"AllocateRealCost": "14.16000000",
"RealTotalCost": "14.16000000",
"TreeNodeUniqKeyName": "Mid-Term Adjustment Project",
"Ratio": "0.17",
"Trend": null,
"TrendType": "none",
"BillDate": null
}
],
"RecordNum": 3,
"Total": {
"RealTotalCost": "8101.12000000",
"CashPayAmount": "8101.12000000",
"IncentivePayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"TransferPayAmount": "0.00000000"
},
"RequestId": "db3c4d66-ce51-4b94-91d0-c65c7938475b"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈