查詢用戶某個賬期內結算賬單。支持賬單條目超過50000條的國內賬號。
接口說明
- 當月數據查詢結果僅供參考，不作為對賬依據；當月最終賬單在次月 2 日 12 點后支持查看/導出（月中會發生包括但不限于以下少數場景：延遲出賬，退款，調賬，欠費核銷等）。
- 賬單數據相對于實際費用消耗延遲 5 小時更新。
- 賬單數據中對于歷史賬期“未結清”狀態的賬單，還款后延遲 5 個小時更新為已結清；對于當月“未結清”狀態的賬單，還款后于次月 2 日 12 點出賬時更新為已結清。
- 當前 API 支持優雅退避，請求速率為 600/60(s)。
- 單用戶限流 10 筆/秒，如遇超時，請重試。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| bssapi:QuerySettleBill | READ |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BillingCycle | string | 是 | 賬期，YYYY-MM。 | 2018-07 |
| Type | string | 否 | 類型。取值：
| SubscriptionOrder |
| ProductCode | string | 否 | 產品代碼。 | rds |
| ProductType | string | 否 | 產品類型。 | rds |
| SubscriptionType | string | 否 | 訂閱類型。取值：
說明
必須和 ProductCode 參數一起使用。
| Subscription |
| IsHideZeroCharge | boolean | 否 | 根據原價（PretaxGrossAmount）是否為 0 做過濾，默認為否（兼容現有邏輯）。
| true |
| NextToken | string | 否 | 用來標記當前開始讀取的位置，置空表示從頭開始。 | CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U |
| MaxResults | integer | 否 | 本次讀取的最大數據記錄數量。默認值：20，最大值：300。 | 20 |
| BillOwnerId | long | 否 | 資源歸屬賬號的 ID，資源歸屬賬號是實際使用資源的賬號。 | 123 |
| RecordID | string | 否 | 訂單號、賬單號。 | 12233 |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "AE3F4057-DFC9-4B81-8858-F620651010C9",
"Success": true,
"Data": {
"NextToken": "CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U",
"BillingCycle": "2020-02",
"MaxResults": 20,
"AccountID": "185xxxxx489",
"TotalCount": 200,
"AccountName": "test@test.aliyunid.com",
"Items": {
"Item": [
{
"Status": "PayFinish",
"RoundDownDiscount": "0",
"Item": "Subscription",
"Currency": "CNY",
"BillAccountName": "test@test.aliyunid.com",
"DeductedByCashCoupons": 0,
"SubscriptionType": "PayAsYouGo",
"UsageStartTime": "2020-03-11 07:00:00",
"BizType": "trusteeship",
"UsageEndTime": "2020-03-11 08:00:00",
"DeductedByCoupons": 0,
"SubOrderId": "325345254353",
"AfterTaxAmount": 0,
"OutstandingAmount": 0,
"PaymentTime": "2020-03-11 08:00:00",
"Tax": 0,
"PretaxAmountLocal": 0,
"PipCode": "rds",
"PaymentTransactionID": "2O3AADJFEAF2PDKSFAMFCB11918",
"PretaxAmount": 100,
"CommodityCode": "rds",
"ProductName": "云數據庫RDS",
"RecordID": "2020xxxx5912",
"AdjustAmount": 0,
"ProductDetail": "關系型數據庫RDS（包月）",
"PaymentCurrency": "USD",
"OwnerID": "3532535235",
"DeductedByPrepaidCard": 0,
"BillAccountID": "185xxxxx489",
"PaymentAmount": 0,
"InvoiceDiscount": 0,
"ProductType": "rds",
"PretaxGrossAmount": 0,
"CashAmount": 0,
"ProductCode": "rds"
}
]
}
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。