批量添加/删除公网NAT网关资源标签
功能介绍
-
为指定公网NAT网关实例批量添加或删除标签。
-
标签管理服务需要使用该接口批量管理实例的标签。
-
一个资源上最多有10个标签。
接口约束
-
需使用VPC域名调用公网NAT标签API。
-
此接口为幂等接口:
-
创建时如果请求体中存在重复key则报错。
-
创建时,不允许重复key,如果数据库存在就覆盖。
-
删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。key最大长度为128个unicode字符,value最大长度为255个unicode字符。删除时tags结构体不能缺失,key不能为空,或者空字符串。
-
调用方法
请参见如何调用API。
URI
POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
nat_gateway_id |
是 |
String |
公网NAT网关ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tags |
是 |
Array of Tags objects |
标签列表。请参考表Tags字段数据结构说明 |
action |
是 |
String |
操作标识:仅限于create(创建)、delete(删除) |
响应参数
无
请求示例
-
批量添加公网NAT网关资源标签,其中,操作标识为create,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。
POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
-
批量删除公网NAT网关资源标签,其中,操作标识为delete,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。
{ "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
响应示例
无
状态码
状态码 |
描述 |
---|---|
204 |
批量添加或删除操作成功。 |
错误码
请参见错误码。