查询账单资源汇总数据

最近更新时间:2021-09-16 08:04:29

我的收藏

1. 接口描述

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

查询账单资源汇总数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillResourceSummary。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
Limit Integer 数量,最大值为1000
Month String 月份,格式为yyyy-mm。不能早于开通账单2.0的月份,最多可拉取24个月内的数据。
PeriodType String 周期类型,byUsedTime按计费周期/byPayTime按扣费周期。需要与费用中心该月份账单的周期保持一致。您可前往账单概览页面顶部查看确认您的账单统计周期类型。
NeedRecordNum Integer 是否需要访问列表的总记录数,用于前端分页
1-表示需要, 0-表示不需要
ActionType String 查询交易类型,如下:
包年包月新购
包年包月续费
包年包月配置变更
包年包月退款
按量计费扣费
按量计费小时结
按量计费日结
按量计费月结
线下项目扣费
线下产品扣费
调账扣费
调账补偿
竞价实例小时结
线下项目调账补偿
线下产品调账补偿
优惠扣费
优惠补偿
按量计费迁入资源
按量计费迁出资源
包年包月迁入资源
包年包月迁出资源
预付费用
小时费用
预留实例退款
按量计费冲正
按量计费冲正
按量计费冲正
按量计费冲正
按量计费冲正
ResourceId String 查询指定资源信息
PayMode String 付费模式 prePay/postPay

3. 输出参数

参数名称 类型 描述
ResourceSummarySet Array of BillResourceSummary 资源汇总列表
Total Integer 资源汇总列表总数
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取账单资源汇总

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeBillResourceSummary
&Month=2018-08
&PeriodType=byPayTime
&Offset=0
&Limit=1
&ActionType=按量计费扣费
&<公共请求参数>

输出示例

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

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 网关错误。
目录