接口說明
每個虛擬接口可支持兩個對等體,IPv4和IPv6對等體,在創(chuàng)建虛擬接口時默認創(chuàng)建IPv4對等體, 本接口一般用于增加ipv6對等體。創(chuàng)建虛擬接口對接體之后,可以通過虛擬接口查詢配置結果 本接口只在支持Ipv6的區(qū)域開放,如需要使用請聯系客服
URL
POST https://dcaas.cn-north-4.myhuaweicloud.com/v3/{project_id}/dcaas/vif-peers
請求參數
| 名稱 | 類型 | IN | 必選 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用戶Token。 獲取Token ,請參考《 統(tǒng)一身份認證 服務API參考》的“獲取用戶Token”章節(jié)。請求響應成功后在響應消息頭中包含的“X-Subject-Token”的值即為Token值。 |
|
project_id
|
string | path | 是 |
租戶項目ID |
Body參數
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
vif_peer
|
CreateVifPeer object | 否 |
創(chuàng)建虛擬接口對等體參數 |
參數：
vif_peer
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
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 |
|
vif_id
|
string | 否 |
vif對等體對應的虛擬接口ID |
返回參數
返回碼: 201
CREATED
| 名稱 | 類型 | 必選 | 描述 |
|---|---|---|---|
|
vif_peer
|
VifPeer object | 是 |
虛擬接口對等體對象 |
201 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的路由配置規(guī)格 |
|
bgp_status
|
string | 否 |
接口BGP協議狀態(tài),如果是靜態(tài)路由接口則狀態(tài)為 null |
|
status
|
string | 否 |
VIF對等體狀態(tài) |
|
vif_id
|
string | 否 |
vif對等體對應的虛擬接口ID |
請求示例
示例 1
創(chuàng)建一個虛擬接口對等體,遠端子網列表為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
示例 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": [
"12.3.4.0/30 172.56.0.0/16"
]
}
}
"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": [
"12.3.4.0/30 172.56.0.0/16"
]
}
}
SDK
點擊 云專線 (DC) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認證方式等在SDK文檔中對應語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。
