All Products
Search
Document Center

MaxCompute:ListRoles

Last Updated:Jul 15, 2024

Obtains MaxCompute project-level roles.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

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.

object

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.

object

The table.

namestring

The name of the table.

tableA
actionsarray

The operations that were performed on the table.

string

The operations that were performed on the table.

describe
resourcearray<object>

The resource.

object

The resource.

namestring

The name of the resource.

resourceA
actionsarray

The operations that were performed on the resource.

string

The operations that were performed on the resource.

read
functionarray<object>

The function.

object

The function.

namestring

The name of the function.

functionA
actionsarray

The operations that were performed on the function.

string

The operations that were performed on the function.

read
packagearray<object>

The package.

object

The package.

namestring

The name of the package.

packageA
actionsarray

The operations that were performed on the package.

string

The operations that were performed on the package.

read
projectarray<object>

The project.

object

The project.

namestring

The name of the MaxCompute project.

projectA
actionsarray

The operations that were performed on the project.

string

The operations that were performed on the project.

list
instancearray<object>

The instance.

object

The instance.

namestring

The name of the instance.

instanceA
actionsarray

The operations that were performed on the instance.

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 timeSummary of changesOperation
No change history