All Products
Search

This Product

    Data Lake Formation:ListDatabases

    Document Center

    Data Lake Formation:ListDatabases

    Last Updated:Dec 16, 2025

    Retrieves databases.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    GET /dlf/v1/{catalogId}/databases HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    catalogId

    string

    Yes

    The ID of the catalog.

    clg-paimon-xxx

    maxResults

    integer

    No

    The maximum number of records to return in a single request.

    1000

    pageToken

    string

    No

    The token for the next page of results. If the response does not provide a token, pass an empty string ("").

    ""

    databaseNamePattern

    string

    No

    The database name pattern for fuzzy matching.

    database%

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    nextPageToken

    string

    The token for the next page of results. A null value indicates that this is the last page.

    E8ABEB1C3DB893D16576269017992F57

    databases

    array

    The databases.

    string

    The database name.

    database_name

    Examples

    Success response

    JSON format

    {
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57",
  "databases": [
    "database_name"
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.