Bind RAM Permissions to a Resource Share via AssociateResourceSharePermission API - Resource Management - Alibaba Cloud - Resource Management

Operation description

This topic provides an example of associating the shared permission AliyunRSDefaultPermissionVSwitch with the resource share rs-6GRmdD3X**** in the cn-hangzhou region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

resourcesharing:AssociateResourceSharePermission

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceShareId	string	Yes	The ID of the resource share.	rs-6GRmdD3X****
PermissionName	string	Yes	The name of the shared permission.	AliyunRSDefaultPermissionVSwitch
Replace	boolean	No	Specifies whether the specified permission replaces the existing permissions. Valid values: false (default): no. The existing permissions are not replaced. This value is suitable for adding the current permission to a resource share that has no permissions. Because a resource share can have only one permission for each resource type, if a resource type in the resource share already has a permission and you set Replace to false, an error is reported. This prevents you from accidentally replacing the existing permissions. true: yes. The permission for the same resource type in the resource share is replaced.	false

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

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	111FB84A-60A9-403E-9067-E55D7EE95BD1

Examples

Success response

JSON format

{
  "RequestId": "111FB84A-60A9-403E-9067-E55D7EE95BD1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ResourceShareId	The ResourceShareId is invalid.	The ResourceShareId parameter is invalid.
400	MissingParameter.ResourceShareId	You must specify ResourceShareId.	You must specify ResourceShareId.
400	MissingParameter.PermissionName	You must specify PermissionName.	PermissionName is not configured.
404	EntityNotExists.Permission	The resource share permission does not exist.	You do not have the required permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.