All Products
Search
Document Center

Resource Access Management:ListRoles

Last Updated:Mar 11, 2024

Queries the list of all RAM roles.

Debugging

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

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
ram:ListRolesList
  • Role
    acs:ram:*:{#accountId}:role/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MarkerstringNo

The marker. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.

EXAMPLE
MaxItemsintegerNo

The number of entries to return. If a response is truncated because it reaches the value of MaxItems, the value of IsTruncated will be true.

Valid values: 1 to 1000. Default value: 100.

100

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
IsTruncatedboolean

Indicates whether the response is truncated.

true
Rolesobject []

The information of RAM roles.

Descriptionstring

The description of the RAM role.

ECS administrator
UpdateDatestring

The time when the RAM role was modified.

2015-01-23T12:33:18Z
MaxSessionDurationlong

The maximum session duration of the RAM role.

3600
RoleNamestring

The name of the RAM role.

ECSAdmin
CreateDatestring

The time when the RAM role was created.

2015-01-23T12:33:18Z
RoleIdstring

The ID of the RAM role.

901234567890****
Arnstring

The Alibaba Cloud Resource Name (ARN) of the RAM role.

acs:ram::123456789012****:role/ECSAdmin
Markerstring

The marker. This parameter is returned only if the value of IsTruncated is true. If the value is true, you can call this operation again and set the Marker parameter to obtain the truncated part.

EXAMPLE

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history