更新时间:2024-04-18 GMT+08:00

批量添加删除中转IP标签

功能介绍

  • 为指定中转IP实例批量添加或删除标签

  • 标签管理服务需要使用该接口批量管理中转IP实例的标签。

  • 一个中转IP上最多有10个标签。

接口约束

此接口为幂等接口:

  • 创建时如果请求体中存在重复key则报错。

  • 创建时,不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。

  • 删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。

  • 删除时tags结构体不能缺失,key不能为空,或者空字符串。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/transit-ips/{resource_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:32

resource_id

String

中转IP的ID。

最小长度:36

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

功能说明:操作标识。 取值范围: create(创建) delete(删除)

枚举值:

  • create

  • delete

tags

Array of Tag objects

标签列表。

数组长度:1 - 10

表4 Tag

参数

是否必选

参数类型

描述

key

String

键。最大长度128个unicode字符。key不能为空。

最小长度:1

最大长度:128

value

String

值。每个值最大长度255个unicode字符。

最小长度:0

最大长度:255

响应参数

请求示例

  • 批量添加中转IP标签,其中,操作标识为create,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。

    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action
    
    {
      "action" : "create",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value2"
      } ]
    }
  • 批量删除中转IP标签,其中,操作标识为delete,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。

    POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action
    
    {
      "action" : "delete",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value2"
      } ]
    }

响应示例

状态码

状态码

描述

204

批量添加或删除操作成功。

错误码

请参见错误码