ListTagResources - Resource Management - Alibaba Cloud Documentation Center

Queries the tags attached to one or more resource shares.

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

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Set the value to `ResourceShare`, which indicates a resource share.	ResourceShare
ResourceId	array	No	The IDs of the resource shares. You can specify up to 20 resource share IDs.
	string	No	The ID of the resource share.	rs-PqysnzIj****
RegionId	string	Yes	The ID of the region to which the resource share belongs.	cn-hangzhou
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key. Note The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	k1
Value	string	No	The tag value. Note The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	v1
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the response of the current request is truncated, you can use the `token` to initiate another request and obtain the remaining entries.	caeba0bbb2be03f84eb48b699f0a****

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. If the response of the current request is truncated, you can use the `token` to initiate another request and obtain the remaining entries.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	8054B059-6B36-53BF-AA45-B8C9A0ED05AB
TagResources	object
TagResource	array<object>	The tags.
	object	The tag.
ResourceId	string	The ID of the resource share.	rs-PqysnzIj****
ResourceType	string	The resource type. Set the value to `ResourceShare`, which indicates a resource share.	ResourceShare
TagKey	string	The tag key.	k1
TagValue	string	The tag value.	v1

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "8054B059-6B36-53BF-AA45-B8C9A0ED05AB",
  "TagResources": {
    "TagResource": [
      {
        "ResourceId": "rs-PqysnzIj****",
        "ResourceType": "ResourceShare",
        "TagKey": "k1",
        "TagValue": "v1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NextToken	The NextToken is invalid.	The NextToken parameter is invalid.
400	MissingParameter.ResourceIdOrTag	You must specify ResourceId or Tag.	You must specify ResourceId or Tag.
400	InvalidParameter.ResourceType	The ResourceType parameter is invalid.	The ResourceType parameter is invalid.
400	MissingParameter.ResourceType	You must specify ResourceType.	The resource type parameter cannot be empty.
400	MissingParameter.TagKey	You must specify TagKey.	You must specify TagKey.
400	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded.	The maximum number of ResourceIds is exceeded.
400	NumberExceed.Tags	The maximum number of Tags is exceeded.	The maximum number of Tags is exceeded.
400	Duplicate.TagKey	The TagKey contains duplicate keys.	The TagKey contains duplicate keys.
500	InternalError	The request processing has failed due to some unknown error.	The request processing has failed due to some unknown error.
403	NoPermission	You are not authorized to perform this action.	You are not authorized to perform this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.