文档

QueryBillOverview - 账单总览查询服务

更新时间:
一键部署

查询用户某个账期内账单总览信息。

调试

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

授权信息

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

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

请求参数

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

账单日期,YYYY-MM。

2018-07
ProductCodestring

产品代码。

rds
ProductTypestring

产品类型。

rds
SubscriptionTypestring

订阅类型:

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

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

1234

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

BCB1E1BC-05BF-4217-80EE-BF09A29407BA
Successboolean

是否成功。

true
Dataobject

返回数据。

BillingCyclestring

账期,格式:YYYY-MM。

2020-03
AccountIDstring

账号 ID。

185766xxxx
AccountNamestring

账号。

test@test.aliyunid.com
Itemsobject []

账单详情。

RoundDownDiscountstring

抹零优惠。

0
Itemstring

账单类型,取值:

  • SubscriptionOrder。预付费账单
  • PayAsYouGoBill。后付费账单
  • Refund。退款
  • Adjustment。调账
PayAsYouGoBill
Currencystring

币种,取值:

  • CNY。
  • USD。
  • JPY。
CNY
SubscriptionTypestring

订阅类型,取值:

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

代金券抵扣。

0
BillAccountNamestring

账单所属账号名称。

test@test.aliyunid.com
BizTypestring

业务类型。

trusteeship
DeductedByCouponsfloat

优惠券抵扣。

0
OutstandingAmountfloat

未结清金额或信用结算金额(普通用户的欠费, 或者信用客户信用额度消耗)。

0
PipCodestring

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

rds
PretaxAmountfloat

应付金额。

100
ProductNamestring

产品名称。

Nat网关
CommodityCodestring

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

rds
AdjustAmountfloat

信用额度退款抵扣。

0
ProductDetailstring

产品明细。

NAT Gateway (Pay-As-You-Go)
OwnerIDstring

账单 OwnerID。

1222
DeductedByPrepaidCardfloat

储值卡抵扣。

0
ProductTypestring

产品类型。

rds
InvoiceDiscountfloat

优惠金额。

0
PaymentAmountfloat

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

100
BillAccountIDstring

账单所属账号 ID。

185766xxxx
PretaxGrossAmountfloat

原始金额。

100
CashAmountfloat

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

0
ProductCodestring

产品代码。

rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BCB1E1BC-05BF-4217-80EE-BF09A29407BA",
  "Success": true,
  "Data": {
    "BillingCycle": "2020-03",
    "AccountID": "185766xxxx",
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "RoundDownDiscount": "0",
          "Item": "PayAsYouGoBill",
          "Currency": "CNY",
          "SubscriptionType": "Subscription",
          "DeductedByCashCoupons": 0,
          "BillAccountName": "test@test.aliyunid.com",
          "BizType": "trusteeship",
          "DeductedByCoupons": 0,
          "OutstandingAmount": 0,
          "AfterTaxAmount": 0,
          "PretaxAmountLocal": 0,
          "Tax": 0,
          "PipCode": "rds",
          "PretaxAmount": 100,
          "ProductName": "Nat网关",
          "CommodityCode": "rds",
          "AdjustAmount": 0,
          "ProductDetail": "NAT Gateway (Pay-As-You-Go)",
          "PaymentCurrency": "USD",
          "OwnerID": "1222",
          "DeductedByPrepaidCard": 0,
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 100,
          "BillAccountID": "185766xxxx",
          "PretaxGrossAmount": 100,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

错误码

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