文档

ListTagResources - 查询资源已经绑定的标签列表

更新时间:

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

接口说明

请求中至少指定以下任一参数,以确定查询对象。

  • ResourceId.N
  • Tag.NTag.N.KeyTag.N.Value
  • TagFilter.N

同时指定下列参数时,返回结果中仅包含同时满足这两个条件的 ECS 资源。

  • Tag.NResourceId.N
  • TagFilter.NResourceId.N

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:ListTagResourcesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883
ResourceTypestring

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

  • instance:ECS 实例。
  • disk:磁盘。
  • snapshot:快照。
  • image:镜像。
  • securitygroup:安全组。
  • volume:存储卷。
  • eni:弹性网卡。
  • ddh:专有宿主机。
  • ddhcluster:专有宿主机集群。
  • keypair:SSH 密钥对。
  • launchtemplate:启动模板。
  • reservedinstance:预留实例券。
  • snapshotpolicy:自动快照策略。
  • elasticityassurance:弹性保障。
  • capacityreservation:容量预定。
  • command:云助手命令。
  • invocation:云助手命令执行结果。
instance
ResourceIdarray

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

string

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

i-bp1j6qtvdm8w0z1o****
Tagobject []

标签列表。

Keystring

精确查找 ECS 资源时使用的标签键。标签键长度的取值范围为 1~128。N 的取值范围为 1~20。

Tag.N参数使用说明:

  • 方式一:用于精确查找绑定了指定标签的 ECS 资源,由一个键值对组成。

    • 仅指定Tag.N.Key时,则返回关联该标签键的所有资源。

    • 仅指定Tag.N.Value,则报错InvalidParameter.TagValue

    • 同时指定多个标签键值对时,仅同时满足所有标签键值对的 ECS 资源会被查找到。

  • 方式二:用于查询非默认资源组内的资源信息。Key的取值固定为acs:rm:rgId,对应的Value取值为资源组 ID。

    • 如果Key取值为acs:rm:rgId,则Value的取值只能是非默认资源组 ID。如果指定的资源组 ID 为默认资源组,则会返回错误信息。

    • 如果Key取值为acs:rm:rgId,则不支持再指定其他标签键值对。如果通过多个Tag.N参数同时查询资源组和标签对应的资源,则会返回错误信息。

TestKey
Valuestring

精确查找 ECS 资源时使用的标签值。标签值长度的取值范围为 1~128。N 的取值范围为 1~20。

说明 Key=acs:rm:rgId时,该参数只能传入资源组 ID,且资源组 ID 不能为默认资源组。
TestValue
TagFilterobject []

Tag 过滤规则。

TagValuesarray

模糊查找 ECS 资源时使用的标签值。标签值长度的取值范围为 1~128。N 的取值范围为 1~5。具体的参数说明请参见TagFilter.N.TagKey参数描述。

string

模糊查找 ECS 资源时使用的标签值。标签值长度的取值范围为 1~128。N 的取值范围为 1~5。具体的参数说明请参见TagFilter.N.TagKey参数描述。

TestTagFilter
TagKeystring

模糊查找 ECS 资源时使用的标签键。标签键长度的取值范围为 1~128。N 的取值范围为 1~5。

TagFilter.N用于模糊查找绑定了指定标签的 ECS 资源,由一个键和一个或多个值组成。模糊查询可能会有 2 秒延时,仅支持模糊过滤后资源数小于等于 5000 的情况。

  • 通过标签键(TagFilter.N.TagKey)模糊查找 ECS 资源时,标签值(TagFilter.N.TagValues.N)必须为空。例如,模糊搜索标签键为environment的 ECS 资源时,TagFilter.1.TagKey可以设置为env*(前缀匹配的模糊搜索方式)、*env*(两边匹配的模糊搜索方式)或者env(精确搜索方式),而TagFilter.1.TagValues必须为空。

  • 通过标签值(TagFilter.N.TagValues.N)模糊查找 ECS 资源时,标签键(TagFilter.N.TagKey)必须设置为精确值。例如,模糊搜索标签键为env,标签值为product的 ECS 资源时,TagFilter.1.TagKey必须精确设置为envTagFilter.1.TagValues.1可以设置为proc*(前缀匹配的模糊搜索方式)、*proc*(两边匹配的模糊搜索方式)或者proc(精确搜索方式)。同一个TagKey下只能用同一种搜索方式,如果设置了多个不同的搜索方式,则以第一个方式为准。

  • 标签键之间为交集关系,即仅同时满足您指定的所有标签键的 ECS 资源才会被查找到。

  • 同一标签键下的标签值之间为并集关系,即满足您为该标签键指定的任一标签值的 ECS 资源均会被查找到。

说明 TagFilter.NTag.N参数不能同时使用,否则会返回错误信息。
env

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResourcesobject []

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

TagValuestring

标签值。

TestValue
ResourceTypestring

资源类型。可能值:

  • instance:ECS 实例。
  • disk:磁盘。
  • snapshot:快照。
  • image:镜像。
  • securitygroup:安全组。
  • volume:存储卷。
  • eni:弹性网卡。
  • ddh:专有宿主机。
  • ddhcluster:专有宿主机集群。
  • keypair:SSH 密钥对。
  • launchtemplate:启动模板。
  • reservedinstance:预留实例券。
  • snapshotpolicy:自动快照策略。
  • elasticityassurance:弹性保障。
  • capacityreservation:容量预定。
  • command:云助手命令。
  • invocation:云助手命令执行结果。
instance
ResourceIdstring

资源 ID。

i-bp1j6qtvdm8w0z1o****
TagKeystring

标签键。

TestKey

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "instance",
        "ResourceId": "i-bp1j6qtvdm8w0z1o****",
        "TagKey": "TestKey"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidDefaultResourceGroup.NotSupportedThe specified parameter Tag is not support for default resource group.不支持查询默认资源组。
400InvalidTag.NotSupportedYou can only specify Tag for either resource tag or resource group.不支持同时查询资源组和标签。
400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed , Valid : 50.-
400NumberExceed.TagsThe Tags parameter's number is exceed , Valid : 20.-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.资源标签已达上限。
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400InvalidTagCountThe specified tags are beyond the permitted range.指定的标记超出取值范围。
400Invalid.ScopeThe specified scope is invalid.可见范围参数无效。
400InvalidTags.MalFormedThe tags must be empty, when the tagFilters is not empty.-
403PermissionDenied.TagOwnerBidThe specified operator not have permission to set TagOwnerBid value.-
403PermissionDenied.TagOwnerUidThe specified operator not have permission to set TagOwnerUid value.无权设置标签归属者。
403PermissionDenied.ScopeThe specified operator not have permission to set Scope value.指定的操作员无权设置范围值。
403InvalidResourceId.NotSupportedThe specified ResourceId does not support tagging.指定的资源 ID 不支持标记。
403NoPermission.TagThe operator is not permission for the tag.您没有操作该资源标签的权限。
403BothEmpty.TagsAndResourcesThe specified Tags and ResourcesIds are not allow to both empty.-
403PermissionDenied.TagsFuzzyQueryThe specified operator has not permission to query fuzzy tags.-
403NumberExceed.TagValuesThe number of the specified TagValues is beyond permitted range, the max is 5.-
403InvalidFilter.MalformedThe specified Filter is not valid.-
403InvalidTagFilter.MalformedThe specified TagFilter is not valid.-
403Invalid.NextTokenThe specified NextToken is not valid.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.提供的RegionId不存在
404InvalidRegionId.NotFound%s提供的地域 ID 不存在。
404MissingParameter.ResourceIdsThe parameter - ResourceIds.N should not be null.-
404MissingParameter.TagOwnerUidThe parameter - TagOwnerUid should not be null.-
404MissingParameter.TagOwnerBidThe parameter - TagOwnerBid should not be null.-
404MissingParameter.ResourceTypeThe parameter - ResourceType should not be null.参数ResourceType不能为空。
404MissingParameter.TagsThe parameter - Tags should not be null.-
404MissingParameter.RegionIdThe parameter - RegionId should not be null.-
404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.指定的资源不存在,请检查参数 ResourceId 是否正确。
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.指定的资源类型不存在。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
500ServiceUnavailableThe service is unavailable, please try again later.服务暂时不可用,请稍候重试。
500InternalErrorThe process of creating snapshot has failed due to some unknown error.创建快照失败。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)