文档首页/ NAT网关 NAT/ API参考 (巴黎区域) / API（私网NAT网关）/ 中转IP标签管理/ 添加中转IP标签
更新时间：2024-03-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加中转IP标签

功能介绍

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

  • 此接口为幂等接口：

  • 创建时，如果创建的标签已经存在（key相同），则覆盖。

调用方法

请参见如何调用API。

URI

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

表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参数

参数

是否必选

参数类型

描述

tag

是

Tag object

标签。
表4 Tag

参数

是否必选

参数类型

描述

key

是

String

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

最小长度：1

最大长度：128

value

是

String

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

最小长度：0

最大长度：255

响应参数

无

请求示例

添加中转IP标签，其中，标签键为“key1”，对应的值为“value1”。

POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags

{
  "tag" : {
    "key" : "key1",
    "value" : "value1"
  }
}

响应示例

无

状态码

状态码

描述

204

添加操作成功。

错误码

请参见错误码。

父主题： 中转IP标签管理