Resource Access Management:ListRoles - Resource Access Management - Alibaba Cloud - Resource Access Management

Lists RAM 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

ram:ListRoles

get

*Role

acs:ram:*:{#accountId}:role/*

None

Request parameters

Parameter	Type	Required	Description	Example
Marker	string	No	The marker. If the response is truncated, you can use `Marker` to retrieve the content that starts from the position after the truncation point.	EXAMPLE
MaxItems	integer	No	The number of entries to return. If the response is truncated because it reaches the `MaxItems` limit, the `IsTruncated` parameter is set to `true`. Valid values: 1 to 1000. Default value: 100.	100
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key.	owner
Value	string	No	The tag value.	alice

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
IsTruncated	boolean	Indicates whether the response is truncated.	true
Roles	object
Role	array<object>	The role information.
	array<object>	The role information.
Description	string	The description of the role.	ECS management role
UpdateDate	string	The time when the role was last updated.	2015-01-23T12:33:18Z
MaxSessionDuration	integer	The maximum session duration of the role.	3600
RoleName	string	The name of the role.	ECSAdmin
CreateDate	string	The time when the role was created.	2015-01-23T12:33:18Z
RoleId	string	The ID of the role.	901234567890****
Arn	string	The resource descriptor of the role.	acs:ram::123456789012****:role/ECSAdmin
Tags	object
Tag	array<object>	The tags.
	object	The tags.
TagKey	string	The tag key.	owner
TagValue	string	The tag value.	alice
AllowConsoleLogin	boolean		true
Marker	string	This parameter is returned only when `IsTruncated` is `true`. If the value of `IsTruncated` is `true`, call this operation again and use `Marker` to retrieve the truncated content.	EXAMPLE

Examples

Success response

JSON format

{
  "RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "IsTruncated": true,
  "Roles": {
    "Role": [
      {
        "Description": "ECS management role",
        "UpdateDate": "2015-01-23T12:33:18Z",
        "MaxSessionDuration": 3600,
        "RoleName": "ECSAdmin",
        "CreateDate": "2015-01-23T12:33:18Z",
        "RoleId": "901234567890****",
        "Arn": "acs:ram::123456789012****:role/ECSAdmin",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "alice"
            }
          ]
        },
        "AllowConsoleLogin": true
      }
    ]
  },
  "Marker": "EXAMPLE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.