Domain name for API request: billing.tencentcloudapi.com.
This API is used to obtain consumption details summarized by product.
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: DescribeCostSummaryByProduct. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
Region | No | String | Common Params. This parameter is not required. |
BeginTime | Yes | String | The value must be of the same month as EndTime . The query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09 , the data returned will be for the entire month of September 2018. |
EndTime | Yes | String | The value must be of the same month as BeginTime . The query period must start and end on the same month and the query result returned will be of the entire month. For example, if both BeginTime and EndTime are 2018-09 , the data returned will be for the entire month of September 2018. |
Limit | Yes | Integer | Data quantity per fetch. The maximum value is 100. |
Offset | Yes | Integer | Offset, which starts from 0 by default |
PayerUin | No | String | UIN of the user querying the bill data |
NeedRecordNum | No | Integer | Whether to return the record count. 0 for no, 1 for yes. Default is no. |
Parameter Name | Type | Description |
---|---|---|
Ready | Integer | Data readiness, 0 for not ready, 1 for ready |
Total | ConsumptionSummaryTotal | Consumption details |
Data | Array of ConsumptionBusinessSummaryDataItem | Consumption details summarized by productNote: This field may return null, indicating that no valid values can be obtained. |
RecordNum | Integer | Record count. The system returns null when NeedRecordNum is 0.Note: 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 obtain consumption details summarized by product.
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCostSummaryByProduct
<Common request parameters>
{
"NeedRecordNum": "1",
"EndTime": "2018-11",
"Limit": "1",
"BeginTime": "2018-11",
"Offset": "0"
}
{
"Response": {
"Ready": 1,
"RecordNum": 2,
"Total": {
"RealTotalCost": "220.67"
},
"Data": [
{
"BusinessCode": "p_cvm",
"BusinessCodeName": " Cloud Virtual Machine ",
"RealTotalCost": "220.67",
"Trend": {
"Type": "postPay",
"Value": "test"
}
}
],
"RequestId": "59a408bc-5d95-4d40-bf21-58e5e8d48dd0"
}
}
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 |
---|---|
InternalError.GatewayError | Gateway error. |
Was this page helpful?