查询账单明细数据

最近更新时间:2021-09-13 08:03:25

我的收藏

1. 接口描述

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

查询账单明细数据

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillDetail。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量
Limit Integer 数量,最大值为100
PeriodType String 周期类型,byUsedTime按计费周期/byPayTime按扣费周期。需要与费用中心该月份账单的周期保持一致。您可前往账单概览页面顶部查看确认您的账单统计周期类型。
Month String 月份,格式为yyyy-mm,Month和BeginTime&EndTime必传一个,如果有传BeginTime&EndTime则Month字段无效。不能早于开通账单2.0的月份,最多可拉取24个月内的数据。
BeginTime String 周期开始时间,格式为Y-m-d H:i:s,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传。不能早于开通账单2.0的月份,最多可拉取24个月内的数据。(不支持跨月查询)
EndTime String 周期结束时间,格式为Y-m-d H:i:s,Month和BeginTime&EndTime必传一个,如果有该字段则Month字段无效。BeginTime和EndTime必须一起传。不能早于开通账单2.0的月份,最多可拉取24个月内的数据。(不支持跨月查询)
NeedRecordNum Integer 是否需要访问列表的总记录数,用于前端分页
1-表示需要, 0-表示不需要
ProductCode String 查询指定产品信息(暂时未开放获取)
PayMode String 付费模式 prePay/postPay
ResourceId String 查询指定资源信息
ActionType String 查询交易类型。如 按量计费日结,按量计费小时结 等
ProjectId Integer 项目ID:资源所属项目ID

3. 输出参数

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

4. 示例

示例1 获取账单明细

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeBillDetail
&Month=2018-07
&PeriodType=byPayTime
&Offset=0
&Limit=1
&BeginTime=2018-11-0100:00:00
&EndTime=2018-11-0123:59:59
&NeedRecordNum=1
&ResourceId=ins-49zhx6z1
&<公共请求参数>

输出示例

{
  "Response": {
    "DetailSet": [
      {
        "PayerUin": "909619400",
        "OwnerUin": "909619400",
        "OperateUin": "909619400",
        "BusinessCodeName": "云服务器CVM",
        "BusinessCode": "p_cvm",
        "ProductCodeName": "云服务器CVM-标准型SA2",
        "ProductCode": "sp_cvm_sa2",
        "PayModeName": "包年包月",
        "ProjectName": "默认项目",
        "ProjectId": "0",
        "RegionName": "西南地区(成都)",
        "RegionId": "16",
        "ZoneName": "成都一区",
        "ResourceId": "ins-m1okcccv",
        "ResourceName": "windows-1GB-cd-1880",
        "ActionType": "prepay_renew",
        "ActionTypeName": "包年包月续费",
        "OrderId": "20201102400000425173641",
        "BillId": "20201102400000425173641",
        "PayTime": "2020-11-02 02:29:57",
        "FeeBeginTime": "2020-11-02 12:05:15",
        "FeeEndTime": "2020-12-02 12:05:15",
        "ComponentSet": [
          {
            "ComponentCodeName": "带宽",
            "ComponentCode": "v_cvm_bandwidth",
            "ItemCodeName": "带宽-按带宽计费",
            "ItemCode": "sv_cvm_bandwidth_prepay",
            "SinglePrice": "18",
            "ContractPrice": "17.46",
            "SpecifiedPrice": "18",
            "PriceUnit": "元/Mbps/月",
            "UsedAmount": "1",
            "UsedAmountUnit": "Mbps",
            "TimeSpan": "1",
            "TimeUnitName": "月",
            "Cost": "18",
            "Discount": "0.97",
            "ReduceType": "折扣",
            "RealCost": "17.46",
            "VoucherPayAmount": "0",
            "CashPayAmount": "17.46",
            "IncentivePayAmount": "0"
          },
          {
            "ComponentCodeName": "运算组件",
            "ComponentCode": "virtual_v_cvm_compute",
            "ItemCodeName": "运算组件-标准型SA2-1核1G",
            "ItemCode": "virtual_v_cvm_compute_sa2",
            "SinglePrice": "18",
            "ContractPrice": "17.46",
            "SpecifiedPrice": "18",
            "PriceUnit": "元/个/月",
            "UsedAmount": "1",
            "UsedAmountUnit": "个",
            "TimeSpan": "1",
            "TimeUnitName": "月",
            "Cost": "18",
            "Discount": "0.97",
            "ReduceType": "折扣",
            "RealCost": "17.46",
            "VoucherPayAmount": "0",
            "CashPayAmount": "17.46",
            "IncentivePayAmount": "0"
          },
          {
            "ComponentCodeName": "系统盘",
            "ComponentCode": "v_cvm_rootdisk",
            "ItemCodeName": "高效云系统盘",
            "ItemCode": "sv_cvm_rootdisk_cbspremium",
            "SinglePrice": "0.35",
            "ContractPrice": "0.3395",
            "SpecifiedPrice": "0.35",
            "PriceUnit": "元/GB/月",
            "UsedAmount": "50",
            "UsedAmountUnit": "GB",
            "TimeSpan": "1",
            "TimeUnitName": "月",
            "Cost": "17.5",
            "Discount": "0.97",
            "ReduceType": "折扣",
            "RealCost": "16.98",
            "VoucherPayAmount": "0",
            "CashPayAmount": "16.98",
            "IncentivePayAmount": "0"
          }
        ],
        "Tags": null
      }
    ],
    "Total": 11841,
    "RequestId": "eb914214-778b-470e-93a1-f1e03d58c47b"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.GatewayError 网关错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
UnsupportedOperation 操作不支持。
目录