ListSharedTargets - Resource Management - Alibaba Cloud Documentation Center

Queries principals.

Operation description

If you are a resource owner, you can query the principals with which you share your resources. If you are a principal, you can query the resources that are shared with you.

This topic provides an example on how to call the API operation to query the principals with which you share your resources in the cn-hangzhou region. The response shows that you share your resources with the principals 114240524784**** and 172050525300****.

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.

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:ListSharedTargets	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceOwner	string	Yes	The owner of the resource share. Self: your account. If you set the value to Self, the principals that are associated with your resource shares are queried. OtherAccounts: another account. If you set the value to OtherAccounts, the resource shares with which your account is associated and the owners of the resource shares are queried.	Self
ResourceType	string	No	The type of the shared resources. For more information about the types of resources that can be shared, see Services that work with Resource Sharing.	VSwitch
ResourceId	string	No	The ID of the shared resource.	vsw-bp1upw03qyz8n7us9****
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	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.	TGlzdFJlc291cm****
ResourceShareIds	array	No	The ID of a resource share. Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.
	string	No	The ID of the resource share. Valid values of N: 1 to 5. This indicates that a maximum of five resource shares can be specified at a time.	rs-6GRmdD3X****
Targets	array	No	The information about the principals.
	string	No	The information about a principal. If the value of `AllowExternalTargets` is `false`, you can set this parameter to the ID of a resource directory, folder, or member. If the value of `AllowExternalTargets` is `true`, you can set this parameter to the ID of an Alibaba Cloud account, resource directory, folder, or member 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.	114240524784****

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

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.	TGlzdFJlc291cm****
RequestId	string	The request ID.	04677DCA-7C33-464B-8811-1B1DA3C3D197
SharedTargets	array<object>	The information of the principals.
SharedTarget	object	The information of the principals.
TargetId	string	The ID of the principal or resource owner. If the value of `ResourceOwner` is `Self`, the value of this parameter is the ID of a principal. If the value of `ResourceOwner` is `OtherAccounts`, the value of this parameter is the ID of a resource owner.	114240524784****
UpdateTime	string	The time when the association of the principal was updated.	2020-12-07T09:16:59.905Z
CreateTime	string	The time when the principal was associated with the resource share.	2020-12-07T09:16:59.905Z
ResourceShareId	string	The ID of the resource share.	rs-6GRmdD3X****
External	boolean	Indicates whether the principal is outside the resource directory. Valid values: true false	false
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.	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }

Examples

Sample success responses

JSONformat

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "04677DCA-7C33-464B-8811-1B1DA3C3D197",
  "SharedTargets": [
    {
      "TargetId": "114240524784****",
      "UpdateTime": "2020-12-07T09:16:59.905Z",
      "CreateTime": "2020-12-07T09:16:59.905Z",
      "ResourceShareId": "rs-6GRmdD3X****",
      "External": false,
      "TargetProperty": "{\n    \"timeRange\":{\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.ResourceOwner	You must specify ResourceOwner.	You must specify ResourceOwner.
400	InvalidParameter.ResourceOwner	The ResourceOwner is invalid.	The ResourceOwner parameter is invalid.
400	InvalidParameter.ResourceType	The ResourceType is invalid.	The specified ResourceType 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.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	InvalidParameter.ResourceId	The ResourceId is invalid.	The ResourceId parameter is invalid.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2024-01-03	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-23	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-23	The Error code has changed. The response structure of the API has changed	View Change Details