Creating a Virtual Interface
Function
This API is used to create a virtual interface.
Debugging
For details, see Calling APIs.
URI
POST /v3/{project_id}/dcaas/virtual-interfaces
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
virtual_interface |
Yes |
CreateVirtualInterface object |
Specifies the virtual interface to be created. |
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 |
service_type |
No |
String |
Specifies the gateway type. The value can be VGW, GDGW, or LGW. You do not need to configure this parameter if a virtual gateway is used. Enumeration values:
|
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 of the virtual interface. The value 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. The value can be static or bgp. Default: static Enumeration values:
|
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 connection. |
enable_bfd |
No |
Boolean |
Specifies whether to enable 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 virtual interface belongs to. Minimum: 36 Maximum: 36 |
tags |
No |
Array of Tag objects |
Specifies the tags. Array length: 0–10 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Specifies the tag key. The key can contain a maximum of 36 Unicode characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Minimum: 0 Maximum: 36 |
value |
No |
String |
Specifies the tag value. The value can contain a maximum of 43 Unicode characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Minimum: 0 Maximum: 43 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
virtual_interface |
VirtualInterface object |
Specifies the virtual interface. |
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. The value 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. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. Maximum: 255 |
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. The value can be VGW, GDGW, or LGW. Enumeration values:
|
status |
String |
Specifies the operating status. The value 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 |
vgw_id |
String |
Specifies the virtual gateway ID. Minimum: 36 Maximum: 36 |
vlan |
Integer |
Specifies the VLAN for connecting to the customer 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 NQA is enabled. The value can be true or false. |
enable_bfd |
Boolean |
Specifies whether BFD is enabled. 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 |
tags |
Array of Tag objects |
Specifies the tags. Array length: 0–10 |
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 edge site ID. |
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. The value 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:
|
vif_peers |
Array of VifPeer objects |
Provides information about virtual interface peers. |
extend_attribute |
VifExtendAttribute object |
Provides extended parameter information. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The key can contain a maximum of 36 Unicode characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Minimum: 0 Maximum: 36 |
value |
String |
Specifies the tag value. The value can contain a maximum of 43 Unicode characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Minimum: 0 Maximum: 43 |
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 of the virtual interface. The value can be IPv4 or IPv6. |
local_gateway_ip |
String |
Specifies the gateway address of the virtual interface peer used on the cloud. |
remote_gateway_ip |
String |
Specifies the gateway of the virtual interface peer used in the on-premises data center. |
route_mode |
String |
Specifies the routing mode. The value can be static or bgp. Maximum: 255 Enumeration values:
|
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. If this parameter cannot be obtained, contact customer service to migrate your ports. |
enable_nqa |
Boolean |
Specifies whether NQA is enabled. The value can be true or false. |
enable_bfd |
Boolean |
Specifies whether BFD is enabled. The value can be true or false. |
Parameter |
Type |
Description |
---|---|---|
ha_type |
String |
Specifies the availability detection type of the virtual interface. Enumeration values:
|
ha_mode |
String |
Specifies the availability detection mode. Enumeration values:
|
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
{ "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" }
SDK Sample Code
The SDK sample code is as follows.
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
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 |
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 CreateVirtualInterfaceSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); CreateVirtualInterfaceRequest request = new CreateVirtualInterfaceRequest(); CreateVirtualInterfaceRequestBody body = new CreateVirtualInterfaceRequestBody(); List<String> listVirtualInterfaceRemoteEpGroup = new ArrayList<>(); listVirtualInterfaceRemoteEpGroup.add("1.1.2.0/30"); CreateVirtualInterface virtualInterfacebody = new CreateVirtualInterface(); virtualInterfacebody.withName("vif-0819") .withDescription("mytest") .withDirectConnectId("4673e339-8412-4ee1-b73e-2ba9cdfa54c1") .withType(CreateVirtualInterface.TypeEnum.fromValue("private")) .withVlan(332) .withBandwidth(2) .withLocalGatewayV4Ip("1.1.1.1/30") .withRemoteGatewayV4Ip("1.1.1.2/30") .withVgwId("8a47064a-f34c-4f94-b7fe-cac456c9b37b") .withRouteMode(CreateVirtualInterface.RouteModeEnum.fromValue("static")) .withRemoteEpGroup(listVirtualInterfaceRemoteEpGroup); body.withVirtualInterface(virtualInterfacebody); request.withBody(body); try { CreateVirtualInterfaceResponse response = client.createVirtualInterface(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 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
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 |
# coding: utf-8 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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateVirtualInterfaceRequest() listRemoteEpGroupVirtualInterface = [ "1.1.2.0/30" ] virtualInterfacebody = CreateVirtualInterface( name="vif-0819", description="mytest", direct_connect_id="4673e339-8412-4ee1-b73e-2ba9cdfa54c1", type="private", vlan=332, bandwidth=2, local_gateway_v4_ip="1.1.1.1/30", remote_gateway_v4_ip="1.1.1.2/30", vgw_id="8a47064a-f34c-4f94-b7fe-cac456c9b37b", route_mode="static", remote_ep_group=listRemoteEpGroupVirtualInterface ) request.body = CreateVirtualInterfaceRequestBody( virtual_interface=virtualInterfacebody ) response = client.create_virtual_interface(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 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
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateVirtualInterfaceRequest{} var listRemoteEpGroupVirtualInterface = []string{ "1.1.2.0/30", } nameVirtualInterface:= "vif-0819" descriptionVirtualInterface:= "mytest" directConnectIdVirtualInterface:= "4673e339-8412-4ee1-b73e-2ba9cdfa54c1" localGatewayV4IpVirtualInterface:= "1.1.1.1/30" remoteGatewayV4IpVirtualInterface:= "1.1.1.2/30" virtualInterfacebody := &model.CreateVirtualInterface{ Name: &nameVirtualInterface, Description: &descriptionVirtualInterface, DirectConnectId: &directConnectIdVirtualInterface, Type: model.GetCreateVirtualInterfaceTypeEnum().PRIVATE, Vlan: int32(332), Bandwidth: int32(2), LocalGatewayV4Ip: &localGatewayV4IpVirtualInterface, RemoteGatewayV4Ip: &remoteGatewayV4IpVirtualInterface, VgwId: "8a47064a-f34c-4f94-b7fe-cac456c9b37b", RouteMode: model.GetCreateVirtualInterfaceRouteModeEnum().STATIC, RemoteEpGroup: listRemoteEpGroupVirtualInterface, } request.Body = &model.CreateVirtualInterfaceRequestBody{ VirtualInterface: virtualInterfacebody, } response, err := client.CreateVirtualInterface(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot