全部產品
Search
文件中心

DataWorks:GetSchema - 擷取資料地圖資料庫模式資訊

更新時間:Mar 21, 2026

擷取資料地圖中給定模式的詳細資料,當前支援MaxCompute和Hologres類型。

介面說明

  1. 需要購買 DataWorks 基礎版及以上版本才能使用。

  2. 當前支援 MaxCompute 和 Hologres 類型。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

Id

string

ID,可參考 ListSchemas 介面返回結果,以及中繼資料實體相關概念說明

格式為${EntityType}:${執行個體 ID 或轉義後的 URL}:${資料目錄標識}:${資料庫名稱}:${模式名稱},對於不存在的層級Null 字元佔位。

說明

對於 MaxCompute 類型,執行個體 ID 層級使用Null 字元佔位,資料庫名稱為 MaxCompute 專案名稱,且要求該專案已開啟三層模型。

幾種常用類型 ID 格式參考如下

maxcompute-schema:::project_name:schema_name (要求該專案已開啟三層模型)

holo-schema:instance_id::database_name:schema_name

說明

其中
instance_id: holo 執行個體 ID
database_name: 資料庫名稱
project_name: MaxCompute 專案名
schema_name: schema 名稱



maxcompute-schema:::project_name:schema_name

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

請求 ID。

A89B5D9D-74EA-XXXXXX

Success

boolean

請求是否成功。

true

Schema Schema

schema 資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A89B5D9D-74EA-XXXXXX",
  "Success": true,
  "Schema": {
    "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
    "Name": "test_db",
    "Comment": "test comment",
    "Type": "MANAGED",
    "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情