EnableResourceDirectory - Resource Management - Alibaba Cloud Documentation Center

Enables a resource directory.

Operation description

You can use the current account or a newly created account to enable a resource directory. For more information, see Enable a resource directory.

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

resourcemanager:EnableResourceDirectory

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MAName	string	No	The name of the newly created account. Specify the name in the `<Prefix>@rdadmin.aliyunid.com` format. The prefix can contain letters, digits, and special characters but cannot contain consecutive special characters. The prefix must start and end with a letter or digit. Valid special characters include underscores (`_`), periods (.), and hyphens (-). The prefix must be 2 to 50 characters in length.	user01@rdadmin.aliyunid.com
MASecureMobilePhone	string	No	The mobile phone number that is bound to the newly created account. If you leave this parameter empty, the mobile phone number that is bound to the current account is used. The mobile phone number you specify must be the same as the mobile phone number that you specify when you call the SendVerificationCodeForEnableRD operation to obtain a verification code. Specify the mobile phone number in the `<Country code>-<Mobile phone number>` format. Note Mobile phone numbers in the `86-<Mobile phone number>` format in the Chinese mainland are not supported.	xx-13900001234
VerificationCode	string	No	The verification code. You can call the SendVerificationCodeForEnableRD operation to obtain the verification code.	123456
EnableMode	string	Yes	The mode in which you enable a resource directory. Valid values: CurrentAccount: The current account is used to enable a resource directory. NewManagementAccount: A newly created account is used to enable a resource directory. If you select this mode, you must configure the `MAName`, `MASecureMobilePhone`, and `VerificationCode` parameters.	CurrentAccount
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. false (default): performs a dry run and performs the actual request.	false

Response elements

Element	Type	Description	Example
	object	The returned result.
ResourceDirectory	object	The information about the resource directory.
ResourceDirectoryId	string	The ID of the resource directory.	rd-54****
MasterAccountId	string	The ID of the management account.	507408460615****
MasterAccountName	string	The name of the management account.	alice@example.com
RootFolderId	string	The ID of the Root folder.	r-G9****
CreateTime	string	The time when the resource directory was enabled.	2021-12-08T02:15:31.744Z
RequestId	string	The ID of the request.	EC2FE94D-A4A2-51A1-A493-5C273A36C46A

Examples

Success response

JSON format

{
  "ResourceDirectory": {
    "ResourceDirectoryId": "rd-54****",
    "MasterAccountId": "507408460615****",
    "MasterAccountName": "alice@example.com",
    "RootFolderId": "r-G9****",
    "CreateTime": "2021-12-08T02:15:31.744Z"
  },
  "RequestId": "EC2FE94D-A4A2-51A1-A493-5C273A36C46A"
}

Error codes

HTTP status code	Error code	Error message	Description
409	NotSupport.AccountInAnotherResourceDirectory	The specified account is an Alibaba Cloud account or already exists in another resource directory.
409	Invalid.EnterpriseName	You must specify the enterprise name.	No enterprise name is specified for the account. Specify an enterprise name for the account.
409	EnterpriseRealNameVerificationError	The specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.	The account does not pass enterprise real-name verification. Complete the verification for the account first.
409	EntityAlreadyExists.ResourceDirectory	The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.	The account has been used to enable a resource directory. Do not use the account to enable a resource directory again.
409	InvalidParameter.ManagementAccountName.AlreadyUsed	The ManagementAccountName has been used.	The name specified for the management account already exists. Specify a valid name.
409	Invalid.VerificationCode	The verification code is invalid.	The verification code is invalid.
409	InvalidParameter.ManagementAccountName	The management account name is in the wrong format.	The format of the name specified for the management account is incorrect.
409	InvalidParameter.ManagementAccountSecurityInfo	The parameter management account secure mobile phone is invalid.	The format of the mobile phone number specified for security purposes is incorrect.
409	MissingSecureMobilePhone	Secure mobile phone is missing.	No mobile phone number is specified for security purposes.
409	MissingSecurityInfo	Security info is missing.	No security information is specified.
409	NotSupport.Account.Site	The caller is not a China site account, which is not supported.	The account is not registered at the current site. Use an account registered at the current site.
409	Invalid.AccountType	The specified profile type of account is invalid.	The account type is invalid. Use an enterprise account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.