All Products
Search

This Product

    Data Lake Formation:ListTables

    Document Center

    Data Lake Formation:ListTables

    Last Updated:Dec 16, 2025

    Retrieves a list of tables.

    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/{database}/tables HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    catalogId

    string

    Yes

    The catalog ID.

    clg-paimon-xxx

    database

    string

    Yes

    The database name.

    database_name

    maxResults

    integer

    No

    The maximum number of records to return.

    1000

    pageToken

    string

    No

    The token to retrieve the next page of results. If the response does not include this parameter, pass an empty string ("").

    ""

    tableNamePattern

    string

    No

    The table name pattern.

    table%

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    tables

    array

    A list of tables.

    string

    The details of the table.

    table_name

    nextPageToken

    string

    The token to retrieve the next page of results. If this parameter is null, all results have been returned.

    E8ABEB1C3DB893D16576269017992F57

    Examples

    Success response

    JSON format

    {
  "tables": [
    "table_name"
  ],
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.