全部產品
Search
文件中心

DataWorks:開放API(OpenAPI)

更新時間:Nov 15, 2024

DataWorks開放平台提供OpenAPI能力,通過調用DataWorks的OpenAPI使用DataWorks的各項功能,實現應用和DataWorks的整合和互動。

背景資訊

DataWorks的OpenAPI提供100多個API功能,通過調用API,可以快速進行大量操作和系統整合對接等工作,提高資料開發效率,滿足企業定製化需求。您還可以通過開放平台,輕鬆擷取OpenAPI的使用方式,包括免費額度使用方式、調用次數和調度明細等資訊。關於OpenAPI詳細資料,請參見DataWorks OpenAPI概述

使用限制

  • 版本要求:

    DataWorks為您提供不同功能模組的OpenAPI,如租戶、中繼資料、資料開發、營運中心等功能模組。各功能模組的OpenAPI對DataWorks的版本要求與功能本身對DataWorks版本的要求一致。

    • 各版本的OpenAPI有相應的調用限制,詳情請參見調用限制

    • 各版本的OpenAPI分別提供相應的每月免費調用額度,超過之後則需隨用隨付,可免費調用的額度及後續隨用隨付的詳情請參見免費額度與計費方式

    • 各個OpenAPI對應的版本,請參見OpenAPI列表

  • 可用地區:

    華東1(杭州)、華東2(上海)、華南1(深圳)、華北2(北京)、華北3(張家口)、北京政務雲、華東2(上海)金融雲、西南1(成都)、中國(香港)、亞太地區東南1(新加坡)、印尼(雅加達)、美國(矽谷)、美國(維吉尼亞)、德國(法蘭克福)、英國(倫敦)、日本(東京)、澳大利亞(雪梨)關停中、馬來西亞(吉隆坡) 。

查看OpenAPI使用方式

登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的更多 > 開放平台,進入開放平台的開發人員後台頁面。

您可在該頁面查看OpenAPI的使用方式,以及DataWorks為您提供的OpenAPI最佳實務。OpenAPI

OpenAPI功能區簡介

OpenAPI頁面可以為您展示OpenAPI的使用方式,具體如下:

  • OpenAPI免費額度:可以查看每個自然月截止當前日期API的免費額度使用方式。目前,不同版本的DataWorks會為您提供不同的免費調用額度,免費額度使用完後,超出部分會隨用隨付,具體請參考DataWorks OpenAPI概述

  • OpenAPI調用次數:可以查看每個自然月截止當前日期所有OpenAPI的總調用次數,按自然月累計,每月1日清零重新累計。

  • OpenAPI調用明細:可以查看特定時間段內API的調用資訊,包括調用日期、API類別、API層級、當天調用次數和本月累計調用次數。您可以通過API類型和API層級篩選所要尋找的API資訊。不同版本的DataWorks每日可調用的次數上限不同,詳情請參見DataWorks OpenAPI概述

OpenAPI最佳實務

在開放平台的OpenAPI頁面上,有OpenAPI最佳實務模組,在模組下直接單擊最佳實務,可跳轉到相應的最佳實務文檔。或者,您也可以點擊以下連結跳轉到相應的最佳實務文檔,供您參考。

更多OpenAPI參考,詳情請參見API概覽