DescribeCenVbrHealthCheck - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Queries the health check information for a virtual border router (VBR) in a specified region.

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:DescribeCenVbrHealthCheck

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId	string	Yes	The ID of the region where the Virtual Border Router (VBR) is deployed. For more information, see DescribeChildInstanceRegions.	cn-hangzhou
VbrInstanceId	string	No	The ID of the VBR.	vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the VBR.	1250123456123456
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	1
VbrHealthChecks	object
VbrHealthCheck	array<object>	The health check configurations of the VBR.
	object
HealthCheckTargetIp	string	The destination IP address of the health check.	192.XX.XX.1
VbrInstanceId	string	The VBR ID.	vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId	string	The ID of the region where the VBR is deployed.	cn-hangzhou
CenId	string	The CEN ID.	cen-6hpdgj7ni6pz1k****
HealthyThreshold	integer	The number of probe packets that are sent during a health check.	8
HealthCheckInterval	integer	The interval, in seconds, at which probe packets are sent during a health check.	2
HealthCheckSourceIp	string	The source IP address of the health check.	172.XX.XX.1
HealthCheckOnly	boolean	Specifies whether to enable the detection-only feature for the health check. true: The system detects the link status but does not switch routes if the health check fails. `If this feature is enabled, the system detects the link status but does not switch routes when the health check fails.` false: If a redundant route is available in the CEN instance, the system switches to the redundant route if the health check fails. `If this feature is disabled and a redundant route is available in the CEN instance, the system switches to the redundant route when the health check fails.`	false
Description	string	The description of the health check.	healthcheck_description

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "B8C9702E-304A-4E18-AC89-BE2D91C2C176",
  "PageNumber": 1,
  "TotalCount": 1,
  "VbrHealthChecks": {
    "VbrHealthCheck": [
      {
        "HealthCheckTargetIp": "192.XX.XX.1",
        "VbrInstanceId": "vbr-bp1kznorjeembsuhl****",
        "VbrInstanceRegionId": "cn-hangzhou",
        "CenId": "cen-6hpdgj7ni6pz1k****",
        "HealthyThreshold": 8,
        "HealthCheckInterval": 2,
        "HealthCheckSourceIp": "172.XX.XX.1",
        "HealthCheckOnly": false,
        "Description": "healthcheck_description"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.