使用OpenAPI
本文為您介紹使用巨量資料開發治理平台DataWorks OpenAPI的基本資料、使用限制、計費及調用說明。
基本資料
|
版本 |
OpenAPI門戶 |
支援的API列表 |
支援的地區 |
|
2024-05-18（新版OpenAPI） |
華東1（杭州）、華東2（上海）、華南1（深圳）、華北2（北京）、華北3（張家口）、北京政務雲、華東2（上海）金融雲、西南1（成都）、中國（香港）、亞太地區東南1（新加坡）、印尼（雅加達）、美國（矽谷）、美國（維吉尼亞）和德國（法蘭克福）、英國（倫敦）、日本（東京）、馬來西亞（吉隆坡） 重要
資料開發相關API使用說明：
請您確認是否已使用新版資料開發（Data Studio），並選擇對應的OpenAPI版本。若未正確選擇，可能導致查詢失敗或無法擷取預期結果。 |
||
|
2020-05-18（舊版OpenAPI） |
使用限制
-
DataWorks為您提供不同功能模組的OpenAPI，如租戶、中繼資料、資料開發、營運中心等功能模組。各功能模組的OpenAPI對DataWorks的版本要求與功能本身對DataWorks版本的要求一致。
-
為規範DataWorks OpenAPI的調用，保障系統穩定性，將OpenAPI分為讀、寫兩類。不同DataWorks版本中的讀、寫OpenAPI分別有相應的QPS限制；其中基礎版還設有每日調用次數上限，標準版、專業版、企業版不設每日調用次數上限。各版本還對應不同的每月免費調用額度及超出後的隨用隨付規則，匯總如下表。
版本
QPS限制
每日調用次數上限
每月免費調用額度
超出免費額度後隨用隨付
基礎版
所有API總QPS≤5
每日API總調用次數≤100次
3100次/月
有調用限制，不支援額外隨用隨付。
標準版
每日API總調用次數不限
100000次/月
0.05美元/萬次
專業版
每日API總調用次數不限
500000次/月
0.05美元/萬次
企業版
-
讀API總QPS≤50
-
寫API總QPS≤20
每日API總調用次數不限
1000000次/月
0.05美元/萬次
重要-
API QPS和調用次數的統計口徑：每個主帳號及其子帳號在每個地區的累計值。
-
當超過QPS限制，或基礎版超過每日調用次數上限後，將會出現調用失敗，請合理控制調用並發和次數。
-
對基礎版，API調用成功和調用失敗的次數均計入每日調用次數上限；標準版、專業版、企業版不設每日調用次數上限，調用失敗次數不計入每日調用次數上限，請關注每月免費調用額度及隨用隨付規則。
-
各API的讀寫類型可以根據API名稱判斷，例如
CreateFile為寫API，ListFiles為讀API。
-
前提條件
您在調用OpenAPI前，請檢查是否開啟AliyunDataWorksFullAccess許可權，以防因許可權問題導致調用OpenAPI失敗，詳情可參考使用者權限控制。
免費額度與計費方式
各版本每月免費調用額度、超出後隨用隨付單價，以及 QPS、每日調用次數等限制，已合并在上文使用限制一節的匯總表中。以下補充說明計費統計口徑與注意事項。
-
每個自然月會給每個主帳號（包含子帳號）在每個地區的OpenAPI一定的免費調用額度，不同版本的DataWorks每月可用的免費額度不一樣。
-
基礎版同時受每日調用次數與每月免費調用額度限制（詳情見上文使用限制），超出後不可繼續調用，且不支援隨用隨付。標準版、專業版不設每日調用次數上限，每月各有免費調用額度（見上文使用限制中的匯總表）；超出免費額度後支援隨用隨付，單價與環境差異請參見資源成本中的OpenAPI計費。企業版不設每日調用次數上限，免費額度用盡後隨用隨付規則保持不變。
-
DataWorks標準版、專業版和企業版在每月免費調用額度用完後，支援按隨用隨付的價格繼續調用。International sites use the unit price and billing shown in the documentation.詳情請參見資源成本，實際計費價格以最終賬單顯示的價格為準。
調用說明
關於使用阿里雲OpenAPI的詳細介紹，請參見阿里雲OpenAPI。
調用方式
|
調用方式 |
支援情況 |
說明 |
|
阿里雲SDK（推薦） |
支援 |
巨量資料開發治理平台 DataWorks SDK支援語言及依賴安裝方法請參見巨量資料開發治理平台 DataWorks SDK。 |
|
支援 |
原生HTTP調用需要您自己實現簽名演算法，並構建自訂請求，發起HTTP調用。有關簽名機制的更多詳細資料，請參見請求結構和簽名機制。 |
調用樣本
介面風格
RPC風格。
存取點
根據DataWorks專案空間所在的地區，選擇對應的服務存取點地址，以獲得最低延遲。例如華北3（張家口）的VPC接入地址為dataworks-vpc.cn-zhangjiakou.aliyuncs.com，更多資訊請參見服務存取點（2024-05-18）和服務存取點（2020-05-18）。
查看OpenAPI使用方式
您可以通過開放平台，輕鬆擷取OpenAPI的使用方式，包括免費額度使用方式、調用次數和調度明細等資訊。詳情請參見開放API（OpenAPI）。