Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to query the details of a cost allocation bill by item.
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: DescribeAllocationSummaryByItem. |
| 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, and 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: RiTimeSpan - Deduction duration of a reserved instance ExtendPayAmount1 - Original price for the deduction duration of a reserved instance RealCost - Discounted total CashPayAmount - Cash amount VoucherPayAmount - Amount of promo voucher IncentivePayAmount - Amount of free credit TransferPayAmount - Royalty amount Cost - Original price of a component |
| 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 |
| BusinessCodes.N | No | Array of String | Product code, used for filtering |
| OwnerUins.N | No | Array of String | User UIN, used for filtering |
| OperateUins.N | No | Array of String | Operator UIN, used for filtering |
| PayModes.N | No | Array of String | Billing mode code, used for filtering |
| ActionTypes.N | No | Array of String | Transaction type code, used for filtering |
| ProductCodes.N | No | Array of String | Subproduct code, used for filtering |
| RegionIds.N | No | Array of String | Region ID, used for filtering |
| ZoneIds.N | No | Array of String | Availability Zone (AZ) ID, used for filtering |
| InstanceTypes.N | No | Array of String | Instance type code, used for filtering |
| Tag.N | No | Array of String | Tag, used for filtering |
| ComponentCodes.N | No | Array of String | Component type code, used for filtering |
| ItemCodes.N | No | Array of String | Component name code, used for filtering |
| SearchKey | No | String | Fuzzy search: supports tag, resource ID, and resource alias. |
| ProjectIds.N | No | Array of Integer | Project ID, used for filtering |
| AllocationType.N | No | Array of Integer | Cost collection type, with the enumerated values as follows: 0 - Allocation 1 - Collection -1 - Unallocated |
| Parameter Name | Type | Description |
|---|---|---|
| RecordNum | Integer | Total quantity. |
| Total | AllocationOverviewTotal | Total amount of a cost allocation bill |
| Detail | Array of AllocationSummaryByItem | Details of a Cost Allocation Bill by item |
| 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. |
This example shows you how to query details of a cost allocation bill by item.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAllocationSummaryByItem
<Common request parameters>
{
"Month": "2024-02",
"Limit": 1,
"Offset": 0,
"PeriodType": "month"
}
{
"Response": {
"Detail": [
{
"ActionType": "billVirtualId",
"ActionTypeName": "Monthly billing accuracy difference"
"AllocationType": 1,
"BillDate": "2025-01-01",
"BlendedDiscount": "",
"BusinessCode": "billVirtualId",
"BusinessCodeName": "Monthly billing accuracy difference"
"CashPayAmount": "-0.00000285",
"ComponentCode": "billVirtualId",
"ComponentCodeName": "monthly billing accuracy difference",
"ComponentConfig": "",
"ContractPrice": "-0.00000285",
"DeductedMeasure": "",
"Discount": "",
"FeeBeginTime": "2024-02-01 00:00:00",
"FeeEndTime": "2024-02-07 23:59:59",
"Formula": "",
"FormulaUrl": "",
"IncentivePayAmount": "0.00000000",
"InstanceType": "",
"InstanceTypeName": "",
"ItemCode": "billVirtualId",
"ItemCodeName": "Monthly billing accuracy difference"
"OperateUin": "909619400",
"OwnerUin": "909619400",
"PayMode": "postPay",
"PayModeName": "Pay-as-you-go"
"PayerUin": "909619400",
"PriceInfo": [],
"ProductCode": "billVirtualId",
"ProductCodeName": "Monthly Billing Accuracy Difference"
"ProjectId": 0,
"ProjectName": "Billing Accuracy Compensation",
"RealTotalCost": "-0.00000285",
"RealTotalMeasure": "",
"RegionId": 0,
"RegionName": "Other"
"RegionType": "other",
"RegionTypeName": "Other"
"ReserveDetail": "",
"ResourceId": "909619400(UIN)",
"ResourceName": "Billing accuracy compensation",
"RiCost": "0.00000000",
"RiTimeSpan": "0.00000000",
"SPCost": "0.00000000",
"SinglePrice": "-0.00000285",
"SinglePriceUnit": "CNY/month",
"SplitItemId": "",
"SplitItemName": "",
"Tag": [
{
"TagKey": "department",
"TagValue": "Operation center"
}
],
"TimeSpan": "1.00000000",
"TimeUnit": "month"
"TotalCost": "-0.00000285",
"TransferPayAmount": "0.00000000",
"TreeNodeUniqKey": "909619400-6391dae9802da",
"TreeNodeUniqKeyName": "Customer application group"
"UsedAmount": "1.00000000",
"UsedAmountUnit": "",
"VoucherPayAmount": "0.00000000",
"ZoneId": 0,
"ZoneName": "Other"
}
],
"RecordNum": 18411,
"RequestId": "ceb74979-c668-42f6-b266-57541de2f755",
"Total": {
"CashPayAmount": "1630.93000000",
"IncentivePayAmount": "31062.86000000",
"RealTotalCost": "32953.81000000",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "260.02000000"
}
}
}
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. |
| AuthFailure.UnauthorizedOperation | No permission. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Parameters are missing |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback