批量添加删除私网NAT网关标签
功能介绍
-
为指定私网NAT网关实例批量添加或删除标签
-
标签管理服务需要使用该接口批量管理私网NAT网关实例的标签。
-
一个私网NAT网关上最多有10个标签。
接口约束
此接口为幂等接口:
-
创建时如果请求体中存在重复key则报错。
-
创建时,不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。
-
删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。
-
删除时tags结构体不能缺失,key不能为空,或者空字符串。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/private-nat-gateways/{resource_id}/tags/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 最小长度:1 最大长度:32 |
resource_id |
是 |
String |
私网NAT网关的ID。 最小长度:36 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:1 最大长度:10240 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
功能说明:操作标识。 取值范围: create(创建) delete(删除) 枚举值:
|
tags |
是 |
Array of Tag objects |
标签列表。 数组长度:1 - 10 |
响应参数
无
请求示例
-
批量添加私网NAT网关标签,其中,操作标识为create,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
-
批量删除私网NAT网关标签,其中,操作标识为delete,标签列表中包含两个标签,其中第一个标签键为“key1”,对应的值为“value1”,第二个标签键为“key2”,对应的值为“value2”。
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
响应示例
无
状态码
状态码 |
描述 |
---|---|
204 |
批量添加或删除操作成功。 |
错误码
请参见错误码。