Enables the health check feature for a virtual border router (VBR) to detect anomalies on Express Connect circuits. You can modify the health check configuration of a VBR based on business requirements.
Operation description
You can enable 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 system returns a request ID and runs the task in the background. You can call the DescribeCenVbrHealthCheck operation to query the status of health check configurations. If health check configurations are returned, health check is configured or modified.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cen:EnableCenVbrHealthCheck | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
CenId | string | Yes | The ID of the Cloud Enterprise Network (CEN) instance. | cen-hahhfskfkseig**** |
VbrInstanceRegionId | string | Yes | The ID of the region where the VBR is deployed. You can call the DescribeChildInstanceRegions operation to query the most recent region list. | cn-shenzhen |
VbrInstanceId | string | Yes | The ID of the VBR. | vbr-wz95o9aylj181n5mzk**** |
HealthCheckSourceIp | string | Yes | The source IP address for the health check. You can set the source IP address in the following ways:
| 192.XX.XX.1 |
HealthCheckTargetIp | string | Yes | The destination IP address for the health check. Set the destination IP address to the IP address of the VBR on the customer side. | 10.XX.XX.1 |
VbrInstanceOwnerId | long | No | The ID of the Alibaba Cloud account to which the VBR belongs. Note
This parameter is required if the VBR and the CEN instance belong to different Alibaba Cloud accounts.
| 1250123456123456 |
HealthCheckInterval | integer | No | The time interval at which probe packets are sent during a health check. Unit: seconds. Default value: 2. Valid values: 2 to 3. | 2 |
HealthyThreshold | integer | No | The number of probe packets that are sent during a health check. Unit: packets. Valid values: 3 to 8. Default value: 8. | 8 |
HealthCheckOnly | boolean | No | Specifies whether to enable probing during the health check. Valid values:
| false |
Description | string | No | The description of the health check. The description must be 1 to 256 characters in length, and cannot start with | testdesc |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1F59F19C-EFD2-40B1-94D5-65B40CA8E34A"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | RouteConflict | The specified route already exists. | 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. |
400 | OperationFailed.StatusNotSupport | The VBR or VPC instance to CBN attachment is not in a valid state for the operation. | The error message returned because the status of the VBR or VPC does not support this operation. Try again later. |
400 | OperationFailed.SourceIpUnSupported | The specified source IP address is unsupported. | The error message returned because the specified source IP address is not supported. Enter a valid IP address and try again. |
400 | InvalidStatus.HealthCheck | Can not modify, please delete health check config first. | You must delete the health check configurations before you can make the modifications. |
400 | OperationFailed.IpAddressExhausted | No IP addresses are available for allocation. | The operation failed because no IP addresses can be allocated. |
400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-01-04 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2023-03-27 | The Error code has changed | see changesets | ||||||||
| ||||||||||
2023-03-09 | The Error code has changed | see changesets | ||||||||
|