All Products
Search

This Product

    Data Management:ListDataLakeTableName

    Document Center

    Data Management:ListDataLakeTableName

    Last Updated:Oct 28, 2025

    Retrieves a list of data lake table names.

    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

    Tid

    integer

    No

    The tenant ID.

    Note

    Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see View tenant information.

    3****

    CatalogName

    string

    Yes

    The name of the data catalog.

    hive

    DbName

    string

    Yes

    The name of the database.

    default

    TableNamePattern

    string

    No

    The regular expression used to match table names.

    .*

    NextToken

    string

    No

    The token that is used to retrieve the next page of results. Set this parameter to the value of NextToken that is returned from the last call. You do not need to specify this parameter for the first call.

    • If NextToken is empty, no subsequent query is required.

    • If NextToken has a return value, the value is the token for the next query.

    f056501ada12****

    MaxResults

    integer

    No

    The number of entries to return on each page. The maximum value is 100.

    20

    TableType

    string

    No

    The type of the table. Valid values:

    • MANAGED_TABLE: Internal table.

    • EXTERNAL_TABLE: Foreign table.

    • VIRTUAL_VIEW: Virtual view.

    • INDEX_TABLE: Index table.

    • MATERIALIZED_VIEW: Materialized view.

    MANAGED_TABLE

    WorkspaceId

    integer

    No

    The ID of the workspace.

    12****

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response.

    RequestId

    string

    The request ID, used for log tracing and troubleshooting.

    C5B8E84B-42B6-4374-AD5A-6264E175****

    Success

    boolean

    Indicates 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 fails.

    UnknownError

    ErrorMessage

    string

    The error message returned if the request fails.

    UnknownError

    TableNameList

    array

    A list of table names.

    string

    The name of the table.

    test_name

    NextToken

    string

    The token that is used to retrieve the next page of results.

    NesLoKLEdIZrKhDT7I2gS****

    MaxResults

    integer

    The number of entries returned per page.

    20

    Examples

    Success response

    JSON format

    {
  "RequestId": "C5B8E84B-42B6-4374-AD5A-6264E175****",
  "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.