调用EnableCenVbrHealthCheck接口为边界路由器VBR（Virtual Border Router）实例设置健康检查或修改VBR实例的健康检查配置。

使用说明

您可以通过为VBR实例设置健康检查，监测本地数据中心与阿里云之间物理专线的连接状况，以便及时发现问题。

在使用健康检查功能前，请先了解以下信息：

  • 如果您的边界路由器实例使用的是静态路由，那么在您设置完健康检查后，您需要在边界路由器实例连接的本地数据中心中添加一条静态路由条目。

    静态路由的目标网段为健康检查的源IP地址，网段掩码为32位，下一跳为边界路由器实例的阿里云侧IP地址。

  • 如果您的边界路由器实例使用的是BGP动态路由协议，则无需在本地数据中心添加路由条目。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 否 EnableCenVbrHealthCheck

要执行的操作。取值：EnableCenVbrHealthCheck。

CenId String 是 cen-hahhfskfkseig****

云企业网实例ID。
HealthCheckSourceIp String 是 192.XX.XX.1

指定健康检查源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地址冲突。
HealthCheckTargetIp String 是 10.XX.XX.1

指定健康检查的目标IP地址。

目标IP地址为VBR实例客户侧IP地址。
VbrInstanceId String 是 vbr-wz95o9aylj181n5mzk****

VBR实例ID。
VbrInstanceRegionId String 是 cn-shenzhen

VBR实例所在的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

VbrInstanceOwnerId Long 否 1688000000000000

VBR实例所属的阿里云账号（主账号）ID。

说明 如果VBR实例和云企业网实例不属于同一个账号，本参数必填。
HealthCheckInterval Integer 否 2

指定健康检查发送连续探测报文的时间间隔。

默认值：2。取值范围：2~3。

单位：秒。

HealthyThreshold Integer 否 8

指定健康检查发送探测报文的个数。

默认值：8。取值范围：3~8。

单位：个。

返回数据

名称 类型 示例值 描述
RequestId String 1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=EnableCenVbrHealthCheck
&CenId=cen-hahhfskfkseig****
&HealthCheckSourceIp=192.XX.XX.1
&HealthCheckTargetIp=10.XX.XX.1
&VbrInstanceId=vbr-wz95o9aylj181n5mzk****
&VbrInstanceRegionId=cn-shenzhen
&<公共请求参数>

正常返回示例

XML格式 

<EnableCenVbrHealthCheckResponse>
  <RequestId>1F59F19C-EFD2-40B1-94D5-65B40CA8E34A</RequestId>
</EnableCenVbrHealthCheckResponse>

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
400 RouteConflict The specified route already exists. 输入的路由已存在。
400 Illegal.SourceIpOrTargetIp The specified source IP address or destination IP address is invalid. 源IP或者目的IP非法。

访问错误中心查看更多错误码。