ListGroups - Resource Access Management - Alibaba Cloud Documentation Center

Queries Resource Access Management (RAM) user groups.

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:ListGroups

list

*Group

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

None

Request parameters

Parameter	Type	Required	Description	Example
Marker	string	No	The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.	EXAMPLE
MaxItems	integer	No	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 100. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	065527AA-2F2E-AD7C-7484-F2626CFE4934
Groups	object
Group	array<object>	The information about the RAM user groups.
	object	The information about the RAM user group.
DisplayName	string	The display name of the RAM user group.	Dev-Team
GroupId	string	The ID of the RAM user group.	740317625433843****
UpdateDate	string	The update time.	2020-10-19T12:33:18Z
GroupName	string	The name of the RAM user group.	dev-team
Comments	string	The description.	开发团队
CreateDate	string	The creation time.	2020-10-19T12:33:18Z
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
Marker	string	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

Success response

JSON format

{
  "RequestId": "065527AA-2F2E-AD7C-7484-F2626CFE4934",
  "Groups": {
    "Group": [
      {
        "DisplayName": "Dev-Team",
        "GroupId": "740317625433843****",
        "UpdateDate": "2020-10-19T12:33:18Z",
        "GroupName": "dev-team",
        "Comments": "开发团队",
        "CreateDate": "2020-10-19T12:33:18Z"
      }
    ]
  },
  "IsTruncated": true,
  "Marker": "EXAMPLE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.