AssociateResourceShare - Resource Management - Alibaba Cloud Documentation Center

Associates resources or principals with a resource share.

Operation description

This topic provides an example on how to call the API operation to associate the vSwitch vsw-bp183p93qs667muql**** and the member 172050525300**** with the resource share rs-6GRmdD3X**** in the cn-hangzhou region. After the association, the vSwitch is shared with the member.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
resourcesharing:AssociateResourceShare	Write	All Resources *	resourcesharing:Target	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceShareId	string	Yes	The ID of the resource share.	rs-6GRmdD3X****
Resources	object []	No	The information about the resources.
ResourceType	string	No	The type of a shared resource. Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time. For more information about the types of resources that can be shared, see Services that work with Resource Sharing. Note `Resources.N.ResourceId` and `Resources.N.ResourceType` must be used in pairs.	VSwitch
ResourceId	string	No	The ID of a shared resource. Valid values of N: 1 to 5. This indicates that a maximum of five shared resources can be specified at a time. Note Resources.N.ResourceId and Resources.N.ResourceType must be used in pairs.	vsw-bp183p93qs667muql****
Targets	array	No	The information about the principals.
	string	No	The information about a principal. If the value of `AllowExternalTargets` for the resource share is `false`, the resource share supports only resource sharing within a resource directory. In this case, you can set this parameter to the ID of the resource directory, ID of a folder in the resource directory, or ID of a member in the resource directory. If the value of `AllowExternalTargets` for the resource share is `true`, the resource share supports both resource sharing within a resource directory and resource sharing outside a resource directory. In this case, you can set this parameter to the ID of an independent Alibaba Cloud account, ID of the resource directory, ID of a folder in the resource directory, ID of a member in the resource directory, or the name of an Alibaba Cloud service. For more information, see Resource sharing modes, View the ID of a resource directory, View the ID of a folder, or View the ID of a member. Valid values of N: 1 to 5. This indicates that a maximum of five principals can be specified at a time.	172050525300****
PermissionNames	array	No	The information about the permissions. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see Permission library.
	string	No	The name of a permission. If you do not configure this parameter, the system automatically associates the default permission for the specified resource type with the resource share. For more information, see Permission library.	AliyunRSDefaultPermissionVSwitch
TargetProperties	object []	No	The properties of the principal. Note This parameter is available only when you specify an Alibaba Cloud service as a principal.
TargetId	string	No	The ID of the principal. Note `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.	172050525300****
Property	string	No	The property parameter of the principal. For example, you can specify a parameter that indicates the time range for resource sharing. Valid values of `timeRangeType`: timeRange: a specific time range day: all day Note `TargetProperties.N.TargetId` and `TargetProperties.N.Property` must be used in pairs.	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	111FB84A-60A9-403E-9067-E55D7EE95BD1
ResourceShareAssociations	object []	The information about the entities that are associated with the resource share.
UpdateTime	string	The time when the association of the entity was updated. The value of this parameter depends on the value of the AssociationType parameter: If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the association of the shared resource was updated. If the value of `AssociationType` is `Target`, the value of this parameter is the time when the association of the principal was updated.	2020-12-04T09:40:41.246Z
EntityId	string	The ID of the entity. The value of this parameter depends on the value of the AssociationType parameter: If the value of `AssociationType` is `Resource`, the value of this parameter is the ID of the shared resource. If the value of `AssociationType` is `Target`, the value of this parameter is the ID of the principal.	vsw-bp183p93qs667muql****
ResourceShareName	string	The name of the resource share.	test
CreateTime	string	The time when the association of the entity was created. The value of this parameter depends on the value of the AssociationType parameter: If the value of `AssociationType` is `Resource`, the value of this parameter is the time when the shared resource was associated with the resource share. If the value of `AssociationType` is `Target`, the value of this parameter is the time when the principal was associated with the resource share.	2020-12-04T09:40:41.246Z
EntityType	string	The type of the entity. The value of this parameter depends on the value of the AssociationType parameter: If the value of AssociationType is Resource, the value of this parameter is the type of the shared resource. For information about the types of resources that can be shared, see Services that work with Resource Sharing. If the value of AssociationType is Target, the value of this parameter is `Account`.	VSwitch
ResourceShareId	string	The ID of the resource share.	rs-6GRmdD3X****
AssociationStatusMessage	string	The cause of the association failure.	The reason for the association failure.
AssociationType	string	The association type. Valid values: Resource Target	Resource
AssociationStatus	string	The association status. Valid values: Associating: The entity is being associated. Associated: The entity is associated. Failed: The entity fails to be associated. Disassociating: The entity is being disassociated. Disassociated: The entity is disassociated. Note The system deletes the records of entities in the `Failed` or `Disassociated` state within 48 hours to 96 hours.	Associating
TargetProperty	string	The properties of the principal, such as the time range within which the resource is shared. Note This parameter is returned only if the principal is an Alibaba Cloud service.	{ "plan":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }

Examples

Sample success responses

JSONformat

{
  "RequestId": "111FB84A-60A9-403E-9067-E55D7EE95BD1",
  "ResourceShareAssociations": [
    {
      "UpdateTime": "2020-12-04T09:40:41.246Z",
      "EntityId": "vsw-bp183p93qs667muql****",
      "ResourceShareName": "test",
      "CreateTime": "2020-12-04T09:40:41.246Z",
      "EntityType": "VSwitch",
      "ResourceShareId": "rs-6GRmdD3X****",
      "AssociationStatusMessage": "The reason for the association failure.",
      "AssociationType": "Resource",
      "AssociationStatus": "Associating",
      "TargetProperty": "{\n    \"plan\":{\n        \"timeRangeType\":\"timeRange\",\n        \"beginAtTime\":\"00:00\",\n        \"timezone\":\"UTC+8\",\n        \"endAtTime\":\"19:59\"\n    }\n}"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.ResourceShareId	You must specify ResourceShareId.	You must specify ResourceShareId.
400	InvalidParameter.ResourceShareId	The ResourceShareId is invalid.	The ResourceShareId parameter is invalid.
400	InvalidParameter.Resources	The Resources is invalid.	The specified shared resource is invalid.
400	InvalidParameter.Resources.Duplicate	The Resources contains duplicate values.	The specified Resources parameter contains duplicate values.
400	InvalidParameter.Resources.Length	The maximum number of Resources exceeds 5.	The number of specified shared resources cannot exceed 5.
400	InvalidParameter.Targets	The Targets is invalid.	The specified Targets parameter is invalid.
400	InvalidParameter.Targets.Duplicate	The Targets contains duplicate values.	The specified Targets parameter contains duplicate values.
400	InvalidParameter.Targets.Length	The maximum number of Targets exceeds 5.	The number of Targets values cannot exceed 5.
400	InvalidTarget	The shared target does not exist in the resource directory.	The specified Targets value is not a member in the resource directory.
400	ResourceAndTargetBothEmpty	Either a resource or a shared target must be specified.	You must specify a resource or a resource account.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InvalidParameter.ResourceType	The ResourceType is invalid.	The specified ResourceType parameter is invalid.
400	InvalidParameter.PermissionNames.Duplicate	The PermissionNames duplicate values.	Duplicate values are specified for the PermissionNames parameter.
400	InvalidParameter.PermissionNames.Length	The maximum length of PermissionNames exceeds quota limit.	The length of the value specified for the PermissionNames parameter exceeds the limit.
400	InvalidParameter.TargetProperties	The TargetProperties is invalid.	The TargetProperties is invalid.
400	InvalidParameter.TargetProperties.Duplicate	The TargetProperties contains duplicate values.	TargetProperties contains duplicate parameters.
400	InvalidParameter.TargetProperties.Length	The TargetProperties beyond the length limit.	The TargetProperties beyond the length limit.
404	EntityNotExists.ResourceShare	The resource share does not exist in the current account.	The resource share does not exist in the current account.
404	EntityNotExists.Permission	The resource share permission does not exist.	You do not have the required permissions.
409	NotEnableSharingWithResourceDirectory	You have not enabled sharing with your Resource Directory.	You have not enabled sharing with Resource Directory.
409	AccountNotInResourceDirectory	The account is not a master or a member of a resource directory.	The specified Targets value is not a member in the resource directory.
409	ResourceShareStatusMismatchAction	The status of the resource share does not allow the specified operation.	The status of the resource share does not allow the specified operation.
409	QuotaExceeded.SharedResource.Count	The maximum number of shared resources per account exceeds the limit.	The maximum number of Resources values per account is exceeded.
409	ShareWithYourself	You cannot share resources with yourself.	You cannot share resources with yourself.
409	AssociateConflict	You cannot perform the operation while disassociation operation is being performed.	The association operation is not supported while an disassociation is being performed.
409	NotManagementAccount	Only the management account of the service is allowed to share such resources.	Only the management account of the resource directory can be used to share the current type of resource. If you still want to use the current account, contact the owner of the management account to configure the current account as a delegated administrator account of the trusted service to which the resource belongs.
409	QuotaExceeded.PendingInvitations	The maximum number of pending invitations exceeds the limit.	The number of invitations exceeds the upper limit.
409	InvalidTarget.LegalEntityMismatch	The target account does not have the same legal entity as the resource owner account.	The enterprise name of the principal is inconsistent with that of the resource owner.
409	ExternalTargetsNotAllowed.ResourceType	The resource share includes resource types that cannot be shared with accounts outside the resource directory.	The resource share contains resources that do not support this operation.
409	InvalidTarget.SiteMismatch	Cross-site resource sharing is not supported.	The principal and resource owner are registered at different sites.
409	NotSupport.Service.ExistInOtherResourceShare	The resource type has been shared to the target service through other resourceShare. Please share it in the same resourceShare.	-
409	NotSupport.Service.AssociateConflict	The same resource cannot be shared repeatedly to the target service.	-

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

Change history

Change time

Summary of changes

Operation

2024-01-23

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 409
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: TargetProperties

2024-01-03

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	Error Codes 409 change
	delete Error Codes: 404
Output Parameters	The response structure of the API has changed.

2023-04-07

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 409 change
	delete Error Codes: 400
	delete Error Codes: 404

2023-04-07

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 409 change
	delete Error Codes: 400
	delete Error Codes: 404