ListTables - List tables in a MaxCompute project - MaxCompute

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

odps:ListTables

list

*Project

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The MaxCompute project name.	projectA

Request parameters

Parameter	Type	Required	Description	Example
prefix	string	No	Filters results by name prefix. Only tables whose names start with this value are returned.	a
marker	string	No	A pagination token. Results are returned in alphabetical order starting after this marker.	Y29tbWlzc2lvbl9leHRlcm5hbF91cmdlXzFfd3Ih
maxItem	integer	No	The maximum number of results per page.	10
type	string	No	The table type. Valid values: internal : internal external : external	internal
schemaName	string	No	The schema name.	default

Response elements

Element	Type	Description	Example
	object	PopResult<ListResultDTO<TableInfo, MarkerPageInfo>>
requestId	string	The request ID.	0a06dd4516687375802853481ec9fd
data	object	The response data.
tables	array<object>	The table details.
	object	The table details.
name	string	The table name.	sale_detail
owner	string	The table owner.	188785396123****
type	string	The table type.	internal
schema	string	The schema that the table belongs to.	default
creationTime	integer	The time when the table was created.	2022-01-17T07:07:47Z
displayName	string	The display name of the table.	sale_detail
marker	string	A pagination token. Results are returned in alphabetical order starting after this marker.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of results per page.	10

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.