API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ResourceDirectoryMaster/2022-04-19) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Services
|
API |
Title |
Description |
| EnableResourceDirectory | EnableResourceDirectory | Enables a resource directory. |
| SendVerificationCodeForEnableRD | SendVerificationCodeForEnableRD | Sends a verification code to the mobile phone number bound to a newly created account when you use the account to enable a resource directory. |
| GetResourceDirectory | GetResourceDirectory | Queries the information of a resource directory. If you use a management account to call this API operation, the system returns the information of the resource directory that is enabled by using the management account. If you use a member to call this operation, the system returns the information of |
| DestroyResourceDirectory | DestroyResourceDirectory | Disables a resource directory. This operation cannot be undone. Therefore, proceed with caution. |
Folders
|
API |
Title |
Description |
| CreateFolder | CreateFolder | Creates a folder. |
| GetFolder | GetFolder | Queries the information about a folder. |
| DeleteFolder | DeleteFolder | Deletes a folder. |
| ListFoldersForParent | ListFoldersForParent | Queries the information of all subfolders of a folder. |
| UpdateFolder | UpdateFolder | Changes the name of a folder. |
| ListAncestors | ListAncestors | Queries the information of all the parent folders of a specified folder. |
| ListAuthorizedFolders | ListAuthorizedFolders | Queries the folders that you have query permissions for. |
Members
|
API |
Title |
Description |
| CreateResourceAccount | CreateResourceAccount | Creates a member of the resource account type. |
| GetAccount | GetAccount | Queries the information about a member. |
| MoveAccount | MoveAccount | Moves a member from a folder to another. |
| UpdateAccount | UpdateAccount | Changes the display name of a member, or switches the type of a member. |
| ListAccounts | ListAccounts | Queries a list of members in a resource directory. |
| RemoveCloudAccount | RemoveCloudAccount | Removes a member of the cloud account type. |
| ListAccountsForParent | ListAccountsForParent | Queries the information of members in a folder. |
| GetPayerForAccount | GetPayerForAccount | Queries the information of a billing account. |
| UpdatePayerForAccount | UpdatePayerForAccount | Updates the billing account of a member. |
| InviteAccountToResourceDirectory | InviteAccountToResourceDirectory | Invites an account to join a resource directory. |
| AcceptHandshake | AcceptHandshake | Accepts an invitation. |
| GetHandshake | GetHandshake | Queries the information of an invitation. |
| DeclineHandshake | DeclineHandshake | Rejects an invitation. |
| CancelHandshake | CancelHandshake | Cancels an invitation. |
| ListHandshakesForAccount | ListHandshakesForAccount | Queries the invitations that are associated with an account. |
| ListHandshakesForResourceDirectory | ListHandshakesForResourceDirectory | Queries invitations in a resource directory. |
| SendVerificationCodeForBindSecureMobilePhone | SendVerificationCodeForBindSecureMobilePhone | Sends a verification code to the mobile phone number that you want to bind to a member of the resource account type in a resource directory for security purposes. |
| BindSecureMobilePhone | BindSecureMobilePhone | Binds a mobile phone number to a member of the resource account type in a resource directory for security purposes. |
| SetMemberDeletionPermission | SetMemberDeletionPermission | Enables or disables the member deletion feature. |
| SetMemberDisplayNameSyncStatus | SetMemberDisplayNameSyncStatus | Enables or disables the Member Display Name Synchronization feature. |
| CheckAccountDelete | CheckAccountDelete | Performs a member deletion check. |
| GetAccountDeletionCheckResult | GetAccountDeletionCheckResult | Queries the result of a member deletion check. |
| DeleteAccount | DeleteAccount | Deletes a member of the resource account type. |
| GetAccountDeletionStatus | GetAccountDeletionStatus | Queries the deletion status of a member. |
| TagResources | TagResources | Attaches tags to members in a resource directory. |
| UntagResources | UntagResources | Removes tags from the members in a resource directory. |
| ListTagResources | ListTagResources | Queries the tags that are added to the members in a resource directory. |
| ListTagKeys | ListTagKeys | Queries tag keys. |
| ListTagValues | ListTagValues | Queries the tag values of a tag key. |
| ChangeAccountEmail | ChangeAccountEmail | Changes the email address that is bound to a member. |
| RetryChangeAccountEmail | RetryChangeAccountEmail | Resends a verification email for the email address change of a member. |
| CancelChangeAccountEmail | CancelChangeAccountEmail | Cancels the email address change of a member. |
| AddMessageContact | AddMessageContact | Adds a contact. |
| SendEmailVerificationForMessageContact | SendEmailVerificationForMessageContact | Sends verification information to the email address of a contact. |
| SendPhoneVerificationForMessageContact | SendPhoneVerificationForMessageContact | Sends verification information to the mobile phone number of a contact. |
| ListMessageContactVerifications | ListMessageContactVerifications | Queries the mobile phone number or email address to be verified for a contact. |
| AssociateMembers | AssociateMembers | Binds a contact to a resource directory, folder, or member. |
| DisassociateMembers | DisassociateMembers | Unbinds a contact from a resource directory, folder, or member. |
| GetMessageContact | GetMessageContact | Queries the information about a contact. |
| ListMessageContacts | ListMessageContacts | Queries contacts. |
| DeleteMessageContact | DeleteMessageContact | Deletes a contact. |
| GetMessageContactDeletionStatus | GetMessageContactDeletionStatus | Queries the deletion status of a contact. |
| UpdateMessageContact | UpdateMessageContact | Updates a contact. |
| CancelMessageContactUpdate | CancelMessageContactUpdate | Cancels the update of the mobile phone number or email address of a contact. |
| PrecheckForConsolidatedBillingAccount | PrecheckForConsolidatedBillingAccount | Checks whether a management account or member can be used as a main financial account. |
| ListAuthorizedAccounts | ListAuthorizedAccounts | Queries the members that have query permissions. |
Control policy
|
API |
Title |
Description |
| EnableControlPolicy | EnableControlPolicy | Enables the Control Policy feature. |
| DisableControlPolicy | DisableControlPolicy | Disables the Control Policy feature. |
| GetControlPolicyEnablementStatus | GetControlPolicyEnablementStatus | Queries the status of the Control Policy feature. |
| CreateControlPolicy | CreateControlPolicy | Creates a custom access control policy. |
| GetControlPolicy | GetControlPolicy | Queries the details of an access control policy. |
| ListControlPolicies | ListControlPolicies | Queries access control policies. |
| UpdateControlPolicy | UpdateControlPolicy | Updates a custom access control policy. |
| DeleteControlPolicy | DeleteControlPolicy | Deletes a custom access control policy. |
| AttachControlPolicy | AttachControlPolicy | Attaches an access control policy. |
| DetachControlPolicy | DetachControlPolicy | Detaches an access control policy. |
| ListControlPolicyAttachmentsForTarget | ListControlPolicyAttachmentsForTarget | Queries the access control policies that are attached to a folder or member. |
| ListTargetAttachmentsForControlPolicy | ListTargetAttachmentsForControlPolicy | Queries the objects to which an access control policy is attached. |
Trusted service
|
API |
Title |
Description |
| ListTrustedServiceStatus | ListTrustedServiceStatus | Queries the trusted services that are enabled within a management account or delegated administrator account. |
| RegisterDelegatedAdministrator | RegisterDelegatedAdministrator | Specifies a member in a resource directory as a delegated administrator account of a trusted service. |
| DeregisterDelegatedAdministrator | DeregisterDelegatedAdministrator | Removes a delegated administrator account for a trusted service. |
| ListDelegatedAdministrators | ListDelegatedAdministrators | Queries delegated administrator accounts. |
| ListDelegatedServicesForAccount | ListDelegatedServicesForAccount | Queries the trusted services for a specified delegated administrator account. |