有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

获取账单资源汇总数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillResourceSummary。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,此参数为可选参数。
Offset Integer 分页偏移量,Offset=0表示第一页,如果Limit=100,则Offset=100表示第二页,Offset=200表示第三页,依次类推
示例值:0
Limit Integer 数量,最大值为1000
示例值:1
Month String 月份,格式为yyyy-mm。不能早于开通账单2.0的月份
示例值:2018-08
NeedRecordNum Integer 是否需要访问列表的总记录数,用于前端分页
1-表示需要, 0-表示不需要
ActionType String 查询交易类型(请使用交易类型名称入参),入参示例枚举如下:
包年包月新购
包年包月续费
包年包月配置变更
包年包月退款
按量计费扣费
线下项目扣费
线下产品扣费
调账扣费
调账补偿
按量计费小时结
按量计费日结
按量计费月结
竞价实例小时结
线下项目调账补偿
线下产品调账补偿
优惠扣费
优惠补偿
按量计费迁入资源
按量计费迁出资源
包年包月迁入资源
包年包月迁出资源
预付费用
小时费用
预留实例退款
按量计费冲正
包年包月转按量
保底扣款
节省计划小时费用
示例值:按量计费扣费
ResourceId String 查询指定资源信息
示例值:ins-1op7g2iz
PayMode String 付费模式 prePay/postPay
示例值:prePay
BusinessCode String 产品名称代码
备注:如需获取当月使用过的BusinessCode,请调用API:获取产品汇总费用分布
示例值:p_cvm
PayerUin String 支付者的账号 ID(账号 ID 是用户在腾讯云的唯一账号标识),默认查询本账号账单,如集团管理账号需查询成员账号自付的账单,该字段需入参成员账号UIN
TagKey String 分账标签键,用户自定义(支持2021-01以后账单查询)
示例值:province
TagValue String 分账标签值,该参数为空表示该标签键下未设置标签值的记录
(支持2021-01以后账单查询)
示例值:0

3. 输出参数

参数名称 类型 描述
ResourceSummarySet Array of BillResourceSummary 资源汇总列表
Total Integer 资源汇总列表总数,入参NeedRecordNum为0时不返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:103
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取账单资源汇总

获取账单资源汇总

输入示例

POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillResourceSummary

{
    "Offset": 0,
    "Limit": 1,
    "PeriodType": "byPayTime",
    "Month": "2022-01",
    "NeedRecordNum": 1
}

输出示例

{
    "Response": {
        "ResourceSummarySet": [
            {
                "BusinessCodeName": "abc",
                "ProductCodeName": "abc",
                "PayModeName": "abc",
                "ProjectName": "abc",
                "RegionName": "abc",
                "ZoneName": "abc",
                "ResourceId": "abc",
                "ResourceName": "abc",
                "ActionTypeName": "abc",
                "OrderId": "abc",
                "PayTime": "2020-09-22 00:00:00",
                "FeeBeginTime": "2020-09-22 00:00:00",
                "FeeEndTime": "2020-09-22 00:00:00",
                "ConfigDesc": "abc",
                "ExtendField1": "abc",
                "ExtendField2": "abc",
                "TotalCost": "abc",
                "Discount": "abc",
                "ReduceType": "abc",
                "RealTotalCost": "abc",
                "VoucherPayAmount": "abc",
                "CashPayAmount": "abc",
                "IncentivePayAmount": "abc",
                "TransferPayAmount": "abc",
                "ExtendField3": "abc",
                "ExtendField4": "abc",
                "ExtendField5": "abc",
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ],
                "PayerUin": "abc",
                "OwnerUin": "abc",
                "OperateUin": "abc",
                "BusinessCode": "abc",
                "ProductCode": "abc",
                "RegionId": 0,
                "InstanceType": "abc",
                "OriginalCostWithRI": "abc",
                "SPDeduction": "abc",
                "OriginalCostWithSP": "abc"
            }
        ],
        "Total": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SummaryDataNotReady 汇总数据正在构建中,请稍后再试。
InternalError.GatewayError 网关错误。
InternalError.UnknownError 未定义异常。