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.
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:
- The required resource types are displayed in bold characters.
- 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 |
|---|---|---|---|---|
| governance:EnrollAccount | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AccountNamePrefix | string | No | The prefix for the account name of the member.
| test-account |
| DisplayName | string | No | The display name of the account.
| test-account |
| FolderId | string | No | The ID of the parent folder.
| fd-5ESoku**** |
| PayerAccountUid | long | No | The ID of the billing account.
| 19534534552**** |
| AccountUid | long | No | The account ID.
| 12868156179**** |
| BaselineItems | object [] | No | An array that contains baseline items. If this parameter is specified, the configurations of the baseline items are merged with the baseline of the specified account. The configurations of the same baseline items are subject to the configuration of this parameter. We recommend that you leave this parameter empty and configure the | |
| Name | string | No | The name of the baseline item. | ACS-BP_ACCOUNT_FACTORY_VPC |
| Version | string | No | The version of the baseline item. | 1.0 |
| Config | string | No | The configurations of the baseline item. | {\"Notifications\":[{\"GroupKey\":\"account_msg\",\"Contacts\":[{\"Name\":\"aa\"}],\"PmsgStatus\":1,\"EmailStatus\":1,\"SmsStatus\":1}]} |
| Skip | boolean | No | Specifies whether to skip the baseline item. Valid values:
| false |
| 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:
Note
This parameter is available only for resellers at the international site (alibabacloud.com).
| resell |
| RegionId | string | No | The region ID. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "7071E5FA-515E-5F53-B335-B87D619C6A66",
"AccountUid": 0
}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. |
| 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. |
| 500 | InternalError | A system error occurred. | A system error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-15 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||
|