調用GetCatalog API擷取資料地圖的資料目錄詳情-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

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

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:GetCatalog

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Id	string	是	資料目錄實體 ID，當前支援 dlf 與 starrocks 類型，可參考 ListCatalogs 介面返回結果，以及中繼資料實體相關概念說明。對於 dlf 類型，格式為 `dlf-catalog::catalog_id` 對於 starrocks 類型，格式為`starrocks-catalog:(instance_id\|encoded_jdbc_url):catalog_name` 說明其中 `catalog_id`: dlf 目錄 id `instance_id`: 執行個體 ID，對應資料來源以執行個體模式註冊時需要提供 `encoded_jdbc_url`: JDBC 串連串的 URLEncode 編碼,對應資料來源以串連串方式註冊時需要提供 `catalog_name`: starrocks 目錄名稱	dlf-catalog::catalog_id

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	1AFAE64E-D1BE-432B-A9****
Success	boolean	請求是否成功。	true
Catalog	Catalog	資料目錄資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Catalog": {
    "Id": "dlf-catalog:123456XXX:test_catalog\nstarrocks-catalog:c-abc123xxx:default_catalog",
    "Name": "default_catalog",
    "Comment": "this is a comment\n",
    "Type": "Internal",
    "CreateTime": 1722073854000,
    "ModifyTime": 1722073854000,
    "ParentMetaEntityId": "dlf\nstarrocks:c-abc123xxx"
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。