ListTagResources

调用API ListTagResources查询一个或多个弹性伸缩资源已经绑定的标签列表,可以帮助您更好地分类和管理弹性伸缩资源,实现资源的自动化管理和权限控制等目标。

接口说明

  • 请求参数中至少指定一个参数:ResourceId.N或者Tag.N(即Tag.N.KeyTag.N.Value),用以确定查询对象。
  • 如果同时指定参数Tag.NResourceId.N时,返回结果中仅包含同时满足这两个条件的弹性伸缩资源。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListTagResources

系统规定参数。取值:ListTagResources

RegionId String cn-hangzhou

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

ResourceType String scalinggroup

资源类型,目前仅支持伸缩组。取值:scalinggroup。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

ResourceId.N String asg-bp17xb4x1vr29lgt****

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

Tag.N.Key String TestKey

精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围:1~128,N的取值范围:1~20。

Tag.N用于精确查找绑定了指定标签的弹性伸缩资源,由一个键值对组成。

  • 仅指定Tag.N.Key时,则返回关联该标签键的所有资源。
  • 仅指定Tag.N.Value时,则出现MissingParameter.TagKey的报错提示。
  • 同时指定多个标签键值对时,仅同时满足所有标签键值对的弹性伸缩资源会被查找到。
Tag.N.Value String TestValue

精确查找弹性伸缩资源时使用的标签值。可以为空字符串。最多支持128个字符,N的取值范围:1~20。

返回数据

名称

类型

示例值

描述

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

RequestId String DE65F6B7-7566-4802-9007-96F2494A****

请求ID。

TagResources Array of TagResource

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

TagResource
TagValue String TestValue

资源的标签值。

ResourceType String ALIYUN::ESS::SCALINGGROUP

资源类型。

ResourceId String asg-bp17xb4x1vr29lgt****

资源ID。

TagKey String TestKey

资源的标签键。

Propagate Boolean false

标识该标签是否为可传播标签。可能值:

  • true:伸缩组上的标签只会传播到即将扩容的实例上,不会传播到已经在伸缩组中运行的实例上。
  • false:伸缩组上的标签不会传播到实例上。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=scalinggroup
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&ResourceId=["asg-bp17xb4x1vr29lgt****"]
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&公共请求参数

正常返回示例

XML格式

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

<ListTagResourcesResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>DE65F6B7-7566-4802-9007-96F2494A****</RequestId>
    <TagResources>
        <TagValue>TestValue</TagValue>
        <ResourceType>ALIYUN::ESS::SCALINGGROUP</ResourceType>
        <ResourceId>asg-bp17xb4x1vr29lgt****</ResourceId>
        <TagKey>TestKey</TagKey>
        <Propagate>false</Propagate>
    </TagResources>
</ListTagResourcesResponse>

JSON格式

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

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "DE65F6B7-7566-4802-9007-96F2494A****",
  "TagResources" : [ {
    "TagValue" : "TestValue",
    "ResourceType" : "ALIYUN::ESS::SCALINGGROUP",
    "ResourceId" : "asg-bp17xb4x1vr29lgt****",
    "TagKey" : "TestKey",
    "Propagate" : false
  } ]
}

错误码

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