文档首页/ NAT网关 NAT/ API参考/ API（公网NAT网关）/ 公网NAT网关标签v3/ 批量添加/删除公网NAT网关资源标签
更新时间：2024-03-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量添加/删除公网NAT网关资源标签

功能介绍

  • 为指定公网NAT网关实例批量添加或删除标签。

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

  • 一个资源上最多有10个标签。

接口约束

  • 此接口为幂等接口：

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

    • 创建时，不允许重复key，如果数据库存在就覆盖。

    • 删除时，如果删除的标签不存在，默认处理成功，删除时不对标签字符集范围做校验。key最大长度为128个unicode字符，value最大长度为255个unicode字符。删除时tags结构体不能缺失，key不能为空，或者空字符串。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/nat_gateways/{nat_gateway_id}/tags/action

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

参数

是否必选

参数类型

描述

tags

是

Array of PublicTags objects

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

action

是

String

操作标识：仅限于create（创建）、delete（删除）
表4 PublicTags

参数

是否必选

参数类型

描述

key

是

String

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

value

是

String

值。每个值最大长度255个unicode字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除，可以为空字符串。,不能包含非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”

响应参数

无

请求示例

  • 批量添加公网NAT网关资源标签，其中，操作标识为create，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

    POST  https://{Endpoint}/v3/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"
  } ]
}

响应示例

无

SDK代码示例

SDK代码示例如下。

  • 批量添加公网NAT网关资源标签，其中，操作标识为create，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.nat.v2.region.NatRegion;
import com.huaweicloud.sdk.nat.v2.*;
import com.huaweicloud.sdk.nat.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchCreateDeleteNatGatewayTagSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        NatClient client = NatClient.newBuilder()
                .withCredential(auth)
                .withRegion(NatRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreateDeleteNatGatewayTagRequest request = new BatchCreateDeleteNatGatewayTagRequest();
        BatchCreateDeleteNatTagsRequestBody body = new BatchCreateDeleteNatTagsRequestBody();
        List<PublicTags> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new PublicTags()
                .withKey("key1")
                .withValue("value1")
        );
        listbodyTags.add(
            new PublicTags()
                .withKey("key2")
                .withValue("value2")
        );
        body.withAction("create");
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            BatchCreateDeleteNatGatewayTagResponse response = client.batchCreateDeleteNatGatewayTag(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • 批量删除公网NAT网关资源标签，其中，操作标识为delete，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.nat.v2.region.NatRegion;
import com.huaweicloud.sdk.nat.v2.*;
import com.huaweicloud.sdk.nat.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchCreateDeleteNatGatewayTagSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        NatClient client = NatClient.newBuilder()
                .withCredential(auth)
                .withRegion(NatRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreateDeleteNatGatewayTagRequest request = new BatchCreateDeleteNatGatewayTagRequest();
        BatchCreateDeleteNatTagsRequestBody body = new BatchCreateDeleteNatTagsRequestBody();
        List<PublicTags> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new PublicTags()
                .withKey("key1")
                .withValue("value1")
        );
        listbodyTags.add(
            new PublicTags()
                .withKey("key2")
                .withValue("value2")
        );
        body.withAction("delete");
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            BatchCreateDeleteNatGatewayTagResponse response = client.batchCreateDeleteNatGatewayTag(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • 批量添加公网NAT网关资源标签，其中，操作标识为create，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    		 
    # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdknat.v2.region.nat_region import NatRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdknat.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = NatClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(NatRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchCreateDeleteNatGatewayTagRequest()
        listTagsbody = [
            PublicTags(
                key="key1",
                value="value1"
            ),
            PublicTags(
                key="key2",
                value="value2"
            )
        ]
        request.body = BatchCreateDeleteNatTagsRequestBody(
            action="create",
            tags=listTagsbody
        )
        response = client.batch_create_delete_nat_gateway_tag(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 批量删除公网NAT网关资源标签，其中，操作标识为delete，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    		 
    # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdknat.v2.region.nat_region import NatRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdknat.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = NatClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(NatRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchCreateDeleteNatGatewayTagRequest()
        listTagsbody = [
            PublicTags(
                key="key1",
                value="value1"
            ),
            PublicTags(
                key="key2",
                value="value2"
            )
        ]
        request.body = BatchCreateDeleteNatTagsRequestBody(
            action="delete",
            tags=listTagsbody
        )
        response = client.batch_create_delete_nat_gateway_tag(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 批量添加公网NAT网关资源标签，其中，操作标识为create，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := nat.NewNatClient(
        nat.NatClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreateDeleteNatGatewayTagRequest{}
	var listTagsbody = []model.PublicTags{
        {
            Key: "key1",
            Value: "value1",
        },
        {
            Key: "key2",
            Value: "value2",
        },
    }
	request.Body = &model.BatchCreateDeleteNatTagsRequestBody{
		Action: "create",
		Tags: listTagsbody,
	}
	response, err := client.BatchCreateDeleteNatGatewayTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 批量删除公网NAT网关资源标签，其中，操作标识为delete，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := nat.NewNatClient(
        nat.NatClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreateDeleteNatGatewayTagRequest{}
	var listTagsbody = []model.PublicTags{
        {
            Key: "key1",
            Value: "value1",
        },
        {
            Key: "key2",
            Value: "value2",
        },
    }
	request.Body = &model.BatchCreateDeleteNatTagsRequestBody{
		Action: "delete",
		Tags: listTagsbody,
	}
	response, err := client.BatchCreateDeleteNatGatewayTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

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

错误码

请参见错误码。

父主题： 公网NAT网关标签v3