ListTables - MaxCompute - Alibaba Cloud Documentation Center

Obtains tables in a MaxCompute project.

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:
- The required resource types are displayed in bold characters.
- 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
odps:ListTables	list	Project acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}	none	none

Request syntax

GET /api/v1/projects/{projectName}/tables HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The name of the MaxCompute project.	projectA
prefix	string	No	The names of the returned resources. The names must start with the value specified by the prefix parameter. If the prefix parameter is set to a, the names of the returned resources must start with a.	a
marker	string	No	Specifies the marker after which the returned list begins.	Y29tbWlzc2lvbl9leHRlcm5hbF91cmdlXzFfd3Ih
maxItem	integer	No	The maximum number of entries to return on each page.	10
type	string	No	The type of the table. Enumeration Value: internal: internal. external: external.	internal
schemaName	string	No	The name of the schema.	default

Response parameters

Parameter	Type	Description	Example
	object	PopResult<ListResultDTO<TableInfo, MarkerPageInfo>>
requestId	string	The request ID.	0a06dd4516687375802853481ec9fd
data	object	The returned data.
tables	array<object>	The information about tables.
tables	object	The information about tables.
name	string	The name of the table.	dim_odps
owner	string	The owner of the table.	1887853961230110
type	string	The type of the table.	internal
schema	string	The schema to which the table belongs.	default
creationTime	long	The time when the table was created.	2022-01-17T07:07:47Z
displayName	string	The display name of the table.	sale_detail
marker	string	Indicates the marker after which the returned list begins.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of entries returned per page.	10

Examples

Sample success responses

JSONformat

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "data": {
    "tables": [
      {
        "name": "dim_odps\n",
        "owner": "1887853961230110",
        "type": "internal\n",
        "schema": "default",
        "creationTime": 0,
        "displayName": "sale_detail"
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-23	The response structure of the API has changed	View Change Details
2023-11-14	The request parameters of the API has changed. The response structure of the API has changed	View Change Details