全部產品
Search
文件中心

DataWorks:資料服務API

更新時間:Jun 19, 2024

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

進入API尋找介面

  1. 進入資料地圖頁面。

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

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

    image.png

尋找API

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

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

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

    image.png

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

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

查看API詳情

API詳情頁面為您展示API的基礎資訊技術資訊參數資訊返回樣本使用說明image

地區

描述

單擊編輯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

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