You can call this operation to enable the health check feature for a virtual border router (VBR) associated with a Cloud Enterprise Network (CEN) instance. This allows you to detect failures of physical connections in a timely manner. You can also modify the health check configuration for a VBR by calling this API operation.

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 No EnableCenVbrHealthCheck

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

CenId String Yes cen-hahhfskfkseig****

The ID of the CEN instance.

HealthCheckSourceIp String Yes 192.XX.XX.1

You can use either of the following methods to specify the source IP address of the health check.

Automatic IP Address: The system automatically assigns an IP address within the CIDR block 100.96.0.0/16 (recommended).

Custom IP Address: You can specify a source IP address that is available within the CIDR block 10.0.0.0/8, 192.168.0.0/16, or 172.16.0.0/12. The specified source IP address must not overlap with the IP addresses of the Alibaba Cloud-facing and client-facing interfaces on the VBR instance, or the IP addresses of the instances with which the VBR instance needs to communicate in the CEN.

HealthCheckTargetIp String Yes 10.XX.XX.1

Specifies the destination IP address of the health check. The destination IP address is the IP address of the client-facing interface on the VBR instance.

VbrInstanceId String Yes vbr-wz95o9aylj181n5mzk****

The ID of the VBR instance.

VbrInstanceRegionId String Yes cn-shenzhen

The ID of the region where the VBR instance is deployed. You can call the DescribeRegionsoperation to query region IDs.

VbrInstanceOwnerId Long No 1233233323445689999

The User ID (UID) of the account to which the VBR instance belongs.

HealthCheckInterval Integer No 2

Specifies the time interval at which probe packets are sent during the health check.

Default value: 2. Valid values: 2 to 3.

Unit: second.

HealthyThreshold Integer No 8

Specifies the number of probe packets to be sent during the health check.

Default value: 8. Valid values: 3 to 8.

Unit: packet.

Response parameters

Parameter Type Example Description
RequestId String A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

{
    "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.