Queries the details of an account group.

In the example of this topic, a request is sent to query the details of the account group whose ID is ca-88ea626622af0055****. 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. The account group is in the 1state, 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetAggregator

The operation that you want to perform. Set the value to GetAggregator.

AggregatorId String Yes ca-88ea626622af0055****

The ID of the account group.

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

Response parameters

Parameter Type Example Description
RequestId String 733DD93C-2277-4905-AE0C-0BA95C04B8BC

The ID of the request.

Aggregator Object

The details of the account group.

AggregatorCreateTimestamp String 1623034091000

The timestamp when the account group is created.

AggregatorAccounts Array of AggregatorAccounts

The information about the member accounts in the account group.

RecorderStatus String 2

The status of the configuration recorder for the member account. Valid values:

  • REGISTRABLE: The configuration recorder has not been registered.
  • BUILDING: The configuration recorder is being deployed.
  • REGISTERED: The configuration recorder has been registered.
  • REBUILDING: The configuration recorder is being redeployed.
AccountId Long 171322098523****

The member account ID, which indicates the Alibaba Cloud account ID of the member account.

AccountType String ResourceDirectory

The affiliation of the member account. The value is fixed to ResourceDirectory.

AccountName String Alice

The member account name, which indicates the name of the Alibaba Cloud account that corresponds to the member account.

AggregatorAccountCount Long 2

The number of member accounts in the account group.

Description String Test account group

The description of the account group.

AggregatorName String Test_Group

The name of the account group.

AggregatorStatus Integer 1

The status of the account group. Valid values:

  • 0: being created.
  • 1: created.
AggregatorType String CUSTOM

The type of the account group. Valid values:

  • RD: global account group.
  • CUSTOM: custom account group.
AccountId Long 100931896542****

The ID of the management account used to create the account group.

AggregatorId String ca-88ea626622af0055****

The ID of the account group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetAggregator
&AggregatorId=ca-88ea626622af0055****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAggregatorResponse>
	<RequestId>733DD93C-2277-4905-AE0C-0BA95C04B8BC</RequestId>
	<Aggregator>
		<AggregatorName>Test_Group</AggregatorName>
		<AccountId>100931896542****</AccountId>
		<Description>Test account group</Description>
		<AggregatorAccounts>
			<AccountId>171322098523****</AccountId>
			<RecorderStatus>REGISTERED</RecorderStatus>
			<AccountType>ResourceDirectory</AccountType>
			<AccountName>Alice</AccountName>
		</AggregatorAccounts>
		<AggregatorAccounts>
			<AccountId>100532098349****</AccountId>
			<RecorderStatus>REGISTERED</RecorderStatus>
			<AccountType>ResourceDirectory</AccountType>
			<AccountName>Tom</AccountName>
		</AggregatorAccounts>
		<AggregatorCreateTimestamp>1623034091000</AggregatorCreateTimestamp>
		<AggregatorAccountCount>2</AggregatorAccountCount>
		<AggregatorStatus>1</AggregatorStatus>
		<AggregatorType>CUSTOM</AggregatorType>
		<AggregatorId>ca-88ea626622af0055****</AggregatorId>
	</Aggregator>
</GetAggregatorResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "733DD93C-2277-4905-AE0C-0BA95C04B8BC",
  "Aggregator" : {
    "AggregatorName" : "Test_Group",
    "AccountId" : "100931896542****",
    "Description" : "Test account group",
    "AggregatorAccounts" : [ {
      "AccountId" : "171322098523****",
      "RecorderStatus" : "REGISTERED",
      "AccountType" : "ResourceDirectory",
      "AccountName" : "Alice"
    }, {
      "AccountId" : "100532098349****",
      "RecorderStatus" : "REGISTERED",
      "AccountType" : "ResourceDirectory",
      "AccountName" : "Tom"
    } ],
    "AggregatorCreateTimestamp" : 1623034091000,
    "AggregatorAccountCount" : 2,
    "AggregatorStatus" : 1,
    "AggregatorType" : "CUSTOM",
    "AggregatorId" : "ca-88ea626622af0055****"
  }
}

Error codes

HTTP status code Error code Error message Description
400 Invalid.AggregatorId.Value The specified AggregatorId is invalid. The error message returned because the specified account group ID does not exist or you are not authorized to use the account group.
404 AccountNotExisted Your account does not exist. The error message returned because your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.