华为云计算 云知识 创建虚拟接口CreateVirtualInterface
创建虚拟接口CreateVirtualInterface

 

功能介绍

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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

type

String

虚拟接口的类型,private

枚举值:

  • private

  • public

service_type

String

接入网关类型:VGW/GDGW/LGW

枚举值:

  • vpc

  • VGW

  • GDWW

  • LGW

vlan

Integer

对接客户侧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,用于跨租户创建虚拟接口场景

ent erp rise_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

虚拟接口创建时间

最大长度:255

update_time

String

虚拟接口更新时间

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

  • public

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

是否使能nqa功能: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

vif_peers

Array of VifPeer objects

vif的Peer的相关信息

extend_attribute

VifExtendAttribute object

接口BFD/NQA等可靠性检测信息,只有配置BFD和NQA的扩展参数才会显示扩展参数信息

表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

表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,
    "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",
      "remote_ep_group" : [ "1.1.2.0/30" ],
      "service_ep_group" : null
    } ],
    "enterprise_project_id" : "0"
  },
  "request_id" : "5633df7af874576d819a481c76673236"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

 

上一篇:替换VolcanoJobreplaceBatchVolcanoShV1alpha1NamespacedJob 下一篇:裸金属服务器有哪些功能

弹性云服务器 ECS

 

弹性云服务器(Elastic Cloud Server)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境,确保服务持久稳定运行,提升运维效率