更新虚拟接口对等体UpdateVifPeer
接口说明
更新虚拟接口对等体信息,包括远端子网,名字和描述等。 本接口只在支持Ipv6的区域开放,如需要使用请联系客服
URL
PUT https://dcaas.cn-north-4.myhuaweicloud.com/v3/{project_id}/dcaas/vif-peers/{vif_peer_id}
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。 获取Token ,请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
project_id
|
string | path | 是 |
租户项目ID |
|
vif_peer_id
|
string | path | 是 |
虚拟接口对等体ID |
Body参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
vif_peer
|
UpdateVifPeer object | 否 |
更新虚拟接口对等体参数 |
参数：
vif_peer
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
name
|
string | 否 |
VIF对等体名字 |
|
description
|
string | 否 |
VIF对等体名字描述信息 |
|
remote_ep_group
|
Array of strings | 否 |
远端子网列表,记录用户侧的cidrs |
返回参数
返回码: 200
OK
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
vif_peer
|
VifPeer object | 是 |
虚拟接口对等体对象 |
200 vif_peer
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
id
|
string | 否 |
资源ID |
|
tenant_id
|
string | 否 |
归属租户ID |
|
name
|
string | 否 |
VIF对等体名字 |
|
description
|
string | 否 |
VIF对等体名字描述信息 |
|
address_family
|
string | 否 |
接口的地址簇类型,ipv4,ipv6 |
|
local_gateway_ip
|
string | 否 |
VIF对等体云侧接口地址 |
|
remote_gateway_ip
|
string | 否 |
VIF对等体客户侧接口地址 |
|
route_mode
|
string | 否 |
路由模式:static/bgp |
|
bgp_asn
|
integer | 否 |
BGP邻居的AS号 |
|
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 |
|
status
|
string | 否 |
VIF对等体状态 |
|
vif_id
|
string | 否 |
vif对等体对应的虚拟接口ID |
请求示例
示例 1
更新虚拟接口对等体的名称和名称,修改远端子网列表。
"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
示例 1
{
"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",
"remote_ep_group": [
"20.1.1.0/24"
]
}
}
"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",
"remote_ep_group": [
"20.1.1.0/24"
]
}
}
SDK
点击 云专线 (DC) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
