Obtain project-level roles by calling the ListRoles API - MaxCompute - Alibaba Cloud - MaxCompute

获取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: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	MaxCompute 项目名称	projectA

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	请求 id。	0a06dfe716686526652451361e80ae
data	object	返回数据。
roles	array<object>	角色列表
	array<object>	角色列表
name	string	角色名称。	roleA
type	string	角色类型 Valid values: resource : resource admin : admin	admin
policy	string	角色的 Policy 授权信息	{ "Statement": [ { "Action": [ "odps:" ], "Effect": "Allow", "Resource": [ "acs:odps::projects/{projectname}/authorization/packages" ] } ], "Version": "1" }
acl	object	角色的 ACL 授权信息
table	array<object>	表
	object	表
name	string	表名称。	tableA
actions	array	表操作
	string	表操作	describe
resource	array<object>	资源
	object	资源
name	string	资源名称。	resourceA
actions	array	资源操作
	string	资源操作	read
function	array<object>	函数
	object	函数
name	string	函数名称。	functionA
actions	array	函数操作
	string	函数操作	read
package	array<object>	Package
	object	package
name	string	package 名称	packageA
actions	array	package 操作
	string	package 操作	read
project	array<object>	项目
	object	项目
name	string	maxcompute 项目名称	projectA
actions	array	项目操作
	string	项目操作	list
instance	array<object>	实例
	object	实例
name	string	实例名称。	instanceA
actions	array	实例操作
	string	实例操作	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.