Call ListResources to get project resources - MaxCompute - Alibaba Cloud - MaxCompute

Queries the list of resources in a MaxCompute project.

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

list

*Project

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
schemaName	string	No	The schema name.	default
name	string	No	The resource name.	res
marker	string	No	The pagination token. Results are returned in alphabetical order starting from the first entry after the marker value.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	No	The maximum number of results to return per page.	10

Response elements

Element	Type	Description	Example
	object	PopResult<ListResultDTO<ResourceInfo, MarkerPageInfo>>
requestId	string	The request ID.	0bc3b4ae16685836687916212e7850
data	object	The returned data.
resources	array<object>	The list of resources.
	object	The resource information.
displayName	string	The display name of the resource.	res_1
name	string	The resource name.	res_1
owner	string	The owner of the resource.	1265860483008101
type	string	The resource type. Valid values: file : file py : py jar : jar volumefile : volumefile table : table	file
schema	string	The schema to which the resource belongs.	schemaA
lastUpdator	string	The user who last updated the resource.	ALIYUN$xxx@test.aliyunid.com
creationTime	integer	The time when the resource was created.	2022-01-29T03:34:09Z
lastModifiedTime	integer	The time when the resource was last modified.	2023-04-18T06:15:05Z
comment	string	The comment on the resource.	filr类型资源
size	integer	The size of the resource.	10
contentMD5	string	The Base64-encoded 128-bit MD5 hash of the HTTP request body.	MACiECZtnLiNkNS1v5****=1
marker	string	The pagination token for the next page of results.	ZmN0X21vbnRoX3Rhb2Jhb19pbmRleCE=
maxItem	integer	The maximum number of results returned per page.	10

Examples

Success response

JSON format

{
  "requestId": "0bc3b4ae16685836687916212e7850",
  "data": {
    "resources": [
      {
        "displayName": "res_1\n",
        "name": "res_1",
        "owner": "1265860483008101",
        "type": "file",
        "schema": "schemaA",
        "lastUpdator": "ALIYUN$xxx@test.aliyunid.com",
        "creationTime": 0,
        "lastModifiedTime": 0,
        "comment": "filr类型资源",
        "size": 10,
        "contentMD5": "MACiECZtnLiNkNS1v5****=1"
      }
    ],
    "marker": "ZmN0X21vbnRoX3Rhb2Jhb19pbmRleCE=",
    "maxItem": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.