tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCostDetail

Last updated: 2024-05-28 17:27:13

1. API Description

Domain name for API request: billing.tencentcloudapi.com.

This API is used to query consumption details.

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: 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 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 cost analysis is activated and within the past 24 months.
EndTime No Timestamp Cycle end time 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 cost analysis is activated and within the past 24 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 Month, in the format of yyyy-mm. Either Month or BeginTime&EndTime must be entered, and if BeginTime&EndTime is entered, Month becomes invalid. It cannot be earlier than the month when cost analysis is activated. Data of up to 24 months can be retrieved.
ProductCode No String Used to query information of a specified product (currently not available)
PayMode No String Payment mode. Options include prePay and postPay.
ResourceId No String Used to query information of a specified resource

3. Output Parameters

Parameter Name Type Description
DetailSet Array of CostDetail Consumption details
Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Querying consumption details

Input Example

https://billing.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>

Output Example

{
    "Response": {
        "DetailSet": [
            {
                "PayerUin": "abc",
                "BusinessCodeName": "abc",
                "ProductCodeName": "abc",
                "PayModeName": "abc",
                "ProjectName": "abc",
                "RegionName": "abc",
                "ZoneName": "abc",
                "ResourceId": "abc",
                "ResourceName": "abc",
                "ActionTypeName": "abc",
                "OrderId": "abc",
                "BillId": "abc",
                "FeeBeginTime": "abc",
                "FeeEndTime": "abc",
                "ComponentSet": [
                    {
                        "ComponentCodeName": "abc",
                        "ItemCodeName": "abc",
                        "SinglePrice": "abc",
                        "PriceUnit": "abc",
                        "UsedAmount": "abc",
                        "UsedAmountUnit": "abc",
                        "Cost": "abc",
                        "Discount": "abc",
                        "RealCost": "abc",
                        "VoucherPayAmount": "abc",
                        "CashPayAmount": "abc",
                        "IncentivePayAmount": "abc"
                    }
                ],
                "ProductCode": "abc"
            }
        ],
        "Total": 1,
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
InternalError.GatewayError Gateway error.
InternalError.UnknownError Undefined exception.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy