All Products
Search
Document Center

Resource Management:EnableResourceDirectory

Last Updated:Jun 25, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
MANamestringNo

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
MASecureMobilePhonestringNo

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
VerificationCodestringNo

The verification code.

You can call the SendVerificationCodeForEnableRD operation to obtain the verification code.

123456
EnableModestringYes

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
DryRunbooleanNo

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 parameters

ParameterTypeDescriptionExample
object

The returned result.

ResourceDirectoryobject

The information about the resource directory.

ResourceDirectoryIdstring

The ID of the resource directory.

rd-54****
MasterAccountIdstring

The ID of the management account.

507408460615****
MasterAccountNamestring

The name of the management account.

alice@example.com
RootFolderIdstring

The ID of the Root folder.

r-G9****
CreateTimestring

The time when the resource directory was enabled.

2021-12-08T02:15:31.744Z
RequestIdstring

The ID of the request.

EC2FE94D-A4A2-51A1-A493-5C273A36C46A

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
409NotSupport.AccountInAnotherResourceDirectoryThe specified account is an Alibaba Cloud account or already exists in another resource directory.-
409Invalid.EnterpriseNameYou must specify the enterprise name.No enterprise name is specified for the account. Specify an enterprise name for the account.
409EnterpriseRealNameVerificationErrorThe 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.
409EntityAlreadyExists.ResourceDirectoryThe 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.
409InvalidParameter.ManagementAccountName.AlreadyUsedThe ManagementAccountName has been used.The name specified for the management account already exists. Specify a valid name.
409Invalid.VerificationCodeThe verification code is invalid.The verification code is invalid.
409InvalidParameter.ManagementAccountNameThe management account name is in the wrong format.The format of the name specified for the management account is incorrect.
409InvalidParameter.ManagementAccountSecurityInfoThe parameter management account secure mobile phone is invalid.The format of the mobile phone number specified for security purposes is incorrect.
409MissingSecureMobilePhoneSecure mobile phone is missing.No mobile phone number is specified for security purposes.
409MissingSecurityInfoSecurity info is missing.No security information is specified.
409NotSupport.Account.SiteThe 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.
409Invalid.AccountTypeThe specified profile type of account is invalid.The account type is invalid. Use an enterprise account.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-21The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 409 change
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DryRun