API standards and multilingual preset SDKs
The OpenAPI of this product (ResourceDirectoryMaster/2022-04-19) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service
|
API |
Title |
Description |
| EnableResourceDirectory | Enable a resource directory | 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 | Get resource directory information | Queries the information about a resource directory. If a management account calls this operation, the details of the resource directory activated by the management account are returned. If a member calls this operation, the details of the resource directory to which the member belongs are returned. |
| DestroyResourceDirectory | DestroyResourceDirectory | Disables a resource directory. This operation cannot be undone. Therefore, proceed with caution. |
Resource folder
|
API |
Title |
Description |
| ListFoldersForParent | ListFoldersForParent | Queries the information of all subfolders of a folder. |
| ListAncestors | Query all parent folders of a specified folder | Queries information about all parent folders of a specified folder. |
| ListAuthorizedFolders | ListAuthorizedFolders | Queries the folders that you have query permissions for. |
Member
|
API |
Title |
Description |
| CreateResourceAccount | Create a member | Creates a member of the resource account type by calling CreateResourceAccount. |
| 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 | Remove a member of the cloud account type | 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 | Accept a handshake | Accepts an invitation by the invited Alibaba Cloud account. |
| 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 | Send a verification code to a secure phone number | Sends a verification code to a secure phone number when you set the secure phone number for a member of the resource account type by calling SendVerificationCodeForBindSecureMobilePhone. |
| 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 | Check member account deletion | Performs a pre-deletion check on a member account by calling CheckAccountDelete. |
| GetAccountDeletionCheckResult | GetAccountDeletionCheckResult | Queries the result of a member deletion check. |
| GetAccountDeletionStatus | GetAccountDeletionStatus | Queries the deletion status of a member. |
| 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 | Add contact | Adds a message notification 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 | Associate a contact | Associates a contact with a resource directory, folder, or member account. |
| DisassociateMembers | Disassociate a contact | Disassociates 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 | Retrieves the enablement status of the control policy. |
| CreateControlPolicy | Create a control policy | Creates a custom control policy by calling CreateControlPolicy. |
| GetControlPolicy | Query control policy details | Queries the details of a control policy. |
| ListControlPolicies | ListControlPolicies | Call `ListControlPolicies` to retrieve a list of control policies. |
| UpdateControlPolicy | Modify a custom control policy | Modifies a custom control policy by calling UpdateControlPolicy. |
| DeleteControlPolicy | DeleteControlPolicy | Deletes a custom access control policy. |
| AttachControlPolicy | Attach a control policy | Attaches a control policy to a specified target node. |
| DetachControlPolicy | DetachControlPolicy | Detaches an access control policy. |
| ListControlPolicyAttachmentsForTarget | ListControlPolicyAttachmentsForTarget | Lists the control policies attached to the Root, a folder, or a member. |
| ListTargetAttachmentsForControlPolicy | ListTargetAttachmentsForControlPolicy | Queries the objects to which an access control policy is attached. |
Trusted service
|
API |
Title |
Description |
| ListTrustedServiceStatus | Query the trusted services enabled for the management account or a delegated administrator account | Queries the list of trusted services enabled for the management account or a 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 | Lists the trusted services for which the specified member account is a delegated administrator. |
Others
|
API |
Title |
Description |
| CreateFolder | CreateFolder | Creates a folder. |
| DeleteAccount | DeleteAccount | Deletes a member of the resource account type. |
| DeleteFolder | DeleteFolder | Deletes a folder. |
| GetAccount | GetAccount | Queries the information about a member. |
| GetFolder | Retrieve folder information | Retrieves the information about a folder. |
| ListTagKeys | ListTagKeys | Queries tag keys. |
| ListTagResources | ListTagResources | Queries the tags that are added to the members in a resource directory. |
| ListTagValues | ListTagValues | Queries the tag values of a tag key. |
| TagResources | TagResources | Attaches tags to members in a resource directory. |
| UntagResources | UntagResources | Removes tags from the members in a resource directory. |
| UpdateFolder | Modify a folder | Modifies the name of a folder by calling UpdateFolder. |