All Products
Search
Document Center

Resource Management:ListTagResources

Last Updated:Mar 03, 2024

Queries the tags that are added to the resources of various Alibaba Cloud services.

Operation description

For information about the Alibaba Cloud services that support tags, see Services that work with Tag.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
NextTokenstringNo

The token that is used to start the next query.

caeba0bbb2be03f84eb48b699f0a****
PageSizeintegerNo

The number of entries to return on each page.

Maximum value: 1000. Default value: 50.

50
TagsstringNo

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

If you specify multiple tags, the system queries the resources to which all these tags are added.

Limits:

  • 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 on 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.
{"k1":"v1","k2":"v2"}
CategorystringNo

The type of the tag. Valid values:

  • Custom
  • System
  • All

Default value: All.

Custom
ResourceARNarrayNo

The Alibaba Cloud Resource Name (ARN) of a resource.

stringNo

The ARN of a resource.

Valid values of N: 1 to 50.

Format: arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}. Fields:

  • ProductCode: the service code. You can set this field to a value obtained from the response of the ListSupportResourceTypes operation.
  • Region: the region ID of the resource. You can set this field to an asterisk (*) to indicate the current region.
  • Account: the ID of the Alibaba Cloud account to which the resource belongs. You can set this field to an asterisk (*) to indicate the current Alibaba Cloud account.
  • ResourceType: the resource type. You can set this field to a value obtained from the response of the ListSupportResourceTypes operation.
  • ResourceId: the resource ID.
Note You can set ProductCode and ResourceType in ResourceARN to values defined in Resource Group, ActionTrail, or Resource Center.
arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

Indicates whether the next query is required.

  • If the value of this parameter is empty ("NextToken": ""), all results are returned, and the next query is not required.
  • If the value of this parameter is not empty, the next query is required, and the value is the token used to start the next query.
caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

The ID of the request.

014738E0-3C7F-47D8-8FB9-469500C6F387
TagResourcesobject []

The information of the tags that are added to the resources.

ResourceARNstring

The ARN of the resource.

arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****
Tagsobject []

The information of the tags.

Keystring

The tag key.

k1
Valuestring

The tag value.

v1
Categorystring

The type of the tag. Valid values:

  • Custom
  • System
Custom

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "014738E0-3C7F-47D8-8FB9-469500C6F387",
  "TagResources": [
    {
      "ResourceARN": "arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1",
          "Category": "Custom"
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.TagsThe specified value of parameter Tags is not valid.The specified value of parameter Tags is not valid.
403Duplicate.TagKeyThe Tag.N.Key contains duplicate keys.The Tag.N.Key contains duplicate keys.
403Invalid.ResourceIdARNThe parameter ResourceIdARN is invalid.The parameter ResourceIdARN is invalid.
403InvalidParameter.CategoryThe specified Category is invalid. Valid values are Custom and System.The specified Category is invalid. Valid values are Custom and System.
403MissingParameter.ResourceIdsYou must specify ResourceIds.You must specify ResourceIds.
403NoPermission.OperatorThe user is not authorized to operate on the specified resource.The user is not authorized to operate on the specified resource.
403NoPermission.SystemTagThe user does not have permission to operate the system tag.The user does not have permission to operate the system tag.
403NoPermissionKey.CategorySome keys cannot be modified because the user does not have permission.Some keys cannot be modified because the user does not have permission.
403NoPermissionKey.OperatorYou are not authorized to operate the tag key.You are not authorized to operate the tag key.
403NumberExceed.ResourceIdsThe maximum number of ResourceIds is exceeded.The maximum number of ResourceIds is exceeded.
403NumberExceed.TagsThe maximum number of Tags is exceeded.The maximum number of Tags is exceeded.
403QuotaExceed.TagsPerResourceThe maximum number of tags for each resource is exceeded.The maximum number of tags for each resource is exceeded.
403Invalid.NextTokenThe parameter NextToken is invalid.The parameter NextToken is invalid.
403InvalidParameter.TagKeyThe Tag.N.Key parameter is invalid.The Tag.N.Key parameter is invalid.
403InvalidParameter.TagValueThe Tag.N.Value parameter is invalid.The Tag.N.Value parameter is invalid.
403InvalidParameter.ResourceTypeThe ResourceType parameter is invalid.The ResourceType parameter is invalid.
404Missing.TagKeyTag.N.Value has been specified and you must specify Tag.N.Key.Tag.N.Value has been specified and you must specify Tag.N.Key.
404MissingParameter.AliUidYou must specify AliUid.You must specify AliUid.
404MissingParameter.BidYou must specify Bid.You must specify Bid.
404MissingParameter.RegionIdYou must specify RegionId.You must specify RegionId.
404MissingParameter.RemoveNumYou must specify RemoveNum.You must specify RemoveNum.
404MissingParameter.ResourceIdARNYou must specify ResourceIdARN.You must specify ResourceIdARN.
404MissingParameter.TagKeyYou must specify TagKey.You must specify TagKey.
404MissingParameter.TagsYou must specify Tags.You must specify Tags.
404NoMatch.RemoveNumThe specified DataNum does not match the deleted number.The specified DataNum does not match the deleted number.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    delete Error Codes: 404