華為云計(jì)算 云知識(shí) 更新虛擬接口UpdateVirtualInterface
更新虛擬接口UpdateVirtualInterface

 

功能介紹

更新虛擬接口的詳細(xì)信息

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

租戶項(xiàng)目ID

virtual_interface_id

String

虛擬接口ID。

最小長(zhǎng)度:36

最大長(zhǎng)度:36

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 獲取Token ,請(qǐng)參考《 統(tǒng)一身份認(rèn)證 服務(wù)API參考》的“獲取用戶Token”章節(jié)。請(qǐng)求響應(yīng)成功后在響應(yīng)消息頭中包含的“X-Subject-Token”的值即為Token值。

最小長(zhǎng)度:0

最大長(zhǎng)度:10240

表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

virtual_interface

UpdateVirtualInterface object

虛擬接口更新對(duì)象

表4 UpdateVirtualInterface

參數(shù)

是否必選

參數(shù)類型

描述

name

String

虛擬接口名字

最小長(zhǎng)度:0

最大長(zhǎng)度:64

description

String

虛擬接口描述信息

最小長(zhǎng)度:0

最大長(zhǎng)度:128

bandwidth

Integer

虛擬接口帶寬配置

最小值:2

最大值:2147483647

remote_ep_group

Array of strings

遠(yuǎn)端子網(wǎng)列表,記錄租戶側(cè)的cidrs

service_ep_group

Array of strings

用于公網(wǎng)專線,用戶訪問公網(wǎng)服務(wù)地址列表

enable_bfd

Boolean

是否使能bfd功能:true或false

enable_nqa

Boolean

是否使能nqa功能:true或false

status

String

對(duì)其他租戶創(chuàng)建的虛擬接口進(jìn)行確認(rèn),可以是ACCEPTED和REJECTED

枚舉值:

  • ACCEPTED

  • REJECTED

響應(yīng)參數(shù)

狀態(tài)碼: 200

表5 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

request_id

String

操作請(qǐng)求ID

virtual_interface

VirtualInterface object

虛擬接口對(duì)象

表6 VirtualInterface

參數(shù)

參數(shù)類型

描述

id

String

虛擬接口的ID

最大長(zhǎng)度:36

name

String

虛擬接口的名字

最大長(zhǎng)度:64

admin_state_up

Boolean

管理狀態(tài):true或false

bandwidth

Integer

虛擬接口接入帶寬

最小值:2

最大值:2147483647

create_time

String

虛擬接口創(chuàng)建時(shí)間

最大長(zhǎng)度:255

update_time

String

虛擬接口更新時(shí)間

description

String

虛擬接口的描述

最大長(zhǎng)度:128

direct_connect_id

String

物理專線的ID

最大長(zhǎng)度:36

service_type

String

接入網(wǎng)關(guān)的類型:包括VGW,GDGW,LGW等

枚舉值:

  • VGW

  • GDGW

  • LGW

status

String

操作狀態(tài),合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_CREATE,PENDING_UPDATE,PENDING_DELETE,DELETED,AUTHORIZATION,REJECTED

tenant_id

String

租戶ID

最小長(zhǎng)度:32

最大長(zhǎng)度:32

type

String

表示接口類型:private

缺省值:private

最大長(zhǎng)度:255

枚舉值:

  • private

  • public

vgw_id

String

虛擬網(wǎng)關(guān)的ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

vlan

Integer

同用戶網(wǎng)關(guān)對(duì)接的vlan, 配置范圍0-3999

最小值:0

最大值:3999

route_limit

Integer

VIF遠(yuǎn)端子網(wǎng)路由配置規(guī)格

最小值:1

最大值:200

缺省值:50

enable_nqa

Boolean

是否使能nqa功能:true或false

enable_bfd

Boolean

是否使能nqa功能:true或false

lag_id

String

VIF關(guān)聯(lián)的鏈路聚合組ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

device_id

String

歸屬的設(shè)備ID

enterprise_project_id

String

實(shí)例所屬企業(yè)項(xiàng)目ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

tags

Array of Tag objects

標(biāo)簽信息

數(shù)組長(zhǎng)度:0 - 10

vif_peers

Array of VifPeer objects

vif的Peer的相關(guān)信息

extend_attribute

VifExtendAttribute object

接口BFD/NQA等可靠性檢測(cè)信息,只有配置BFD和NQA的擴(kuò)展參數(shù)才會(huì)顯示擴(kuò)展參數(shù)信息

表7 Tag

參數(shù)

參數(shù)類型

描述

key

String

標(biāo)簽鍵,最大長(zhǎng)度36個(gè)unicode字符,格式為大小寫字母,數(shù)字,中劃線“-”,下劃線“_”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:36

value

String

標(biāo)簽值,最大長(zhǎng)度43個(gè)unicode字符,格式為大小寫字母,數(shù)字,中劃線“-”,下劃線“_”,點(diǎn)“.”,中文。

最小長(zhǎng)度:0

最大長(zhǎng)度:43

表8 VifPeer

參數(shù)

參數(shù)類型

描述

id

String

資源ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

tenant_id

String

歸屬租戶ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

name

String

VIF對(duì)等體名字

最小長(zhǎng)度:0

最大長(zhǎng)度:64

description

String

VIF對(duì)等體名字描述信息

最小長(zhǎng)度:0

最大長(zhǎng)度:128

address_family

String

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

local_gateway_ip

String

VIF對(duì)等體云側(cè)接口地址

remote_gateway_ip

String

VIF對(duì)等體客戶側(cè)接口地址

route_mode

String

路由模式:static/bgp

最大長(zhǎng)度:255

枚舉值:

  • bgp

  • static

bgp_asn

Integer

BGP鄰居的AS號(hào)

最小值:1

最大值:4294967295

bgp_md5

String

BGP鄰居的MD5密碼

remote_ep_group

Array of strings

遠(yuǎn)端子網(wǎng)列表,記錄租戶側(cè)的cidrs

service_ep_group

Array of strings

該字段用于公網(wǎng)專線接口,表示租戶可以訪問云上公網(wǎng)服務(wù)地址列表

device_id

String

歸屬的設(shè)備ID

bgp_route_limit

Integer

BGP的路由配置規(guī)格

bgp_status

String

接口BGP協(xié)議狀態(tài),如果是靜態(tài)路由接口則狀態(tài)為 null

最大長(zhǎng)度:10

status

String

VIF對(duì)等體狀態(tài)

vif_id

String

vif對(duì)等體對(duì)應(yīng)的虛擬接口ID

最小長(zhǎng)度:36

最大長(zhǎng)度:36

表9 VifExtendAttribute

參數(shù)

參數(shù)類型

描述

ha_type

String

虛擬接口的可用性檢測(cè)類型

枚舉值:

  • nqa

  • bfd

ha_mode

String

檢測(cè)的具體的配置模式

枚舉值:

  • auto_single

  • auto_multi

  • static_single

  • static_multi

  • enhance_nqa

detect_multiplier

Integer

檢測(cè)的重試次數(shù)

缺省值:5

min_rx_interval

Integer

檢測(cè)的接收時(shí)長(zhǎng)間隔

缺省值:1000

min_tx_interval

Integer

檢測(cè)的發(fā)送時(shí)長(zhǎng)間隔

缺省值:1000

remote_disclaim

Integer

檢測(cè)的遠(yuǎn)端的標(biāo)識(shí),用于靜態(tài)BFD

local_disclaim

Integer

檢測(cè)的本端的標(biāo)識(shí),用于靜態(tài)BFD

請(qǐng)求示例

更新虛擬接口的名稱和描述,將帶寬修改為2。

PUT https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/
0d0fdf63-f2c4-491c-8866-d504796189be { "virtual_interface" : { "name" : "vif-0819", "description" : "mytest", "bandwidth" : 2 } }

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "virtual_interface" : {
    "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
    "name" : "vif-0819",
    "description" : "mytest",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1",
    "vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b",
    "type" : "private",
    "service_type" : "VGW",
    "vlan" : 332,
    "bandwidth" : 2,
    "status" : "ACTIVE",
    "create_time" : "2022-08-19T11:28:06.000Z",
    "admin_state_up" : true,
    "enable_bfd" : false,
    "route_limit" : 50,
    "enable_nqa" : false,
    "vif_peers" : [ {
      "id" : "c768eb52-12a8-4859-9b43-81194643040c",
      "tenant_id" : "0605768a3300d5762f82c01180692873",
      "name" : "vif-0819",
      "description" : "",
      "address_family" : "ipv4",
      "local_gateway_ip" : "1.1.1.1/30",
      "remote_gateway_ip" : "1.1.1.2/30",
      "route_mode" : "static",
      "bgp_asn" : null,
      "bgp_md5" : null,
      "device_id" : "18.9.215.131",
      "bgp_route_limit" : 100,
      "bgp_status" : null,
      "status" : "ACTIVE",
      "vif_id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
      "remote_ep_group" : [ "1.1.2.0/30" ],
      "service_ep_group" : null
    } ],
    "enterprise_project_id" : "0"
  },
  "request_id" : "5633df7af874576d819a481c76673236"
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。