ListTables

Obtains tables of different data source types within a tenant by page.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries displayed on each page. The default value is 10 and the maximum value is 100.	10
DataSourceType	string	Yes	The type of the data source. Valid values: odps, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.	odps
NextToken	string	No	Pagination information, which specifies the starting point of this read.	12222

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E25887B7-579C-54A5-9C4F-83A****
Data	object	The returned data.
Total	integer	The total number.	100
TableEntityList	array<object>	An array of entities.
	array<object>	The information about the table.
EntityQualifiedName	string	The unique identifier of the table entity.	maxcompute-table.project.table
EntityContent	object	The information about the table.
TableName	string	The name of the table.	table
DataSourceQualifiedName	string	The unique identifier of the data source.	accountId:cn-shanghai:odps:project
DataSourceUniqueId	string	The unique ID of the data source identifier.	e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg
DatabaseName	string	The name of the database.	database
ProjectName	string	The name of the ODPS project.	project
InstanceId	string	The ID of the data source instance.	rm-uf6rn0123
NextToken	string	Pagination information, which specifies the starting point of the next read.	AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=

Examples

Success response

JSON format

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Data": {
    "Total": 100,
    "TableEntityList": [
      {
        "EntityQualifiedName": "maxcompute-table.project.table",
        "EntityContent": {
          "TableName": "table",
          "DataSourceQualifiedName": "accountId:cn-shanghai:odps:project",
          "DataSourceUniqueId": "e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg",
          "DatabaseName": "database",
          "ProjectName": "project",
          "InstanceId": "rm-uf6rn0123"
        }
      }
    ],
    "NextToken": "AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.