获取账单明细数据

最近更新时间:2024-03-18 01:08:12

我的收藏

1. 接口描述

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

获取账单明细数据。
注意事项:
1.在请求接口时,由于网络不稳定或其它异常,可能会导致请求失败。如果您遇到这种情况,我们建议您在接口请求失败时,手动发起重试操作,这样可以更好地确保您的接口请求能够成功执行。
2.对于账单明细数据量级很大(例如每月账单明细量级超过20w)的客户,通过 API 调用账单数据效率较低,建议您开通账单数据存储功能,通过存储桶中获取账单文件进行分析。账单存储至COS桶

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillDetail。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,此参数为可选参数。
Offset Integer 分页偏移量,Offset=0表示第一页,如果Limit=100,则Offset=100表示第二页,Offset=200表示第三页,依次类推
示例值:1
Limit Integer 数量,最大值为300
示例值:1
Month String 月份,格式为yyyy-mm,Month和BeginTime&EndTime必传一个,如果有传BeginTime&EndTime则Month字段无效。最多可拉取近18个月内的数据。
示例值:2018-07
BeginTime String 周期开始时间,格式为yyyy-mm-dd hh:ii:ss,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传,且为相同月份,不支持跨月查询,查询结果是整月数据。最多可拉取18个月内的数据。
示例值:2018-11-0100:00:00
EndTime String 周期结束时间,格式为yyyy-mm-dd hh:ii:ss,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传,且为相同月份,不支持跨月查询,查询结果是整月数据。最多可拉取近18个月内的数据。
示例值:2018-11-0123:59:59
NeedRecordNum Integer 是否需要访问列表的总记录数,用于前端分页
1-表示需要, 0-表示不需要
示例值:1
ProductCode String 已废弃参数,未开放
示例值:0
PayMode String 付费模式 prePay(表示包年包月)/postPay(表示按时按量)
示例值:prePay
ResourceId String 查询指定资源信息
示例值:ins-49zhx6z1
ActionType String 查询交易类型(请使用交易类型名称入参),入参示例枚举如下:
包年包月新购
包年包月续费
包年包月配置变更
包年包月退款
按量计费扣费
线下项目扣费
线下产品扣费
调账扣费
调账补偿
按量计费小时结
按量计费日结
按量计费月结
竞价实例小时结
线下项目调账补偿
线下产品调账补偿
优惠扣费
优惠补偿
按量计费迁入资源
按量计费迁出资源
包年包月迁入资源
包年包月迁出资源
预付费用
小时费用
预留实例退款
按量计费冲正
包年包月转按量
保底扣款
节省计划小时费用
示例值:按量计费日结
ProjectId Integer 项目ID:资源所属项目ID
示例值:0
BusinessCode String 产品名称代码
备注:如需获取当月使用过的BusinessCode,请调用API:获取产品汇总费用分布
示例值:p_cvm
Context String 上一次请求返回的上下文信息,翻页查询Month>=2023-05的月份的数据可加快查询速度,数据量10万级别以上的用户建议使用,查询速度可提升2~10倍
示例值:UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7
PayerUin String 支付者的账号 ID(账号 ID 是用户在腾讯云的唯一账号标识),默认查询本账号账单,如集团管理账号需查询成员账号自付的账单,该字段需入参成员账号UIN
示例值:909619400

3. 输出参数

参数名称 类型 描述
DetailSet Array of BillDetail 详情列表
Total Integer 总记录数,24小时缓存一次,可能比实际总记录数少
注意:此字段可能返回 null,表示取不到有效值。
示例值:11841
Context String 本次请求的上下文信息,可用于下一次请求的请求参数中,加快查询速度
注意:此字段可能返回 null,表示取不到有效值。
示例值:UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取账单明细

获取账单明细

输入示例

POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillDetail
<公共请求参数>

{
    "Offset": 0,
    "Limit": 1,
    "Month": "2023-07",
    "NeedRecordNum": 1,
    "ResourceId": "ins-wxf3fmq8"
}

输出示例

{
    "Response": {
        "Context": "m7u3i6W6Xt6VmK1NGvNzCXEBwkmoH/Y3ROhw2ICs3RkxMDTe6z/M5dFHpIoeEc+MOBKEhnly44tsqyRJRRL0ZNpmtARd8SDzLfknCLcJtVkf6NJGoV8FXlYLQxABqcSt",
        "DetailSet": [
            {
                "ActionType": "pre_to_post",
                "ActionTypeName": "包年包月转按量",
                "AssociatedOrder": {
                    "PrepayPurchase": "20230707400000442656611",
                    "PrepayRenew": "20230707400000442695851,20230707400000442708571"
                },
                "BillDay": "2023-07-17 00:00:00",
                "BillId": "20230707400000442821061",
                "BusinessCode": "p_cvm",
                "BusinessCodeName": "云服务器CVM",
                "BillMonth": "2023-07-01 00:00:00",
                "ComponentSet": [
                    {
                        "BlendedDiscount": "1.00000000",
                        "CashPayAmount": "-80.43264806",
                        "ComponentCode": "virtual_v_cvm_compute",
                        "ComponentCodeName": "运算组件",
                        "ComponentConfig": [
                            {
                                "Name": "项目",
                                "Value": "element_test"
                            },
                            {
                                "Name": "主机",
                                "Value": "ins-wxf3fmq8"
                            },
                            {
                                "Name": "内网IP",
                                "Value": "10.12.0.42"
                            },
                            {
                                "Name": "所属网络",
                                "Value": "私有网络"
                            },
                            {
                                "Name": "可用区",
                                "Value": "广州二区"
                            }
                        ],
                        "ContractPrice": "-80.89000000",
                        "Cost": "-80.89000000",
                        "DeductedMeasure": "-",
                        "Discount": "1",
                        "IncentivePayAmount": "-0.45735194",
                        "InstanceType": "",
                        "ItemCode": "virtual_v_cvm_compute_s2",
                        "ItemCodeName": "运算组件-标准型S2-2核4G",
                        "OriginalCostWithRI": "0.00000000",
                        "OriginalCostWithSP": "0.00000000",
                        "PriceUnit": "元/个/月",
                        "RealCost": "-80.89000000",
                        "RealTotalMeasure": "-",
                        "ReduceType": "折扣",
                        "RiTimeSpan": "0.00000000",
                        "SPDeduction": "0.00000000",
                        "SPDeductionRate": "0.00000000",
                        "SinglePrice": "-80.89000000",
                        "SpecifiedPrice": "-80.89000000",
                        "TimeSpan": "1",
                        "TimeUnitName": "月",
                        "TransferPayAmount": "0",
                        "UsedAmount": "1",
                        "UsedAmountUnit": "个",
                        "VoucherPayAmount": "0"
                    }
                ],
                "FeeBeginTime": "2023-07-07 16:14:21",
                "FeeEndTime": "2023-07-07 16:14:21",
                "Formula": "退款:343.12元,现金券: 0元,代金券/折扣券不退(订单号20230707400000442656611:部件cvm:现金支付88.81元-已使用第一阶梯按量:0.02元=剩余88.79元;订单号20230707400000442656611:部件bandwidth:现金支付0元=剩余0元;订单号20230707400000442695851:部件cvm:现金支付172.92元=剩余172.92元;订单号20230707400000442695851:部件bandwidth:现金支付0元=剩余0元;订单号20230707400000442708571:部件cvm:现金支付84.12元-原价95.6*使用时间3.2258%*折扣:88=剩余81.41元;",
                "FormulaUrl": "https://buy.cloud.tencent.com/price/cvm",
                "Id": "1725547686519644160",
                "OperateUin": "909619400",
                "OrderId": "20230707400000442821061",
                "OwnerUin": "909619400",
                "PayModeName": "包年包月",
                "PayTime": "2023-07-07 16:14:18",
                "PayerUin": "909619400",
                "PriceInfo": [
                    "操作系统: linux",
                    "连续使用时长T: 不分阶梯",
                    "平台: 云平"
                ],
                "ProductCode": "sp_cvm_s2",
                "ProductCodeName": "云服务器CVM-标准型S2",
                "ProjectId": 1002227,
                "ProjectName": "element_test",
                "RegionId": "1",
                "RegionName": "华南地区(广州)",
                "ResourceId": "ins-wxf3fmq8",
                "ResourceName": "",
                "Tags": [],
                "ZoneName": "广州二区"
            }
        ],
        "RequestId": "ca7573cb-473d-40f3-8c58-7be43ae60195",
        "Total": 14
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.QueryCountFailed 获取数据条数失败。
InternalError 内部错误。
InternalError.GatewayError 网关错误。
InternalError.UnknownError 未定义异常。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
UnsupportedOperation 操作不支持。