产品动态
产品公告
Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to get the bill summarized by instance.
A maximum of 5 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: DescribeBillResourceSummary. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required. |
| Offset | Yes | Integer | Pagination offset. If Offset is 0, it indicates the first page. If Limit is 100, "Offset = 100" indicates the second page, then "Offset = 200" indicates the third page, and so on. |
| Limit | Yes | Integer | Quantity, maximum is 1000 |
| Month | Yes | String | Bill month in the format of "yyyy-mm". This value must be no earlier than March 2019, when Bill 2.0 was launched. |
| NeedRecordNum | No | Integer | Indicates whether or not the total number of records of accessing the list is required, used for frontend pages. 1 = yes, 0 = no |
| ActionType | No | String | Hourly settlement Daily settlement Yearly/monthly subscription Spot New yearly/monthly subscription Yearly/monthly subscription renewal Yearly/monthly subscription specification adjustment Yearly/monthly subscription refund Adjustment - deduction Adjustment - refund Hourly RI fee One-off RI Fee Hourly Savings Plan fee Offline project deduction Offline product deduction |
| ResourceId | No | String | ID of the instance to be queried |
| PayMode | No | String | Billing mode: prePay/postPay |
| BusinessCode | No | String | Product code Note: To query the product codes used in the current month, call DescribeBillSummaryByProduct. |
| PayerUin | No | String | The account ID of the payer, which is the unique identifier of a Tencent Cloud user. This account is allowed to query its own bills by default. If an organization admin account needs to query the self-pay bills of members, this field should be specified as the member account ID. |
| TagKey | No | String | Cost allocation tag key, which can be customized. This parameter can be used for querying bills after January 2021. |
| TagValue | No | String | Resource tag value. If it is left empty, there are no records with tag values set under this tag key. This parameter can be used for querying bills after January 2021. |
| Parameter Name | Type | Description |
|---|---|---|
| ResourceSummarySet | Array of BillResourceSummary | Resource summary list |
| Total | Integer | Total number of resource summary lists, which will not be returned when NeedRecordNum is 0. 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. |
This example shows you how to get the bill summarized by instance.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillResourceSummary
{
"Offset": 0,
"Limit": 1,
"PeriodType": "byPayTime",
"Month": "2022-01",
"NeedRecordNum": 1
}
{
"Response": {
"RequestId": "43c51fc6-4a40-4529-8d3a-5663b558cfad",
"ResourceSummarySet": [
{
"ActionTypeName": "Daily settlement",
"BillMonth": "2022-01-01 00:00:00",
"BusinessCode": "p_cls",
"BusinessCodeName": "cloud log service",
"CashPayAmount": "0.00000231",
"ConfigDesc": "cloud log service-request: 0.000083 Per million times",
"Discount": "1",
"ExtendField1": "-",
"ExtendField2": "-",
"ExtendField3": "-",
"ExtendField4": "-",
"ExtendField5": "-",
"FeeBeginTime": "2022-01-05 00:00:00",
"FeeEndTime": "2022-01-21 23:59:59",
"IncentivePayAmount": "0.00000000",
"InstanceType": "-",
"OperateUin": "100010445724",
"OrderId": "-",
"OriginalCostWithRI": "0.00000000",
"OriginalCostWithSP": "0.00000000",
"OwnerUin": "100010445724",
"PayModeName": "Pay-As-You-Go resources",
"PayTime": "0000-00-00 00:00:00",
"PayerUin": "100010445724",
"ProductCode": "sp_cls",
"ProductCodeName": "cloud log service",
"ProjectName": "default",
"RealTotalCost": "0.00000231",
"ReduceType": "discount",
"RegionId": 1,
"RegionName": "South China (Guangzhou)",
"ResourceId": "100010445724-1",
"ResourceName": "",
"Tags": [],
"TotalCost": "2.16E-6",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"ZoneName": "Guangzhou Zone 1"
}
],
"Total": 95
}
}
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.SummaryDataNotReady | Summary is being built. Please try again later. |
| InternalError.GatewayError | Gateway error. |
| InternalError.UnknownError | Undefined exception. |
文档反馈