本文為您介紹使用巨量資料開發治理平台DataWorks OpenAPI的基本資料、使用限制、計費及調用說明。
基本資料
版本 | OpenAPI門戶 | 支援的API列表 | 支援的地區 |
2024-05-18（新版OpenAPI） | 華東1（杭州）、華東2（上海）、華南1（深圳）、華北2（北京）、華北3（張家口）、北京政務雲、華東2（上海）金融雲、西南1（成都）、中國（香港）、亞太地區東南1（新加坡）、印尼（雅加達）、美國（矽谷）、美國（維吉尼亞）和德國（法蘭克福）、英國（倫敦）、日本（東京）、馬來西亞（吉隆坡） 說明 資料開發相關API使用說明：
| ||
2020-05-18（舊版OpenAPI） |
使用限制
DataWorks為您提供不同功能模組的OpenAPI，如租戶、中繼資料、資料開發、營運中心等功能模組。各功能模組的OpenAPI對DataWorks的版本要求與功能本身對DataWorks版本的要求一致。
為規範DataWorks OpenAPI的調用，保障系統穩定性，將OpenAPI分為讀、寫兩類。不同DataWorks版本中的讀、寫OpenAPI分別有相應的QPS限制和每日調用次數限制，具體如下。
版本
QPS限制
每日調用次數上限
基礎版
所有API總QPS≤5
每日API總調用次數≤100次
標準版
每日API總調用次數≤1000次
專業版
每日API總調用次數≤10000次
企業版
讀API總QPS≤50
寫API總QPS≤20
每日API總調用次數不限
重要API QPS和調用次數的統計口徑：每個主帳號及其子帳號在每個地區的累計值。
當超過QPS或每日調用次數限制後，將會出現調用失敗，請合理控制調用並發和次數。
API調用成功和調用失敗的次數都會計入每日調用限制次數中。
各API的讀寫類型可以根據API名稱判斷，例如
CreateFile為寫API，ListFiles為讀API。
免費額度與計費方式
各版本的OpenAPI分別提供相應的每月免費調用額度，超過之後則需隨用隨付，可免費調用的額度及後續隨用隨付的詳情如下。
版本 | 免費調用額度 | 超出免費調用額度後隨用隨付 |
基礎版 | 3100次/月 | 有調用限制，不支援額外隨用隨付。 |
標準版 | 31000次/月 | |
專業版 | 310000次/月 | |
企業版 | 1000000次/月 | 0.05美元/萬次 |
每個自然月會給每個主帳號（包含子帳號）在每個地區的OpenAPI一定的免費調用額度，不同版本的DataWorks每月可用的免費額度不一樣。
受不同版本DataWorks日調用次數限制（詳情見使用限制），基礎版、標準版、專業版的每月實際可調用量可能無法超過免費調用額度，且不支援隨用隨付。
DataWorks企業版免費額度用盡後，支援根據隨用隨付的價格進行收費，實際計費價格以最終賬單顯示的價格為準。
只有當API調用成功後，才會消耗免費調用額度並且在超過免費調用額度後隨用隨付。如果API調用失敗，則不會消耗免費調用額度且不計量計費。
調用說明
關於使用阿里雲OpenAPI的詳細介紹，請參見阿里雲OpenAPI。
調用方式
調用方式 | 支援情況 | 說明 |
阿里雲SDK（推薦） | 支援 | 巨量資料開發治理平台 DataWorks SDK支援語言及依賴安裝方法請參見巨量資料開發治理平台 DataWorks SDK。 |
介面風格
RPC風格。
存取點
根據DataWorks專案空間所在的地區，選擇對應的服務存取點地址，以獲得最低延遲。例如華北3（張家口）的VPC接入地址為dataworks-vpc.cn-zhangjiakou.aliyuncs.com，更多資訊請參見服務存取點（2024-05-18）和服務存取點（2020-05-18）。
查看OpenAPI使用方式
您可以通過開放平台，輕鬆擷取OpenAPI的使用方式，包括免費額度使用方式、調用次數和調度明細等資訊。詳情請參見開放API（OpenAPI）。