使用GetDatabase擷取資料地圖資料庫詳情-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

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

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
Id	string	是	資料庫實體 ID，可參考 ListDatabases 介面返回結果，以及中繼資料實體相關概念說明。格式為`${EntityType}:${執行個體 ID 或轉義後的 URL}:${資料目錄標識}:${資料庫名稱}`，對於不存在的層級使用Null 字元佔位。說明 starrocks 類型的資料目錄標識為目錄名稱，dlf 類型的資料目錄標識為目錄 ID, 其他類型不支援目錄層級，可用Null 字元佔位。幾種常用類型 ID 格式參考如下 `dlf-database::catalog_id:database_name` `holo-database:instance_id::database_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` 說明其中 `catalog_id`: dlf 目錄 id。 `instance_id`: 執行個體 ID，對應資料來源以執行個體模式註冊時需要提供。 `encoded_jdbc_url`: JDBC 串連串的 URLEncode 編碼,對應資料來源以串連串方式註冊時需要提供。 `database_name`: 資料庫名稱。	dlf-database::catalog_id:database_name

返回參數

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

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "Id": "holo-database:h-xxxx::test_db",
    "Name": "test_db",
    "Comment": "test comment",
    "LocationUri": "oss://test-bucket/test_db",
    "ParentMetaEntityId": "holo:h-xxxx",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

錯誤碼

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

變更歷史

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