全部產品
Search
文件中心

Data Management:GetDataLakeDatabase - 擷取資料湖的資料庫資訊

更新時間:Mar 21, 2026

調用此API可以擷取資料湖中的資料庫資訊。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetDataLakeDatabase

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

DataRegion

string

資料湖所屬的地區。

cn-hangzhou

CatalogName

string

資料目錄名。

hive

Name

string

資料庫名稱。

default

Tid

integer

租戶 ID。

說明

取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊

3

WorkspaceId

integer

工作空間 ID。

12****

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

E5EE2B9E-2F95-57FA-B284-CB441CEE49D6

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功。

  • false:請求失敗。

true

ErrorCode

string

錯誤碼。

404

ErrorMessage

string

錯誤資訊。

code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29

Database DLDatabase

資料庫資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E5EE2B9E-2F95-57FA-B284-CB441CEE49D6",
  "Success": true,
  "ErrorCode": "404",
  "ErrorMessage": "code: 404, can not find catalog, name : hive1 request id: FF737753-9641-1F51-AFDA-7DF541114B29",
  "Database": {
    "Description": "Default database for catalog hive",
    "Parameters": {
      "test": "test",
      "test2": 1
    },
    "DbId": 19,
    "CatalogName": "hive",
    "Name": "default",
    "Location": "oss://xxx"
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情