Queries tags that are bound to the resources of various cloud services.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

ResourceARN.N RepeatList No arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxxxxxx

The Alibaba Cloud Resource Name (ARN) of resource N. For more information about supported resource types and ARN examples, see Types of resources that support tag API operations.

Valid values of N: 1 to 10.

Example:

ResourceARN.1 = arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}

NextToken String No caeba0bbb2be03f84eb48b699f0a****

The token used to start the next query.

PageSize Integer No 50

The number of entries to return on each page.

Maximum value: 1000. Default value: 50.

Tags String No {"k1":"v1","k2":"v2"}

The key-value pairs of tags. You can specify 1 to 10 key-value pairs.

You need to obtain the intersection of the key-value pairs for multiple tags.

  • A tag key must be 1 to 128 characters in length.
  • A tag value must be 1 to 128 characters in length.
  • Tag keys and tag values are case-sensitive.
  • Each tag key of a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten.
Category String No Custom

The type of the tag. Valid values:

  • Custom
  • System
  • All

Default value: All.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a****

The token used to start the next query.

If the value of this parameter is empty, all results are returned.

RequestId String 014738E0-3C7F-47D8-8FB9-469500C6F387

The ID of the request.

TagResources Array

The information of tags that are bound to resources.

ResourceARN String arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxxxxxx

The ARN of the resource.

Tags Array

The information of the tags.

Category String Custom

The type of the tag. Valid values:

  • Custom
  • System
Key String v1

The tag key.

Value String k1

The tag value.

Examples

Sample requests

https://tag.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListTagResourcesResponse>
      <RequestId>014738E0-3C7F-47D8-8FB9-469500C6F387</RequestId>
      <NextToken></NextToken>
      <TagResources>
            <ResourceARN>arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxxxxxx</ResourceARN>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v2</Value>
                  <Key>k2</Key>
            </Tags>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v1</Value>
                  <Key>k1</Key>
            </Tags>
      </TagResources>
      <TagResources>
            <ResourceARN>arn:acs:ecs:cn-hangzhou:123456789****:disk/d-xxxxxxxxxxxxxx</ResourceARN>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v1</Value>
                  <Key>k1</Key>
            </Tags>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v2</Value>
                  <Key>k2</Key>
            </Tags>
      </TagResources>
      <TagResources>
            <ResourceARN>arn:acs:cdn:cn-hangzhou:123456789****:domain/name.test.com</ResourceARN>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v2</Value>
                  <Key>k2</Key>
            </Tags>
            <Tags>
                  <Category>Custom</Category>
                  <Value>v1</Value>
                  <Key>k1</Key>
            </Tags>
      </TagResources>
</ListTagResourcesResponse>

JSON format

{
    "RequestId": "014738E0-3C7F-47D8-8FB9-469500C6F387",
    "NextToken": "",
    "TagResources": [
        {
            "ResourceARN": "arn:acs:ecs:cn-hangzhou:123456789****:instance/i-xxxxxxxxxxxxxx",
            "Tags": [
                {
                    "Category": "Custom",
                    "Value": "v2",
                    "Key": "k2"
                },
                {
                    "Category": "Custom",
                    "Value": "v1",
                    "Key": "k1"
                }
            ]
        },
        {
            "ResourceARN": "arn:acs:ecs:cn-hangzhou:123456789****:disk/d-xxxxxxxxxxxxxx",
            "Tags": [
                {
                    "Category": "Custom",
                    "Value": "v1",
                    "Key": "k1"
                },
                {
                    "Category": "Custom",
                    "Value": "v2",
                    "Key": "k2"
                }
            ]
        },
        {
            "ResourceARN": "arn:acs:cdn:cn-hangzhou:123456789****:domain/name.test.com",
            "Tags": [
                {
                    "Category": "Custom",
                    "Value": "v2",
                    "Key": "k2"
                },
                {
                    "Category": "Custom",
                    "Value": "v1",
                    "Key": "k1"
                }
            ]
        }
    ]
}

Error codes

HTTP status code Error code Error message Description
403 Duplicate.TagKey The Tag.N.Key contains duplicate keys. The error message returned because a duplicate tag key is specified.
403 Invalid.ResourceIdARN The parameter ResourceIdARN is invalid. The error message returned because the value of the ResourceIdARN parameter is invalid.
403 InvalidParameter.Category The specified Category is invalid. Valid values are Custom and System. The error message returned because the value of the Category parameter is invalid. The value can be Custom or System.
404 Missing.TagKey Tag.N.Value has been specified and you must specify Tag.N.Key. The error message returned because the key of tag N is not specified.
404 MissingParameter.AliUid You must specify AliUid. The error message returned because the AliUid parameter is not specified.
404 MissingParameter.Bid You must specify Bid. The error message returned because the Bid parameter is not specified.
404 MissingParameter.RegionId You must specify RegionId. The error message returned because the RegionId parameter is not specified.
404 MissingParameter.RemoveNum You must specify RemoveNum. The error message returned because the RemoveNum parameter is not specified.
404 MissingParameter.ResourceIdARN You must specify ResourceIdARN. The error message returned because the ResourceIdARN parameter is not specified.
403 MissingParameter.ResourceIds You must specify ResourceIds. The error message returned because the ResourceIds parameter is not specified.
404 MissingParameter.TagKey You must specify TagKey. The error message returned because the TagKey parameter is not specified.
404 MissingParameter.Tags You must specify Tags. The error message returned because the Tags parameter is not specified.
404 NoMatch.RemoveNum The specified DataNum does not match the deleted number. The error message returned because the value of the RemoveNum parameter is invalid.
403 NoPermission.Operator The user is not authorized to operate on the specified resource. The error message returned because you are not authorized to perform the operation.
403 NoPermission.SystemTag The user does not have permission to operate the system tag. The error message returned because you are not authorized to perform operations on the system tag.
403 NoPermissionKey.Category Some keys cannot be modified because the user does not have permission. The error message returned because you are not authorized to perform operations on some tag keys.
403 NoPermissionKey.Operator You are not authorized to operate the tag key. The error message returned because you are not authorized to perform operations on the tag key.
403 NumberExceed.ResourceIds The maximum number of ResourceIds is exceeded. The error message returned because the maximum value of the ResourceIds parameter has been reached.
403 NumberExceed.Tags The maximum number of Tags is exceeded. The error message returned because the maximum value of the Tags parameter has been reached.
403 QuotaExceed.TagsPerResource The maximum number of tags for each resource is exceeded. The error message returned because the maximum number of tags for a resource has been reached.
403 Invalid.NextToken The parameter NextToken is invalid. The error message returned because the value of the NextToken parameter is invalid.
400 InvalidParameter.Tags The specified value of parameter Tags is not valid. The error message returned because the value of the Tags parameter is invalid.
403 InvalidParameter.TagKey The Tag.N.Key parameter is invalid. The error message returned because the value of the TagKey parameter is invalid.
403 InvalidParameter.TagValue The Tag.N.Value parameter is invalid. The error message returned because the value of the TagValue parameter is invalid.
403 InvalidParameter.ResourceType The ResourceType parameter is invalid. The error message returned because the value of the ResourceType parameter is invalid.

For a list of error codes, visit the API Error Center.