• Direct Connect

dc
  1. Help Center
  2. Direct Connect
  3. API Reference
  4. API
  5. Virtual Gateway
  6. Description

Description

Object

Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list.

Object Models

Table 1 Virtual gateway objects

Parameter

Type

CRUD

Default Value

Constraints

Description

id

String

R

Automatically generated

uuid

Specifies the virtual gateway ID.

tenant_id

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the tenant ID.

name

String

CRU

Left blank

The value can contain 0 to 64 characters.

Only digits, letters, underscores (_), and hyphens (-) are supported.

Specifies the virtual gateway name.

description

String

CRU

Left blank

The value can contain 0 to 128 characters.

Provides supplementary information about the virtual gateway.

vpc_id

String

CR

N/A

uuid

Specifies the ID of the VPC to be accessed.

local_ep_group_id

String

CRU

N/A

uuid

Specifies the ID of the local endpoint group that records CIDRs of the VPC.

device_id

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the ID of the physical device used by the virtual gateway.

redundant_device_id

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the ID of the redundant physical device used by the virtual gateway.

type

String

CR

default

The value can contain 0 to 255 characters.

Specifies the virtual gateway type. The value can be default or double ipsec.

ipsec_bandwidth

Integer

CR

N/A

<1,300>

Specifies the IPsec VPN access bandwidth in Mbit/s.

status

String

R

NA

N/A

Specifies the operating status. Possible values are: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, and PENDING_DELETE.

admin_state_up

Boolean

CR

true

Only true is supported.

Specifies the administrative status. The value can be true or false.