文档首页/ NAT网关 NAT/ API参考（安卡拉区域）/ API（公网NAT网关）/ 公网NAT网关标签v2.0/ 添加公网NAT网关资源标签
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加公网NAT网关资源标签

功能介绍

  • 添加公网NAT网关资源标签。一个资源上最多有10个标签。

接口约束

  • 需使用VPC域名调用公网NAT标签API。

  • 此接口为幂等接口：

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

  • 创建tag时，要求网关存在。

调用方法

请参见如何调用API。

URI

POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

nat_gateway_id

是

String

所属公网NAT网关的id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

tag

是

TagBody object

标签列表。请参考表TagBody字段数据结构说明。
表4 TagBody

参数

是否必选

参数类型

描述

key

是

String

键。最大长度128个unicode字符。key不能为空。不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”

value

是

String

值。每个值最大长度255个unicode字符，可以为空字符串。不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”

响应参数

无

请求示例

添加公网NAT网关资源标签，其中，标签键为“key1”，对应的值为“value1”。

POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags

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

响应示例

无

状态码

状态码

描述

204

添加操作成功。

错误码

请参见错误码。