You need to enable JavaScript to run this app.
导航
容器服务
  • 文档首页
    • /
  • 容器服务

ListTagsForResources

最近更新时间：2024.02.26 20:17:38

首次发布时间：2022.12.07 17:14:42

我的收藏

查询符合条件的资源下的所有标签信息。

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 公共参数。

参数名称类型是否必选示例值描述
ActionString是ListTagsForResources公共参数，本接口值：ListTagsForResources。
VersionString是2022-05-12公共参数，本接口值：2022-05-12。

ResourceType

String

是

Cluster

标签的资源类型。容器服务当前仅支持如下两种资源标签：

  • Cluster：集群
  • NodePool：节点池

ResourceIds

Array of String

否

["cc5silumrsfeq****"]

资源 ID 列表，即集群 ID 列表或节点池 ID 列表。
可以调用 ListClusters 接口获取集群 ID，调用 ListNodePools 接口获取节点池 ID。

注意

  • 传入多个资源 ID 时，ID 不可重复。
  • 最多传入 50 个资源 ID。

TagFilters

Array of TagFilter

否

标签列表。多个 K****ey 为“与”关系，同一个 Key 下的不同 Values 为“或”关系。

注意

  • TagFilter**.Key** 不可重复。
  • 最多支持 10 个 TagFilter。

Type

String

否

System

标签类型。取值如下：

  • System：系统标签。
  • Custom：用户自定义标签。

NextToken

String

否

MTIzNDU=

分页查询凭证，用于标记分页的位置。

说明

初次调用该接口时无需设置。后续查询资源标签时，取值为上一次调用该接口后返回的 NextToken 参数值。

MaxResults

Integer

否

10

分页查询时每页显示的记录数，取值：

  • 最小值：1
  • 最大值：100
  • 默认值：10

TagFilter

参数名参数类型是否必选示例值描述
KeyString是key标签键。
ValuesArray of String否["value1","value2"]标签值列表。其中，具体标签值可以为空字符串。

请求示例

POST /?Action=ListTagsForResources&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "ResourceType": "Cluster",
    "ResourceIds": [
        "cc5silumrsfeq****"
    ],
    "TagFilters": [
        {
            "Key": "key",
            "Values": [
                "value1",
                "value2"
            ]
        }
    ],
    "Type": "Custom",
    "NextToken": "MTIzNDU=",
    "MaxResults": 10
}

返回参数

本接口返回参数如下表所示，公共返回参数请参见 返回结果。

参数名称类型示例值描述
ResourceTagsArray of ResourceTag资源绑定标签列表。

NextToken

String

MTIzNDU=

分页查询凭证，用于标记分页的位置。

注意

每次调用该接口后可保存该参数值，用于后续分页查询时，显示上次分页位置之后的资源标签信息。

ResourceTag

参数名称类型示例值描述

ResourceType

String

Cluster

资源类型。参数值说明：

  • Cluster：集群
  • NodePool：节点池
ResourceIdStringcc5silumrsfeq****资源 ID。
TagKeyStringkey标签键。
TagValueStringvalue标签值。

Type

String

System

标签类型。参数值说明：

  • System：系统标签。
  • Custom：用户自定义标签。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "021635330810134****",
        "Action": "ListTagsForResources",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "MTIzNDU=",
        "ResourceTags": [
            {
                "ResourceType": "Cluster",
                "ResourceId": "cc5silumrsfeq****",
                "TagKey": "key",
                "TagValue": "value",
                "Type": "Custom"
            }
        ]
    }
}

错误码

本接口无专有错误码，公共错误码请参见 公共错误码。