調用ListDataLakeDatabase API擷取資料湖資料庫列表-Data Management-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListDataLakeDatabase

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DataRegion	string	是	資料湖所屬的地區。	cn-hangzhou
CatalogName	string	是	查詢的資料目錄名稱。您可前往資料湖控制台查看資料目錄名稱。	hive
SearchKey	string	否	搜尋資料庫名稱的關鍵字。	default
Tid	integer	否	租戶 ID。說明滑鼠移動到介面右上方的頭像處，查看租戶 ID。具體操作，請參見查看租戶資訊。	3****
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	f056501ada12c1cc
MaxResults	integer	否	分頁大小。最大值為 100。	20
WorkspaceId	integer	否	工作空間 ID。	12****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID，用於定位日誌，排查問題。	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true
ErrorCode	string	錯誤碼。	400
ErrorMessage	string	錯誤資訊。	UnknownError
DatabaseList	array	資料庫列表。
	DLDatabase	資料庫詳情。
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	NesLoKLEdIZrKhDT7I2gSw==
MaxResults	integer	限定每次返回的最大條數，可以和 nextToken 搭配使用實現翻頁能力	20

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "DatabaseList": [
    {
      "Description": "Default database for catalog hive",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "DbId": 19,
      "CatalogName": "hive",
      "Name": "default",
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gSw==",
  "MaxResults": 20
}

錯誤碼

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

變更歷史

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