Retrieve Data Lake Table Metadata via ListDataLakeTablebaseInfo - Data Management - Alibaba Cloud - Data Management

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataRegion	string	Yes	The region where the data lake resides.	cn-hangzhou
Rows	integer	No	The number of entries per page.	10
Page	integer	No	The page number.	1
SearchKey	string	No	The keyword used to search for table names.	test
DbName	string	Yes	The name of the database that contains the table.	default
CatalogName	string	Yes	The name of the data catalog to query.	hive
Tid	integer	No	The tenant ID. You can call the GetUserActiveTenant operation to obtain the tenant ID.	3***
WorkspaceId	integer	No	The workspace ID.	12****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	B43AD641-49C2-5299-9E06-1B37EC1B****
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request failed.	true
ErrorCode	string	The error code returned if the request failed.	400
ErrorMessage	string	The error message returned if the request failed.	Specified parameter Rows is not valid.
TablebaseInfoList	array	The list of tables in the data lake.
	DLTablebaseInfo	The basic information about a table in the data lake.
TotalCount	string	The total number of tables that match the specified conditions.	100

Examples

Success response

JSON format

{
  "RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "Specified parameter Rows is not valid.",
  "TablebaseInfoList": [
    {
      "Owner": "test",
      "ViewOriginalText": "\"\"",
      "TableType": "EXTERNAL_TABLE",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "Description": "\"table\"",
      "CreatorId": 0,
      "CreateTime": 1731586286,
      "LastAccessTime": 1608707407,
      "Retention": 30000,
      "Name": "100g_customer",
      "OwnerType": "ROLE ",
      "ViewExpandedText": "\"\"",
      "DbId": 19,
      "DbName": "100g_customer",
      "CatalogName": "hive",
      "PartitionKeys": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "ModifierId": 1410769,
      "Location": "oss://xxx"
    }
  ],
  "TotalCount": "100"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.