全部產品
Search
文件中心

Dataphin:建立單物理表格服務單元

更新時間:Jul 08, 2025

單物理表格服務單元用於對業務資料來源的單個物理表進行中繼資料配置。後續您可以基於該單物理表格服務單元開發訪問該物理表資料的API。本文為您介紹如何建立單物理表格服務單元。

前提條件

  • 已完成服務單元分組的建立。具體操作,請參見建立服務專案分組

  • 當資料來源類型為HBase 0.9.4/1.1.x/1.2.1/2.x、Elasticsearch或MongoDB時,需要完成中繼資料的建立。具體操作,請參見建立中繼資料

  • 需購買行級許可權功能。

使用限制

許可權說明

支援專案系統管理員開發使用者建立服務單元。

步驟一:選擇服務單元類型

  1. 在Dataphin首頁的頂部功能表列,選擇服務 > API開發

  2. 在左上方選擇專案,單擊左側導覽列服務單元,在服務單元頁面,單擊+建立服務單元

  3. 建立服務單元對話方塊,選擇單物理表格服務單元

步驟二:配置單物理表格服務單元參數

  1. 建立服務單元頁面,佈建服務單元的基礎資訊和單元欄位。

    1. 服務單元基礎資訊配置

      參數

      描述

      服務單元名稱

      服務單元的名稱。命名規則如下:

      • 只能包含字母、數字和底線(_)。

      • 以字母開頭。

      • 長度在4~64個字元範圍內。

      服務單元分組

      選擇已建立的服務單元分組。

      模式

      模式用於定義服務單元讀取的資料是來自開發資料來源還是生產資料來源。模式包括BasicDev-Prod模式:

      • Basic:選擇了Basic模式後,服務單元讀取資料時您只能選擇到生產資料來源。

      • Dev-Prod:選擇了Dev-Prod模式後,服務單元讀取資料時您可以選擇開發資料來源和生產資料來源。

      您可以在資料來源頁面,查看您的資料來源是生產資料來源還是開發資料來源。fgagag

      物理資料表

      您可根據資料來源類型以及資料來源篩選物理表。也可以單擊新增資料來源引入新的業務資料來源,以便基於新的業務資料來源建立服務單元。支援的資料來源請參見資料服務支援的資料來源

      服務單元描述

      填寫對服務單元的簡單描述。不超過128個字元。

      最大返回條數

      Dataphin預設最大返回條數為1000條,支援最大限制為10000條。

      用於定義API查詢資料時返回的條數,避免一次查詢過多資料導致Dataphin系統記憶體溢出。如果需要查詢更多資料,您可以在調用API的SDK中修改PageSize參數值,以實現查詢API時返回更多的資料。

      如果已有的服務單元與您配置的基礎資訊相似,則Dataphin會自動為您展示相似服務單元的名稱,您可以在服務單元列表中查看該服務單元的詳細資料。如果需要繼續建立新的服務單元,則單擊繼續建立,即可進入佈建服務單元欄位頁面。gagag

    2. 佈建服務單元欄位。

      參數

      描述

      服務單元欄位類型

      支援選擇的欄位類型包括Double、Float、String、Date、Boolean、Int、Long、Short、Byte、BigDecimal、Binary。您需要根據業務資料表中欄位的類型選擇對應的參數類型。

      如果業務資料表的欄位類型不在待選參數類型範圍內,推薦您選擇String。

      服務單元欄位

      • 支援自訂勾選部分源表欄位作為服務單元欄位,對源表新增欄位也可在編輯時添加勾選。

      • 配置資料來源中欄位對應到服務單元中的欄位名稱,您可以根據業務情況自訂欄位名稱。命名規則如下:

        • 只能包含字母、數字和底線(_)。

        • 以字母開頭。

        • 長度在4~64個字元範圍內。

      • 在編輯單物理表格服務單元時,系統如果判斷到源表欄位已刪除,則支援刪除該服務單元欄位,提交配置後,在引用該服務單元建立API時,不會有該欄位,避免調用API時因源表欄位不存在而失敗。

      服務單元欄位描述

      填寫對服務單元欄位的簡單描述。

      完成服務單元欄位的配置後,單擊底部資料預覽,查看欄位對應業務資料。最多返回1000條資料。

    3. 根據選擇的物理資料表,系統自動為您解析物理資料表所關聯的行級許可權資訊,包括行級許可權名稱、描述說明、控制欄位、資料來源環境、關聯表、關聯欄位。同時,您可以執行如下操作。

      • 開啟關閉行級許可權:控制行級許可權的生效狀態以及在查看服務單元時是否可見行級許可權列表資訊。

      • 去建立行級許可權:操作人需具有行級許可權建立許可權。單擊跳轉至管理中心 > 許可權管理的行級許可權建立頁面,建立行級許可權

        說明
        • 調用該API所返回的資料範圍受到行級許可權的管控,行級許可權不一致時,資料返回結果會存在差異。

        • 當模式為Basic時,展示生產環境關聯的物理資料錶行級許可權;模式為Dev-Prod時,展示開發環境和生產環境關聯的物理資料錶行級許可權。

        • 若服務單元開啟行級許可權並發行,則在該服務單元下建立的API,在被調用時會受到對應行級許可權管控。

        • 在已開啟行級許可權並發行的服務單元下建立API,若在管理中心 > 許可權管理建立/刪除該服務單元所關聯的行級許可權,則系統會自動生效/失效行級許可權,無需重新發布API。

        • 添加的物理表,無論該物理表的欄位是否被API應用或是否添加到服務單元,均會受到物理表所關聯的行級許可權管控。

  2. 單擊提交,完成單物理表格服務單元建立。

後續步驟

  • 在服務單元頁面,單擊操作列下image.png表徵圖,選擇發布,將單物理表格服務單元提交至生產環境,後續就可基於此單物理表格服務單元建立API。詳情請參見建立API

  • 物理表格服務單元建立完成後,您可在服務單元頁面執行編輯、發布、刪除等操作。詳情請參見管理服務單元