计费相关查询消耗明细-成本管理相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： billing.tencentcloudapi.com 。

查询消耗明细

注意事项：

对于消耗明细数据量级很大（例如每月消耗明细量级超过100w）的客户，通过 API 调用明细数据会有超时风险，建议您开通消耗账单数据存储功能，通过存储桶中获取账单文件进行分析。账单存储至COS桶

默认接口请求频率限制：5次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCostDetail。
Version	是	String	公共参数，本接口取值：2018-07-09。
Region	否	String	公共参数，此参数为可选参数。
Limit	是	Integer	数量，最大值为100 示例值：10
Offset	是	Integer	偏移量示例值：0
BeginTime	否	Timestamp	周期开始时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime&EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为同一月份，暂不支持跨月拉取。可拉取的数据是开通成本分析后，且距今 24 个月内的数据。示例值：2024-01-01 00:00:00
EndTime	否	Timestamp	周期结束时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime&EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为同一月份，暂不支持跨月拉取。可拉取的数据是开通成本分析后，且距今 24 个月内的数据。示例值：2024-01-31 00:00:00
NeedRecordNum	否	Integer	是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要示例值：0
Month	否	String	月份，格式为yyyy-mm，Month和BeginTime&EndTime必传一个，如果有传BeginTime&EndTime则Month字段无效。不能早于开通成本分析的月份，最多可拉取24个月内的数据。示例值："2024-01-01 00:00:00"
ProductCode	否	String	查询指定产品信息（暂时未开放获取）示例值："code"
PayMode	否	String	付费模式 prePay/postPay 示例值："postPay"
ResourceId	否	String	查询指定资源信息示例值："1400532488"

3. 输出参数

参数名称	类型	描述
DetailSet	Array of CostDetail	消耗明细注意：此字段可能返回 null，表示取不到有效值。示例值：[ { "ComponentCodeName": "standard storage usage", "ItemCodeName": "cos standard storage usage", "UsedAmount": "44.04199273", "UsedAmountUnit": "GB", "SinglePrice": "0.00080000", "PriceUnit": "USD/GB/Day", "Cost": "0.03523359", "Discount": "1.00000000", "RealCost": "0.03875695", "VoucherPayAmount": "0.00000000", "CashPayAmount": "0.03875695", "IncentivePayAmount": "0.00000000", "Tax": "0.00352336", "TaxRate": "0.10000000" } ]
Total	Integer	记录数注意：此字段可能返回 null，表示取不到有效值。示例值：null
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询消耗明细数据

输入示例

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
&<公共请求参数>

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.GatewayError	网关错误。
InternalError.UnknownError	未定义异常。