All Products
Search
Document Center

Resource Management:EnableResourceDirectory

Last Updated:Jun 05, 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.

In this example, the current account is used to 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

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
resourcemanager:EnableResourceDirectoryWrite
  • All Resources
    *
    none
none

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 with a letter or digit 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: indicates that the current account is used to enable a resource directory.
  • NewManagementAccount: indicates that 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

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
ResourceDirectoryobject

The information of 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
409Invalid.EnterpriseNameYou must specify the enterprise name.You must specify the enterprise name.
409EnterpriseRealNameVerificationErrorThe specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.The specified account does not pass enterprise real-name verification. We recommend you first complete enterprise real-name verification for the account.
409EntityAlreadyExists.ResourceDirectoryThe resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.The resource directory for the account is already enabled. We recommend that you do not enable the resource directory again.
409InvalidParameter.ManagementAccountName.AlreadyUsedThe ManagementAccountName has been used.The management account name already exists. You must 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 specified management account name is invalid.
409InvalidParameter.ManagementAccountSecurityInfoThe parameter management account secure mobile phone is invalid.The specified mobile number is invalid.
409MissingSecureMobilePhoneSecure mobile phone is missing.No phone number is specified.
409MissingSecurityInfoSecurity info is missing.-
409NotSupport.AccountInAnotherResourceDirectoryYour account is a management account for another resource directory or a member of another resource directory.Your account is the management account or a member of another resource directory.

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

Change history

Change timeSummary of changesOperation
No change history