ListRole - Enterprise Distributed Application Service - Alibaba Cloud Documentation Center

Queries a list of 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

edas:ListRole

get

*All Resource

*

None

Request syntax

POST /pop/v5/account/role_list HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

No request parameters.

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	57609587-DFA2-41EC-**-*******
RoleList	object
RoleItem	array<object>	The roles.
	array<object>
ActionList	object
Action	array<object>	The set of permissions to be granted to the role.
	object
Code	string	The serial number of the permission that is granted to the role.	1
Description	string	The description of the permission to be granted to the role.	操作记录
GroupId	string	The ID of the permission group to which the permission that is granted to the role belongs.	31
Name	string	The name of the permission to be granted to the role.	操作记录
Role	object	The roles.
UpdateTime	integer	The timestamp when the role was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1542717260156
IsDefault	boolean	Indicates whether the role is a default role.	false
AdminUserId	string	The ID of the Alibaba Cloud account.	test**@aliyun.com
CreateTime	integer	The timestamp when the role was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1542717260156
Name	string	The name of the role.	Super Admin(All privileges)
Id	integer	The ID of the role.	1

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "57609587-DFA2-41EC-****-*********",
  "RoleList": {
    "RoleItem": [
      {
        "ActionList": {
          "Action": [
            {
              "Code": "1",
              "Description": "操作记录",
              "GroupId": "31",
              "Name": "操作记录"
            }
          ]
        },
        "Role": {
          "UpdateTime": 1542717260156,
          "IsDefault": false,
          "AdminUserId": "test**@aliyun.com",
          "CreateTime": 1542717260156,
          "Name": "Super Admin(All privileges)",
          "Id": 1
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.