Call the EnrollAccount API to create or manage an account - Cloud Governance Center - Alibaba Cloud - Agentic Cloud Governance Center

Creates a new resource account or registers an existing resource account by using Account Factory.

Operation description

You can use this API operation to create a new resource account or register an existing resource account, and apply an account baseline to the account.

The operation to create an account is an asynchronous procedure. After a resource account is created, the Account Factory baseline is implemented on the account. You can call the GetEnrolledAccount operation to query the account details and obtain the implementation result.

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

governance:EnrollAccount

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccountNamePrefix	string	No	The prefix of the account name. This parameter is required if you create a resource account. This parameter is not required if you register an existing account.	test-account
DisplayName	string	No	The display name of the account. This parameter is required if you create a resource account. This parameter is not required if you register an existing account.	test-account
FolderId	string	No	The ID of the parent folder. If you create a resource account and do not specify this parameter, the account is created in the Root folder by default. This parameter is not required if you register an existing account.	fd-5ESoku****
PayerAccountUid	integer	No	The ID of the billing account. If you create a resource account and do not specify this parameter, the account pays its own bills by default. This parameter is not required if you register an existing account.	19534534552****
AccountUid	integer	No	The ID of the account to create an account. This parameter is not required if you create a resource account. This parameter is required if you register an existing account.	12868156179****
BaselineItems	array<object>	No	The baseline item configurations. If this parameter is specified, the baseline item configurations are merged with the specified account baseline. For identical baseline items, the configurations in this parameter take precedence. Leave this parameter empty, specify the account baseline by using the `BaselineId` parameter, and apply configurations to the account by using the existing baseline.
	object	No	The baseline item configuration.
Config	string	No	The baseline item configuration.	{\"Notifications\":[{\"GroupKey\":\"account_msg\",\"Contacts\":[{\"Name\":\"aa\"}],\"PmsgStatus\":1,\"EmailStatus\":1,\"SmsStatus\":1}]}
Name	string	No	The name of the baseline item.	ACS-BP_ACCOUNT_FACTORY_VPC
Skip	boolean	No	Specifies whether to skip the baseline item. Valid values: false: The baseline item is not skipped. true: The baseline item is skipped.	false
Version	string	No	The version of the baseline item.	1.0
BaselineId	string	No	The ID of the baseline. If this parameter is left empty, the system default baseline is used by default.	afb-bp1durvn3lgqe28v****
ResellAccountType	string	No	The identity type of the member. Valid values: resell (default): reseller account. The created member automatically establishes a reseller relationship with your reseller, and you must use the management account to pay for the new member. non_resell: non-reseller account. The created member is a regular Alibaba Cloud account and has no relationship with your current reseller. The account purchases resources directly from Alibaba Cloud and pays its own bills. Note This parameter is supported only for reseller customers on the Alibaba Cloud International website.	resell
RegionId	string	No	The region ID.	cn-hangzhou
Tag	array<object>	No	The list of tags. A maximum of 20 tags can be specified.
	object	No	The tags.
Key	string	No	The tag key.	tagKey
Value	string	No	The tag value.	tagValue

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccountUid	integer	The ID of the account to create an account.	143165363236****
RequestId	string	The request ID.	7071E5FA-515E-5F53-B335-B87D619C6A66

Examples

Success response

JSON format

{
  "AccountUid": 0,
  "RequestId": "7071E5FA-515E-5F53-B335-B87D619C6A66"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter %s is not valid.	The specified parameter %s is invalid.
400	DeployConflict.Blueprint	The %s blueprint is being deployed. Please wait for its deployment to complete and try again.	A blueprint is being implemented. Try again later after the blueprint is implemented.
400	DependencyViolation.Blueprint	The %s blueprint has not been deployed. Please deploy the resource structure first.	You have not deployed a dependent blueprint. You must deploy the dependent blueprint.
400	DependencyViolation.BaselineItem	The dependency of %s baseline item has not been configured. Please config %s first.	No dependency baseline items are configured. Before you can proceed, you must configure a dependency baseline item.
400	IncorrectBlueprintStatus	The current status of the blueprint does not support this operation.	The current status of the blueprint does not support this operation.
500	InternalError	A system error occurred.	A system error occurred.
403	InvalidUser.NotResourceDirectoryMaster	The specified account is not a master account of resource directory.	The specified account is not a master account of resource directory.
404	InvalidUser.NotFound	The specified user does not exist.	The user does not exist.
404	InvalidBlueprint.NotFound	The specified blueprint does not exist.	The specified blueprint does not exist.
404	InvalidBaselineItem.NotFound	The specified baseline item named %s does not exist.	The specified baseline item does not exist.
404	InvalidEnterpriseRealName.NotFound	The specified account has not passed enterprise real name verification. Please complete the verification for the account first.	The specified account has not passed enterprise real-name verification. Please complete the verification for the account first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.