文档

DescribeInstanceBill - 查询实例账单服务

更新时间:
一键部署

查询用户某个账期内所有商品实例或计费项的消费汇总。

接口说明

  • 当月数据查询结果仅供参考,不作为对账依据;当月最终账单在次月 3 日 12 点后支持查看/导出(月中会发生包括但不限于以下少数场景:延迟出账,退款,调账,欠费核销等)。
  • 当月账单数据中不包含未结算(未出账,累账中)的后付费数据。
  • 支持近 18 个月数据。
  • 账单数据相对于实际费用消耗延迟 24 小时更新,其中实例 ID 相关的信息( 实例配置,实例规格,实例昵称,资源组,公网 IP,私网 IP,可用区)延迟 48 小时更新。
  • 账单数据不支持提供分拆型云产品(例如:CDN、OSS、共享带宽等)各个分拆项(例如:域名、Bucket、EIP 等)的具体费用(如需统计含分拆项数据,请前往分账账单)。
  • 对于云通信产品,仅支持查询 2020 年 6 月及以后的明细数据,万网产品(包括域名、商标等)仅支持查询 2020 年 11 月及以后的明细数据。
  • 单用户限流 10 笔/秒,如遇超时,请重试。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:DescribeInstanceBillRead
  • 全部资源
    *
  • bssapi:ProductCode
  • bssapi:ProductType

请求参数

名称类型必填描述示例值
BillingCyclestring

账期 YYYY-MM。仅支持最近 18 个月账期。

2020-03
ProductCodestring

产品代码。

rds
ProductTypestring

产品类型。

rds
SubscriptionTypestring

订阅类型。取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
PayAsYouGo
IsBillingItemboolean

是否按照计费项维度拉取数据。

  • false。与费用中心-费用账单-账单明细-实例账单一致。
  • true。与费用中心-费用账单-账单明细-计费项账单一致。
说明 默认 false。
false
NextTokenstring

用来表示当前调用开始读取的位置,参数值必须为空或者使用返回结果中的 NextToken 设值,否则会报错。空代表从头开始读取。

CAESEgoQCg4KCm
MaxResultsinteger

本次读取的最大数据记录数量。默认值:20,最大值:300。

20
IsHideZeroChargeboolean

根据原价(PretaxGrossAmount)和应付(PretaxAmount)是否都为 0 做过滤。取值:

  • false。
  • true。
false
BillingDatestring

账单日期,仅当 Granularity 为 DAILY 时必填,格式为 YYYY-MM-DD。

2020-03-02
Granularitystring

查询账单的颗粒度。取值如下:

  • MONTHLY:月。与费用中心-费用账单-账单明细-账期账单一致。
  • DAILY:日。与费用中心-费用账单-账单明细-按天账单一致。
说明 选择 DAILY 需指定 BillingDate。
MONTHLY
BillOwnerIdlong

资源归属账号 ID,资源归属账号是实际使用资源的账号。

122
InstanceIDstring

实例 ID。

abc
PipCodestring

产品 Code,与费用中心账单产品 Code 一致。

rds

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Successboolean

是否成功。

true
Dataobject

返回数据。

NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。下次调用时,需要将此设置到入参 NextToken 中。

CAESEgoQCg4KCm
BillingCyclestring

账单日期,格式:YYYY-MM。

2020-03
MaxResultsinteger

本次请求所返回的最大记录条数。

20
AccountIDstring

账号 ID。

122
TotalCountinteger

总记录数。

20
AccountNamestring

用户账号。

test@test.aliyunid.com
Itemsobject []

账单详情。

BillingDatestring

账单日期,仅当 Granularity 为 DAILY 时有值,格式为 YYYY-MM-DD。

2020-03-20
InstanceConfigstring

实例详细配置。

CPU:12
InternetIPstring

公网 IP。

34.xx.x.x
Itemstring

账单类型:

  • SubscriptionOrder (预付订单)。
  • PayAsYouGoBill (后付账单)。
  • Refund (退款)。
  • Adjustment (调账)。
PayAsYouGoBill
Tagstring

资源标签。

key:testKey value:testValue; key:testKey1 value:testValues1
InstanceIDstring

实例 ID。

i-dadada
Currencystring

币种,取值:

  • CNY。
  • USD。
  • JPY。
CNY
BillAccountNamestring

账单所属账号名称。

test@test.aliyunid.com
DeductedByCashCouponsfloat

代金券抵扣。

0.1
SubscriptionTypestring

订阅类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
PayAsYouGo
BizTypestring

业务类型。

trusteeship
InstanceSpecstring

实例规格。

ecs.sn1ne.3xlarge
DeductedByCouponsfloat

优惠券优惠金额。

0.1
BillingItemstring

计费项。仅当 IsBillingItem=true 有值。

带宽
BillingItemCodestring

计费项代码。

disk
Regionstring

地域。

杭州
OutstandingAmountfloat

未结清金额。

0.1
CostUnitstring

财务单元。

未分配
ListPriceUnitstring

单价单位, 仅当 isBillingItem 为 true 时有效。

ResourceGroupstring

资源组。

默认资源组
PipCodestring

产品 Code,与费用中心账单产品 Code 一致。

rds
ServicePeriodUnitstring

服务时长单位。

PretaxAmountfloat

应付金额。

0.1
CommodityCodestring

商品 Code,与费用中心产品明细 Code 一致。

rds
ProductNamestring

产品名称。

云数据库RDS
AdjustAmountfloat

信用额度退款抵扣。

0
NickNamestring

实例昵称。

test
ProductDetailstring

产品明细。

云数据库RDS
Usagestring

用量。

说明 仅当 isBillingItem 为 true 时有效。用量数据为该周期内所有账单的用量总和并非客户的实际购买量。如使用了 1G 的存储,每小时出账,则每小时用量为 1G,按天汇总的账单用量为 1G*24=24G。
100
IntranetIPstring

内网 IP。

192.xx.xx.xx
OwnerIDstring

资源 Owner 账号 AccountID(多账号代付场景)。

123
DeductedByPrepaidCardfloat

储值卡抵扣。

0.1
UsageUnitstring

用量单位, 仅当 isBillingItem 为 true 时有效。

GB
BillAccountIDstring

账单所属账号 ID。

122
PaymentAmountfloat

现金支付(含信用额度退款抵扣)。

0.1
InvoiceDiscountfloat

优惠金额。

0.1
DeductedByResourcePackagestring

资源包抵扣, 仅当 isBillingItem 为 true 时有效。

0.1
ProductTypestring

产品类型。

rds
ServicePeriodstring

服务时长。

3600
Zonestring

可用区。

杭州1
ListPricestring

单价, 仅当 isBillingItem 为 true 时有效。

100
PretaxGrossAmountfloat

原始金额。

0.1
CashAmountfloat

现金支付(不包含信用额度退款抵扣)。

0
ProductCodestring

产品代码。

rds
BillingTypestring

计费方式。

其它
ItemNamestring

项目名称。

iZ28bycvyb4Z

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "NextToken": "CAESEgoQCg4KCm",
    "BillingCycle": "2020-03",
    "MaxResults": 20,
    "AccountID": "122",
    "TotalCount": 20,
    "AccountName": "test@test.aliyunid.com",
    "Items": [
      {
        "BillingDate": "2020-03-20",
        "InstanceConfig": "CPU:12",
        "InternetIP": "34.xx.x.x\t",
        "Item": "PayAsYouGoBill",
        "Tag": "key:testKey value:testValue; key:testKey1 value:testValues1",
        "InstanceID": "i-dadada",
        "Currency": "CNY",
        "BillAccountName": "test@test.aliyunid.com",
        "DeductedByCashCoupons": 0.1,
        "SubscriptionType": "PayAsYouGo",
        "BizType": "trusteeship",
        "InstanceSpec": "ecs.sn1ne.3xlarge\t",
        "DeductedByCoupons": 0.1,
        "BillingItem": "带宽",
        "BillingItemCode": "disk",
        "Region": "杭州",
        "OutstandingAmount": 0.1,
        "CostUnit": "未分配\t",
        "ListPriceUnit": "元",
        "ResourceGroup": "默认资源组\t",
        "PipCode": "rds",
        "ServicePeriodUnit": "秒",
        "PretaxAmount": 0.1,
        "CommodityCode": "rds",
        "ProductName": "云数据库RDS\t",
        "AdjustAmount": 0,
        "NickName": "test",
        "ProductDetail": "云数据库RDS\t",
        "Usage": "100",
        "IntranetIP": "192.xx.xx.xx",
        "OwnerID": "123",
        "DeductedByPrepaidCard": 0.1,
        "UsageUnit": "GB",
        "BillAccountID": "122",
        "PaymentAmount": 0.1,
        "InvoiceDiscount": 0.1,
        "DeductedByResourcePackage": "0.1",
        "ProductType": "rds",
        "ServicePeriod": "3600",
        "Zone": "杭州1",
        "ListPrice": "100",
        "PretaxGrossAmount": 0.1,
        "CashAmount": 0,
        "ProductCode": "rds",
        "BillingType": "其它",
        "ItemName": "iZ28bycvyb4Z"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PipCode
2021-09-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)