ListTagResources - Simple Application Server - Alibaba Cloud Documentation Center

Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules.

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

swas-open:ListTagResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClientToken	string	No	The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence	123e4567-e89b-12d3-a456-426655440000
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
ResourceType	string	Yes	The resource type. Valid values: instance snapshot customimage command firewallrule disk	instance
ResourceId	array	No	The ID of the resource. You can specify up to 50 resource IDs.
	string	No	The resource ID.	s-bw526m1vi6x20c6g****
Tag	array<object>	No	The list of tags. You can specify up to 20 tags.
	object	No	The tag that is added to a resource.
Key	string	No	The key of the tag that you want to add to a resource. The tag key can be 1 to 64 characters in length.	TestKey
Value	string	No	The value of the tag that you want to add to a resource. The tag value can be 1 to 64 characters in length.	TestValue

Response elements

Element	Type	Description	Example
	object	Schema of response.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
TagResources	object
TagResource	array<object>	A collection of resources and the tags of the resources. The information includes the resource IDs, resource types, and key-value pairs of tags.
	object	The information about the resource and its tag.
ResourceType	string	The type of the resource. Valid values: instance snapshot customimage command firewallrule disk	instance
TagValue	string	The tag value.	TestValue
ResourceId	string	The resource ID.	s-bw526m1vi6x20c6g****
TagKey	string	The tag key.	TestKey

Examples

Success response

JSON format

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***",
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F\t",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "instance",
        "TagValue": "TestValue",
        "ResourceId": "s-bw526m1vi6x20c6g****\n",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.