GetAggregator - Cloud Config - Alibaba Cloud Documentation Center

Queries the details of an account group. You can query the name, creation time, member, and type of an account group.

Operation description

The sample request in this topic shows you how to query the details of the ca-88ea626622af0055**** account group. The return result shows that the account group is named Test_Group, its description is Test account group, and it is of the CUSTOM type. The account group is in the 1 state, which indicates that it is created.

Debugging

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

Debug

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	Associated operation
config:GetAggregator	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
AggregatorId	string	Yes	The ID of the account group.	ca-88ea626622af0055****

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	733DD93C-2277-4905-AE0C-0BA95C04B8BC
Aggregator	object	The details of the account group.
AggregatorCreateTimestamp	string	The timestamp generated when the account group was created. Unit: milliseconds.	1623034091000
AggregatorAccounts	object []	The information about the members in the account group.
RecorderStatus	string	The status of the configuration recorder for the member. Valid values: REGISTRABLE: The configuration recorder is not registered. BUILDING: The configuration recorder is being deployed. REGISTERED: The configuration recorder is registered. REBUILDING: The configuration recorder is being redeployed.	REGISTERED
AccountId	long	The ID of the member.	171322098523****
AccountType	string	The resource directory to which the member belongs. Valid value: ResourceDirectory. ResourceDirectory indicates that the member belongs to a resource directory.	ResourceDirectory
AccountName	string	The display name of the member.	Alice
AggregatorAccountCount	long	The number of members in the account group.	2
Description	string	The description of the account group.	The description of the test account group.
AggregatorName	string	The name of the account group.	Test-Group
AggregatorStatus	integer	The status of the account group. Valid values: 0: The account group is being created. 1: The account group was created.	1
AggregatorType	string	The type of the account group. Valid values: RD: a global account group. FOLDER: an account group for a folder. CUSTOM: a custom account group.	CUSTOM
AccountId	long	The ID of the management account that is used to create the account group.	100931896542****
AggregatorId	string	The ID of the account group.	ca-88ea626622af0055****
FolderId	string	The ID of the attached folder of the account group.	fd-brHdgv****

Examples

Sample success responses

JSONformat

{
  "RequestId": "733DD93C-2277-4905-AE0C-0BA95C04B8BC",
  "Aggregator": {
    "AggregatorCreateTimestamp": "1623034091000",
    "AggregatorAccounts": [
      {
        "RecorderStatus": "REGISTERED",
        "AccountId": 0,
        "AccountType": "ResourceDirectory",
        "AccountName": "Alice"
      }
    ],
    "AggregatorAccountCount": 2,
    "Description": "The description of the test account group.",
    "AggregatorName": "Test-Group",
    "AggregatorStatus": 1,
    "AggregatorType": "CUSTOM",
    "AccountId": 0,
    "AggregatorId": "ca-88ea626622af0055****",
    "FolderId": "fd-brHdgv****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.	The specified aggregator ID does not exist or you are not authorized to use the aggregator.
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.