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

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

View PDF

Creating a Virtual Interface

Function

This API is used to create a virtual interface.

Calling Method

For details, see Calling APIs.

URI

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

**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_interface	Yes	CreateVirtualInterface object	Specifies parameters for creating a virtual interface.

**Table 4** CreateVirtualInterface
Parameter	Mandatory	Type	Description
name	No	String	Specifies the virtual interface name. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the virtual interface. Minimum: 0 Maximum: 128
direct_connect_id	No	String	Specifies the ID of the connection associated with the virtual interface. When creating a virtual interface, you need to specify direct_connect_id or lag_id. This parameter is mandatory when LAG is not supported at the site.
type	Yes	String	Specifies the type of the virtual interface. The value is private. Enumeration values: private public
service_type	No	String	Specifies the gateway type, which can be VGW, GDGW, or LGW. Enumeration values: VGW GDGW LGW
vlan	Yes	Integer	Specifies the customer VLAN to be connected. If you select a hosted connection, the VLAN must be the same as that of the hosted connection. Minimum: 0 Maximum: 3999
bandwidth	Yes	Integer	Specifies the virtual interface bandwidth. Minimum: 2 Maximum: 2147483647
local_gateway_v4_ip	No	String	Specifies the IPv4 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv4 address.
remote_gateway_v4_ip	No	String	Specifies the IPv4 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv4 address.
address_family	No	String	Specifies the address family type of the virtual interface, which can be IPv4 or IPv6. Default: ipv4
local_gateway_v6_ip	No	String	Specifies the IPv6 interface address of the gateway used on the cloud. This parameter is mandatory if address_family is set to an IPv6 address.
remote_gateway_v6_ip	No	String	Specifies the IPv6 interface address of the gateway on the on-premises network. This parameter is mandatory if address_family is set to an IPv6 address.
vgw_id	Yes	String	Specifies the ID of the virtual gateway connected by the virtual interface.
route_mode	Yes	String	Specifies the routing mode, which can be static or bgp. Default: static Enumeration values: static bgp
bgp_asn	No	Integer	Specifies the ASN of the BGP peer on the customer side. Minimum: 1 Maximum: 4294967295
bgp_md5	No	String	Specifies the MD5 password of the BGP peer.
remote_ep_group	Yes	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.
service_ep_group	No	Array of strings	Specifies the subnets that access Internet services through a direct connection.
enable_bfd	No	Boolean	Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false. Default: false
enable_nqa	No	Boolean	Specifies whether to enable NQA. The value can be true or false. Default: false
lag_id	No	String	Specifies the ID of the LAG associated with the virtual interface. Minimum: 36 Maximum: 36
resource_tenant_id	No	String	Specifies the project ID of another tenant, which is used to create virtual interfaces across tenants.
enterprise_project_id	No	String	Specifies the ID of the enterprise project that the resource belongs to. Minimum: 36 Maximum: 36

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
virtual_interface	VirtualInterface object	Specifies parameters for creating a virtual interface.

**Table 6** VirtualInterface
Parameter	Type	Description
id	String	Specifies the virtual interface ID. Maximum: 36
name	String	Specifies the virtual interface name. Maximum: 64
admin_state_up	Boolean	Specifies the administrative status, which can be true or false.
bandwidth	Integer	Specifies the virtual interface bandwidth. Minimum: 2 Maximum: 2147483647
create_time	String	Specifies when the virtual interface was created. Maximum: 255
update_time	String	Specifies when the virtual interface was updated.
description	String	Provides supplementary information about the virtual interface. Maximum: 128
direct_connect_id	String	Specifies the connection ID. Maximum: 36
service_type	String	Specifies the gateway type, which can be VGW, GDGW, or LGW. Enumeration values: VGW GDGW LGW
status	String	Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.
tenant_id	String	Specifies the project ID. Minimum: 32 Maximum: 32
type	String	Specifies the type of the virtual interface. The value is private. Default: private Maximum: 255 Enumeration values: private public
vgw_id	String	Specifies the virtual gateway ID. Minimum: 36 Maximum: 36
vlan	Integer	Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999. Minimum: 0 Maximum: 3999
route_limit	Integer	Specifies the remote subnet route configurations of the virtual interface. Minimum: 1 Maximum: 200 Default: 50
enable_nqa	Boolean	Specifies whether to enable NQA. The value can be true or false.
enable_bfd	Boolean	Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.
lag_id	String	Specifies the ID of the LAG associated with the virtual interface. Minimum: 36 Maximum: 36
device_id	String	Specifies the ID of the device that the virtual interface belongs to.
enterprise_project_id	String	Specifies the ID of the enterprise project that the virtual interface belongs to. Minimum: 36 Maximum: 36
local_gateway_v4_ip	String	Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
remote_gateway_v4_ip	String	Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
ies_id	String	Specifies the ID of an IES edge site.
reason	String	Displays error information if the status of a line is Error.
rate_limit	Boolean	Specifies whether rate limiting is enabled on a virtual interface.
address_family	String	Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
local_gateway_v6_ip	String	Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
remote_gateway_v6_ip	String	Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
lgw_id	String	Specifies the ID of the local gateway, which is used in IES scenarios.
gateway_id	String	Specifies the ID of the gateway associated with the virtual interface.
remote_ep_group	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
service_ep_group	Array of strings	Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
bgp_route_limit	Integer	Specifies the BGP route configuration.
priority	String	Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing. Default: normal Enumeration values: normal low
vif_peers	Array of VifPeer objects	Specifies the peer information of the virtual interface.
extend_attribute	VifExtendAttribute object	Specifies extended attributes when BFD or NQA is used for reliability detection.

**Table 7** VifPeer
Parameter	Type	Description
id	String	Specifies the resource ID. Minimum: 36 Maximum: 36
tenant_id	String	Specifies the ID of the project that the virtual interface peer belongs to. Minimum: 36 Maximum: 36
name	String	Specifies the name of the virtual interface peer. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the virtual interface peer. Minimum: 0 Maximum: 128
address_family	String	Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.
local_gateway_ip	String	Specifies the address of the virtual interface peer used on the cloud.
remote_gateway_ip	String	Specifies the address of the virtual interface peer used in the on-premises data center.
route_mode	String	Specifies the routing mode, which can be static or bgp. Maximum: 255 Enumeration values: bgp static
bgp_asn	Integer	Specifies the ASN of the BGP peer. Minimum: 1 Maximum: 4294967295
bgp_md5	String	Specifies the MD5 password of the BGP peer.
remote_ep_group	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.
service_ep_group	Array of strings	Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.
device_id	String	Specifies the ID of the device that the virtual interface peer belongs to.
bgp_route_limit	Integer	Specifies the BGP route configuration.
bgp_status	String	Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null. Maximum: 10
status	String	Specifies the status of the virtual interface peer.
vif_id	String	Specifies the ID of the virtual interface corresponding to the virtual interface peer. Minimum: 36 Maximum: 36
receive_route_num	Integer	Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.
enable_nqa	Boolean	Specifies whether to enable NQA. The value can be true or false.
enable_bfd	Boolean	Specifies whether to enable BFD. The value can be true or false.

**Table 8** VifExtendAttribute
Parameter	Type	Description
ha_type	String	Specifies the availability detection type of the virtual interface. Enumeration values: nqa bfd
ha_mode	String	Specifies the availability detection mode. Enumeration values: auto_single auto_multi static_single static_multi enhance_nqa
detect_multiplier	Integer	Specifies the number of detection retries. Default: 5
min_rx_interval	Integer	Specifies the interval for receiving detection packets. Default: 1000
min_tx_interval	Integer	Specifies the interval for sending detection packets. Default: 1000
remote_disclaim	Integer	Specifies the remote identifier of the static BFD session.
local_disclaim	Integer	Specifies the local identifier of the static BFD session.

Example Requests

Creating a private virtual interface, with the bandwidth set to 2 Mbit/s, VLAN to 332, local gateway to 1.1.1.1/30, and remote gateway to 1.1.1.2/30, and routing mode to static routing

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

{
  "virtual_interface" : {
    "name" : "vif-0819",
    "description" : "mytest",
    "direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1",
    "vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b",
    "vlan" : 332,
    "bandwidth" : 2,
    "local_gateway_v4_ip" : "1.1.1.1/30",
    "remote_gateway_v4_ip" : "1.1.1.2/30",
    "type" : "private",
    "route_mode" : "static",
    "remote_ep_group" : [ "1.1.2.0/30" ]
  }
}

Example Responses

Status code: 201

Created

{
  "virtual_interface" : {
    "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
    "name" : "vif-0819",
    "description" : "mytest",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1",
    "vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b",
    "type" : "private",
    "service_type" : "VGW",
    "vlan" : 332,
    "bandwidth" : 2,
    "device_id" : "18.9.215.131",
    "status" : "ACTIVE",
    "create_time" : "2022-08-19T11:28:06.000Z",
    "admin_state_up" : true,
    "enable_bfd" : false,
    "route_limit" : 50,
    "enable_nqa" : false,
    "local_gateway_v4_ip" : "1.1.1.1/30",
    "remote_gateway_v4_ip" : "1.1.1.2/30",
    "ies_id" : null,
    "reason" : null,
    "rate_limit" : false,
    "local_gateway_v6_ip" : null,
    "remote_gateway_v6_ip" : null,
    "lgw_id" : null,
    "lag_id" : null,
    "priority" : "normal",
    "vif_peers" : [ {
      "id" : "c768eb52-12a8-4859-9b43-81194643040c",
      "tenant_id" : "0605768a3300d5762f82c01180692873",
      "name" : "vif-0819",
      "description" : "",
      "address_family" : "ipv4",
      "local_gateway_ip" : "1.1.1.1/30",
      "remote_gateway_ip" : "1.1.1.2/30",
      "route_mode" : "static",
      "bgp_asn" : null,
      "bgp_md5" : null,
      "device_id" : "18.9.215.131",
      "bgp_route_limit" : 100,
      "bgp_status" : null,
      "status" : "ACTIVE",
      "vif_id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
      "receive_route_num" : -1,
      "remote_ep_group" : [ "1.1.2.0/30" ],
      "enable_bfd" : false,
      "enable_nqa" : false,
      "service_ep_group" : null
    } ],
    "enterprise_project_id" : "0"
  },
  "request_id" : "5633df7af874576d819a481c76673236"
}