Use UpdateAggregator to modify an account group - Cloud Config - Alibaba Cloud - Cloud Config

Modifies the name and description of an account group, and adds or removes members. This operation can be called by the management account or a delegated administrator account in a resource directory.

Operation description

This topic provides an example on how to add a member to the account group ca-dacf86d8314e00eb****. The member ID is 173808452267****, the member name is Tony, and the member type is ResourceDirectory.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:UpdateAggregator

update

*Aggregator

acs:config:*:{#accountId}:aggregator/{#AggregatorId}

None

Request parameters

Parameter	Type	Required	Description	Example
AggregatorId	string	Yes	The account group ID. For information about how to obtain the account group ID, see ListAggregators.	ca-dacf86d8314e00eb****
AggregatorName	string	No	The account group name. For information about how to obtain the account group name, see ListAggregators.	Test_Group
FolderId	string	No	FolderId, supports multiple values separated by commas.	fd-brHdgv**,fd-brHdgk**
Description	string	No	The description of the account group. For information about how to obtain the account group description, see ListAggregators.	Test group
AggregatorAccounts	array<object>	No	The member list in the account group. The requirements for this parameter vary based on the account group type (AggregatorType): Custom account group (CUSTOM): This parameter is required and cannot be empty. The list that you specify replaces the existing member list. You cannot specify both this parameter and FolderId at the same time. If you want to modify only the name or description without changing the member list, call the GetAggregator operation to obtain the current member list and pass it in as-is. If you want to change the members, you must set both AccountId and AccountType. Folder-based account group (FOLDER): You must specify FolderId for each update. The members are automatically recalculated by the server based on the specified folder. You cannot specify a non-empty member list. Global account group (RD): The members are automatically maintained by the server based on the resource directory and cannot be manually modified. You can leave this parameter empty or pass in an empty array. If you pass in a non-empty array, an error is returned. FolderId does not take effect for global account group updates.
	object	No	The account group member information.
AccountId	integer	No	The member ID. For information about how to obtain the member ID, see ListAccounts. Note If you want to update the member list, you must set both AccountId and AccountType.	173808452267****
AccountName	string	No	The member name. For information about how to obtain the member name, see ListAccounts. Note If you want to update the member list, you must set both AccountId and AccountType.	Tony
AccountType	string	No	The member type. Only ResourceDirectory (resource directory) is supported. Note If you want to update the member list, you must set both AccountId and AccountType.	ResourceDirectory
ClientToken	string	No	Ensures the idempotence of the request. Generate a unique parameter value from your client. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length.	1594295238-f9361358-5843-4294-8d30-b5183fac****
Tag `deprecated`	array<object>	No	The tags of the resource. This parameter is deprecated. Ignore this parameter. Values passed in do not take effect. A maximum of 20 tags can be attached.
	object	No	The tags of the resource. A maximum of 20 tags can be attached.
Key	string	No	The tag key of the instance. Valid values of N: 1 to 20. If you specify this parameter, the value cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	key-1
Value	string	No	The tag value of the resource. Valid values of N: 1 to 20. If you specify this parameter, the value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.	value-1

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	8195B664-9565-4685-89AC-8B5F04B44B92
AggregatorId	string	The account group ID.	ca-dacf86d8314e00eb****

Examples

Success response

JSON format

{
  "RequestId": "8195B664-9565-4685-89AC-8B5F04B44B92",
  "AggregatorId": "ca-dacf86d8314e00eb****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.AggregatorAccounts.Empty	You must specify AggregatorAccounts.	You must specify AggregatorAccounts.
400	AggregatorAccountExceedMaxCount	The maximum number of aggregator account is exceeded.	The maximum number of aggregator account is exceeded.
400	AggregatorAccountListDuplicated	The aggregator account list is duplicated.	The aggregator account list is duplicated.
400	AggregatorAccountListItemDuplicated	The aggregator account list item is duplicated.	The aggregator account list item is duplicated.
400	AggregatorAlreadyPending	The aggregator has a pending operation and cannot be updated.	The aggregator has a pending operation and cannot be updated.
400	AggregatorNameDuplicated	The aggregator name is duplicated.	The aggregator name is duplicated.
400	DefaultAggregatorDeleteNotSupport	The default aggregator cannot be deleted.
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.
400	Invalid.AccountType.Value	The specified AccountType is invalid.	The specified account type is invalid.
400	Invalid.AggregatorAccounts.Value	The specified AggregatorAccounts is invalid.	The specified AggregatorAccounts is invalid.
403	AggregatorMemberNoPermission	The aggregator member is not authorized to perform the operation.	The aggregator member is not authorized to perform the operation.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.