文档首页/云专线 DC/API参考 (联盟区域) /API/虚拟接口/更新虚拟接口对等体
更新时间：2026-01-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新虚拟接口对等体

功能介绍

更新虚拟接口对等体信息，包括远端子网，名字和描述等。

调用方法

请参见如何调用API。

URI

PUT /v3/{project_id}/dcaas/vif-peers/{vif_peer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

vif_peer_id

是

String

虚拟接口对等体ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：10240

表3 请求Body参数

参数

是否必选

参数类型

描述

vif_peer

否

UpdateVifPeer object

更新虚拟接口对等体参数

表4 UpdateVifPeer

参数

是否必选

参数类型

描述

name

否

String

VIF对等体名字

最小长度：0

最大长度：64

description

否

String

VIF对等体名字描述信息

最小长度：0

最大长度：128

remote_ep_group

否

Array of strings

远端子网列表，记录用户侧的cidrs

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

vif_peer

VifPeer object

虚拟接口对等体对象

表6 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（Network Quality Analysis）功能：true或false

enable_bfd

Boolean

是否使能bfd（Bidirectional Forwarding Detection）功能：true或false

请求示例

更新虚拟接口对等体的名称和描述，修改远端子网列表。

PUT 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" ]
  }
}

响应示例

状态码： 200

OK

{
  "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" : [ "20.1.1.0/24" ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：虚拟接口