EnrollAccount-阿里云帮助中心

Enrolls an account. You can create a new account or manage an existing account in the account factory.

Operation description

You can call this API operation to create a new account or manage an existing account and apply the account baseline to the account.

Accounts are created in asynchronous mode. After you create an account, you can apply the account baseline to the account. You can call the GetEnrolledAccount API operation to view the details about the account to obtain the result of applying the account baseline to the account.

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 for the account name of the member. If the account baseline is applied to an account that is newly created, you must configure this parameter. If the account baseline is applied to an existing account, you do not need to configure this parameter.	test-account
DisplayName	string	No	The display name of the account. If the account baseline is applied to an account that is newly created, you must configure this parameter. If the account baseline is applied to an existing account, you do not need to configure this parameter.	test-account
FolderId	string	No	The ID of the parent folder. If the account baseline is applied to an account that is newly created, you need to specify a parent folder. If you do not configure this parameter, the account is created in the Root folder. If the account baseline is applied to an existing account, you do not need to configure this parameter.	fd-5ESoku****
PayerAccountUid	integer	No	The ID of the billing account. If the account baseline is applied to an account that is newly created, you need to specify a billing account. If you do not configure this parameter, the self-pay settlement method is used for the account. If the account baseline is applied to an existing account, you do not need to configure this parameter.	19534534552****
AccountUid	integer	No	The account ID. If the account baseline is applied to an account that is newly created, you do not need to configure this parameter. If the account baseline is applied to an existing account, you must configure this parameter.	12868156179****
BaselineItems	array<object>	No	The array that contains baseline items. If this parameter is specified, the configurations of the baseline items are merged with the baseline applied to the specified account. The configurations of the same baseline items are subject to the configurations of this parameter. We recommend that you leave this parameter empty and configure the `BaselineId` parameter to specify an account baseline and apply the configurations of the account baseline to the account.
	object	No	The configurations of the baseline item.
Config	string	No	The configurations of the baseline item.	{\"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	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 baseline ID. If this parameter is left empty, the default baseline is used.	afb-bp1durvn3lgqe28v****
ResellAccountType	string	No	The identity type of the member. Valid values: resell (default): The member is an account for a reseller. A relationship is automatically established between the member and the reseller. The management account of the resource directory must be used as the billing account of the member. non_resell: The member is not an account for a reseller. The member is an account that is not associated with a reseller. You can directly use the account to purchase Alibaba Cloud resources. The member is used as its own billing account. Note This parameter is available only for resellers at the international site (alibabacloud.com).	resell
RegionId	string	No	The region ID.	cn-hangzhou
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key.	tagKey
Value	string	No	The tag value.	tagValue

Response elements

Element	Type	Description	Example
	object	The returned result.
AccountUid	integer	The account ID.	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.