ListRoles

Updated at: 2025-03-12 02:29

Queries all Resource Access Management (RAM) 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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
ram:ListRolesget
*Role
acs:ram:*:{#accountId}:role/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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
Tagarray<object>No

The tags.

objectNo

The tag.

KeystringNo

The key of the tag.

owner
ValuestringNo

The value of the tag.

alice

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Indicates whether the response is truncated.

true
Rolesarray<object>

The information about the RAM roles.

Roleobject

The information about the RAM role.

Descriptionstring

The description of the RAM role.

ECS administrator
UpdateDatestring

The update time.

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 creation time.

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
Tagsarray<object>

The tags.

Tagobject

The tag.

TagKeystring

The key of the tag.

owner
TagValuestring

The value of the tag.

alice
Markerstring

The marker. This parameter is returned only if the value of IsTruncated is true. If the parameter is returned, you can call this operation again and set this 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",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "alice"
            }
          ]
        }
      }
    ]
  },
  "Marker": "EXAMPLE"
}

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2025-01-14The request parameters of the API has changed. The response structure of the API has changedView Change Details
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback