調用EnableCenVbrHealthCheck為邊界路由器開啟物理專線健全狀態檢查-雲企業網-阿里雲

開啟邊界路由器（VBR）的健全狀態檢查功能，確保及時發現出現故障的物理專線，也可修改VBR的健全狀態檢查配置。

介面說明

您可以通過為 VBR 執行個體設定健全狀態檢查，監測本機資料中心與阿里雲之間物理專線的串連狀況，以便及時發現問題。

在使用健全狀態檢查功能前，請先瞭解以下資訊：

如果您的邊界路由器執行個體使用的是靜態路由，那麼在您設定完健全狀態檢查後，您需要在邊界路由器執行個體串連的本機資料中心中添加一條靜態路由條目。靜態路由的目標網段為健全狀態檢查的源 IP 位址，網段掩碼為 32 位，下一跳為邊界路由器執行個體的阿里雲側 IP 位址。
如果您的邊界路由器執行個體使用的是 BGP 動態路由協議，則無需在本機資料中心添加路由條目。
EnableCenVbrHealthCheck 介面屬於非同步介面，即系統會先返回一個 RequestId，但該健全狀態檢查執行個體並未建立或修改完成，系統背景建立任務或修改任務仍在進行。您可以調用 DescribeCenVbrHealthCheck 介面查詢健全狀態檢查的配置資訊，如果可以查到健全狀態檢查的配置資訊，則表示健全狀態檢查建立或者修改完成。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:EnableCenVbrHealthCheck

update

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

無

請求參數

名稱	類型	必填	描述	樣本值
CenId	string	是	雲企業網執行個體 ID。	cen-hahhfskfkseig****
VbrInstanceRegionId	string	是	VBR 執行個體所在的地區 ID。您可以通過調用 DescribeChildInstanceRegions 介面擷取地區 ID。	cn-shenzhen
VbrInstanceId	string	是	VBR 執行個體 ID。	vbr-wz95o9aylj181n5mzk****
HealthCheckSourceIp	string	否	指定健全狀態檢查源 IP 位址。支援以下兩種配置方式：自動產生源 IP（推薦）：系統將自動分配 100.96.0.0/16 網段內的 IP 位址。自訂來源 IP：源 IP 位址可以是 10.0.0.0/8、192.168.0.0/16、172.16.0.0/12 三個網段內任意一個沒有被使用的 IP 位址。但不能與雲企業網中要互連的地址衝突，也不能與 VBR 執行個體的阿里雲側、客戶側 IP 位址衝突。	192.XX.XX.1
HealthCheckTargetIp	string	是	指定健全狀態檢查的目標 IP 位址。目標 IP 位址為 VBR 執行個體客戶側 IP 位址。	10.XX.XX.1
VbrInstanceOwnerId	integer	否	VBR 執行個體所屬的阿里雲帳號（主帳號）ID。說明如果 VBR 執行個體和雲企業網執行個體不屬於同一個帳號，本參數必填。	1250123456123456
HealthCheckInterval	integer	否	指定健全狀態檢查發送連續探測報文的時間間隔。單位：秒。預設值：2。取值範圍：2~3。	2
HealthyThreshold	integer	否	指定健全狀態檢查發送探測報文的個數。單位：個。取值範圍：3~8。預設值：8。	8
HealthCheckOnly	boolean	否	是否只開啟健全狀態檢查的檢測功能。取值： true：是。 `若只開啟健全狀態檢查的檢測功能，健全狀態檢查檢測到鏈路不通時不會觸發路由切換。 > 請確保您有其他方式保證鏈路的冗餘性，否則開啟本功能後，可能會導致鏈路中斷。` false（預設值）：否。 `系統預設關閉本功能。健全狀態檢查檢測到鏈路不通時，如果雲企業網執行個體中存在冗餘的路由，則健全狀態檢查會立刻觸發路由切換使用可用鏈路。`	false
Description	string	否	描述。長度為 1~256 個字元，但不能以`http://` 或`https://`開頭。	testdesc

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1F59F19C-EFD2-40B1-94D5-65B40CA8E34A"
}

異常返回樣本

JSON格式

{
  "RequestId": "A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A",
  "CenId": "Cen-atlpf6evc5kqchpma5",
  "VbrId": "vbr-il7ldy0ux6rb15lc2snrw",
  "RegionId": "cn-hangzhou",
  "SourceIp": "10.10.10.10",
  "TargetIp": "10.10.10.11",
  "PacketNum": "3",
  "Status": "Enable"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RouteConflict	The specified route already exists.	輸入的路由已存在。
400	Illegal.SourceIpOrTargetIp	The specified source IP address or destination IP address is invalid.	源IP或者目的IP非法。
400	OperationFailed.StatusNotSupport	The VBR or VPC instance to CBN attachment is not in a valid state for the operation.	當前VBR或VPC的狀態不支援該操作，請稍後重試。
400	OperationFailed.SourceIpUnSupported	The specified source IP address is unsupported.	不支援參數中指定的源IP地址，請修改後重試。
400	InvalidStatus.HealthCheck	Can not modify, please delete health check config first.	不能修改，請先刪除健全狀態檢查配置。
400	OperationFailed.IpAddressExhausted	No IP addresses are available for allocation.	可分配的IP地址已耗盡，無法操作。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無許可權操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。