调用ListTagResources查询多个云产品的多个云资源绑定的标签列表。

使用说明

本文将提供一个示例，在cn-hangzhou地域，查询已绑定资源的标签列表。返回结果显示：

  • ECS实例i-bp15hr53jws84akg****，绑定标签k1:v1和k2:v2。
  • 云盘d-bp16cat8zekjocv4****，绑定标签k1:v1和k2:v2。
  • VPC实例vpc-bp19dd90tkt6tz7wu****，绑定标签k1:v1和k2:v2。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTagResources

要执行的操作。取值：ListTagResources。

RegionId String 是 cn-hangzhou

资源所属的地域ID。
NextToken String 否 caeba0bbb2be03f84eb48b699f0a****

下一个查询开始的Token。
PageSize Integer 否 50

分页时每页显示的数据行数。

最大值：1000。默认值：50。
Tags String 否 {"k1":"v1","k2":"v2"}

标签键和标签值，键值对取值范围：1~10。

如果指定多个标签，则会查询同时绑定了该多个标签的资源。

约束如下：

  • 标签键取值范围：1~128个字符。
  • 标签值取值范围：1~128个字符。
  • 区分大小写。
  • 同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。
Category String 否 Custom

标签类型。取值：

  • Custom：自定义标签。
  • System：系统标签。
  • All：全部标签。

默认值：All。
ResourceARN.N String 否 arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****

资源ARN（Aliyun Resource Name）。支持的资源类型和ARN示例，请参见支持标签API的资源类型。

N的取值范围：1~50。

格式：

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

说明：

  • ResourceARN支持传递资源组、操作审计和资源管理的Service和ResourceType。
  • ResourceARN支持使用*表示当前地域${Region}，用*表示当前账号${Account}，也就是用arn:acs:${Service}:*:*:${ResourceType}/${ResourceId}表示当前地域当前账号的指定资源。
  • ResourceARN可以不带arn:前缀，即acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}。
  • ResourceARN支持资源类型过滤，即acs:${Service}:${Region}:${Account}:${ResourceType}/*。例如：acs:ecs:*:*:instance/*表示基于ECS实例的过滤。

关于公共请求参数的详情，请参见公共参数。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a****

根据NextToken判断是否具备下一个查询开始的Token。取值：

  • 如果NextToken为空，即"NextToken": ""，表示没有下一个。
  • 如果NextToken有值，则该值就是下一个查询开始的Token。
RequestId String 014738E0-3C7F-47D8-8FB9-469500C6F387

请求ID。
TagResources Array of TagResource

资源绑定的标签信息。
ResourceARN String arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****

资源ARN。
Tags Array of Tag

标签信息。
Key String k1

标签键。
Value String v1

标签值。
Category String Custom

标签类型。取值：

  • Custom：自定义标签。
  • System：系统标签。

示例

请求示例

https://tag.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<ListTagResourcesResponse>
	<RequestId>014738E0-3C7F-47D8-8FB9-469500C6F387</RequestId>
	<NextToken></NextToken>
	<TagResources>
		<ResourceARN>arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****</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-bp16cat8zekjocv4z2fm</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:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****</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格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter.Tags The specified value of parameter Tags is not valid. Tags参数非法。
403 Duplicate.TagKey The Tag.N.Key contains duplicate keys. 参数包含重复标签键。
403 Invalid.ResourceIdARN The parameter ResourceIdARN is invalid. ResourceIdARN参数非法。
403 InvalidParameter.Category The specified Category is invalid. Valid values are Custom and System. 标签类型非法，合法值为Custom，System。
403 MissingParameter.ResourceIds You must specify ResourceIds. 资源列表参数不可为空。
403 NoPermission.Operator The user is not authorized to operate on the specified resource. 该用户没有权限操作。
403 NoPermission.SystemTag The user does not have permission to operate the system tag. 该用户没有权限操作此系统标签。
403 NoPermissionKey.Category Some keys cannot be modified because the user does not have permission. 某些key的标签类型没有操作权限。
403 NoPermissionKey.Operator You are not authorized to operate the tag key. 该用户没有操作此标签键权限。
403 NumberExceed.ResourceIds The maximum number of ResourceIds is exceeded. 资源列表参数数量超限。
403 NumberExceed.Tags The maximum number of Tags is exceeded. 标签参数数量超限。
403 QuotaExceed.TagsPerResource The maximum number of tags for each resource is exceeded. 每个资源上的标签数量有限制，目前有资源已经超限。
403 Invalid.NextToken The parameter NextToken is invalid. NextToken参数非法。
403 InvalidParameter.TagKey The Tag.N.Key parameter is invalid. 标签键参数非法。
403 InvalidParameter.TagValue The Tag.N.Value parameter is invalid. 标签值参数非法。
403 InvalidParameter.ResourceType The ResourceType parameter is invalid. 资源类型参数非法。
404 Missing.TagKey Tag.N.Value has been specified and you must specify Tag.N.Key. 一对键值对，对应的TagValue缺失相同N的TagKey。
404 MissingParameter.AliUid You must specify AliUid. 缺失用户UID参数。
404 MissingParameter.Bid You must specify Bid. bid参数不可为空。
404 MissingParameter.RegionId You must specify RegionId. 缺少RegionId参数。
404 MissingParameter.RemoveNum You must specify RemoveNum. 删除数量参数缺失。
404 MissingParameter.ResourceIdARN You must specify ResourceIdARN. 缺少ResourceIdARN参数。
404 MissingParameter.TagKey You must specify TagKey. 标签键参数不可为空。
404 MissingParameter.Tags You must specify Tags. 缺少参数Tags。
404 NoMatch.RemoveNum The specified DataNum does not match the deleted number. 删除数量参数不匹配。

访问错误中心查看更多错误码。