使用OSS訂閱賬單檔案,支援將賬單資料存放區到指定的OSS bucket中。
介面說明
在調用該介面時,請注意:
-
使用者一次訂閱一個類型的賬單檔案。
-
訂閱後次日開始每日推送上一日產生的賬單檔案,每月 4 號推送上月整賬期的全量賬單檔案。月賬單 PDF 每月 4 號推送上月賬單檔案。
-
按天產生的賬單檔案可能存在時延,延遲產生的賬單會在產生次日推送,也可能會包含上一日之前延遲到上一日產生的賬單。建議每個月初拉取上個月全量檔案。
首次使用 OSS 訂閱,需要給訂閱使用者授予 AliyunConsumeDump2OSSRole 許可權。若授權取消,系統將不再推送檔案,需要使用者重新授權。
-
本訂閱與費用與成本控制台的“賬單資料存放區”為同一功能,訂閱互連。
-
訂閱至 Bucket 下的目錄時,請注意符合目錄命名規範:
不允許使用Emoji,請使用符合要求的 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程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
bss:ModifySubscribeToOSS |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| SubscribeBucket |
string |
是 |
儲存訂閱賬單檔案的 OSS Bucket 名稱。 |
xxxxxx-bucket |
| SubscribeType |
string |
否 |
訂閱的賬單類型。取實值型別:
|
BillingItemDetailForBillingPeriod |
| MultAccountRelSubscribe |
string |
否 |
對於多級帳號,可指定推送賬單的類型。可選值為:
預設:MA。 |
MA |
| BucketOwnerId |
integer |
否 |
隱藏檔的 Oss Owner 對應的 UID。如果是 Bid/ReSeller 訂閱,並需要推送到子帳號的 OSS 上時指定,需要此帳號為調用帳號子帳號,並對此帳號授予 AliyunConsumeDump2OSSRole 許可權。 普通使用者則無需指定,預設為調用帳號。 |
12341324 |
| BeginBillingCycle |
string |
否 |
推送起始賬期。訂閱成功後,系統會自動推送起始賬期到目前時間的資料。月賬單 PDF 訂閱時此參數無效,不會對歷史資料重新推送。最多可推送最近 1 年內資料。 |
2021-03 |
| BucketPath |
string |
否 |
訂閱至 Bucket 下的指定目錄。 |
testpath |
| RowLimitPerFile |
integer |
否 |
單檔案行數上限。當賬單檔案超過上限後,會拆成多個檔案,併合並成一個壓縮包。 |
300000 |
| UsingSsl |
string |
否 |
是否通過 SSL(Secure Sockets Layer)加密協議來保護網路通訊。取值:
|
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Code |
string |
狀態代碼。 |
Success |
| Message |
string |
錯誤資訊。 |
Successful! |
| RequestId |
string |
請求 ID。 |
F61FCE4B-9B56-4FD9-A17E-****** |
| Success |
boolean |
是否成功。 |
true |
樣本
正常返回樣本
JSON格式
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "F61FCE4B-9B56-4FD9-A17E-******",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。