All Products
Search
Document Center

Cloud Config:ListAggregators

Last Updated:May 22, 2024

Queries a list of account groups that the current account manages or to which the current account belongs.

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.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
config:ListAggregatorsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
MaxResultsintegerYes

The maximum number of entries to return in a request. Valid values: 1 to 100.

10

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

20C8526D-12C5-4336-BC72-EBD5D1BA732F
AggregatorsResultobject

The account groups.

NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
Aggregatorsobject []

The information about the account groups.

AggregatorCreateTimestamplong

The timestamp generated when the account group was created.

1623036305000
AggregatorAccountCountlong

The number of member accounts in the account group.

2
Descriptionstring

The description of the account group.

AggregatorNamestring

The name of the account group.

Test_Group
AggregatorStatusinteger

The status of the account group. Valid values:

  • 0: The account group is being created.
  • 1: The account group was created.
1
AggregatorTypestring

The type of the account group. Valid values:

  • RD: global account group.
  • FOLDER: account group of the folder.
  • CUSTOM: custom account group.
CUSTOM
AccountIdlong

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

100931896542****
AggregatorIdstring

The ID of the account group.

ca-88ea626622af0055****
FolderIdstring

The information about the member accounts in the account group.

r-BU****

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****",
        "FolderId": "r-BU****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe 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.