doc-exports/docs/dc/api-ref/CreateVirtualGateway.html

Creating a Virtual Gateway

Function

This API is used to create a virtual gateway.

URI

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

Table 1 URI 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 the virtual gateway to be created.

Table 4 CreateVirtualGateway

Parameter	Mandatory	Type	Description
vpc_id	Yes	String	Specifies the ID of the VPC that the virtual gateway is associated with. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.
enterprise_router_id	No	String	Specifies the ID of the enterprise router that the virtual gateway is attached to. This parameter is mandatory when a virtual gateway is attached to an enterprise router.
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	Specifies the IPv4 subnets of the associated VPC that can be accessed over the virtual gateway. This parameter is mandatory when a virtual gateway is used by a connection for accessing a VPC.
local_ep_group_ipv6	No	Array of strings	Specifies the IPv6 subnets of the associated VPC that can be accessed over the virtual gateway. 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
tags	No	Array of Tag objects	Specifies the tags. Array length: 0–10

Table 5 Tag

Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The key: Cannot be left blank. Must be unique for each resource. Can contain a maximum of 36 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
value	No	String	Specifies the tag value. The value: Can be left blank. Can contain a maximum of 43 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter	Type	Description
virtual_gateway	VirtualGateway object	Specifies the virtual gateway.
request_id	String	Specifies the request ID.

Table 7 VirtualGateway

Parameter	Type	Description
id	String	Specifies the virtual gateway ID.
vpc_id	String	Specifies the ID of the VPC connected using the virtual gateway.
enterprise_router_id	String	Specifies the ID of the enterprise router that the virtual gateway is attached to.
tenant_id	String	Specifies the project ID. 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 of the associated VPC that can be accessed over the virtual gateway.
local_ep_group_ipv6	Array of strings	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	Specifies the administrative status. The value can be true or false. Default: true
status	String	Specifies the operating status. The value 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. (This parameter is not supported currently.)
tags	Array of Tag objects	Specifies the tags. Array length: 0–10

Table 8 Tag

Parameter	Type	Description
key	String	Specifies the tag key. The key: Cannot be left blank. Must be unique for each resource. Can contain a maximum of 36 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).
value	String	Specifies the tag value. The value: Can be left blank. Can contain a maximum of 43 Unicode characters. Can contain only digits, letters, hyphens (-), underscores (_), at signs (@), and periods (.).

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

• Creating a virtual gateway that will be attached to an enterprise router and set the BGP ASN to 64512

  POST https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/virtual-gateways
  
  {
    "virtual_gateway" : {
      "name" : "vgw-er",
      "description" : "",
      "type" : "default",
      "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
      "bgp_asn" : 64512
    }
  }
  

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",
      "tags": [],
      "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"
    }
  }

• The virtual gateway that will be attached to an enterprise router is created

  {
    "virtual_gateway" : {
      "name" : "vgw-er",
      "id" : "7a91797a-cbda-42ff-9f42-73f26c993dd9",
      "description" : "",
      "tenant_id" : "92ea72fe26294aa180a2712c28e43c21",
      "vpc_id" : null,
      "enterprise_router_id" : "61fa53c9-4446-4ebd-89b9-11a52b653a9c",
      "tags": [],
      "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" : null,
      "local_ep_group_ipv6" : null,
      "public_border_group" : null
    }
  }

Status Codes

Status Code	Description
201	Created

Error Codes

See Error Codes.

Parent topic: Virtual Gateways