ListAggregators - Cloud Config - Alibaba Cloud Documentation Center

Queries account groups.

Operation Description

The sample request in this topic shows you how to query account groups. A maximum of 10 entries can be returned for the request. As shown in the responses, the account group returned is named as Test_Group, its description is Test account group, and it is of the CUSTOM type, which indicates a custom account group. The account group contains two member accounts.

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.

Operation	Access level	Resource type	Condition key	Association operation
config:ListAggregators	List	Config acs:config::{#accountId}:	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that is used to initiate the next request. If the response of the current request is truncated, this token is used to initiate another request and obtain the remaining entries.	TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
MaxResults	integer	Yes	The maximum number of entries to return for a single request. Valid values: 1 to 100.	10

For information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	20C8526D-12C5-4336-BC72-EBD5D1BA732F
AggregatorsResult	object	The account groups returned.
NextToken	string	The token that is used to initiate the next request. If the response of the current request is truncated, this token is used to initiate another request and obtain the remaining entries.	TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
Aggregators	array	The information about the account groups.
	object
AggregatorCreateTimestamp	long	The timestamp when the account group was created.	1623036305000
AggregatorAccountCount	long	The number of member accounts in the account group.	2
Description	string	The description of the account group.
AggregatorName	string	The name of the account group.	Test_Group
AggregatorStatus	integer	The status of the account group. Valid values: 0: being created. 1: created.	1
AggregatorType	string	The type of the account group. Valid values: RD: global account group. CUSTOM: custom account group.	CUSTOM
AccountId	long	The ID of the management account used to create the account group.	100931896542****
AggregatorId	string	The ID of the account group.	ca-88ea626622af0055****

Examples

Sample success responses

JSONformat

{
  "RequestId": "20C8526D-12C5-4336-BC72-EBD5D1BA732F",
  "AggregatorsResult": {
    "NextToken": "TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0",
    "Aggregators": [
      {
        "AggregatorCreateTimestamp": 1623036305000,
        "AggregatorAccountCount": 2,
        "Description": "",
        "AggregatorName": "Test_Group",
        "AggregatorStatus": 1,
        "AggregatorType": "CUSTOM",
        "AccountId": 0,
        "AggregatorId": "ca-88ea626622af0055****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
404	AccountNotExisted	Your account does not exist.	The specified account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

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