ListGroups API Overview for Server Group Queries - Security Center - Alibaba Cloud - Security Center

Retrieves the list of server groups for the current user.

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

yundun-sas:ListGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English.	zh
CurrentPage	integer	No	The page number of the current page to return. Minimum value: 1. Default value: 1.	89
PageSize	integer	No	The maximum number of entries to return on each page in a paging query. Default value: 20. Maximum value: 2000.	10
NextToken	string	No	The token for the next query. If NextToken is empty, no additional results exist. If NextToken has a value, the value indicates the token to use for the next query.	1426C575705AE8545E8360A6EFA3B***
UseNextToken	boolean	No	Specifies whether to use the NextToken method to retrieve the vulnerability list data. If this parameter is used, TotalCount is no longer returned. Valid values: true: Uses the NextToken method. false: Does not use the NextToken method.	true

Response elements

Element	Type	Description	Example
	object	PageResult
List	array<object>	The list of server groups.
	object	The server group.
GroupId	integer	The ID of the server group.	11028542
GroupName	string	The name of the server group.	cn-shenzhen+dir-1440978***
GroupFlag	integer	The type of the server group. Valid values: 0: default group 1: other group.	1
PageInfo	object	The pagination information of the query results.
CurrentPage	integer	The page number of the current page in a paging query.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	202
Count	integer	The number of entries returned on the current page.	4
NextToken	string	The NextToken value returned when the NextToken method is used.	B604532DEF982B875E8360A6EFA3B***
Success	boolean	Indicates whether the exception event was processed. Valid values: true: Processed. false: Not processed.	true
Code	string	The status code returned by the API request.	200
Message	string	The detailed information of the error code.	successful
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request, which can be used for troubleshooting and diagnostics.	CB414DB5-F692-5DAB-9F0F-975C060AF***
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "List": [
    {
      "GroupId": 11028542,
      "GroupName": "cn-shenzhen+dir-1440978***",
      "GroupFlag": 1
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 202,
    "Count": 4,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "CB414DB5-F692-5DAB-9F0F-975C060AF***",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.