更新时间:2024-03-28 GMT+08:00
分享

创建私网NAT网关

功能介绍

创建私网NAT网关实例。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/private-nat/gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

gateway

CreatePrivateNatOption object

创建私网NAT网关实例的请求体。

表4 CreatePrivateNatOption

参数

是否必选

参数类型

描述

name

String

私网NAT网关实例的名字。 私网NAT网关实例的名字仅支持数字、字母、_(下划线)、-(中划线)、中文。

最小长度:1

最大长度:64

description

String

私网NAT网关实例的描述。长度范围小于等于255个字符,不能包含“<”和“>”。

最小长度:0

最大长度:255

spec

String

私网NAT网关实例的规格。 取值为: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型

缺省值:Small

枚举值:

  • Small

  • Medium

  • Large

  • Extra-large

downlink_vpcs

Array of DownlinkVpcOption objects

私网NAT网关实例所属的VPC实例。

数组长度:1 - 1

tags

Array of Tag objects

标签列表

数组长度:0 - 10

enterprise_project_id

String

企业项目ID 创建私网NAT网关实例时,关联的企业项目ID。 关于企业项目ID的获取及企业项目特性的详细信息,请参考《企业管理用户指南》。

缺省值:0

最小长度:1

最大长度:36

表5 DownlinkVpcOption

参数

是否必选

参数类型

描述

virsubnet_id

String

私网NAT网关实例所属的子网的ID。

最小长度:36

最大长度:36

表6 Tag

参数

是否必选

参数类型

描述

key

String

标签key值。

最小长度:1

最大长度:128

value

String

标签value。

最小长度:0

最大长度:255

响应参数

状态码: 201

表7 响应Body参数

参数

参数类型

描述

gateway

PrivateNat object

私网NAT网关实例的响应体。

request_id

String

请求ID。

最小长度:1

最大长度:36

表8 PrivateNat

参数

参数类型

描述

id

String

私网NAT网关实例的ID。

最小长度:36

最大长度:36

project_id

String

项目的ID。

最小长度:32

最大长度:32

name

String

私网NAT网关实例的名字。

最小长度:1

最大长度:64

description

String

私网NAT网关实例的描述。长度范围小于等于255个字符,不能包含“<”和“>”。

最小长度:0

最大长度:255

spec

String

私网NAT网关实例的规格。 取值为: "Small":小型 "Medium":中型 "Large":大型 "Extra-large":超大型

缺省值:Small

枚举值:

  • Small

  • Medium

  • Large

  • Extra-large

status

String

私网NAT网关实例的状态。 取值为: "ACTIVE":正常运行 "FROZEN":冻结

枚举值:

  • ACTIVE

  • FROZEN

created_at

String

私网NAT网关实例的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at

String

私网NAT网关实例的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

downlink_vpcs

Array of DownlinkVpc objects

私网NAT网关实例所属的VPC实例。

数组长度:1 - 10

tags

Array of Tag objects

标签列表。

数组长度:1 - 10

enterprise_project_id

String

企业项目ID。 创建私网NAT网关实例时,关联的企业项目ID。

最小长度:1

最大长度:36

表9 DownlinkVpc

参数

参数类型

描述

vpc_id

String

私网NAT网关实例所属VPC的ID。

最小长度:36

最大长度:36

virsubnet_id

String

私网NAT网关实例所属子网的ID。

最小长度:36

最大长度:36

表10 Tag

参数

参数类型

描述

key

String

标签key值。

最小长度:1

最大长度:128

value

String

标签value。

最小长度:0

最大长度:255

请求示例

创建私网NAT网关实例,其中,私网NAT网关实例的名称为private-nat-gateway-name,实例的规格为Small,所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。

POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways

{
  "gateway" : {
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "downlink_vpcs" : [ {
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ],
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

响应示例

状态码: 201

创建私网NAT网关实例成功。

{
  "request_id" : "9882046a9b96f1405472e36d797e33dc",
  "gateway" : {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "updated_at" : "2019-04-22T08:47:13",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  }
}

SDK代码示例

SDK代码示例如下。

创建私网NAT网关实例,其中,私网NAT网关实例的名称为private-nat-gateway-name,实例的规格为Small,所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。

 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
63
64
65
66
67
68
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 CreatePrivateNatSolution {

    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();
        CreatePrivateNatRequest request = new CreatePrivateNatRequest();
        CreatePrivateNatRequestBody body = new CreatePrivateNatRequestBody();
        List<PrivateTag> listGatewayTags = new ArrayList<>();
        listGatewayTags.add(
            new PrivateTag()
                .withKey("key1")
                .withValue("value1")
        );
        List<DownlinkVpcOption> listGatewayDownlinkVpcs = new ArrayList<>();
        listGatewayDownlinkVpcs.add(
            new DownlinkVpcOption()
                .withVirsubnetId("373979ee-f4f0-46c5-80e3-0fbf72646b70")
        );
        CreatePrivateNatOption gatewaybody = new CreatePrivateNatOption();
        gatewaybody.withName("private-nat-gateway-name")
            .withDescription("private-nat-gateway-description")
            .withSpec(CreatePrivateNatOption.SpecEnum.fromValue("Small"))
            .withDownlinkVpcs(listGatewayDownlinkVpcs)
            .withTags(listGatewayTags)
            .withEnterpriseProjectId("2759da7b-8015-404c-ae0a-a389007b0e2a");
        body.withGateway(gatewaybody);
        request.withBody(body);
        try {
            CreatePrivateNatResponse response = client.createPrivateNat(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网关实例,其中,私网NAT网关实例的名称为private-nat-gateway-name,实例的规格为Small,所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。

 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
# 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 = CreatePrivateNatRequest()
        listTagsGateway = [
            PrivateTag(
                key="key1",
                value="value1"
            )
        ]
        listDownlinkVpcsGateway = [
            DownlinkVpcOption(
                virsubnet_id="373979ee-f4f0-46c5-80e3-0fbf72646b70"
            )
        ]
        gatewaybody = CreatePrivateNatOption(
            name="private-nat-gateway-name",
            description="private-nat-gateway-description",
            spec="Small",
            downlink_vpcs=listDownlinkVpcsGateway,
            tags=listTagsGateway,
            enterprise_project_id="2759da7b-8015-404c-ae0a-a389007b0e2a"
        )
        request.body = CreatePrivateNatRequestBody(
            gateway=gatewaybody
        )
        response = client.create_private_nat(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网关实例,其中,私网NAT网关实例的名称为private-nat-gateway-name,实例的规格为Small,所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。

 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
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.CreatePrivateNatRequest{}
	var listTagsGateway = []model.PrivateTag{
        {
            Key: "key1",
            Value: "value1",
        },
    }
	var listDownlinkVpcsGateway = []model.DownlinkVpcOption{
        {
            VirsubnetId: "373979ee-f4f0-46c5-80e3-0fbf72646b70",
        },
    }
	descriptionGateway:= "private-nat-gateway-description"
	specGateway:= model.GetCreatePrivateNatOptionSpecEnum().SMALL
	enterpriseProjectIdGateway:= "2759da7b-8015-404c-ae0a-a389007b0e2a"
	gatewaybody := &model.CreatePrivateNatOption{
		Name: "private-nat-gateway-name",
		Description: &descriptionGateway,
		Spec: &specGateway,
		DownlinkVpcs: listDownlinkVpcsGateway,
		Tags: &listTagsGateway,
		EnterpriseProjectId: &enterpriseProjectIdGateway,
	}
	request.Body = &model.CreatePrivateNatRequestBody{
		Gateway: gatewaybody,
	}
	response, err := client.CreatePrivateNat(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

创建私网NAT网关实例成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品