1. API Description
Domain name for API request: billing.tencentcloudapi.com.
This API is used to get pay-on-behalf bills of the admin account (bills by instance).
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: DescribeBillResourceSummaryForOrganization. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | Yes | Integer | Pagination offset. If Offset is 0, it indicates the first page. When Limit is 100, if Offset is 100, it indicates the second page; if Offset is 200, it indicates the third page, and so on. |
| Limit | Yes | Integer | The number of entries returned at a time. The maximum value is 1000. |
| Month | Yes | String | Bill month in the format of "yyyy-mm". This value must be no earlier than the month when Bill 2.0 is activated. |
| PeriodType | No | String | Cycle type, which can be byUsedTime (by billing cycle) or byPayTime (by deduction time). This value must be the same as the billing period type in Billing Center for that particular month. You can check your billing cycle at the top of the Bill Overview page. |
| NeedRecordNum | No | Integer | Indicates whether the total number of records is required, used for pagination. Valid values: 1 (required), 0 (not required). |
| ActionType | No | String | Transaction type. This parameter needs to be input using the ActionTypeName value. Valid values:Monthly subscription purchase Monthly subscription renewal Monthly subscription upgrade/downgrade Monthly subscription refund Pay-as-you-go deduction Offline project deduction Offline product deduction Adjustment deduction Adjustment compensation Hourly pay-as-you-go Daily pay-as-you-go Monthly pay-as-you-go Hourly spot instance Offline project adjustment compensation Offline product adjustment compensation Offer deduction Offer compensation Pay-as-you-go resource migration in Pay-as-you-go resource migration out Monthly subscription resource migration in Monthly subscription resource migration out Prepaid Hourly RI refund Pay-as-you-go reversal Monthly subscription to pay-as-you-go Minimum spend deduction Hourly savings plan fee |
| ResourceId | No | String | ID of the instance to be queried. |
| PayMode | No | String | Billing mode. Valid values: prePay, postPay. |
| BusinessCode | No | String | Product code Note: To query the product codes ( BusinessCode) used in the current month, call DescribeBillSummaryByProduct. |
| 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. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| ResourceSummarySet | Array of BillDistributionResourceSummary | Resource summary list. |
| Total | Integer | Total number of resource summary lists. It will not be returned if NeedRecordNum is 0.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. |
4. Example
Example1 Getting the bill summarized by instance
This example shows you how to get the bill summarized by instance.
Input Example
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationBillResourceSummary
<Common request parameters>
{
"Offset": 0,
"Limit": 1,
"Month": "2023-08",
"NeedRecordNum": 1,
"ResourceId": "cdb-0a90mrac"
}
Output Example
{
"Response": {
"RequestId": "0a27bddd-8683-4187-b9c0-7d407a2c818f",
"ResourceSummarySet": [
{
"ActionTypeName": "Monthly subscription renewal",
"BusinessCode": "p_cdb",
"BusinessCodeName": "TencentDBMySQL",
"CashPayAmount": "11.56675785",
"ConfigDesc": "MySQL - 1 CPU core",
"Discount": "0.325825",
"ExtendField1": "vpc: vpc-l0u15j26,Default-VPC",
"ExtendField2": "vip: 172.27.0.8",
"ExtendField3": "-",
"ExtendField4": "-",
"ExtendField5": "-",
"FeeBeginTime": "2023-08-07 10:58:41",
"FeeEndTime": "2023-09-07 10:58:41",
"IncentivePayAmount": "0.00000000",
"InstanceType": "-",
"OperateUin": "700000686592",
"OrderId": "20230807867037044170861",
"OriginalCostWithRI": "0.00000000",
"OriginalCostWithSP": "0.00000000",
"OwnerUin": "700000686592",
"PayModeName": "Monthly subscription",
"PayTime": "2023-08-07 03:42:18",
"ProductCode": "sp_cdb_master",
"ProductCodeName": "MySQL - High-Availability Edition (General)",
"ProjectName": "Default project",
"RealTotalCost": "11.56675785",
"ReduceType": "Discount",
"RegionId": 16,
"RegionName": "Southwest China (Chengdu)",
"ResourceId": "cdb-0a90mrac",
"ResourceName": "TencentDBmysql-test7",
"SPDeduction": "0.00000000",
"Tags": [],
"TotalCost": "35.5",
"TransferPayAmount": "0.00000000",
"VoucherPayAmount": "0.00000000",
"ZoneName": "Chengdu Zone 1"
}
],
"Total": 3
}
}
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.SummaryDataNotReady | Summary is being built. Please try again later. |
| InternalError.GatewayError | Gateway error. |
| InternalError.UnknownError | Undefined exception. |
はい
いいえ
この記事はお役に立ちましたか？