You can call this operation to query the tags that are bound to one or more ECS instances.
Description
- Specify in the request at least one of the following parameters or parameter pairs
to determine a query object: the
ResourceId.N
parameter, theTag.N
parameter pair (Tag.N.Key
andTag.N.Value
), and theTagFilter.N
parameter pair (TagFilter.N.TagValues.N and TagFilter.N.TagKey). - If one of the following sets of request parameters is specified as filter conditions,
the response contains only ECS resources that meet all these filter conditions:
- Set 1:
Tag.N.Key, Tag.N.Value
, andResourceId.N
- Set 2:
TagFilter.N.TagValues.N, TagFilter.N.TagKey
, andResourceId.N
- Set 1:
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListTagResources |
The operation that you want to perform. Set the value to ListTagResources. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list. |
ResourceType | String | Yes | instance |
The type of the resource. Valid values:
|
TagFilter.N.TagKey | String | Yes | env |
The key of tag N used for fuzzy search of ECS resources. It must be 1 to 128 characters in length. Valid values of N: 1 to 5. The
Note The
TagFilter.N parameter pair (TagFilter.N.TagKey and TagFilter.N.TagValues.N) cannot be used together
with the Tag.N parameter pairs (TagFilter.N.TagValues.N and TagFilter.N.TagKey). Otherwise, an error
message is returned.
|
ResourceId.N | RepeatList | No | i-bp1j6qtvdm8w0z1o**** |
The IDs of ECS resources. Valid values of N: 1 to 50. |
Tag.N.Key | String | No | TestKey |
The key of tag N used for exact search of ECS resources. It must be 1 to 128 characters in length. Valid values of N: 1 to 20.
|
Tag.N.Value | String | No | TestValue |
The value of tag N used for exact search of ECS resources. It must be 1 to 128 characters in length. Valid values of N: 1 to 20. |
TagFilter.N.TagValues.N | RepeatList | No | TestTagFilter |
The value of tag N used for fuzzy search of ECS resources. It must be 1 to 128 characters in length. Valid values of N: 1 to 5. |
NextToken | String | No | caeba0bbb2be03f84eb48b699f0a4883 |
The token for starting the next query. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
The token for starting the next query. |
RequestId | String | 484256DA-D816-44D2-9D86-B6EE4D5BA78C |
The ID of the request. |
TagResources | Array of TagResource |
The collection of details about resources and tags, such as resource IDs, resource types, and tag key-value pairs. |
|
TagResource | |||
ResourceId | String | i-bp1j6qtvdm8w0z1o**** |
The ID of the resource. |
ResourceType | String | instance |
The type of the resource. |
TagKey | String | TestKey |
The tag key of the resource. |
TagValue | String | TestValue |
The tag value of the resource. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=instance
&ResourceId.1=i-bp1j6qtvdm8w0z1o****
&<Common request parameters>
Sample success responses
XML
format
<ListTagResourcesResponse>
<TagResources>
<TagResource>
<ResourceType>instance</ResourceType>
<TagValue>TestValue</TagValue>
<ResourceId>i-bp1j6qtvdm8w0z1o****</ResourceId>
<TagKey>TestKey</TagKey>
</TagResource>
</TagResources>
<RequestId>DE65F6B7-7566-4802-9007-96F2494AC5XX</RequestId>
</ListTagResourcesResponse>
JSON
format
{
"TagResources": {
"TagResource": [
{
"ResourceType": "instance",
"TagValue": "TestValue",
"ResourceId": "i-bp1j6qtvdm8w0z1o****",
"TagKey": "TestKey"
}
]
},
"RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidRegionId.NotFound | %s | The error message returned because the specified RegionId parameter does not exist. |
404 | MissingParameter.TagOwnerUid | The parameter - TagOwnerUid should not be null | The error message returned because the TagOwnerUid parameter is not specified. |
404 | MissingParameter.TagOwnerBid | The parameter - TagOwnerBid should not be null | The error message returned because the TagOwnerBid parameter is not specified. |
404 | MissingParameter.ResourceType | The parameter - ResourceType should not be null | The error message returned because the ResourceType parameter is not specified. |
404 | MissingParameter.Tags | The parameter - Tags should not be null | The error message returned because the tag-related parameters are not specified. |
404 | MissingParameter.RegionId | The parameter - RegionId should not be null | The error message returned because the RegionId parameter is not specified. |
403 | PermissionDenied.TagOwnerUid | The specified operator not have permission to set TagOwnerUid value. | The error message returned because you are not authorized to set the owner of the tag. |
403 | PermissionDenied.Scope | The specified operator not have permission to set Scope value. | The error message returned because the specified operator is not authorized to specify the Scope parameter. |
400 | NumberExceed.ResourceIds | The ResourceIds parameter's number is exceed , Valid : 50 | The error message returned because more than 50 resource IDs are specified. |
400 | NumberExceed.Tags | The Tags parameter's number is exceed , Valid : 20 | The error message returned because the number of tags has exceeded the maximum value of the Tags parameter. Maximum value: 20. |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The error message returned because the specified tag key already exists. Tag keys must be unique. |
404 | InvalidResourceId.NotFound | The specified ResourceIds are not found in our records. | The error message returned because the specified resource does not exist. Check whether the resource ID is correct. |
404 | InvalidResourceType.NotFound | The ResourceType provided does not exist in our records. | The error message returned because the specified ResourceType parameter does not exist. |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | The error message returned because the specified Tag.N.Key parameter is invalid. |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | The error message returned because the specified Tag.N.Value parameter is invalid. |
400 | OperationDenied.QuotaExceed | The quota of tags on resource is beyond permitted range. | The error message returned because the maximum number of tags that can be bound to the resource has been reached. |
403 | InvalidResourceId.NotSupported | The specified ResourceId does not support tagging. | The error message returned because the specified resource does not support tagging. |
400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | The error message returned because the specified Tag.N.Key and Tag.N.Value parameters do not match. |
400 | InvalidTagCount | The specified tags are beyond the permitted range. | The error message returned because the maximum number of tags has been reached. |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | The error message returned because the specified RegionId parameter does not exist. |
400 | Invalid.Scope | The specified scope is invalid. | The error message returned because the specified scope is invalid. |
403 | NoPermission.Tag | The operator is not permission for the tag. | The error message returned because you are not authorized to manage the tag. |
For a list of error codes, visit the API Error Center.