1. API Description
Domain name for API request: intlpartnersmgt.tencentcloudapi.com.
This API is used to obtain the total amount of customer bills by region.
A maximum of 5 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: DescribeBillSummaryByRegion. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| BillMonth | Yes | String | Bill month in the format of "yyyy-MM" |
| CustomerUin | Yes | Integer | Customer UIN |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| SummaryOverview | Array of RegionSummaryOverviewItem | Region details in the customer bill data totaled by region 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 Obtaining the total amount of customer bills by region
This example shows you how to obtain the total amount of customer bills by region.
Input Example
POST / HTTP/1.1
Host: intlpartnersmgt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillSummaryByRegion
<Common request parameters>
{
"BillMonth": "2022-11",
"CustomerUin": 123456
}
Output Example
{
"Response": {
"SummaryOverview": [
{
"RegionId": "8",
"RegionName": "1North China (Beijing)",
"OriginalCost": "100.00000000",
"VoucherPayAmount": "100.00000000",
"TotalCost": "100.00000000"
}
],
"RequestId": "asdfgh"
}
}
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 |
|---|---|
| InvalidParameterValue.InvalidMonth | Incorrect month value |
| OperationDenied.ServiceBusy | System busy. Please try again later. |
| UnauthorizedOperation.UinNoAuth | The current user doesn’t have permission for the operation. |
是
否
本页内容是否解决了您的问题？