查询账单资源汇总数据

最近更新时间:2019-08-29 21:12:09

1. 接口描述

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

查询账单资源汇总数据

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillResourceSummary
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
Limit Integer 数量,最大值为1000
PeriodType String 周期类型,byUsedTime按计费周期/byPayTime按扣费周期。需要与费用中心该月份账单的周期保持一致。您可前往账单概览页面顶部查看确认您的账单统计周期类型。
Month String 月份,格式为yyyy-mm。不能早于开通账单2.0的月份,最多可拉取24个月内的数据。
NeedRecordNum Integer 是否需要访问列表的总记录数,用于前端分页
1-表示需要, 0-表示不需要

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

输出示例

{
  "Response": {
    "ResourceSummarySet": [
      {
        "BusinessCodeName": "云服务器CVM",
        "ProductCodeName": "标准型S1",
        "PayModeName": "包年包月",
        "ProjectName": "默认项目",
        "RegionName": "华南地区(广州)",
        "ZoneName": "广州一区",
        "ResourceId": "ins-abcdefgh",
        "ResourceName": "测试服务器",
        "ActionTypeName": "包年包月新购",
        "OrderId": "20180808110089",
        "PayTime": "2018-08-08 11:22:33",
        "FeeBeginTime": "2018-08-08 11:25:00",
        "FeeEndTime": "2018-09-08 11:25:00",
        "ConfigDesc": "CPU:1核; 内存:2GB",
        "ExtendField1": "-",
        "ExtendField2": "-",
        "TotalCost": "1200",
        "Discount": "1",
        "ReduceType": "折扣",
        "RealTotalCost": "1200",
        "VoucherPayAmount": "300",
        "CashPayAmount": "400",
        "IncentivePayAmount": "500"
      }
    ]
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SummaryDataNotReady 汇总数据正在构建中,请稍后再试。