文档首页> 云专线 DC> API参考> API> 虚拟网关> 创建虚拟网关

更新时间：2023-12-07 GMT+08:00

在线调试

CLI示例

查看PDF

创建虚拟网关

功能介绍

创建虚拟网关

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/dcaas/virtual-gateways

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户项目ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。最小长度：0 最大长度：10240

表3 请求Body参数
参数	是否必选	参数类型	描述
virtual_gateway	否	CreateVirtualGateway object	创建虚拟网关对象参数

表4 CreateVirtualGateway
参数	是否必选	参数类型	描述
vpc_id	是	String	虚拟网关接入的VPC的ID
name	否	String	虚拟网关名字最小长度：0 最大长度：64
description	否	String	虚拟网关的描述信息最小长度：0 最大长度：128
local_ep_group	是	Array of strings	虚拟网关到访问云上服务IPv4子网列表，通常是vpc的cidrs
local_ep_group_ipv6	否	Array of strings	预留字段用于虚拟网关到访问云上服务IPv6子网列表，通常是vpc的cidrs
bgp_asn	否	Integer	虚拟网关本地的BGP自冶域号(asn) 最小值：1 最大值：4294967295
enterprise_project_id	否	String	实例所属企业项目ID 最小长度：36 最大长度：36
tags	否	Array of Tag objects	标签信息数组长度：0 - 10

表5 Tag
参数	是否必选	参数类型	描述
key	是	String	标签键，最大长度36个unicode字符，格式为大小写字母，数字，中划线“-”，下划线“_”，中文。最小长度：0 最大长度：36
value	否	String	标签值，最大长度43个unicode字符，格式为大小写字母，数字，中划线“-”，下划线“_”，点“.”，中文。最小长度：0 最大长度：43

响应参数

状态码： 201

表6 响应Body参数
参数	参数类型	描述
virtual_gateway	VirtualGateway object	虚拟网关对象
request_id	String	操作请求ID

表7 VirtualGateway
参数	参数类型	描述
id	String	虚拟网关的ID
vpc_id	String	虚拟网关接入的VPC的ID
tenant_id	String	实例所属项目ID。最小长度：32 最大长度：32
name	String	虚拟网关的名字最小长度：0 最大长度：64
description	String	虚拟网关的描述最小长度：0 最大长度：128
type	String	虚拟网关类型：default 缺省值：default
local_ep_group	Array of strings	虚拟网关到访问云上服务IPv4子网列表，通常是vpc的cidrs
local_ep_group_ipv6	Array of strings	预留字段用于虚拟网关到访问云上服务IPv6子网列表，通常是vpc的cidrs
admin_state_up	Boolean	管理状态：true或false 缺省值：true
status	String	操作状态，合法值是：ACTIVE，DOWN，BUILD，ERROR，PENDING_CREATE，PENDING_UPDATE，PENDING_DELETE
bgp_asn	Integer	虚拟网关本地的BGP自冶域号(asn) 最小值：1 最大值：4294967295
enterprise_project_id	String	实例所属企业项目ID 最小长度：36 最大长度：36
device_id	String	归属的设备ID
redundant_device_id	String	归属的冗余设备ID
public_border_group	String	归属的可用区对应的边界组(public border group)，标识是否homezone局点。
tags	Array of Tag objects	标签信息数组长度：0 - 10

表8 Tag
参数	参数类型	描述
key	String	标签键，最大长度36个unicode字符，格式为大小写字母，数字，中划线“-”，下划线“_”，中文。最小长度：0 最大长度：36
value	String	标签值，最大长度43个unicode字符，格式为大小写字母，数字，中划线“-”，下划线“_”，点“.”，中文。最小长度：0 最大长度：43

请求示例

创建一个接入虚拟私有云的虚拟网关，设置本地BGP ASN为64512，虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。

POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways

{
  "virtual_gateway" : {
    "name" : "vgw-c7b22",
    "description" : "",
    "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ]
  }
}

响应示例

状态码： 201

Created

成功创建接入虚拟私有云的虚拟网关。

{
  "virtual_gateway" : {
    "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
    "name" : "vgw-c7b22",
    "description" : "",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
    "device_id" : "26.151.63.100",
    "redundant_device_id" : "26.152.128.20",
    "type" : "default",
    "status" : "ACTIVE",
    "admin_state_up" : true,
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ],
    "enterprise_project_id" : "0",
    "public_border_group" : "center"
  }
}

SDK代码示例

SDK代码示例如下。

创建一个接入虚拟私有云的虚拟网关，设置本地BGP ASN为64512，虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。

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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

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

public class CreateVirtualGatewaySolution {

    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);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("cn-north-4"))
                .build();
        CreateVirtualGatewayRequest request = new CreateVirtualGatewayRequest();
        CreateVirtualGatewayRequestBody body = new CreateVirtualGatewayRequestBody();
        List listVirtualGatewayLocalEpGroup = new ArrayList<>();
        listVirtualGatewayLocalEpGroup.add("192.168.1.0/24");
        CreateVirtualGateway virtualGatewaybody = new CreateVirtualGateway();
        virtualGatewaybody.withVpcId("6592c28e-95d7-4b0a-9f61-004fdf03420c")
            .withName("vgw-c7b22")
            .withDescription("")
            .withLocalEpGroup(listVirtualGatewayLocalEpGroup)
            .withBgpAsn(64512);
        body.withVirtualGateway(virtualGatewaybody);
        request.withBody(body);
        try {
            CreateVirtualGatewayResponse response = client.createVirtualGateway(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());
        }
    }
}

创建一个接入企业路由器的虚拟网关，设置BGP ASN为64512。

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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;


public class CreateVirtualGatewaySolution {

    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);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("cn-north-4"))
                .build();
        CreateVirtualGatewayRequest request = new CreateVirtualGatewayRequest();
        CreateVirtualGatewayRequestBody body = new CreateVirtualGatewayRequestBody();
        CreateVirtualGateway virtualGatewaybody = new CreateVirtualGateway();
        virtualGatewaybody.withName("vgw-er")
            .withDescription("")
            .withBgpAsn(64512);
        body.withVirtualGateway(virtualGatewaybody);
        request.withBody(body);
        try {
            CreateVirtualGatewayResponse response = client.createVirtualGateway(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());
        }
    }
}

创建一个接入虚拟私有云的虚拟网关，设置本地BGP ASN为64512，虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。

# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 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 = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateVirtualGatewayRequest()
        listLocalEpGroupVirtualGateway = [
            "192.168.1.0/24"
        ]
        virtualGatewaybody = CreateVirtualGateway(
            vpc_id="6592c28e-95d7-4b0a-9f61-004fdf03420c",
            name="vgw-c7b22",
            description="",
            local_ep_group=listLocalEpGroupVirtualGateway,
            bgp_asn=64512
        )
        request.body = CreateVirtualGatewayRequestBody(
            virtual_gateway=virtualGatewaybody
        )
        response = client.create_virtual_gateway(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个接入企业路由器的虚拟网关，设置BGP ASN为64512。

# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 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 = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateVirtualGatewayRequest()
        virtualGatewaybody = CreateVirtualGateway(
            name="vgw-er",
            description="",
            bgp_asn=64512
        )
        request.body = CreateVirtualGatewayRequestBody(
            virtual_gateway=virtualGatewaybody
        )
        response = client.create_virtual_gateway(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个接入虚拟私有云的虚拟网关，设置本地BGP ASN为64512，虚拟网关访问云专服务IPv4子网列表为192.168.1.0/24。

package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/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 := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateVirtualGatewayRequest{}
	var listLocalEpGroupVirtualGateway = []string{
        "192.168.1.0/24",
    }
	nameVirtualGateway:= "vgw-c7b22"
	descriptionVirtualGateway:= ""
	bgpAsnVirtualGateway:= int32(64512)
	virtualGatewaybody := &model.CreateVirtualGateway{
		VpcId: "6592c28e-95d7-4b0a-9f61-004fdf03420c",
		Name: &nameVirtualGateway,
		Description: &descriptionVirtualGateway,
		LocalEpGroup: listLocalEpGroupVirtualGateway,
		BgpAsn: &bgpAsnVirtualGateway,
	}
	request.Body = &model.CreateVirtualGatewayRequestBody{
		VirtualGateway: virtualGatewaybody,
	}
	response, err := client.CreateVirtualGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

创建一个接入企业路由器的虚拟网关，设置BGP ASN为64512。

package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/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 := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateVirtualGatewayRequest{}
	nameVirtualGateway:= "vgw-er"
	descriptionVirtualGateway:= ""
	bgpAsnVirtualGateway:= int32(64512)
	virtualGatewaybody := &model.CreateVirtualGateway{
		Name: &nameVirtualGateway,
		Description: &descriptionVirtualGateway,
		BgpAsn: &bgpAsnVirtualGateway,
	}
	request.Body = &model.CreateVirtualGatewayRequestBody{
		VirtualGateway: virtualGatewaybody,
	}
	response, err := client.CreateVirtualGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码	描述
201	Created

错误码

请参见错误码。

父主题：虚拟网关

上一篇：查询虚拟网关列表

下一篇：虚拟接口

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建虚拟网关

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线