開啟邊界路由器(VBR)的健康檢查功能,確保及時發現出現故障的物理專線,也可修改VBR的健康檢查配置。
接口說明
您可以通過為 VBR 實例設置健康檢查,監測本地數據中心與阿里云之間物理專線的連接狀況,以便及時發現問題。
在使用健康檢查功能前,請先了解以下信息:
-
如果您的邊界路由器實例使用的是靜態路由,那么在您設置完健康檢查后,您需要在邊界路由器實例連接的本地數據中心中添加一條靜態路由條目。 靜態路由的目標網段為健康檢查的源 IP 地址,網段掩碼為 32 位,下一跳為邊界路由器實例的阿里云側 IP 地址。
-
如果您的邊界路由器實例使用的是 BGP 動態路由協議,則無需在本地數據中心添加路由條目。
-
EnableCenVbrHealthCheck 接口屬于異步接口,即系統會先返回一個 RequestId,但該健康檢查實例并未創建或修改完成,系統后臺的創建任務或修改任務仍在進行。您可以調用 DescribeCenVbrHealthCheck 接口查詢健康檢查的配置信息,如果可以查到健康檢查的配置信息,則表示健康檢查創建或者修改完成。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:EnableCenVbrHealthCheck | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CenId | string | 是 | 云企業網實例 ID。 | cen-hahhfskfkseig**** |
VbrInstanceRegionId | string | 是 | VBR 實例所在的地域 ID。 您可以通過調用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-shenzhen |
VbrInstanceId | string | 是 | VBR 實例 ID。 | vbr-wz95o9aylj181n5mzk**** |
HealthCheckSourceIp | string | 是 | 指定健康檢查源 IP 地址。支持以下兩種配置方式:
| 192.XX.XX.1 |
HealthCheckTargetIp | string | 是 | 指定健康檢查的目標 IP 地址。 目標 IP 地址為 VBR 實例客戶側 IP 地址。 | 10.XX.XX.1 |
VbrInstanceOwnerId | long | 否 | VBR 實例所屬的阿里云賬號(主賬號)ID。 說明
如果 VBR 實例和云企業網實例不屬于同一個賬號,本參數必填。
| 1250123456123456 |
HealthCheckInterval | integer | 否 | 指定健康檢查發送連續探測報文的時間間隔。單位:秒。 默認值:2。取值范圍:2~3。 | 2 |
HealthyThreshold | integer | 否 | 指定健康檢查發送探測報文的個數。單位:個。 取值范圍:3~8。默認值:8。 | 8 |
HealthCheckOnly | boolean | 否 | 是否只開啟健康檢查的檢測功能。取值:
| false |
Description | string | 否 | 描述。 長度為 1~256 個字符,但不能以 | testdesc |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "1F59F19C-EFD2-40B1-94D5-65B40CA8E34A"
}
錯誤碼
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. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-01-04 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |