ListRoles-阿里云帮助中心

Obtains MaxCompute project-level roles.

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

list

*Project

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

None

Request syntax

GET /api/v1/projects/{projectName}/roles 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

No parameters required.

Response elements

Element	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.
	array<object>	The MaxCompute project-level roles.
name	string	The name of the role.	roleA
type	string	The type of the role. Valid values: 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.
	object	The table.
name	string	The name of the table.	tableA
actions	array	The operations that were performed on the table.
	string	The operations that were performed on the table.	describe
resource	array<object>	The resource.
	object	The resource.
name	string	The name of the resource.	resourceA
actions	array	The operations that were performed on the resource.
	string	The operations that were performed on the resource.	read
function	array<object>	The function.
	object	The function.
name	string	The name of the function.	functionA
actions	array	The operations that were performed on the function.
	string	The operations that were performed on the function.	read
package	array<object>	The package.
	object	The package.
name	string	The name of the package.	packageA
actions	array	The operations that were performed on the package.
	string	The operations that were performed on the package.	read
project	array<object>	The project.
	object	The project.
name	string	The name of the MaxCompute project.	projectA
actions	array	The operations that were performed on the project.
	string	The operations that were performed on the project.	list
instance	array<object>	The instance.
	object	The instance.
name	string	The name of the instance.	instanceA
actions	array	The operations that were performed on the instance.
	string	The operations that were performed on the instance.	read

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.