创建虚拟接口对等体
功能介绍
每个虚拟接口可支持两个对等体,IPv4和IPv6对等体,在创建虚拟接口时默认创建IPv4对等体, 本接口一般用于增加ipv6对等体。创建虚拟接口对接体之后,可以通过虚拟接口查询配置结果 本接口只在支持Ipv6的区域开放,如需要使用请联系客服
URI
POST /v3/{project_id}/dcaas/vif-peers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
vif_peer |
否 |
CreateVifPeer object |
创建虚拟接口对等体参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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_asn |
否 |
Integer |
BGP邻居的AS号 最小值:1 最大值:4294967295 |
bgp_md5 |
否 |
String |
BGP邻居的MD5密码 |
remote_ep_group |
否 |
Array of strings |
远端子网列表,记录租户侧的cidrs |
vif_id |
否 |
String |
vif对等体对应的虚拟接口ID 最小长度:36 最大长度:36 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
vif_peer |
VifPeer object |
虚拟接口对等体对象 |
参数 |
参数类型 |
描述 |
---|---|---|
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_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 |
请求示例
创建一个虚拟接口对等体,远端子网列表为20.1.1.0/24。
POST https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dcaas/vif-peers/68250543-0a13-4ac7-aa36-d018856ac640 { "vif_peer" : { "name" : "vif-0819", "description" : "mytest", "remote_ep_group" : [ "20.1.1.0/24" ] } }
响应示例
状态码: 201
Created
{ "vif_peer" : { "name" : "vif-0819", "description" : "mytest", "id" : "4c95de3e-9f75-4357-9c79-b22498dd71c7", "tenant_id" : "ed28c294165741faaeccab26913122a1", "address_family" : "ipv4", "local_gateway_ip" : "12.3.4.1/30", "remote_gateway_ip" : "12.3.4.2/30", "route_mode" : "static", "bgp_asn" : null, "bgp_md5" : null, "bgp_route_limit" : 100, "bgp_status" : null, "status" : "ACTIVE", "vif_id" : "5d6c17bc-0ebe-420b-8734-21f519e9d7ad", "receive_route_num" : -1, "remote_ep_group" : [ "12.3.4.0/30 172.56.0.0/16" ] } }
状态码
状态码 |
描述 |
---|---|
201 |
Created |
错误码
请参见错误码。