All Products
Search
Document Center

Resource Management:AssociateResourceSharePermission

Last Updated:Nov 19, 2024

Associates permissions with a resource share.

Operation description

This topic provides an example on how to call the API operation to associate the AliyunRSDefaultPermissionVSwitch permission with the rs-6GRmdD3X**** resource share in the cn-hangzhou region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
resourcesharing:AssociateResourceSharePermissionupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceShareIdstringYes

The ID of the resource share.

rs-6GRmdD3X****
PermissionNamestringYes

The name of the permission.

AliyunRSDefaultPermissionVSwitch
ReplacebooleanNo

Specifies whether to use the specified permission to replace an existing permission. Valid values:

  • false: does not use the specified permission to replace an existing permission. This is the default value. If you set the value to false for a resource share that does not have associated permissions, the system associates the specified permission with the resource share. In a resource share, one resource type can have only one permission. If you set the value to false for a resource share that already has a permission for the resource type indicated by the specified permission, the system reports an error. This prevents you from replacing the existing permission by mistake.
  • true: uses the specified permission to replace an existing permission of the same resource type.
false

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

111FB84A-60A9-403E-9067-E55D7EE95BD1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.ResourceShareIdThe ResourceShareId is invalid.The ResourceShareId parameter is invalid.
400MissingParameter.ResourceShareIdYou must specify ResourceShareId.You must specify ResourceShareId.
400MissingParameter.PermissionNameYou must specify PermissionName.PermissionName is not configured.
404EntityNotExists.PermissionThe resource share permission does not exist.You do not have the required permissions.

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

Change history

Change timeSummary of changesOperation
2023-05-18The Error code has changedView Change Details