全部產品
Search
文件中心

DataWorks:資料服務API

更新時間:Jul 25, 2026

資料地圖支援對當前租戶下所有工作空間的資料服務API進行搜尋和定位,實現資料服務API的高效尋找。

進入API尋找介面

  1. 進入資料地圖頁面。

    登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的數據治理 > 數據地圖,在右側頁面中單擊進入數據地圖。

  2. 在搜尋方塊上方,選擇API類目,進入尋找API的頁面。

    搜尋欄左側的搜尋類型下拉式功能表包含代碼、API和資料集三個分組,在API分組中選擇API。

尋找API

  1. 在API類目下的搜尋方塊中輸入API ID、APIPath、API名稱、API描述等關鍵字進行搜尋。

    在搜尋方塊中輸入關鍵字後,將通過關鍵字匹配,在搜尋方塊的下拉式清單中初步篩選,展示出合格前10個API。

  2. 如果在搜尋方塊的下拉式清單中無法定位到目標API,可以單擊搜尋,在列表中展示出所有合格API。

  3. 您可以在頁面左側根據API類型、工作空間、負責人對搜尋結果中的API進行二次過濾。

  4. 找到目標API後,如需查看API詳情,可以單擊目標API進入詳情頁。詳情請參見查看API詳情。

查看API詳情

API詳情頁面為您展示API的基礎信息、技術信息、參數信息、返回示例和使用說明。若 API 為腳本模式,還會額外展示代碼頁簽。

API 詳情頁面分為以下三個地區:地區①位於頁面頂部,展示 API 名稱、描述及編輯 API 入口;地區②位於左側面板,展示 API 的基礎資訊和技術資訊;地區③位於右側面板,通過頁簽展示參數資訊、返回樣本、血緣資訊和使用說明等詳細內容。各地區的具體資訊如下表所示。

地區

描述

①

單擊編輯API跳轉至API所屬工作空間的編輯視窗進行API編輯。詳情請參見API測試、發布與版本管理和註冊外部API服務。

說明

:如果當前登入帳號不在API所屬的工作空間中,請聯絡目標工作空間對應管理員將您的帳號添加到目標空間的成員列表中並賦予開發人員角色,詳情請參見空間級模組許可權管控。

②

在該地區您可以查看該API的如下資訊:

  • 基礎信息:您可以查看API的瀏覽次數、調用次數、API ID、工作空間、負責人、創建時間、更新時間、描述等資訊。

  • 技術信息:您可以查看API類型、請求方式、返回類型、數據源類型、數據源名稱、錶名稱等資訊。

③

在該地區您可以查看該API的如下資訊:

  • 參數信息:您可以查看API的請求參數、返回參數。

    • 請求參數:您可以查看公共請求參數和應用請求參數的参数名、參數類型、參數位置、示例值、默認值、描述、標籤等資訊。

    • 返回參數:您可以查看公共返回參數和應用返回參數的参数名、參數類型、示例值、描述等資訊。

  • 返回示例:在API發布前,如果對API進行測試並在測試時勾選了自動保存正常返回示例,將根據測試結果更新API返回樣本。詳情請參見測試API,您可以根據返回示例的資料內容和資料結構瞭解API返回結果。

  • 血緣信息:您可以查看資料表、API、APP之間的完整血緣關係。資料介面API的上遊血緣支援的資料來源類型包括:Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、AnalyticDB for PostgreSQL。

    說明
    • 生成API是通過資料來源或表封裝的API,因此血緣鏈路將包括:資料表、API、APP。

    • 註冊API是通過後端地址封裝的API,因此血緣鏈路將僅包括:API和APP。

    • 血緣資訊的產出、更新的時效是T+1。

  • 使用說明:您可以進行編輯、查看歷史版本的操作,根據業務說明瞭解相關的資訊。

  • 代碼:僅當 API 為腳本模式時顯示此頁簽,查看開發人員編寫的自訂查詢代碼(如 SQL)。其他 API 類型(如嚮導模式、註冊 API、服務編排 API)不展示該頁簽;嚮導模式 API 的 SQL 需要在資料服務的 API 開發編輯器中查看。

    說明

    如果您從資料地圖全域搜尋方塊中直接搜尋程式碼片段命中指令碼模式 API,系統會自動定位到代碼頁簽。