ListDatabases - DataWorks - Alibaba Cloud Documentation Center

Queries a list of databases in an instance, cluster, or data catalog in Data Map. For DLF or StarRocks data sources, you can call this API operation to query databases in a data catalog. For StarRocks data sources, you can call this API operation to query databases in internal catalogs. For other types of data sources, you can call this API operation to query databases in an instance or cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	The parent entity ID. For more information, see Concepts related to metadata entities. You can refer to the ListCrawlerTypes operation for the parent entity type. If the parent entity is a catalog, the format of `ParentMetaEntityId` follows the response of the ListCatalogs API. If the parent entity is a metadata crawler, the format of `ParentMetaEntityId` is `${CrawlerType}:${Instance ID or encoded URL}`. ParentMetaEntityId format examples `dlf-catalog::catalog_id` `holo:instance_id` `mysql:(instance_id\|encoded_jdbc_url)` Note `catalog_id`: The ID of the DLF catalog. `instance_id`: The instance ID. Required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string. Required when the data source is registered by connection string.	mysql:rm-abc123xxx dlf-catalog:123456XXX:test_catalog
Name	string	No	The name. Supports fuzzy match.	test_tbl
Comment	string	No	The comment. Supports fuzzy match.	test comment
SortBy	string	No	The sort field. Default value: CreateTime. Valid values: CreateTime ModifyTime Name	CreateTime
Order	string	No	The sort order. Default value: Asc. Valid values: Asc: ascending. Desc: descending.	Asc
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of records per page. Default: 10. Maximum: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	9DD08926-38B9-XXXXXXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination result.
TotalCount	long	The total number of records returned.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of records per page.	10
Databases	array	The database list.
DatabaseList	Database	The database information.

Examples

Sample success responses

JSONformat

{
  "RequestId": "9DD08926-38B9-XXXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Databases": [
      {
        "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
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.