全部產品
Search
文件中心

Dataphin:查看API資產詳情

更新時間:Oct 01, 2025

僅已上架的資產可查看資產詳情。本文為您介紹如何查看API資產詳情。

前提條件

已購買資產營運增值服務,併購買資料服務功能

API資產詳情

  1. 在Dataphin首頁的頂部功能表列,選擇資產 > 資產目錄

  2. 選擇API資產頁簽,單擊目標資產的名稱,進入資產詳情頁面。

    image

    地區

    描述

    概要資訊

    為您展示API的名稱、API_ID、類型、描述、標籤資訊。同時,您可以對資產執行以下操作:

    • 查看中繼資料:單擊跳轉至資產清單該API的詳情頁。

    • 搜尋資產:支援快捷搜尋其他對象,選擇需要查看的資產,跳轉至該API詳情頁。

    • 收藏:單擊即可收藏或移除最愛。收藏後,您也可以在個人資料中心查看全量收藏的資產,詳情請參見查看及管理我收藏的資產

    • 下載API文檔:單擊下載API文檔,格式為Word,便於業務人員修改。

    • 申請許可權:單擊快捷跳轉到當前API的許可權申請頁面,詳情請參見管理API許可權

    • 編輯:單擊編輯跳轉至目錄管理下當前API資產編輯頁面,可修改資產的屬性資訊、使用說明等,詳情請參見編輯資產資訊

    • 查看調用說明:單擊查看API的調用樣本模板,包括Java SDK調用方式(含Python SDK調用流程)、Token調用方式、白名單調用方式

      說明

      若在資料服務 > 調用 > 調用說明中修改SDK與調用說明,此處的調用說明將同步修改,因此協助文檔與實際會有差異。

    • 預設調用樣本下載:單擊下載API調用樣本。

    • python調用樣本下載:單擊下載Python樣本檔案壓縮包。

    • Java SDK下載:單擊下載Java SDK程式碼封裝。

    基本資料

    • 屬性資訊:為您展示API的屬性資訊,包括技術屬性。

      • 技術屬性:為您展示API的資產來源、API分組、資料更新頻率等資訊,您可以在資產詳情中查看對應API類型的技術屬性資訊。

        資料更新頻率:當前API的資料來源更新頻率,便於調用方瞭解資料的時效性。

      • 自訂屬性:為您展示在數倉規劃 > 屬性管理所建立的可見於資產目錄的屬性。其中,自訂屬性歸屬於業務屬性、管理屬性、技術屬性。

    • API文檔:您可查看API的基本資料、業務請求參數列表、公用請求參數列表、返回參數列表、JSON返回樣本、行級許可權列表(僅建立API時開啟行級許可權時展示)以及用戶端錯誤碼、服務端錯誤碼(調用API)、服務端錯誤碼(執行SQL語句)。

    • 使用說明:需要在手動上架的API資產編輯頁面開啟使用說明。為您展示當前資產的使用說明,為資料瀏覽者和使用者提供資訊參考。

    資產資訊

    為您展示API的用數統計基本資料等詳細資料。

    • 用數統計:包括API的瀏覽量、收藏數和最近7天調用數。

      • 瀏覽量:為您展示當前API的訪問頁次(PV),每重新整理1次增加1次,即時更新。僅包含訪問資產目錄詳情頁的頁次。

      • 收藏數:為您展示當前API被使用者收藏的次數,包含在資產清單和資產目錄中收藏的次數,即時更新。

      • 最近7天調用數:當前API最近7天被調用的次數,即時更新。

    • 基本資料:包括初次上架時間、最近上架時間、發布人、歸屬目錄。