All Products
Search
Document Center

MaxCompute:ListResources

Last Updated:Oct 22, 2024

Obtains resources 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
odps:ListResourceslist
  • Project
    acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
projectNamestringYes

The name of the MaxCompute project.

projectA
schemaNamestringNo

The name of the schema.

default
namestringNo

The name of the resource.

res
markerstringNo

Specifies the marker after which the returned list begins.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemintegerNo

The maximum number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object

PopResult<ListResultDTO<ResourceInfo, MarkerPageInfo>>

requestIdstring

The ID of the request.

0bc3b4ae16685836687916212e7850
dataobject

The returned data.

resourcesarray<object>

The list of resources.

resourcesobject

The list of resources.

displayNamestring

The display name.

res_1
namestring

The name of the resource.

res_1
ownerstring

The owner of the resource.

1265860483008101
typestring

The resource type.

Valid values:

  • file

  • py

  • jar

  • volumefile

  • table

file
schemastring

The schema to which the resource belongs.

schemaA
lastUpdatorstring

The user who updated the resource.

ALIYUN$xxx@test.aliyunid.com
creationTimelong

The time when the resource was created.

2022-01-29T03:34:09Z
lastModifiedTimelong

The time when the resource was modified.

2023-04-18T06:15:05Z
commentstring

The remarks.

file
sizelong

The size of the resource.

10
contentMD5string

The Base64-encoded 128-bit MD5 hash value of the HTTP request body.

MACiECZtnLiNkNS1v5****=1
markerstring

Indicates the marker after which the returned list begins.

ZmN0X21vbnRoX3Rhb2Jhb19pbmRleCE=
maxIteminteger

The maximum number of entries returned per page.

10

Examples

Sample success responses

JSONformat

{
  "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": "file\n",
        "size": 10,
        "contentMD5": "MACiECZtnLiNkNS1v5****=1"
      }
    ],
    "marker": "ZmN0X21vbnRoX3Rhb2Jhb19pbmRleCE=",
    "maxItem": 10
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-14The request parameters of the API has changed. The response structure of the API has changedView Change Details