使用OpenAPI
本文為您介紹使用大數(shù)據(jù)開發(fā)治理平臺(tái)DataWorks OpenAPI的基本信息、使用限制、計(jì)費(fèi)及調(diào)用說明。
基本信息
版本 | OpenAPI門戶 | 支持的API列表 | 支持的地域 |
2024-05-18（新版OpenAPI） | 華東1（杭州）、華東2（上海）、華南1（深圳）、華北2（北京）、華北3（張家口）、北京政務(wù)云、華東2（上海）金融云、西南1（成都）、中國(guó)（香港）、亞太東南1（新加坡）、印度尼西亞（雅加達(dá)）、美國(guó)（硅谷）、美國(guó)（弗吉尼亞）和德國(guó)（法蘭克福）、英國(guó)（倫敦）、日本（東京）、馬來西亞（吉隆坡） 說明 數(shù)據(jù)開發(fā)相關(guān)API使用說明：
| ||
2020-05-18（舊版OpenAPI） |
使用限制
DataWorks為您提供不同功能模塊的OpenAPI，如租戶、元數(shù)據(jù)、數(shù)據(jù)開發(fā)、運(yùn)維中心等功能模塊。各功能模塊的OpenAPI對(duì)DataWorks的版本要求與功能本身對(duì)DataWorks版本的要求一致。
為規(guī)范DataWorks OpenAPI的調(diào)用，保障系統(tǒng)穩(wěn)定性，將OpenAPI分為讀、寫兩類。不同DataWorks版本中的讀、寫OpenAPI分別有相應(yīng)的QPS限制和每日調(diào)用次數(shù)限制，具體如下。
版本
QPS限制
每日調(diào)用次數(shù)上限
基礎(chǔ)版
所有API總QPS≤5
每日API總調(diào)用次數(shù)≤100次
標(biāo)準(zhǔn)版
每日API總調(diào)用次數(shù)≤1000次
專業(yè)版
每日API總調(diào)用次數(shù)≤10000次
企業(yè)版
讀API總QPS≤50
寫API總QPS≤20
每日API總調(diào)用次數(shù)不限
重要API QPS和調(diào)用次數(shù)的統(tǒng)計(jì)口徑：每個(gè)主賬號(hào)及其子賬號(hào)在每個(gè)地域的累計(jì)值。
當(dāng)超過QPS或每日調(diào)用次數(shù)限制后，將會(huì)出現(xiàn)調(diào)用失敗，請(qǐng)合理控制調(diào)用并發(fā)和次數(shù)。
API調(diào)用成功和調(diào)用失敗的次數(shù)都會(huì)計(jì)入每日調(diào)用限制次數(shù)中。
各API的讀寫類型可以根據(jù)API名稱判斷，例如
CreateFile為寫API，ListFiles為讀API。
免費(fèi)額度與計(jì)費(fèi)方式
各版本的OpenAPI分別提供相應(yīng)的每月免費(fèi)調(diào)用額度，超過之后則需按量付費(fèi)，可免費(fèi)調(diào)用的額度及后續(xù)按量計(jì)費(fèi)的詳情如下。
版本 | 免費(fèi)調(diào)用額度 | 超出免費(fèi)調(diào)用額度后按量計(jì)費(fèi) |
基礎(chǔ)版 | 3100次/月 | 有調(diào)用限制，不支持額外按量付費(fèi)。 |
標(biāo)準(zhǔn)版 | 31000次/月 | |
專業(yè)版 | 310000次/月 | |
企業(yè)版 | 1000000次/月 | 0.3元/萬(wàn)次 |
每個(gè)自然月會(huì)給每個(gè)主賬號(hào)（包含子賬號(hào)）在每個(gè)地域的OpenAPI一定的免費(fèi)調(diào)用額度，不同版本的DataWorks每月可用的免費(fèi)額度不一樣。
受不同版本DataWorks日調(diào)用次數(shù)限制（詳情見使用限制），基礎(chǔ)版、標(biāo)準(zhǔn)版、專業(yè)版的每月實(shí)際可調(diào)用量可能無法超過免費(fèi)調(diào)用額度，且不支持按量付費(fèi)。
DataWorks企業(yè)版免費(fèi)額度用盡后，支持根據(jù)按量計(jì)費(fèi)的價(jià)格進(jìn)行收費(fèi)，公共云的計(jì)費(fèi)如上所示，政務(wù)云環(huán)境下超出后的計(jì)費(fèi)為0.6元/萬(wàn)次，金融云環(huán)境下超出后的計(jì)費(fèi)為0.57元/萬(wàn)次，實(shí)際計(jì)費(fèi)價(jià)格以最終賬單顯示的價(jià)格為準(zhǔn)。
只有當(dāng)API調(diào)用成功后，才會(huì)消耗免費(fèi)調(diào)用額度并且在超過免費(fèi)調(diào)用額度后按量計(jì)費(fèi)。如果API調(diào)用失敗，則不會(huì)消耗免費(fèi)調(diào)用額度且不計(jì)量計(jì)費(fèi)。
調(diào)用說明
關(guān)于使用阿里云OpenAPI的詳細(xì)介紹，請(qǐng)參見阿里云OpenAPI。
調(diào)用方式
調(diào)用方式 | 支持情況 | 說明 |
阿里云SDK（推薦） | 支持 | 大數(shù)據(jù)開發(fā)治理平臺(tái) DataWorks SDK支持語(yǔ)言及依賴安裝方法請(qǐng)參見大數(shù)據(jù)開發(fā)治理平臺(tái) DataWorks SDK。 |
接口風(fēng)格
RPC風(fēng)格。
接入點(diǎn)
根據(jù)DataWorks項(xiàng)目空間所在的地域，選擇對(duì)應(yīng)的服務(wù)接入點(diǎn)地址，以獲得最低延遲。例如華北3（張家口）的VPC接入地址為dataworks-vpc.cn-zhangjiakou.aliyuncs.com，更多信息請(qǐng)參見服務(wù)接入點(diǎn)（2024-05-18）和服務(wù)接入點(diǎn)（2020-05-18）。
查看OpenAPI使用情況
您可以通過開放平臺(tái)，輕松獲取OpenAPI的使用情況，包括免費(fèi)額度使用情況、調(diào)用次數(shù)和調(diào)度明細(xì)等信息。詳情請(qǐng)參見開放API（OpenAPI）。