ListDataLakeTable - Data Management - Alibaba Cloud Documentation Center

Retrieves a list of data lake 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

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:ListDataLakeTable

get

*All Resource

*

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 name of the metadata table. This parameter supports regular expressions.	.*
TableType	string	No	The type of the table. Valid values: MANAGED_TABLE: Internal table. EXTERNAL_TABLE: External table. VIRTUAL_VIEW: Virtual view. INDEX_TABLE: Index table. MATERIALIZED_VIEW: Materialized view.	MANAGED_TABLE
NextToken	string	No	The token used to retrieve the next page of results. To retrieve the next page, set this parameter to the `NextToken` value from the previous response. If you do not specify this parameter, the first page is returned. If NextToken is empty, there are no more queries. If NextToken has a value, the value is the token to start the next query.	f056501ada12****
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100.	20
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.	3D3FB827-E667-50DB-AD59-C83F8237****
Success	boolean	Indicates whether the request was successful. 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
TableList	array	The list of table details.
	DLTable	The list of tables.
NextToken	string	The token that is used to retrieve the next page of results.	NesLoKLEdIZrKhDT7I2gS****
MaxResults	integer	The number of entries returned on each page.	20

Examples

Success response

JSON format

{
  "RequestId": "3D3FB827-E667-50DB-AD59-C83F8237****",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "TableList": [
    {
      "ViewOriginalText": "\"\"",
      "Owner": "zhangsan",
      "TableType": "EXTERNAL_TABLE",
      "Parameters": {
        "EXTERNAL": "TRUE",
        "delta.minReaderVersion": "1"
      },
      "Description": "test",
      "CreatorId": 0,
      "CreateTime": 1731586286,
      "StorageDescriptor": {
        "OriginalColumns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "SortCols": [
          {
            "Order": 1,
            "Col": "col1"
          }
        ],
        "Parameters": {
          "test": "test",
          "test2": 1
        },
        "SkewedInfo": {
          "SkewedColValues": [
            [
              "\"123\""
            ]
          ],
          "SkewedColValueLocationMaps": {
            "test": "test",
            "test2": 1
          },
          "SkewedColNames": [
            "col1"
          ]
        },
        "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
        "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
        "Columns": [
          {
            "Comment": "from deserializer",
            "Type": "string",
            "Name": "col"
          }
        ],
        "IsCompressed": false,
        "SerdeInfo": {
          "SerializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "DeserializerClass": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
          "Parameters": {
            "serialization.format": "1"
          },
          "Description": "\"serialize\"",
          "SerdeType": 0,
          "SerializerClass": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
          "Name": "name"
        },
        "BucketCols": [
          "2010"
        ],
        "NumBuckets": -1,
        "Location": "oss://xxx"
      },
      "LastAccessTime": 1608707407,
      "Retention": 300,
      "Name": "100g_customer",
      "OwnerType": "USER",
      "ViewExpandedText": "\"\"",
      "DbId": 19,
      "DbName": "default",
      "CatalogName": "hive",
      "PartitionKeys": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "ModifierId": 1410769,
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.