更新时间:2024-09-26 GMT+08:00

查询所有监听器的标签集合

功能介绍

查询用户下所有监听器的标签集合。

接口约束

无。

URI

GET /v2.0/{project_id}/listeners/tags

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

标签所在的项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token

响应参数

表3 响应参数

参数

参数类型

描述

tags

Array

标签列表,按key值聚合。详见表4

例如:一个用户共有2个监听器,监听器A标签的键为"test",值为“value1”;监听器B标签的键为"test",值为“value2”。则查询到的标签列表中对象的key为“test”,values为["value1","value2"]

表4 tags 字段数据结构说明

参数

参数类型

描述

key

String

键。

  • 不能为空。
  • 长度不超过128个字符。
  • 由英文字母、数字、下划线、中划线、中文字符组成。
  • 同一资源的key值不能重复。

values

Array

标签值列表。

  • 长度不超过255个字符。
  • 由英文字母、数字、下划线、点、中划线、中文字符组成。

请求示例

  • 请求样例
    GET https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/tags

响应示例

  • 响应样例
    {
        "tags": [
            {
                "key": "key1", 
                "values": [
                    "value1", 
                    "value2"
                ]
            }, 
            {
                "key": "key2", 
                "values": [
                    "value1", 
                    "value2"
                ]
            }
        ]
    }

返回码

请参见返回码