All Products
Search
Document Center

MaxCompute:ListRoles

Last Updated:Nov 29, 2024

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.

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
projectNamestringYes

The name of the MaxCompute project.

projectA

Response parameters

ParameterTypeDescriptionExample
object

PopResult

requestIdstring

The ID of the request.

0a06dfe716686526652451361e80ae
dataobject

The returned data.

rolesarray<object>

The MaxCompute project-level roles.

roleobject

The MaxCompute project-level roles.

namestring

The name of the role.

roleA
typestring

The type of the role.

Enumeration Value:
  • resource: resource.
  • admin: admin.
admin
policystring

The policy that is attached to the role.

{ "Statement": [ { "Action": [ "odps:*" ], "Effect": "Allow", "Resource": [ "acs:odps:*:projects/{projectname}/authorization/packages" ] } ], "Version": "1" }
aclobject

The ACL-based permissions that are granted to the role.

tablearray<object>

The table.

tableobject

The table.

namestring

The name of the table.

tableA
actionsarray

The operations that were performed on the table.

actionstring

The operations that were performed on the table.

describe
resourcearray<object>

The resource.

resourceobject

The resource.

namestring

The name of the resource.

resourceA
actionsarray

The operations that were performed on the resource.

actionstring

The operations that were performed on the resource.

read
functionarray<object>

The function.

functionobject

The function.

namestring

The name of the function.

functionA
actionsarray

The operations that were performed on the function.

actionstring

The operations that were performed on the function.

read
packagearray<object>

The package.

packageListobject

The package.

namestring

The name of the package.

packageA
actionsarray

The operations that were performed on the package.

actionstring

The operations that were performed on the package.

read
projectarray<object>

The project.

projectobject

The project.

namestring

The name of the MaxCompute project.

projectA
actionsarray

The operations that were performed on the project.

actionstring

The operations that were performed on the project.

list
instancearray<object>

The instance.

instanceobject

The instance.

namestring

The name of the instance.

instanceA
actionsarray

The operations that were performed on the instance.

actionstring

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 timeSummary of changesOperation
2024-09-27The internal configuration of the API is changed, but the call is not affectedView Change Details