更新时间:2023-12-18 GMT+08:00

批量添加监听器标签

功能介绍

批量添加监听器的标签。

接口约束

  • 最多支持添加10个标签。
  • 此接口为幂等接口。
  • 添加时注意以下两点:
    • 如果请求体中存在重复key,则报错。
    • 如果请求体中无重复key,但是数据库中存在请求体中的key,则将数据库中的key值覆盖。
    • action固定为create。

URI

POST /v2.0/{project_id}/listeners/{listener_id}/tags/action

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

标签所在的项目ID。

listener_id

String

要添加标签的监听器的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token

表3 请求参数

参数

是否必选

参数类型

描述

tags

Array

标签列表。详见表4

action

String

操作标识;

取值范围:

  • create:创建标签。
表4 resource_tag 字段数据结构说明

参数

是否必选

参数类型

描述

key

String

标签名称。

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

value

String

标签值。

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

响应参数

请求示例

  • 请求样例
    POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags/action
    
    {
        "action": "create", 
        "tags": [
            {
                "key": "key1", 
                "value": "value1"
            }, 
            {
                "key": "key2", 
                "value": "value2"
            }
        ]
    }

响应示例

  • 响应样例

返回码

请参见返回码