查詢用戶某個賬期內所有商品實例或計費項的消費匯總。API已升級為DescribeInstanceBill,此API不再提供50000行以后數據的查詢。
接口說明
API 描述
在調用本接口時,請注意:
- 實例賬單 API 已升級,請使用新版 API: DescribeInstanceBill 。此 API 不再提供 50000 行以后數據的查詢。
- 實例賬單是根據賬單數據拆分生成,一般會有一天延遲。
- 實例信息在賬期內會變化,月匯總的實例 Config 和 Spec 對應記錄生成時間信息,如需詳情可參考對應明細賬單。
- 云通信產品可查詢從 2020 年 6 月以后的數據; 萬網產品可查詢從 2020 年 11 月以后的數據。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
bss:DescribeBillList | Read |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BillingCycle | string | 是 | 賬期 YYYY-MM。僅支持最近 18 個月賬期。 | 2020-03 |
ProductCode | string | 否 | 產品代碼。 | rds |
ProductType | string | 否 | 產品類型。當 ProductCode 為云市場產品 code 時,此參數必填。 | rds |
SubscriptionType | string | 否 | 訂閱類型。取值:
說明
必須和 ProductCode 參數一起使用。
| PayAsYouGo |
IsBillingItem | boolean | 否 | 是否按照計費項維度拉取數據。
默認 false。 | false |
PageNum | integer | 否 | 頁碼,默認值為 1。 | 1 |
PageSize | integer | 否 | 每頁數量,默認值:20,最大值:300。 | 20 |
IsHideZeroCharge | boolean | 否 | 根據原價(PretaxGrossAmount)和應付(PretaxAmount)是否都為 0 做過濾。取值:
| false |
BillingDate | string | 否 | 賬單日期,僅當 Granularity 為 DAILY 時必填,格式為 YYYY-MM-DD。 | 2020-03-03 |
Granularity | string | 否 | 查詢賬單的顆粒度。取值:
選擇 DAILY 需指定 BillingDate。 | MONTHLY |
BillOwnerId | long | 否 | 資源歸屬賬號 ID,資源歸屬賬號是實際使用資源的賬號。 | 122 |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
"Success": true,
"Data": {
"PageNum": 1,
"BillingCycle": "2020-03",
"AccountID": "185xxxx3489",
"PageSize": 20,
"TotalCount": 2,
"AccountName": "test@test.aliyunid.com",
"Items": {
"Item": [
{
"BillingDate": "2020-03",
"InstanceConfig": "CPU:12",
"InternetIP": "34.xx.x.x",
"Item": "PayAsYouGoBill",
"Tag": "tag",
"InstanceID": "i-kjhdskjgshfdlkjfdh",
"Currency": "CNY",
"DeductedByCashCoupons": 0,
"SubscriptionType": "PayAsYouGo",
"InstanceSpec": "ecs.sn1ne.3xlarge",
"DeductedByCoupons": 0,
"BillingItem": "其他",
"Region": "杭州",
"OutstandingAmount": 0,
"CostUnit": "未分配",
"ListPriceUnit": "元",
"ResourceGroup": "默認資源組",
"PipCode": "rds",
"ServicePeriodUnit": "秒",
"PretaxAmount": 0,
"CommodityCode": "rds",
"ProductName": "云數據庫RDS",
"AdjustAmount": 0,
"NickName": "test",
"ProductDetail": "云數據庫RDS",
"Usage": "100",
"IntranetIP": "192.xx.xx.xx",
"OwnerID": "169***013",
"DeductedByPrepaidCard": 0,
"UsageUnit": "GB",
"PaymentAmount": 0,
"InvoiceDiscount": 0,
"DeductedByResourcePackage": "NULL",
"ProductType": "rds",
"ServicePeriod": "10",
"Zone": "cn-hangzhou-h",
"ListPrice": "100",
"PretaxGrossAmount": 0,
"CashAmount": 0,
"ProductCode": "rds",
"BillingType": "其它"
}
]
}
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||
---|---|---|---|---|
2024-03-28 | OpenAPI 描述信息更新 | 看變更集 | ||
|