Help Center/ Direct Connect/ API Reference/ APIs/ Virtual Gateway/ Creating a Virtual Gateway

Updated on 2023-12-07 GMT+08:00

View PDF

Creating a Virtual Gateway

Function

This API is used to create a virtual gateway.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
virtual_gateway	No	CreateVirtualGateway object	Specifies parameters for creating a virtual gateway.

**Table 4** CreateVirtualGateway
Parameter	Mandatory	Type	Description
vpc_id	Yes	String	Specifies the ID of the VPC that the virtual gateway is associated with.
name	No	String	Specifies the virtual gateway name. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the virtual gateway. Minimum: 0 Maximum: 128
local_ep_group	Yes	Array of strings	Lists the IPv4 subnets that can be accessed over the virtual gateway. Generally, the list contains the subnet CIDR blocks of the associated VPC.
local_ep_group_ipv6	No	Array of strings	Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.
bgp_asn	No	Integer	Specifies the local BGP autonomous system number (ASN) of the virtual gateway. Minimum: 1 Maximum: 4294967295
enterprise_project_id	No	String	Specifies the ID of the enterprise project that the virtual gateway belongs to. Minimum: 36 Maximum: 36

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
virtual_gateway	VirtualGateway object	Specifies parameters for creating a virtual gateway.
request_id	String	Specifies the request ID.

**Table 6** VirtualGateway
Parameter	Type	Description
id	String	Specifies the virtual gateway ID.
vpc_id	String	Specifies the ID of the VPC connected by the virtual gateway.
tenant_id	String	Specifies the ID of the project that the instance belongs to. Minimum: 32 Maximum: 32
name	String	Specifies the virtual gateway name. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the virtual gateway. Minimum: 0 Maximum: 128
type	String	Specifies the virtual gateway type. The value can only be default. Default: default
local_ep_group	Array of strings	Specifies the IPv4 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC.
local_ep_group_ipv6	Array of strings	Specifies the IPv6 subnets connected by the virtual gateway, which is usually the CIDR blocks of a VPC. This is a reserved field.
admin_state_up	Boolean	Specifies the administrative status, which can be true or false. Default: true
status	String	Specifies the virtual gateway status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
bgp_asn	Integer	Specifies the local BGP ASN of the virtual gateway. Minimum: 1 Maximum: 4294967295
enterprise_project_id	String	Specifies the ID of the enterprise project that the virtual gateway belongs to. Minimum: 36 Maximum: 36
device_id	String	Specifies the ID of the device that the virtual interface belongs to.
redundant_device_id	String	Specifies the ID of the redundant device.
public_border_group	String	Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.

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

Created

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"
  }
}