ListRoles - MaxCompute - Alibaba Cloud Documentation Center

Obtains MaxCompute project-level roles.

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:ListRoles	list	*Project `acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}`	none	none

Request syntax

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

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	PopResult
requestId	string	The ID of the request.	0a06dfe716686526652451361e80ae
data	object	The returned data.
roles	array<object>	The MaxCompute project-level roles.
role	object	The MaxCompute project-level roles.
name	string	The name of the role.	roleA
type	string	The type of the role. Enumeration Value: resource: resource. admin: admin.	admin
policy	string	The policy that is attached to the role.	{ "Statement": [ { "Action": [ "odps:" ], "Effect": "Allow", "Resource": [ "acs:odps::projects/{projectname}/authorization/packages" ] } ], "Version": "1" }
acl	object	The ACL-based permissions that are granted to the role.
table	array<object>	The table.
table	object	The table.
name	string	The name of the table.	tableA
actions	array	The operations that were performed on the table.
action	string	The operations that were performed on the table.	describe
resource	array<object>	The resource.
resource	object	The resource.
name	string	The name of the resource.	resourceA
actions	array	The operations that were performed on the resource.
action	string	The operations that were performed on the resource.	read
function	array<object>	The function.
function	object	The function.
name	string	The name of the function.	functionA
actions	array	The operations that were performed on the function.
action	string	The operations that were performed on the function.	read
package	array<object>	The package.
packageList	object	The package.
name	string	The name of the package.	packageA
actions	array	The operations that were performed on the package.
action	string	The operations that were performed on the package.	read
project	array<object>	The project.
project	object	The project.
name	string	The name of the MaxCompute project.	projectA
actions	array	The operations that were performed on the project.
action	string	The operations that were performed on the project.	list
instance	array<object>	The instance.
instance	object	The instance.
name	string	The name of the instance.	instanceA
actions	array	The operations that were performed on the instance.
action	string	The operations that were performed on the instance.	read

Examples

Sample success responses

JSONformat

{
  "requestId": "0a06dfe716686526652451361e80ae",
  "data": {
    "roles": [
      {
        "name": "roleA",
        "type": "admin",
        "policy": "{\n      \"Statement\": [\n            {\n                  \"Action\": [\n                        \"odps:*\"\n                  ],\n                  \"Effect\": \"Allow\",\n                  \"Resource\": [\n                        \"acs:odps:*:projects/{projectname}/authorization/packages\"\n                  ]\n            }\n      ],\n      \"Version\": \"1\"\n}",
        "acl": {
          "table": [
            {
              "name": "tableA",
              "actions": [
                "describe"
              ]
            }
          ],
          "resource": [
            {
              "name": "resourceA",
              "actions": [
                "read"
              ]
            }
          ],
          "function": [
            {
              "name": "functionA",
              "actions": [
                "read"
              ]
            }
          ],
          "package": [
            {
              "name": "packageA",
              "actions": [
                "read"
              ]
            }
          ],
          "project": [
            {
              "name": "projectA",
              "actions": [
                "list"
              ]
            }
          ],
          "instance": [
            {
              "name": "instanceA",
              "actions": [
                "read"
              ]
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-27	The internal configuration of the API is changed, but the call is not affected	View Change Details