更新时间:2024-10-21 GMT+08:00
分享

创建虚拟接口

功能介绍

虚拟接口配置物理专线上与客户互联的IP和路由等相关信息

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

virtual_interface

CreateVirtualInterface object

创建虚拟接口对象参数

表4 CreateVirtualInterface

参数

是否必选

参数类型

描述

name

String

虚拟接口名字

最小长度:0

最大长度:64

description

String

虚拟接口描述信息

最小长度:0

最大长度:128

direct_connect_id

String

虚拟接口关联的物理专线ID。在创建虚拟接口时,需要关联direct_connect_id或lag_id,当LAG功能在当前局点不支持时,该参数为必选。

type

String

虚拟接口的类型:private

枚举值:private

service_type

String

接入网关的类型:包括VGW、GDGW、LGW等,VGW场景不需要配置该参数。

枚举值:

  • VGW
  • GDGW
  • LGW

vlan

Integer

对接客户侧vlan。当关联物理连接选择托管专线时,vlan需要和托管专线保持一致。

最小值:0

最大值:3999

bandwidth

Integer

虚拟接口接入带宽

最小值:2

最大值:2147483647

local_gateway_v4_ip

String

云侧网关IPv4接口地址,如果address_family是IPv4,是必选参数

remote_gateway_v4_ip

String

客户侧网关IPv4接口地址,如果address_family是IPv4,是必选参数

address_family

String

接口的地址簇类型,ipv4,ipv6

缺省值:ipv4

local_gateway_v6_ip

String

云侧网关IPv6接口地址,如果address_family是IPv6,是必选参数

remote_gateway_v6_ip

String

客户侧网关IPv6接口地址,如果address_family是IPv6,是必选参数

vgw_id

String

虚拟接口连接的虚拟网关的ID

route_mode

String

路由模式:static/bgp

缺省值:static

枚举值:

  • static
  • bgp

bgp_asn

Integer

客户侧BGP邻居的AS号

最小值:1

最大值:4294967295

bgp_md5

String

BGP邻居的MD5密码

remote_ep_group

Array of strings

远端子网列表,记录租户侧的cidrs

service_ep_group

Array of strings

访问公网服务的子网列表

enable_bfd

Boolean

是否使能bfd功能:true或false。

缺省值:false

enable_nqa

Boolean

是否使能nqa功能:true或false。

缺省值:false

lag_id

String

虚拟接口关联的链路聚合组ID

最小长度:36

最大长度:36

resource_tenant_id

String

目标的租户的ID,用于跨租户创建虚拟接口场景

enterprise_project_id

String

实例所属企业项目ID

最小长度:36

最大长度:36

tags

Array of Tag objects

标签信息

数组长度:0 - 10

表5 Tag

参数

是否必选

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

virtual_interface

VirtualInterface object

虚拟接口对象

表7 VirtualInterface

参数

参数类型

描述

id

String

虚拟接口的ID

最大长度:36

name

String

虚拟接口的名字

最大长度:64

admin_state_up

Boolean

管理状态:true或false

bandwidth

Integer

虚拟接口接入带宽

最小值:2

最大值:2147483647

create_time

String

虚拟接口创建时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ

最大长度:255

description

String

虚拟接口的描述

最大长度:128

direct_connect_id

String

物理专线的ID

最大长度:36

service_type

String

接入网关的类型:包括VGW、GDGW、LGW等。

枚举值:

  • VGW
  • GDGW
  • LGW

status

String

操作状态,合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE,DELETED,AUTHORIZATION,REJECTED

tenant_id

String

租户ID

最小长度:32

最大长度:32

type

String

表示接口类型:private

缺省值:private

最大长度:255

枚举值:private

vgw_id

String

虚拟网关的ID

最小长度:36

最大长度:36

vlan

Integer

同用户网关对接的vlan, 配置范围0-3999

最小值:0

最大值:3999

route_limit

Integer

VIF远端子网路由配置规格

最小值:1

最大值:200

缺省值:50

enable_nqa

Boolean

是否使能nqa功能:true或false

enable_bfd

Boolean

是否使能bfd功能:true或false

lag_id

String

VIF关联的链路聚合组ID

最小长度:36

最大长度:36

device_id

String

归属的设备ID

enterprise_project_id

String

实例所属企业项目ID

最小长度:36

最大长度:36

tags

Array of Tag objects

标签信息

数组长度:0 - 10

local_gateway_v4_ip

String

云侧网关IPv4接口地址,该字段现已经移到vifpeer参数列表中,未来将会废弃。

remote_gateway_v4_ip

String

客户侧网关IPv4接口地址,该字段现已经移到vifpeer参数列表中,未来将会废弃。

ies_id

String

归属的IES站点的ID

reason

String

如果资源的状态是Error的情况下,该参数会显示相关错误信息。

rate_limit

Boolean

标识虚拟接口是否开启限速

address_family

String

接口的地址簇类型,ipv4,ipv6。该字段现已迁移到vifpeer参数列表中,未来将会废弃。

local_gateway_v6_ip

String

云侧网关IPv6接口地址,该字段现已迁移到vifpeer参数列表中,未来将会废弃。

remote_gateway_v6_ip

String

客户侧网关IPv6接口地址,该字段现已迁移到vifpeer参数列表中,未来将会废弃。

lgw_id

String

本地网关的ID,用于IES场景。

gateway_id

String

虚拟接口关联的网关的ID。

remote_ep_group

Array of strings

远端子网列表,记录租户侧的cidrs。该字段现已迁移到vifpeer参数列表中,未来将会废弃。

service_ep_group

Array of strings

该字段用于公网专线接口,表示租户可以访问云上公网服务地址列表。该字段现已迁移到vifpeer参数列表中,未来将会废弃。

bgp_route_limit

Integer

BGP的路由配置规格

priority

String

虚拟接口的优先级,支持两种优先级状态normal和low。 接口优先级相同时表示负载关系,接口优先级不同时表示主备关系,出云流量优先转到优先级更高的normal接口。 目前仅BGP模式接口支持。

缺省值:normal

枚举值:

  • normal
  • low

vif_peers

Array of VifPeer objects

vif的Peer的相关信息

extend_attribute

VifExtendAttribute object

扩展参数信息

表8 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

表9 VifPeer

参数

参数类型

描述

id

String

资源ID

最小长度:36

最大长度:36

tenant_id

String

归属租户ID

最小长度:36

最大长度:36

name

String

VIF对等体名字

最小长度:0

最大长度:64

description

String

VIF对等体名字描述信息

最小长度:0

最大长度:128

address_family

String

接口的地址簇类型,ipv4,ipv6

local_gateway_ip

String

VIF对等体云侧接口地址

remote_gateway_ip

String

VIF对等体客户侧接口地址

route_mode

String

路由模式:static/bgp

最大长度:255

枚举值:

  • bgp
  • static

bgp_asn

Integer

BGP邻居的AS号

最小值:1

最大值:4294967295

bgp_md5

String

BGP邻居的MD5密码

remote_ep_group

Array of strings

远端子网列表,记录租户侧的cidrs

service_ep_group

Array of strings

该字段用于公网专线接口,表示租户可以访问云上公网服务地址列表

device_id

String

归属的设备ID

bgp_route_limit

Integer

BGP的路由配置规格

bgp_status

String

接口BGP协议状态,如果是静态路由接口则状态为 null

最大长度:10

status

String

VIF对等体状态

vif_id

String

vif对等体对应的虚拟接口ID

最小长度:36

最大长度:36

receive_route_num

Integer

路由模式为bgp:receive_route_num值为接收搭配BGP的路由数目; 路由模式为static:该字段无意义,值为-1; 注:若早期接入云上的部分用户无法获取该字段信息,如需要请联系客服迁移专线端口。

enable_nqa

Boolean

是否使能nqa功能:true或false

enable_bfd

Boolean

是否使能bfd功能:true或false

表10 VifExtendAttribute

参数

参数类型

描述

ha_type

String

虚拟接口的可用性检测类型

枚举值:

  • nqa
  • bfd

ha_mode

String

检测的具体的配置模式

枚举值:

  • auto_single
  • auto_multi
  • static_single
  • static_multi
  • enhance_nqa

detect_multiplier

Integer

检测的重试次数

缺省值:5

min_rx_interval

Integer

检测的接收时长间隔

缺省值:1000

min_tx_interval

Integer

检测的发送时长间隔

缺省值:1000

remote_disclaim

Integer

检测的远端的标识,用于静态BFD

local_disclaim

Integer

检测的本端的标识,用于静态BFD

请求示例

  • 创建一个private类型的虚拟接口,设置带宽为2,VLAN为332,云侧网关IPv4接口地址为1.1.1.1/30,客户侧网关IPv4接口地址为1.1.1.2/30,使用静态路由模式。
    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" ]
      }
    }

响应示例

状态码: 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"
}

SDK代码示例

SDK代码示例如下。

创建一个private类型的虚拟接口,设置带宽为2,VLAN为332,云侧网关IPv4接口地址为1.1.1.1/30,客户侧网关IPv4接口地址为1.1.1.2/30,使用静态路由模式。

 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());
        }
    }
}

创建一个private类型的虚拟接口,设置带宽为2,VLAN为332,云侧网关IPv4接口地址为1.1.1.1/30,客户侧网关IPv4接口地址为1.1.1.2/30,使用静态路由模式。

 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)

创建一个private类型的虚拟接口,设置带宽为2,VLAN为332,云侧网关IPv4接口地址为1.1.1.1/30,客户侧网关IPv4接口地址为1.1.1.2/30,使用静态路由模式。

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

错误码

请参见错误码

相关文档