Help Center/ Direct Connect/ API Reference/ API/ Virtual Gateways/ Creating a Virtual Gateway
Updated on 2026-11-11 GMT+08:00

Creating a Virtual Gateway

Function

This API is used to create a virtual gateway.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcaas:vgw:create

    Write

    vgw *

    -

    -

    • er:instances:get
    • vpc:vpcs:get

    vpc

    -

    instances

    -

    -

    • g:EnterpriseProjectId

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

virtual_gateway

No

CreateVirtualGateway object

Definition

Specifies the parameters for creating a virtual gateway.

Constraints

N/A

Table 4 CreateVirtualGateway

Parameter

Mandatory

Type

Description

vpc_id

Yes

String

Definition

Specifies the ID of the VPC that the virtual gateway is associated with.

Constraints

N/A

Range

The value is in UUID format and is connected by hyphens (-).

Default Value

N/A

name

No

String

Definition

Specifies the virtual gateway name.

Constraints

N/A

Range

The value can contain a maximum of 64 characters.

Default Value

N/A

description

No

String

Definition

Provides supplementary information about the virtual gateway.

Constraints

N/A

Range

The value can contain a maximum of 128 characters.

Default Value

N/A

local_ep_group

Yes

Array of strings

Definition

Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC.

Constraints

N/A

local_ep_group_ipv6

No

Array of strings

Definition

Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

Constraints

N/A

bgp_asn

No

Integer

Definition

Specifies the local BGP ASN of the virtual gateway.

Constraints

N/A

Range

1 to 4294967295

Default Value

N/A

enterprise_project_id

No

String

Definition

Specifies the ID of the enterprise project that the instance belongs to.

Range

The value is 0 or a string that contains a maximum of 36 bytes in UUID format with hyphens (-). 0 indicates the default enterprise project.

tags

No

Array of Tag objects

Definition

Specifies the tag information.

Constraints

The array length ranges from 0 to 10.

Table 5 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Specifies the tag key. Each key cannot start or end with a space, or start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

Constraints

N/A

Range

1 to 128 characters

Default Value

N/A

value

No

String

Definition

Specifies the tag value. The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

N/A

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

virtual_gateway

VirtualGateway object

Definition

Specifies the virtual gateway object.

request_id

String

Definition

Specifies the request ID.

Range

N/A

Table 7 VirtualGateway

Parameter

Type

Description

id

String

Definition

Specifies the virtual gateway ID.

Range

N/A

vpc_id

String

Definition

Specifies the ID of the VPC connected by the virtual gateway.

Range

The value is in UUID format and is connected by hyphens (-).

tenant_id

String

Definition

Specifies the project ID.

Range

N/A

name

String

Definition

Specifies the name of the virtual gateway.

Range

The value can contain a maximum of 64 characters.

description

String

Definition

Provides supplementary information about the virtual gateway.

Range

The value can contain a maximum of 128 characters.

type

String

Definition

Specifies the virtual gateway type. The value can only be default.

Range

N/A

local_ep_group

Array of strings

Definition

Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway.

local_ep_group_ipv6

Array of strings

Definition

Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. This is a reserved field.

admin_state_up

Boolean

Definition

Specifies the administrative status.

Range

true or false

status

String

Definition

Specifies the operation status.

Range

  • ACTIVE: normal

  • DOWN: unavailable

  • BUILD: provisioning

  • ERROR: abnormal

  • PENDING_CREATE: creating

  • PENDING_UPDATE: updating

  • PENDING_DELETE: deleting

bgp_asn

Integer

Definition

Specifies the local BGP ASN of the virtual gateway.

Range

1 to 4294967295

enterprise_project_id

String

Definition

Specifies the ID of the enterprise project that the instance belongs to.

Range

The value is 0 or a string that contains a maximum of 36 bytes in UUID format with hyphens (-). 0 indicates the default enterprise project.

device_id

String

Definition

Specifies the ID of the device to which the virtual interface belongs.

Range

N/A

redundant_device_id

String

Definition

Specifies the ID of the redundant device.

Range

N/A

public_border_group

String

Definition

Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

Range

N/A

tags

Array of Tag objects

Definition

Specifies the tag information.

Table 8 Tag

Parameter

Type

Description

key

String

Definition

Specifies the tag key. Each key cannot start or end with a space, or start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

Range

1 to 128 characters

value

String

Definition

Specifies the tag value. The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Range

The value can contain a maximum of 255 characters.

Example Requests

  • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 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" ]
      }
    }

Example Responses

Status code: 201

  • The virtual gateway for accessing the VPC is 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"
      },
      "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
    }

SDK Sample Code

The SDK sample code is as follows.

  • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24

     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 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");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            DcClient client = DcClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateVirtualGatewayRequest request = new CreateVirtualGatewayRequest();
            CreateVirtualGatewayRequestBody body = new CreateVirtualGatewayRequestBody();
            List<String> 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());
            }
        }
    }
    
  • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24

     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
    # coding: utf-8
    
    import os
    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.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = DcClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(DcRegion.value_of("<YOUR REGION>")) \
            .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)
    
  • Creating a virtual gateway that will be used to access a VPC, with the local BGP ASN set to 64512 and the IPv4 subnet to 192.168.1.0/24

     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
    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")
        projectId := "{project_id}"
    
        auth, err := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            SafeBuild()
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        hcClient, err := dc.DcClientBuilder().
             WithRegion(region.ValueOf("<YOUR REGION>")).
             WithCredential(auth).
             SafeBuild()
    
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        client := dc.NewDcClient(hcClient)
    
        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)
        }
    }
    

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Created

Error Codes

See Error Codes.