GetDatabase - 获取数据地图数据库详情 - 大数据开发治理平台 DataWorks

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Id	string	是	数据库实体 ID，可参考 ListDatabases 接口返回结果，以及元数据实体相关概念说明。格式为`${EntityType}:${实例 ID 或转义后的 URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位。说明 starrocks 类型的数据目录标识为目录名称，dlf 类型的数据目录标识为目录 ID, 其他类型不支持目录层级，可用空字符占位。几种常用类型 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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。