查询用户某个账期内所有商品实例或计费项的消费汇总。
接口说明
- 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月 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:DescribeInstanceBill | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BillingCycle | string | 是 | 账期 YYYY－MM。仅支持最近 18 个月账期。 | 2020-03 |
| ProductCode | string | 否 | 产品代码。 | rds |
| ProductType | string | 否 | 产品类型。 | rds |
| SubscriptionType | string | 否 | 订阅类型。取值：
| PayAsYouGo |
| IsBillingItem | boolean | 否 | 是否按照计费项维度拉取数据。
说明
默认 false。
| false |
| NextToken | string | 否 | 用来表示当前调用开始读取的位置，参数值必须为空或者使用返回结果中的 NextToken 设值，否则会报错。空代表从头开始读取。 | CAESEgoQCg4KCm |
| MaxResults | integer | 否 | 本次读取的最大数据记录数量。默认值：20，最大值：300。 | 20 |
| IsHideZeroCharge | boolean | 否 | 根据原价（PretaxGrossAmount）和应付（PretaxAmount）是否都为 0 做过滤。取值：
| false |
| BillingDate | string | 否 | 账单日期，仅当 Granularity 为 DAILY 时必填，格式为 YYYY-MM-DD。 | 2020-03-02 |
| Granularity | string | 否 | 查询账单的颗粒度。取值如下：
说明
选择 DAILY 需指定 BillingDate。
| MONTHLY |
| BillOwnerId | long | 否 | 资源归属账号 ID，资源归属账号是实际使用资源的账号。 | 122 |
| InstanceID | string | 否 | 实例 ID。 | abc |
| PipCode | string | 否 | 产品 Code，与费用中心账单产品 Code 一致。 | rds |
返回参数
示例
正常返回示例
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-13 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
| 2021-09-23 | OpenAPI 返回结构发生变更 | 看变更集 | ||||
|