賬單域API使用手冊
本文重點介紹賬單域API的功能及其選擇方案。
導讀
隨著云上業務體量和業務場景復雜度的增加，許多企業在“多組織跨部門管理效率”，“精細化管理質量”以及“云上成本”等方面面臨著越來越大的挑戰。企業開始通過集成阿里云“BSS OpenAPI”能力，自建用云分析視圖或自建云管平臺來支撐精細化用云分析。由于費用賬單數據維度多，不同API匯總數據粒度差異大，賬單API的選擇和使用決定了API能力被集成的效率和準確性。
本文從“常用API概覽”、“API選擇方案”、“控制臺功能對應API”、“數據字段對應API匯總”、“各數據源產商品字段對比”、“典型場景最佳實踐”等方面介紹賬單域API，幫助您更準確地選擇API、更高效地使用API，進而獲取各維度的賬單數據。
常用API概覽
查詢實例賬單 | 結算賬單查詢服務 | 賬單總覽查詢服務 |
賬號賬單查詢服務 | 分賬賬單服務 | 查詢月費用分攤服務 |
詳單訂閱服務 | 取消詳單訂閱服務 | 查詢企業財務關系列表 |
API選擇方案
選擇賬單域API時，您可以結合需要查詢的數據，對比每個API的入參、出參，做出最優的API接口決策。
需查詢數據字段 | 可使用API | 入參 | 主要出參字段 |
計費項 | 查詢實例賬單服務：查詢實例賬單服務 | IsBillingItem：true 按月查詢：
按日查詢：
| InstanceConfig：實例詳細配置 InstanceID：實例ID InstanceSpec：實例規格 BillingItem：計費項 BillingItemCode：計費項代碼 CostUnit：財務單元 ResourceGroup：默認資源組 Tag：資源標簽 ListPrice：單價 Usage：用量 OwnerID：財務子賬號ID |
實例 | IsBillingItem：false 按月查詢：
按日查詢：
| InstanceConfig：實例詳細配置 InstanceID：實例ID IDInstanceSpec：實例規格 CostUnit：財務單元 ResourceGroup：默認資源組 Tag：資源標簽 OwnerID：財務子賬號ID | |
訂單號/賬單號 | 結算賬單查詢服務：結算賬單查詢服務 | BillingCycle：YYYY-MM BillOwnerId：資源歸屬賬號ID，資源歸屬賬號是實際使用資源的賬號。 RecordID：訂單號/賬單號 | AccountID：賬號ID SubscriptionType：訂閱類型 UsageStartTime、UsageEndTime：賬單發生時間 RecordID：訂單號/賬單號 OwnerID：財務子賬號ID PipCode：產品Code 說明 產品Code與“費用與成本”賬單中“產品Code”字段含義一致。 CommodityCod：產品明細Code |
財務云主、子賬號 | 查詢企業財務關系列表：查詢企業財務關系列表 | UserId (主賬號UID）：XXX StatusList：關聯狀態 說明 示例：RELATED。 | SetupTime：關系建立時間 State：關系狀態 RelationId：關系 IDAccountType：企業財務賬號類型 RelationType：關系策略 說明 FinancialManagement表示“財務管理”關系 FinancialTrusteeship 表示“財務托管”關系 |
賬號賬單查詢服務：賬號賬單查詢服務 | 按月查詢：
按日查詢：
| BillingCycle：賬期 BillingDate：賬單日期 CostUnit：財務單元 Code：PipCode | |
分賬賬單 | 分賬賬單：分賬賬單服務 | 按月查詢：
按日查詢：
| SplitBillingCycle：分賬月 SplitItemID：分拆項ID 說明 了解更多“分賬賬單”。 InstanceID：實例ID Usage：用量 BillingItem：計費項 Tag：資源標簽 ListPrice：單價 |
明細賬單 | 詳單數據獲取： | SubscribeBucket：abc 說明 您訂閱時設置“oss”的“bucket”名稱，示例值：abc 計費項明細：
實例明細：
| InstanceConfig：實例詳細配置 InstanceID：實例ID InstanceSpec：實例規格 BillingItem：計費項 CostUnit：財務單元 ResourceGroup：默認資源組 Tag：資源標簽 ListPrice：單價 Usage：用量 PipCode：產品Code CommodityCod：產品明細Code RecordID：訂單號/賬單號 OwnerID：財務子賬號ID |
控制臺功能對應API
1、控制臺路徑：費用與成本 – 賬單 – 賬單詳情 – 明細賬單
調用查詢實例賬單服務 獲取明細賬單“實例”、“計費項”維度數據。
調用方法可參見API選擇方案
2、控制臺路徑：費用與成本 – 賬單 – 賬單詳情 – 明細賬單
調用賬號賬單查詢服務 獲取明細賬單“賬號”維度數據。
調用方法可參見API選擇方案中，“數據字段”為“財務云主、子賬號”的接口說明。
調用賬號賬單查詢服務獲取的數據，對應控制臺“統計周期”為“賬單月份或天”的數據。
3、控制臺路徑：費用與成本 – 成本分攤 – 分賬賬單
調用分賬賬單服務 獲取“分賬賬單”數據。
調用方法可參見API選擇方案中，“數據字段”為“分賬賬單”的接口說明。
調用分賬賬單服務獲取的數據，對應控制臺“統計周期”為“賬單月份或天”的數據，不支持獲取“明細”維度數據。
4、控制臺路徑：費用與成本 – 企業財務 – 財務關聯
調用查詢企業財務關系列表 獲取“企業財務關系列表”數據。
調用方法可參見API選擇方案中，“數據字段”為“財務云主、子賬號”的接口說明。
調用查詢企業財務關系列表獲取的數據，對應舊版費用與成本控制臺“財務關聯”數據。
企業財務-財務關聯僅在舊版費用與成本提供。判斷您所使用的控制臺版本，請參見如何辨別費用與成本新版和舊版？
5、控制臺路徑：費用與成本 – 賬單 – 賬單詳情 – 明細賬單
調用結算賬單查詢服務 獲取“訂單號/賬單號”維度數據。
調用方法可參見API選擇方案中，“數據字段”為“訂單號/賬單號”中的接口說明。
調用結算賬單查詢服務獲取的數據，對應控制臺“明細賬單”數據。
6、控制臺路徑：費用與成本 – 賬單 – 賬單詳情 – 明細賬單
調用賬單訂閱服務 獲取“計費項”或“實例”維度數據。
調用方法可參見API選擇方案中，“數據字段”為“明細賬單”的接口說明。
調用賬單訂閱服務獲取的數據，對應控制臺“明細賬單”數據。
數據維度對應API匯總
查詢數據維度 | 可使用API |
產品 | 結算賬單查詢服務結算賬單查詢服務 賬單總覽查詢服務賬單總覽查詢服務 查詢實例賬單服務查詢實例賬單服務 賬號賬單查詢服務賬號賬單查詢服務 分賬賬單服務分賬賬單服務 查詢月費用分攤服務查詢月費用分攤服務 |
財務單元 | 查詢實例賬單服務查詢實例賬單服務 賬號賬單查詢服務賬號賬單查詢服務 分賬賬單服務分賬賬單服務 |
按日 | 分賬賬單服務分賬賬單服務 查詢實例賬單服務查詢實例賬單服務 賬號賬單查詢服務賬號賬單查詢服務 |
按月 | 結算賬單查詢服務結算賬單查詢服務 分賬賬單服務分賬賬單服務 查詢實例賬單服務查詢實例賬單服務 賬號賬單查詢服務賬號賬單查詢服務 賬單總覽查詢服務賬單總覽查詢服務 查詢月費用分攤服務查詢月費用分攤服務 |
各數據源產商品字段對比
數據源 | 產品Code | 產品明細Code | 產品名稱 | 商品名稱 |
控制臺 | - | - | 產品 | 產品明細 |
OSS（中文） | 產品Code | 產品明細Code | 產品 | 產品明細 |
OSS（英文） | Product Code | Product Type | ProductName | ProductDetail |
API | PipCode | CommodityCode | ProductName | ProductDetail |
常見FAQ
每月的日賬單匯總數據與當月賬單數據對比結果不一致，為什么？
日賬單中不包含后付費未結算的數據，月賬單中包含后付費未結算的數據。
通過子賬號調用“查詢月費用分攤服務”，RAM子賬號已被授權，為什么無返回值？
“查詢月費用分攤服務”目前只支持主賬號的AK查詢數據，后續會支持。
關于這些出參“PipCode、CommodityCode、ProductCode、ProductType”分別是什么意思？
“PipCode”是“產品Code”，與控制臺“用戶中心”賬單中“產品Code”字段含義一致；
“CommodityCode”是“產品明細Code”，與控制臺“用戶中心”中“產品明細Code”一致；
“ProductCode、ProductType”均是在API中透出的后臺冗余數據，和上述pipCode以及commodityCode不是一個概念，不能作為數據匯總和對賬分析使用。
為什么從出參的“ProductCode、ProductType”字段中獲取數據，傳到入參“ProductCode、ProductType”這兩個字段中無法獲取數據？
目前API的出參的“ProductCode、ProductType”和API入參“ProductCode、ProductType”在底層是兩套數據，且入參中“ProductCode、ProductType”目前的枚舉數據沒有可獲取的完整list，因此不建議傳入參數查詢。 如需要基于“產品Code”或“產品明細Code”分析數據，可通過“PipCode（產品Code）”和“CommodityCode（產品明細Code）”匯總分析。
各個API中入參“BillOwnerId”是指什么子賬號？
這里“BillOwnerId”是資源歸屬賬號ID，資源歸屬賬號是實際使用資源的賬號。
“實例明細賬單”和“計費項明細賬單”有什么區別？
兩份數據在出參字段上，都有“產品、產品明細、賬期、實例ID、訂賬單號、賬單類型”等字段，而“計費項明細賬單”存在一個獨有的“計費項（BillingItem）”字段。
更多數據字段的使用，請查看詳單文件格式
典型場景最佳實踐
1. 通過賬單數據分析資源規格變化情況
調用“查詢實例賬單服務”接口，獲取“實例ID（InstanceID）”、“實例配置（InstanceConfig）”字段，和歷史數據做對比即可。
2.如何批量查詢所有財務管理子賬號數據？
以“結算賬單查詢服務”為例：
通過財務云子賬號list獲取所有財務云賬單數據
調用“查詢企業財務關系列表”（查詢企業財務關系列表），獲取“關聯狀態（RELATED）”子賬號list，篩選出“財務管理（FinancialManagement）”子賬號list；
將“財務管理”子賬號list，枚舉傳入“結算賬單查詢服務”的“BillOwnerId”字段后，將獲取的數據組合起來即可。