You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeTagsByResource

最近更新时间：2023.09.22 17:49:51

首次发布时间：2023.03.30 19:59:27

我的收藏

调用 DescribeTagsByResource 接口查询已绑定标签的资源。

接口说明

  • 单次调用该接口最多支持查询 10 个标签。
  • 同一标签键最多支持同时查询 3 个标签值。

请求参数

名称

类型

是否必选

示例值

描述

InstanceIds

Array of String

是

["kafka-cnng5b3sy14s****","kafka-cnng5b3sy14s***"]

已绑定标签的实例 ID。
支持一次传入多个实例 ID，最多同时传入 50 个实例 ID。

TagFilters

Array of TagFilterObject

否

[{"Key":"test-key:","Value":"test-val"}]

根据指定标签键值进行过滤，支持根据标签键筛选，或根据标签键+标签值进行筛选。
详细示例及说明请参考根据标签筛选实例。

PageSize

Integer

是

10

查询结果分页展示时，此参数用于表示每页的数据量。取值范围为 1~100。

PageNumber

Int32

是

1

查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。

响应参数

名称

类型

示例值

描述

Total

Integer

10

指定标签对应的的总实例数量。

TagResources

Array of TagResourceObject

/

实例的标签信息。详细说明请参考 TagResourceObject。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeTagsByResource&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
   "InstanceIds":["kafka-cnng5b3sy14s****"],
   "PageNumber":1,
   "PageSize":10
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230217175421E698024A11179196218F",
        "Action": "DescribeTagsByResource",
        "Version": "2022-01-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "TagResources": [
            {
                "InstanceId": "kafka-cnng5b3sy14s****",
                "Key": "module",
                "Value": "tcp"
            }
        ],
        "Total": 1
    }
}