導出阿里云OSS訂閱賬單詳單數據。
接口說明
在調用該接口時,請注意:
-
用戶一次訂閱一個類型的賬單文件。
-
訂閱后次日開始每日推送上一日生成的賬單文件,每月 4 號推送上月整賬期的全量賬單文件。月賬單 PDF 每月 4 號推送上月賬單文件。
-
按天生成的賬單文件可能存在時延,延遲生成的賬單會在生成次日推送,也可能會包含上一日之前延遲到上一日生成的賬單。建議每個月初拉取上個月全量文件。
-
本訂閱與費用中心首頁的“賬單數據存儲”為同一功能,訂閱互通。
-
訂閱至 Bucket 下的目錄時,請注意符合目錄命名規范:
- 不允許使用表情符,請使用符合要求的 UTF-8 字符。
- / 用于分割路徑,可快速創建子目錄,但不要以 / 或 \ 開頭,不要出現連續的 /。
- 不允許出現名為 .. 的子目錄。
- 總長度控制在 1~254 個字符。
-
文件名:
-
BillingItemDetailForBillingPeriod(計費項賬單明細)
-
每日推送文件名格式:
UID_BillingItemDetail_YYYYMMDD
,例如:169**_BillingItemDetail_20190310
。 -
下月初完整文件名格式:
UID_BillingItemDetail_YYYYMM
,例如:169**_BillingItemDetail_201903
。
-
-
InstanceDetailForBillingPeriod(實例賬單明細)
-
每日推送文件名格式:
UID_InstanceDetail_YYYYMMDD
,例如:169**_InstanceDetail_20190310
。 -
下月初完整文件名格式:
UID_InstanceDetail_YYYYMM
,例如:169**_InstanceDetail_201903
。
-
-
InstanceDetailMonthly(實例賬單賬期匯總)
- 每日推送文件名格式:
UID_InstanceDetailMonthly_YYYYMM
,例如:169**_InstanceDetailMonthly_201903
。此文件每日更新月初至當日的全量數據,直至次月 4 號。
- 每日推送文件名格式:
-
BillingItemDetailMonthly(計費項賬單賬期匯總)
- 每日推送文件名格式:
UID_BillingItemDetailMonthly_YYYYMM
,例如:169**_BillingItemDetailMonthly_201903
。此文件每日更新月初至當日的全量數據,直至次月 4 號。
- 每日推送文件名格式:
-
SplitItemDetailDaily(分賬賬單按天匯總)
- 每日推送文件名格式:
UID_SplitItemDetailDaily_YYYYMM
,例如:169**_SplitItemDetailDaily_201903
。此文件每日更新月初至當日的全量數據,直至次月 4 號。
- 每日推送文件名格式:
-
MonthBill(月賬單 PDF)
- 每月推送文件名格式:
UID_MonthBill_YYYYMM
,例如:169**_MonthBill_201903
。每月 4 號推送上月賬單文件。
- 每月推送文件名格式:
-
-
除 MonthBill 為 PDF 文件外,其余文件類型為 csv 文件。但如果賬單數據行數超過一定閾值,會自動拆分成多個 csv 文件,并合并壓縮成一個 zip 文件,zip 文件名格式相同。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
bss:ModifySubscribeToOSS | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SubscribeBucket | string | 是 | 指定詳單導出的 OSS Bucket。 | xxxxxx-bucket |
SubscribeType | string | 否 | 訂閱類型。取值類型:
| BillingItemDetailForBillingPeriod |
MultAccountRelSubscribe | string | 否 | 對于多級賬號,可指定推送賬單的類型。可選值為:
默認:MA。 | MA |
BucketOwnerId | long | 否 | 存儲文件的 Oss Owner 對應的 UID。如果是 Bid/ReSeller 訂閱,并需要推送到子賬號的 OSS 上時指定,需要此賬號為調用賬號子賬號,并對此賬號授予 AliyunConsumeDump2OSSRole 權限。 普通用戶則無需指定,默認為調用賬號。 | 12341324 |
BeginBillingCycle | string | 否 | 推送起始賬期。訂閱成功后,系統會自動推送起始賬期到當前時間的數據。月賬單 PDF 訂閱時此參數無效,不會對歷史數據重新推送。最多可推送最近 1 年內數據。 | 2021-03 |
BucketPath | string | 否 | OSS Bucket 存儲路徑。 | testpath |
RowLimitPerFile | integer | 否 | 單文件行數上限。當賬單文件超過上限后,會拆成多個文件,并合并成一個壓縮包。 | 300000 |
UsingSsl | string | 否 | 是否通過 SSL(Secure Sockets Layer)加密協議來保護網絡通信。當此參數設為 true 時,表示啟用 SSL 加密,以確保數據傳輸的安全性和完整性。 |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "F61FCE4B-9B56-4FD9-A17E-******",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-06-19 | OpenAPI 入參發生變更 | 查看變更詳情 |