ListDataLakeTablebaseInfo - Data Management - Alibaba Cloud Documentation Center

Queries basic information about tables in the data lake.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListDataLakeTablebaseInfo	get	All Resources ``	none	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 that is used to search for tables.	test
DbName	string	Yes	The name of the database to which the table belongs.	default
CatalogName	string	Yes	The name of the data catalog to query.	hive
Tid	long	No	The tenant ID. You can call the GetUserActiveTenant operation to query the tenant ID.	3***
WorkspaceId	long	No	The workspace ID.	12****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	B43AD641-49C2-5299-9E06-1B37EC1B****
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.	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.
TablebaseInfo	DLTablebaseInfo	The basic information about the table.
TotalCount	string	The number of tables that meet the conditions.	100

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.