Use ListTagResources to query tags of ECS resources - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Lists the tags on one or more ECS resources.

Operation description

API

To find specific resources, include at least one of the following parameters in your request.

ResourceId.N
Tag.N (Tag.N.Key and Tag.N.Value)
TagFilter.N

If you specify the following parameter combinations, the API returns only the ECS resources that match all conditions.

Tag.N and ResourceId.N
TagFilter.N and ResourceId.N

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

ecs:ListTagResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the resource is located. You can call the DescribeRegions operation to view the latest list of Alibaba Cloud regions.	cn-hangzhou
RegionId	string	Yes		cn-hangzhou
NextToken	string	No	The pagination token to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a4883
ResourceType	string	Yes	The resource type. Valid values: instance: ECS instance disk: disk snapshot: snapshot image: image securitygroup: security group volume: volume eni: elastic network interface ddh: dedicated host ddhcluster: dedicated host cluster keypair: SSH key pair launchtemplate: launch template reservedinstance: reserved instance snapshotpolicy: snapshot policy elasticityassurance: Elasticity Assurance capacityreservation: capacity reservation command: Cloud Assistant command invocation: The result of a command execution or file delivery in Cloud Assistant activation: Cloud Assistant managed instance activation code managedinstance: Cloud Assistant managed instance	instance
ResourceId	array	No	The ID of an ECS resource. The value of N ranges from 1 to 50.	i-bp1j6qtvdm8w0z1o****
	string	No		i-bp1j6qtvdm8w0z1o****
Tag	array<object>	No	A list of tags.
	object	No
Key	string	No	The tag key to use for an exact match. The tag key must be 1 to 128 characters in length. The value of N ranges from 1 to 20. Usage notes for the `Tag.N` parameter: Method 1: To find ECS resources that have specific tags. If you specify only `Tag.N.Key`, the operation returns all resources that have the specified tag key. If you specify only `Tag.N.Value`, the operation returns an `InvalidParameter.TagValue` error. If you specify multiple tag key-value pairs, the operation returns only the ECS resources that match all specified pairs. Method 2: To query resources in a non-default resource group. If you set `Key` to `acs:rm:rgId`, you must set `Value` to the ID of a non-default resource group. If you specify the ID of the default resource group, the operation returns an error. If you set `Key` to `acs:rm:rgId`, you cannot specify other tag key-value pairs. If you use multiple `Tag.N` parameters to query for resources by both resource group and tag, the operation returns an error.	TestKey
Value	string	No	The tag value to use for an exact match. The tag value must be 1 to 128 characters in length. The value of N ranges from 1 to 20. Note When `Key` is `acs:rm:rgId`, you must set this parameter to the ID of a non-default resource group.	TestValue
TagFilter	array<object>	No	A list of tag filters. Note This parameter is in invitation-only preview and is not yet available.
	object	No
TagValues	array	No	The tag values to use for a fuzzy match. The tag value must be 1 to 128 characters in length. The value of N ranges from 1 to 5. For more information, see the description of the `TagFilter.N.TagKey` parameter.	TestTagFilter
	string	No		TestTagFilter
TagKey	string	No	The tag key to use for a fuzzy match. The tag key must be 1 to 128 characters in length. The value of N ranges from 1 to 5. Use the `TagFilter.N` parameter to perform a fuzzy match on tags to find matching ECS resources. Each filter consists of one key and one or more values. A fuzzy match may have a 2-second latency and is supported only for queries that return 5,000 or fewer resources after filtering. To perform a fuzzy match by tag key (`TagFilter.N.TagKey`), you must leave the tag values (`TagFilter.N.TagValues.N`) empty. For example, to search for ECS resources that have the tag key `environment`, you can set `TagFilter.1.TagKey` to `env` (prefix match), `env` (substring match), or `env` (exact match), but you must leave `TagFilter.1.TagValues` empty. To perform a fuzzy match by tag value (`TagFilter.N.TagValues.N`), you must set the tag key (`TagFilter.N.TagKey`) to an exact value. For example, to search for ECS resources with the tag key `env` and the tag value `product`, you must set `TagFilter.1.TagKey` to `env`. You can then set `TagFilter.1.TagValues.1` to `proc` (prefix match), `proc` (substring match), or `proc` (exact match). For the same `TagKey`, you can use only one search pattern. If you specify multiple patterns, the system uses only the first pattern. Tag keys are combined by using a logical AND. The operation returns only the ECS resources that match all specified tag keys. Tag values for the same tag key are combined by using a logical OR. The operation returns the ECS resources that match any of the specified tag values for that tag key. Note You cannot specify both the `TagFilter.N` and `Tag.N` parameters in the same request.	env

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResources	object
TagResource	array<object>	An array of tags and their associated resources. Each object in the array contains the resource ID, resource type, tag key, and tag value.
	object
TagValue	string	The tag value.	TestValue
ResourceType	string	The resource type. Valid values: `instance`: An ECS instance. `disk`: A disk. `snapshot`: A snapshot. `image`: An image. `securitygroup`: A security group. `volume`: A volume. `eni`: An elastic network interface. `ddh`: A dedicated host. `ddhcluster`: A dedicated host cluster. `keypair`: An SSH key pair. `launchtemplate`: A launch template. `reservedinstance`: A reserved instance. `snapshotpolicy`: An automatic snapshot policy. `elasticityassurance`: An elasticity assurance. `capacityreservation`: A capacity reservation. `command`: A Cloud Assistant command. `invocation`: The result of a Cloud Assistant command execution. `activation`: An activation code for a managed instance. `managedinstance`: A managed instance.	instance
ResourceId	string	The resource ID.	i-bp1j6qtvdm8w0z1o****
TagKey	string	The tag key.	TestKey

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "instance",
        "ResourceId": "i-bp1j6qtvdm8w0z1o****",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	The default resource group cannot be queried.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	Resource groups and tags cannot be queried at the same time.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed , Valid : 50.	The number of ResourceIds parameters specified exceeds the limit.
400	NumberExceed.Tags	The Tags parameter's number is exceed , Valid : 20.	The number of labels specified exceeds the limit.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
400	Invalid.Scope	The specified scope is invalid.
400	InvalidTags.MalFormed	The tags must be empty, when the tagFilters is not empty.
500	ServiceUnavailable	The service is unavailable, please try again later.
500	InternalError	The process of creating snapshot has failed due to some unknown error.	The snapshot cannot be created.
403	PermissionDenied.TagOwnerBid	The specified operator not have permission to set TagOwnerBid value.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	You are not authorized to specify the TagOwnerUid parameter.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	You are not authorized to specify the Scope parameter.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.
403	NoPermission.Tag	The operator is not permission for the tag.	You are not authorized to manage the tag.
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The parameter passed in must contain Tags or
403	PermissionDenied.TagsFuzzyQuery	The specified operator has not permission to query fuzzy tags.
403	NumberExceed.TagValues	The number of the specified TagValues is beyond permitted range, the max is 5.
403	InvalidFilter.Malformed	The specified Filter is not valid.
403	InvalidTagFilter.Malformed	The specified TagFilter is not valid.
403	Invalid.NextToken	The specified NextToken is not valid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	MissingParameter.ResourceIds	The parameter - ResourceIds.N should not be null.
404	MissingParameter.TagOwnerUid	The parameter - TagOwnerUid should not be null.
404	MissingParameter.TagOwnerBid	The parameter - TagOwnerBid should not be null.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	The ResourceType parameter is required.
404	MissingParameter.Tags	The parameter - Tags should not be null.
404	MissingParameter.RegionId	The parameter - RegionId should not be null.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	The specified resource does not exist. Check whether the ResourceId parameter is correct.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.