云专线 DC-创建虚拟接口:响应参数

时间:2023-11-28 10:14:42

响应参数

状态码: 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、GEIP

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

虚拟接口远端子网路由配置规格

最小值:1

最大值:200

缺省值:50

enable_nqa

Boolean

是否使能nqa功能:true或false

enable_bfd

Boolean

是否使能nqa功能:true或false

lag_id

String

虚拟接口关联的链路聚合组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

虚拟接口的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

虚拟接口对等体名称

最小长度:0

最大长度:64

description

String

虚拟接口对等体名称描述信息

最小长度:0

最大长度:128

address_family

String

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

local_gateway_ip

String

虚拟接口对等体云侧接口地址

remote_gateway_ip

String

虚拟接口对等体客户侧接口地址

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_id

String

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

最小长度:36

最大长度:36

receive_route_num

Integer

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

表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

support.huaweicloud.com/api-dc/CreateVirtualInterface.html