EnableCenVbrHealthCheck - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Operation description

You can configure a health check for a VBR instance to monitor the connection status of the Express Connect circuit between your data center and Alibaba Cloud. This helps you promptly identify issues.

Before you use the health check feature, note the following:

If your VBR instance uses static routing, create a static route in the data center connected to the VBR instance after you configure the health check. Set the destination CIDR block of the static route to the source IP address of the health check, the subnet mask to 32 bits, and the next hop to the Alibaba Cloud-side IP address of the VBR instance.
If your VBR instance uses the Border Gateway Protocol (BGP) dynamic routing protocol, you do not need to create a route in the data center.
EnableCenVbrHealthCheck is an asynchronous operation. After you send a request, the system returns a RequestId, but the health check is not yet created or modified because the task is still running in the background. You can call the DescribeCenVbrHealthCheck operation to query the health check configuration. If the configuration is returned, this indicates that the health check is created or modified.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:EnableCenVbrHealthCheck

update

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

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 instance is deployed. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-shenzhen
VbrInstanceId	string	Yes	The ID of the VBR instance.	vbr-wz95o9aylj181n5mzk****
HealthCheckSourceIp	string	No	The source IP address for the health check. You can configure the source IP address in one of 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 can specify an unused 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 conflict with an IP address that is used for communication in the CEN instance. The specified IP address also cannot conflict with the Alibaba Cloud-side or client-side IP address of the VBR instance.	192.XX.XX.1
HealthCheckTargetIp	string	Yes	The destination IP address for the health check. The destination IP address is the client-side IP address of the VBR instance.	10.XX.XX.1
VbrInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account to which the VBR instance belongs. Note This parameter is required if the VBR instance 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 only the detection feature. Valid values: true: Yes. `If you enable only the detection feature, the system performs a health check but does not switch routes when the Express Connect circuit is down. > Make sure that you have another way to ensure link redundancy. Otherwise, network interruptions may occur.` false (default): No. `This feature is disabled by default. If the health check detects a link failure and a redundant route is available in the CEN instance, the system immediately switches to the available route.`	false
Description	string	No	The description. The description must be 1 to 256 characters in length and cannot start with `http://` or `https://`.	testdesc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

Examples

Success response

JSON format

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

Error response

JSON format

{
  "RequestId": "A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A",
  "CenId": "Cen-atlpf6evc5kqchpma5",
  "VbrId": "vbr-il7ldy0ux6rb15lc2snrw",
  "RegionId": "cn-hangzhou",
  "SourceIp": "10.10.10.10",
  "TargetIp": "10.10.10.11",
  "PacketNum": "3",
  "Status": "Enable"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.