All Products
Search

This Product

    Data Management:ListDataLakeTableName

    Document Center

    Data Management:ListDataLakeTableName

    Last Updated:Aug 28, 2026

    Queries table names in a data lake.

    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

    dms:ListDataLakeTableName

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DataRegion

    string

    Yes

    The region where the data lake resides.

    cn-hangzhou
    Tid

    integer

    No

    The ID of the tenant.

    Note

    To view the tenant ID, go to the DMS console and hover over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.

    3***
    CatalogName

    string

    Yes

    The name of the data catalog.

    hive
    DbName

    string

    Yes

    The database name.

    default
    TableNamePattern

    string

    No

    A regular expression used to filter table names.

    .*
    NextToken

    string

    No

    The token used to retrieve the next page of results. Valid values:

    • If NextToken is empty, there is no next page.

    • If a value of NextToken is returned, use it to retrieve the next page.

    f056501ada12c1cc
    MaxResults

    integer

    No

    The number of records per page. Valid values: 1 to 100.

    20
    TableType

    string

    No

    The type of the data table. Valid values:

    • MANAGED_TABLE

    • EXTERNAL_TABLE

    • VIRTUAL_VIEW

    • INDEX_TABLE

    • MATERIALIZED_VIEW

    MANAGED_TABLE
    WorkspaceId

    integer

    No

    The workspace ID.

    12****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID. You can use the ID to query logs and troubleshoot issues.

    C5B8E84B-42B6-4374-AD5A-6264E1753378
    Success

    boolean

    Whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    ErrorCode

    string

    The error code returned if the request failed.

    UnknownError
    ErrorMessage

    string

    The error message returned if the request failed.

    UnknownError
    TableNameList

    array

    The table names.

    string

    The table name.

    test_name
    NextToken

    string

    The token for retrieving the next page of results.

    NesLoKLEdIZrKhDT7I2gS****
    MaxResults

    integer

    The number of records per page.

    20

    Examples

    Success response

    JSON format

    {
  "RequestId": "C5B8E84B-42B6-4374-AD5A-6264E1753378",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "TableNameList": [
    "test_name"
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.