ListDatabases API Overview for Cross-Source Database Queries - DataWorks - Alibaba Cloud - DataWorks

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.

Operation description

DataWorks Basic Edition or a higher edition is required.
For the StarRocks type, only the Internal catalog is supported.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListDatabases

list

*All Resource

*

None

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.	holo:instance_id
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 elements

Element	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	integer	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.
	Database	The database information.

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.