调用ListTagResources查询一个或多个ECS资源已经绑定的标签列表。

接口说明

  • 请求中至少指定参数ResourceId.NTag.NTag.N.KeyTag.N.Value)·,以确定检索对象。
  • Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value,则报错InvalidParameter.TagValue
  • 如果您同时指定Tag.NResource.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。
  • 如果您同时指定多个标签键值对,返回结果中为资源中包含被指定的多个键值对的资源。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

资源所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ResourceType String instance

资源类型定义。取值范围:

  • instance:ECS实例
  • disk:磁盘
  • snapshot:快照
  • image:镜像
  • securitygroup:安全组
  • volume:存储卷
  • eni:弹性网卡
  • ddh:专有宿主机
  • keypair:SSH密钥对
  • launchtemplate:启动模板
Action String ListTagResources

系统规定参数。取值:ListTagResources

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始Token。

ResourceId.N RepeatList i-instanceid1

资源ID,N的取值范围为1~50。

Tag.N.Key String FinanceDept

资源的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

Tag.N.Value String FinanceJoshua

资源的标签值。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始Token。

RequestId String DE65F6B7-7566-4802-9007-96F2494AC5XX

请求ID。

TagResources

由资源及其标签组成的合集,包含了资源ID、资源类型和标签键值等信息。

ResourceId String i-bp1j6qtvdm8w0z1o0***

资源ID。

ResourceType String instance

资源类型。

TagKey String FinanceDept

标签键。

TagValue String FinanceJoshua

标签值。

示例

请求示例

https://ecs.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=instance
&ResourceId.1=i-bp1j6qtvdm8w0z1o0***
&<公共请求参数>

正常返回示例

XML 格式

<ListTagResourcesResponse>
	  <TagResources>
		    <TagResource>
			      <ResourceType>instance</ResourceType>
			      <TagValue>FinanceJoshua</TagValue>
			      <ResourceId>i-bp1j6qtvdm8w0z1o0***</ResourceId>
			      <TagKey>FinanceDept</TagKey>
		    </TagResource>
	  </TagResources>
	  <RequestId>DE65F6B7-7566-4802-9007-96F2494AC5XX</RequestId>
</ListTagResourcesResponse>

JSON 格式

{
	"TagResources":{
		"TagResource":[
			{
				"ResourceType":"instance",
				"TagValue":"FinanceJoshua",
				"ResourceId":"i-bp1j6qtvdm8w0z1o0***",
				"TagKey":"FinanceDept"
			}
		]
	},
	"RequestId":"DE65F6B7-7566-4802-9007-96F2494AC512"
}

错误码

HttpCode 错误码 错误信息 描述
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 资源类型不存在。
404 MissingParameter.Tags The parameter - Tags should not be null 标签参数不存在。
404 MissingParameter.RegionId The parameter - RegionId should not be null 地域参数不存在。
403 PermissionDenied.TagOwnerUid The specified operator not have permission to set TagOwnerUid value. 无权设置标签归属者。
403 PermissionDenied.Scope The specified operator not have permission to set Scope value. 可见范围参数不可修改。
400 NumberExceed.ResourceIds The ResourceIds parameter's number is exceed , Valid : 50 资源ID参数不能超过50个。
400 NumberExceed.Tags The Tags parameter's number is exceed , Valid : 20 标签列表参数不能超过20个。
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. 标签键中存在重复的键。
404 InvalidResourceId.NotFound The specified ResourceIds are not found in our records. 资源不存在。
404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 指定的资源类型不存在。
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定的标签键不合法。
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定的标签值不合法。
400 OperationDenied.QuotaExceed The quota of tags on resource is beyond permitted range. 资源标签已达上限。
403 InvalidResourceId.NotSupported The specified ResourceId does not support tagging. 指定的资源 ID 不支持标记。
400 InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 指定的 Tag.n.Key 和 Tag.n.Value 不匹配。
400 InvalidTagCount The specified tags are beyond the permitted range. 指定的标记超出取值范围。
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。
400 Invalid.Scope The specified scope is invalid. 可见范围参数非法。
403 NoPermission.Tag The operator is not permission for the tag. 没有操作该资源标签的权限。

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