Configures or modifies health check for a virtual border router (VBR).

Usage notes

You can configure the health check feature for a VBR to monitor the Express Connect circuit between your data center and Alibaba Cloud. This helps you detect connection issues in a timely manner.

Before you use the health check feature, take note of the following information:

  • If your VBR uses static routing, you must add a static route for the data center that is connected to the VBR after you configure the health check feature.

    Set the destination CIDR block to the source IP address of health checks, set the mask length to 32, and set the next hop to the IP address of the VBR on the Alibaba Cloud side.

  • If your VBR uses dynamic Border Gateway Protocol (BGP) routing, you do not need to add routes for the data center.
  • EnableCenVbrHealthCheck is an asynchronous operation. After you send a request, the request ID is returned but the operation is still being performed in the system background. You can call DescribeCenVbrHealthCheck to query the status of health check configurations. If health check configurations can be found, health check is configured or modified.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes EnableCenVbrHealthCheck

The operation that you want to perform. Set the value to EnableCenVbrHealthCheck.

CenId String Yes cen-hahhfskfkseig****

The ID of the Cloud Enterprise Network (CEN) instance.

VbrInstanceRegionId String Yes cn-shenzhen

The ID of the region where the VBR is deployed.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

VbrInstanceId String Yes vbr-wz95o9aylj181n5mzk****

The ID of the VBR.

HealthCheckSourceIp String Yes 192.XX.XX.1

The source IP address of the health check. You can set the source IP address in the following ways:

  • Automatic IP Address (recommended): The system automatically assigns an IP address from the 100.96.0.0/16 CIDR block.
  • Custom IP Address: You must specify an idle IP address from the 10.0.0.0/8, 192.168.0.0/16, or 172.16.0.0/12 CIDR block. The specified IP address cannot be the IP address of the VBR on the Alibaba Cloud side, the IP address of the VBR on the customer side, or other IP addresses with which the VBR communicates through the CEN instance.
HealthCheckTargetIp String Yes 10.XX.XX.1

The destination IP address of health check.

Set the destination IP address to the IP address of the VBR on the customer side.

VbrInstanceOwnerId Long No 1250123456123456

The ID of the Alibaba Cloud account to which the VBR belongs.

Note The parameter is required if the VBR and the CEN instance belong to different Alibaba Cloud accounts.
HealthCheckInterval Integer No 2

The time interval at which probe packets are sent during health check. Unit: seconds. Default value: 2. Valid values: 2 to 3.

HealthyThreshold Integer No 8

The number of probe packets that are sent during health check. Unit: connections. Valid values: 3 to 8. Default value: 8.

HealthCheckOnly Boolean No false

Specifies whether to enable probing during the health check. Valid values:

  • true: yes

    If you enable probing, the system does not switch to another route if the route detected is not reachable.
    Note Make sure that a redundant route is available. Otherwise, network disconnections may occur.

  • false (default): no

    Probing is disabled by default. If a redundant route is specified, the system switches to the redundant route when the detected route is not reachable.

Response parameters

Parameter Type Example Description
RequestId String 1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=EnableCenVbrHealthCheck
&CenId=cen-hahhfskfkseig****
&VbrInstanceRegionId=cn-shenzhen
&VbrInstanceId=vbr-wz95o9aylj181n5mzk****
&HealthCheckSourceIp=192.XX.XX.1
&HealthCheckTargetIp=10.XX.XX.1
&VbrInstanceOwnerId=1250123456123456
&HealthCheckInterval=2
&HealthyThreshold=8
&HealthCheckOnly=false
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 RouteConflict The specified route already exists. The error message returned because the specified route already exists.
400 Illegal.SourceIpOrTargetIp The specified source IP address or destination IP address is invalid. The error message returned because the specified source or destination IP address is invalid.

For a list of error codes, visit the API Error Center.