ListResourceShareAssociations - Resource Management - Alibaba Cloud Documentation Center

Queries the records of resources or principals that are associated with a resource share.

Operation description

This topic provides an example of how to query the records of shared resources that are associated with a resource share created by the current account in the China (Hangzhou) region. The response shows that the current account is associated with the following two resources:

In the resource share rs-6GRmdD3X****, a shared resource of the VSwitch type with the ID vsw-bp1upw03qyz8n7us9**** was added. The resource is in the Associated state, which means the resource is being shared.
In the resource share rs-6GRmdD3X****, a shared resource of the VSwitch type with the ID vsw-bp183p93qs667muql**** was removed. The resource is in the Disassociated state, which means the resource is no longer shared.

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:ListResourceShareAssociations

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	string	No	The resource ID. Note This parameter is not available when `AssociationType` is set to `Target`.	vsw-bp183p93qs667muql****
ResourceArn	string	No	The Alibaba Cloud Resource Name (ARN) of the resource. Note This parameter is not available when `AssociationType` is set to `Target`.	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
Target	string	No	The ID of the principal. Note This parameter is not available when `AssociationType` is set to `Resource`.	172050525300****
AssociationType	string	Yes	The association type. Valid values: Resource: Queries the records of shared resources. Target: Queries the records of principals.	Resource
AssociationStatus	string	No	The association status. Valid values: Associating: The entity is being associated. Associated: The entity is associated. Failed: The association failed. Disassociating: The entity is being disassociated. Disassociated: The entity is disassociated. Note Records in the `Failed` and `Disassociated` states are automatically deleted by the system within 48 to 96 hours.	Associated
MaxResults	integer	No	The maximum number of entries to return for a single request. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	If the response is truncated, you can use `NextToken` to retrieve the next page of results.	TGlzdFJlc291cm****
ResourceShareIds	array	No	The IDs of the resource shares. You can specify up to 5 resource share IDs.	rs-6GRmdD3X****
	string	No	The ID of the resource share.	rs-6GRmdD3X****

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	If the response is truncated, you can use `NextToken` to retrieve the next page of results.	TGlzdFJlc291cm****
RequestId	string	The request ID.	11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB
ResourceShareAssociations	array<object>	The information about the shared resources or principals.
	object	The information about the shared resources or principals.
UpdateTime	string	The time when the association was updated. Two cases exist: If `AssociationType` is `Resource`, this parameter indicates the time when the resource was updated. If `AssociationType` is `Target`, this parameter indicates the time when the principal was updated.	2020-12-07T07:39:02.920Z
EntityId	string	The ID of the associated entity. Valid values: If `AssociationType` is `Resource`, this parameter is the resource ID. If `AssociationType` is `Target`, this parameter is the principal ID.	vsw-bp1upw03qyz8n7us9****
ResourceArn	string	The ARN of the associated resource. Note This parameter is not available when `AssociationType` is set to `Target`.	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
ResourceShareName	string	The name of the resource share.	example
CreateTime	string	The time when the association was created. Two cases exist: If `AssociationType` is `Resource`, this parameter indicates the time when the resource was added or removed. If `AssociationType` is `Target`, this parameter indicates the time when the principal was added or removed.	2020-12-07T07:39:01.818Z
EntityType	string	The type of the associated entity. Valid values: If the entity is a resource, this parameter is the resource type. For more information, see Alibaba Cloud services that support resource sharing. If the entity is a principal, this parameter is `Account`.	VSwitch
ResourceShareId	string	The ID of the resource share.	rs-6GRmdD3X****
AssociationStatusMessage	string	The reason why the association failed.	The reason for the association failure.
AssociationType	string	The association type. Valid values: Resource: The entity is a resource. Target: The entity is a principal.	Resource
AssociationStatus	string	The association status. Valid values: Associating: The entity is being associated. Associated: The entity is associated. Failed: The association failed. Disassociating: The entity is being disassociated. Disassociated: The entity is disassociated. Note Records in the `Failed` and `Disassociated` states are automatically deleted by the system within 48 to 96 hours.	Failed
External	boolean	Indicates whether the principal is outside the resource directory. Valid values: true: The principal is outside the resource directory. false: The principal is within the resource directory.	false
TargetProperty	string	The properties of the principal. For example, the time period for resource sharing. Valid values for `timeRangeType`: timeRange: a specified time period. day: the whole day. Note This parameter is returned only when the principal is an Alibaba Cloud service.	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }
AssociationFailedDetails	array<object>	The details of the failure to associate or disassociate the resource or principal.
	object	The details of the failure to associate or disassociate the resource or principal.
Status	string	This parameter is deprecated. Use FailureReason instead.	无
StatusMessage	string	This parameter is deprecated. Use FailureDescription instead.	无
AssociateType	string	This parameter is deprecated. Use OperationType instead.	无
ResourceArn	string	The ARN of the associated resource. Note This parameter is not available when `AssociationType` is set to `Resource`.	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
EntityType	string	The type of the associated entity. Valid values: If the entity is a resource, this parameter is the resource type. For more information, see Alibaba Cloud services that support resource sharing. If the entity is a principal, this parameter can be `ResourceDirectory`, `Folder`, `Account`, or `Service`.	Account
FailureReason	string	The reason for the failure to associate or disassociate the entity. Valid values: Unavailable: The sharing fails because the resource does not exist or is in an invalid state. LimitExceeded: The number of principals with which the resource can be shared exceeds the upper limit. ZonalResourceInaccessible: The resource is unavailable in the region. InternalError: An internal error occurred. UnsupportedOperation: The operation is not supported.	Unavailable
FailureDescription	string	The detailed description of the failure to associate or disassociate the entity.	You cannot access the specified resource at this time.
OperationType	string	The operation type. Valid values: Associate: The operation is to associate the entity. Disassociate: The operation is to disassociate the entity.	Associate
EntityId	string	The ID of the associated entity. Valid values: If AssociationType is Resource, this parameter is the principal ID. If AssociationType is Target, this parameter is the resource ID.	172050525300****

Examples

Success response

JSON format

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB",
  "ResourceShareAssociations": [
    {
      "UpdateTime": "2020-12-07T07:39:02.920Z",
      "EntityId": "vsw-bp1upw03qyz8n7us9****",
      "ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
      "ResourceShareName": "example",
      "CreateTime": "2020-12-07T07:39:01.818Z",
      "EntityType": "VSwitch",
      "ResourceShareId": "rs-6GRmdD3X****",
      "AssociationStatusMessage": "The reason for the association failure. ",
      "AssociationType": "Resource",
      "AssociationStatus": "Failed",
      "External": false,
      "TargetProperty": "{\n    \"timeRange\":{\n        \"timeRangeType\":\"timeRange\",\n        \"beginAtTime\":\"00:00\",\n        \"timezone\":\"UTC+8\",\n        \"endAtTime\":\"19:59\"\n    }\n}",
      "AssociationFailedDetails": [
        {
          "Status": "无",
          "StatusMessage": "无",
          "AssociateType": "无",
          "ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
          "EntityType": "Account",
          "FailureReason": "Unavailable",
          "FailureDescription": "You cannot access the specified resource at this time.",
          "OperationType": "Associate",
          "EntityId": "172050525300****"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.AssociationType	You must specify AssociationType.	You must specify AssociationType.
400	InvalidParameter.AssociationType	The AssociationType is invalid.	The AssociationType parameter is invalid.
400	InvalidParameter.AssociationStatus	The AssociationStatus is invalid.	The AssociationStatus parameter is invalid.
400	InvalidParameter.MaxResults	The MaxResults is invalid.	The MaxResults parameter is invalid.
400	InvalidParameter.NextToken	The NextToken is invalid.	The NextToken parameter is invalid.
400	InvalidParameter.NextToken.Length	The maximum length of NextToken exceeds 256 characters.	The length of NextToken cannot exceed 256 characters.
400	InvalidParameter.ResourceShareIds	The ResourceShareIds is invalid.	The ResourceShareIds parameter is invalid.
400	InvalidParameter.ResourceShareIds.Duplicate	The ResourceShareIds contains duplicate values.	The ResourceShareIds parameter contains duplicate values.
400	InvalidParameter.ResourceShareIds.Length	The maximum length of ResourceShareIds exceeds 5 characters.	The number of ResourceShareIds values cannot exceed 5.
400	InvalidParameter.Target	The Target is invalid.	The Target parameter is invalid.
400	InvalidParameter.ResourceId	The ResourceId is invalid.	The ResourceId parameter is invalid.
400	ConflictedAssociationType	The specified ResourceId or Target conflicts with AssociationType.	The specified parameter conflicts with AssociationType.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InvalidParameter.ResourceArn	The ResourceArn is invalid.	The ResourceArn is invalid.
400	InvalidParameter.ResourceConflict	Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.	Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.