Domain name for API request: billing.intl.tencentcloudapi.com.
This API is used to query consumption details.
Notes:
For customers with large-scale consumption detail (for example, monthly consumption detail exceeding 1M), there will be a timeout risk when retrieving detailed data via API call. It is recommended to enable the billing data storage function and analyze bill files obtained in a bucket. Store bills to COS
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: DescribeCostDetail. |
| 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 | The number of entries returned at a time. The maximum value is 100. |
| Offset | Yes | Integer | Offset |
| BeginTime | No | Timestamp | Cycle start time. The query granularity is daily. The hour/minute/second parameter must be input in the format of yyyy-mm-dd hh:ii:ss. Either Month or BeginTime&EndTime must be entered, and if this field is present, Month becomes invalid. BeginTime and EndTime must be entered together, and must be in the same month. Cross-month retrieval is not currently supported. Data retrievable is the data after consumption bill is enabled and within the past 18 months. |
| EndTime | No | Timestamp | Cycle end time. The query granularity is daily. The hour-minute-second parameter must be imported in the format of yyyy-mm-dd hh:ii:ss. Either Month or BeginTime&EndTime must be specified. If this field is present, Month becomes invalid. BeginTime and EndTime must be specified together and must be in the same month. Cross-month retrieval is not currently supported. Data retrievable is the data after consumption bill is enabled and within the past 18 months. |
| NeedRecordNum | No | Integer | Whether the total number of records in the list is needed, for frontend pagination1: needed, 0: not needed |
| Month | No | String | The month is in the format of yyyy-mm. Either Month or BeginTime&EndTime must be specified. If BeginTime&EndTime is specified, the Month field is invalid. It cannot be earlier than the month when the consumption bill was enabled. Data within the last 18 months can be pulled at most. |
| ProductCode | No | String | Query information of a specified product |
| PayMode | No | String | Payment mode. Options include prePay and postPay. |
| ResourceId | No | String | Used to query information of a specified resource |
| Parameter Name | Type | Description |
|---|---|---|
| DetailSet | Array of CostDetail | Consumption details |
| Total | Integer | Record countNote: 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. |
https://billing.intl.tencentcloudapi.com/?Action=DescribeCostDetail
&Offset=0
&Limit=10
&BeginTime=2018-11-01 00:00:00
&EndTime=2018-11-01 23:59:59
&NeedRecordNum=1
&<Common request parameters>
{
"Response": {
"DetailSet": [
{
"PayerUin": "10002011014",
"BusinessCodeName": "Cloud Object Storage (COS)"
"ProductCodeName": "Cloud Object Storage (COS) Traffic"
"PayModeName": "Pay-as-you-go"
"ProjectName": "Default Project",
"RegionName": "South China (Guangzhou)",
"ZoneName": "Other"
"ResourceId": "cpn-dev-238-ap-beijing-1000000086",
"ResourceName": "cpn-dev-238-ap-beijing",
"ActionTypeName": "Pay-as-you-go daily billing"
"OrderId": "20211009400006732337101",
"BillId": "2021100940000673233",
"FeeBeginTime": "2021-11-03 00:00:00",
"FeeEndTime": "2021-11-03 23:59:59",
"ComponentSet": [
{
"ComponentCodeName": "Public Network Downstream Traffic"
"ItemCodeName": "COS Outbound External Network Traffic"
"SinglePrice": "0.50000000",
"PriceUnit": "CNY/GB/Day"
"UsedAmount": "0.0020975",
"UsedAmountUnit": "GB",
"Cost": "0.00104875",
"Discount": "1",
"RealCost": "0.00104875",
"VoucherPayAmount": "0",
"CashPayAmount": "0.00104875",
"IncentivePayAmount": "0",
"Tax": "",
"TaxRate": ""
}
],
"ProductCode": "sp_cos_bw"
}
],
"Total": 1,
"RequestId": "51db5fda-deac-4d51-8464-d23c32791abd"
}
}
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.QueryCountFailed | Failed to get the number of data entries. |
| InternalError | Internal error. |
| InternalError.GatewayError | Gateway error. |
| InternalError.UnknownError | Undefined exception. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| UnsupportedOperation | Operation unsupported. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários