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
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AggregatorId | string | Yes | The ID of the account group. | ca-88ea626622af0055**** |
| Tag | array<object> | No | The tags of the resource. You can add up to 20 tags to a resource. | |
| object | No | The tags of the resource. You can add up to 20 tags to a resource. | ||
| Key | string | No | The tag key. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with You can specify at most 20 tag keys. | key-1 |
| Value | string | No | The tag values. The tag values can be an empty string or up to 128 characters in length. The tag values cannot start with Each key-value must be unique. You can specify at most 20 tag values in each call. | value-1 |
For more information about common request parameters, see Common parameters.
Response parameters
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****",
"Tags": [
{
"TagKey": "key-1",
"TagValue": "value-1"
}
]
}
}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. | - |
| 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.