ListDatabases - 查询数据地图数据库列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

查询数据地图中给定实例/集群/数据目录下的数据库列表。对于dlf/starrocks类型，查询给定数据目录下的数据库列表，其中starocks类型仅支持查询Internal Catalog；对于其他类型，查询给定实例/集群下的数据库列表。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。
对于 starrocks 类型，当前仅支持查询 Internal catalog

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ParentMetaEntityId	string	是	父层级实体 ID，可参考元数据实体相关概念说明。父层级实体类型参考 ListCrawlerTypes 接口若父层级实体为数据目录，`ParentMetaEntityId`格式参考 ListCatalogs 接口返回结果。如果父层级实体为元数据采集器，`ParentMetaEntityId`格式为`${CrawlerType}:${实例 ID 或转义后的 URL}`。几种常用类型的 ParentMetaEntityId 格式参考如下： `dlf-catalog::catalog_id` `holo:instance_id` `mysql:(instance_id\|encoded_jdbc_url)` 说明其中 `catalog_id`: dlf 目录 id。 `instance_id`: 实例 ID，对应数据源以实例模式注册时需要提供。 `encoded_jdbc_url`: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供。	holo:instance_id
Name	string	否	名称，模糊匹配。	test_tbl
Comment	string	否	注释，模糊匹配。	test comment
SortBy	string	否	排序字段，默认为 CreateTime，枚举值，当前支持： CreateTime：创建时间 ModifyTime：修改时间 Name：名称	CreateTime
Order	string	否	排序方向，默认为 Asc，枚举值，当前支持： Asc：升序 Desc：降序	Asc
PageNumber	integer	否	分页页码，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10，最大为 100。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	9DD08926-38B9-XXXXXXX
Success	boolean	请求是否成功。	true
PagingInfo	object	分页结果。
TotalCount	long	总条数。	1
PageNumber	integer	页码。	1
PageSize	integer	分页大小。	10
Databases	array	数据库列表。
DatabaseList	Database	数据库信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "9DD08926-38B9-XXXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Databases": [
      {
        "Id": "dlf-database::catalog_id:database_name",
        "Name": "database_name",
        "Comment": "test comment",
        "LocationUri": "oss://test-bucket/test_db",
        "ParentMetaEntityId": "dlf-catalog::catalog_id",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

错误码

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