文档

ListTagResources - 查询弹性伸缩资源已经绑定的标签列表

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
ResourceTypestring

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

scalinggroup
NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
ResourceIdsarray

资源 ID。

string

资源 ID。

asg-bp17xb4x1vr29lgt****
Tagsobject []

标签信息的集合。

Keystring

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

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

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

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

TestValue

返回参数

名称类型描述示例值
object

查询资源已绑定标签的返回信息集合。

NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

DE65F6B7-7566-4802-9007-96F2494A****
TagResourcesobject []

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

TagValuestring

资源的标签值。

TestValue
ResourceTypestring

资源类型。

ALIYUN::ESS::SCALINGGROUP
ResourceIdstring

资源 ID。

asg-bp17xb4x1vr29lgt****
TagKeystring

资源的标签键。

TestKey
Propagateboolean

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

  • true:伸缩组上的标签只会传播到新创建的实例上,而不会传播到已经在伸缩组中运行的实例上。
  • false:伸缩组上的标签不会传播到实例上。
false

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史