All Products
Search

This Product

    Cloud Enterprise Network:EnableCenVbrHealthCheck

    Document Center

    Cloud Enterprise Network:EnableCenVbrHealthCheck

    Last Updated:Oct 22, 2024

    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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:EnableCenVbrHealthCheckupdate
    • CenInstance
      acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    • virtualborderrouter
      acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CenIdstringYes

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

    		cen-hahhfskfkseig****
    VbrInstanceRegionIdstringYes

    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
    VbrInstanceIdstringYes

    The ID of the VBR.

    		vbr-wz95o9aylj181n5mzk****
    HealthCheckSourceIpstringYes

    The source IP address for 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.
    		192.XX.XX.1
    HealthCheckTargetIpstringYes

    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
    VbrInstanceOwnerIdlongNo

    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
    HealthCheckIntervalintegerNo

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

    		2
    HealthyThresholdintegerNo

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

    		8
    HealthCheckOnlybooleanNo

    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 detected route is not reachable. 

  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 if the detected route is not reachable.
    		false
    DescriptionstringNo

    The description of the health check.

    The description must be 1 to 256 characters in length, and cannot start with http:// or https://.

    		testdesc

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400RouteConflictThe specified route already exists.The specified route already exists.
    400Illegal.SourceIpOrTargetIpThe specified source IP address or destination IP address is invalid.The error message returned because the specified source or destination IP address is invalid.
    400OperationFailed.StatusNotSupportThe 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.
    400OperationFailed.SourceIpUnSupportedThe 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.
    400InvalidStatus.HealthCheckCan not modify, please delete health check config first.You must delete the health check configurations before you can make the modifications.
    400OperationFailed.IpAddressExhaustedNo IP addresses are available for allocation.The operation failed because no IP addresses can be allocated.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe 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 timeSummary of changesOperation
    2024-01-04The Error code has changed. The request parameters of the API has changedView Change Details
    2023-03-27The Error code has changedView Change Details
    2023-03-09The Error code has changedView Change Details