API overview

Updated at:

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (ResourceSharing/2020-01-10) 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.

Resource shares

API

Title

Description

EnableSharingWithResourceDirectory EnableSharingWithResourceDirectory Enables resource sharing for a resource directory.
CreateResourceShare CreateResourceShare Creates a resource share.
ListResourceShares ListResourceShares Queries resource shares.
UpdateResourceShare UpdateResourceShare Modifies the information of a resource share.
DeleteResourceShare DeleteResourceShare Deletes a resource share.
AssociateResourceShare AssociateResourceShare Associates a shared resource or a principal with a resource share.
DisassociateResourceShare DisassociateResourceShare Removes shared resources or principals from a resource share.
ListResourceShareAssociations ListResourceShareAssociations Queries the records of resources or principals that are associated with a resource share.
ListSharedResources ListSharedResources Queries the resources that you have shared or that other accounts have shared with you.
ListSharedTargets ListSharedTargets Queries the principals of a resource share.
DescribeRegions DescribeRegions Queries the regions where the Resource Sharing service is available.
CheckSharingWithResourceDirectoryStatus CheckSharingWithResourceDirectoryStatus Checks the status of resource sharing within a resource directory.
ChangeResourceGroup ChangeResourceGroup Transfers a resource share from one resource group to another.
TagResources TagResources Adds tags to a resource share.
ListTagResources ListTagResources Queries the tags that are added to resource shares.
UntagResources UntagResources Removes tags from resource shares.

Resource sharing invitations

API

Title

Description

ListResourceShareInvitations ListResourceShareInvitations A principal calls the ListResourceShareInvitations operation to query the resource sharing invitations that it has received.
AcceptResourceShareInvitation AcceptResourceShareInvitation A principal calls the AcceptResourceShareInvitation operation to accept a resource sharing invitation.
RejectResourceShareInvitation RejectResourceShareInvitation Rejects a resource sharing invitation.

Resource sharing permissions

API

Title

Description

AssociateResourceSharePermission AssociateResourceSharePermission Associates permissions with a resource share.
DisassociateResourceSharePermission DisassociateResourceSharePermission Disassociates a permission from a resource share. You can disassociate a permission from a resource share only if the resource share does not contain resources of the type indicated by the permission.
ListResourceSharePermissions ListResourceSharePermissions Queries the permissions that are associated with a resource share.
GetPermission GetPermission Queries the information about a permission.
ListPermissionVersions ListPermissionVersions Queries the versions of a permission.
ListPermissions ListPermissions Queries the information about the default permission.