調用GetDataLakeCatalog API擷取資料湖的資料目錄-Data Management-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetDataLakeCatalog

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
CatalogName	string	是	資料目錄名。	hive
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 或 ListUserTenants 擷取該參數的值。	3****
WorkspaceId	integer	否	工作空間 ID。	12****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID，用於定位日誌，排查問題。	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Success	boolean	請求是否成功，傳回值如下： true：請求成功。 false：請求失敗。	true
ErrorCode	string	錯誤碼。	400
ErrorMessage	string	調用失敗時，返回的出錯資訊。	code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B****
Catalog	DLCatalog	資料目錄資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF****",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "code: 404, can not find catalog, name : hiv request id: 6090E571-E5B1-1E6D-BF44-F9E10E8B****",
  "Catalog": {
    "Description": "init default catalog",
    "Name": "hive",
    "Location": "oss://xxxx"
  }
}

錯誤碼

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

變更歷史

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