ListTagResources - 查询资源绑定的标签

更新时间:
复制 MD 格式

查询一个或多个交付组已绑定的标签,或按标签键值筛选出绑定了指定标签的交付组。

接口说明

本接口遵循阿里云标签规范,用于查询无影云应用交付组上绑定的标签。您可以按资源 ID 查看资源已绑定的标签,也可以按标签键值筛选出绑定了指定标签的资源。

前置条件

  • 已创建交付组,交付组 ID 可通过 ListAppInstanceGroup 接口获取。

  • 交付组已绑定标签。标签可通过 TagResources 接口绑定,也可以在控制台或标签服务中绑定。

参数说明

  • ResourceType 为必填参数,当前仅支持 APPINSTANCEGROUP(交付组),传入其他值会返回错误码 InvalidResourceType.Invalid。

  • ResourceId.N 与 Tag.N 至少指定一个,两者都不传时返回错误码 MissingParameter.ResourceIdsOrTags。
    • 仅传 ResourceId.N:返回这些资源上已绑定的全部标签。

    • 仅传 Tag.N:返回绑定了指定标签的全部资源及其匹配的标签。

    • 同时传入:仅返回指定资源中绑定了指定标签的记录。

  • Tag.N.Key 为必填项,为空时返回错误码 InvalidTagPolicy.KeyInvalid;Tag.N.Value 可不传,表示不限制该标签键对应的值。

  • 多个 Tag.N 之间为“且”关系,资源需同时绑定全部指定标签才会被返回。

返回结果说明

  • 返回结果以“资源 + 标签键值”为一条记录,一个资源绑定了多个标签时会返回多条记录。

  • TotalCount 为本次返回的记录条数。

  • 本接口会一次性返回全部匹配结果,返回的 NextToken 为空即表示没有更多数据。

调用顺序

  1. 调用 ListAppInstanceGroup 获取交付组 ID。

  2. 调用 TagResources 为交付组绑定标签。

  3. 调用本接口按资源 ID 或标签条件查询绑定关系。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

ResourceType

string

是

资源类型。取值:

  • APPINSTANCEGROUP:交付组。

不区分大小写。当前仅支持该取值,传入其他值会返回错误码 InvalidResourceType.Invalid。

APPINSTANCEGROUP

ResourceId

array

否

资源 ID 列表,最多支持 50 个。

资源类型为交付组时,传入交付组 ID(以 aig- 开头),可通过 ListAppInstanceGroup 接口获取。

说明

ResourceId.N 与 Tag.N 至少指定一个。仅传 ResourceId.N 时,返回这些资源上已绑定的全部标签。

string

是

资源 ID。资源类型为交付组时为交付组 ID。

aig-9ciijz60n4xsv****

Tag

array<object>

否

标签条件列表,最多支持 20 个。

说明

ResourceId.N 与 Tag.N 至少指定一个。多个标签之间为“且”关系,仅返回同时绑定了全部指定标签的资源。

object

否

标签条件。

Key

string

是

标签键。必填,区分大小写,长度为 1~128 个字符。

Resolution

Value

string

否

标签值。区分大小写,长度不超过 256 个字符。不传时表示不限制该标签键对应的值,即匹配该键下的任意标签值。

720p

NextToken

string

否

分页查询凭证。首次查询无需传入;如果上一次调用返回了非空的 NextToken,请将其原样传入以获取后续结果。

AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==

返回参数

名称

类型

描述

示例值

object

Schema of Response

NextToken

string

下一次查询的起始凭证。为空表示没有更多数据。本接口会一次性返回全部匹配结果,该字段通常为空。

AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==

RequestId

string

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

TagResources

array<object>

资源与标签的绑定记录列表。每条记录对应一个资源上的一个标签键值。

object

资源与标签的绑定记录。

ResourceId

string

资源 ID。资源类型为交付组时为交付组 ID。

aig-9ciijz60n4xsv****

ResourceType

string

资源类型。取值:

  • APPINSTANCEGROUP:交付组。

APPINSTANCEGROUP

TagKey

string

标签键。

Resolution

TagValue

string

标签值。

720p

TotalCount

integer

本次返回的标签记录条数。一个资源绑定了多个标签时,每个标签键值计为一条记录。

2

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAYRHtOLVQzCYj17y+OP7LZRrUJaF4rnBGQkWwMiVHlLZBB1w3Us37CVvhvyM0TXavA==",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TagResources": [
    {
      "ResourceId": "aig-9ciijz60n4xsv****",
      "ResourceType": "APPINSTANCEGROUP",
      "TagKey": "Resolution",
      "TagValue": "720p"
    }
  ],
  "TotalCount": 2
}

错误码

HTTP status code

错误码

错误信息

描述

500 ServiceUnavailable Service unavailable. Please try again later. 服务不可用,请稍后再试。

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

变更历史

更多信息,参考变更详情。