DescribeCenVbrHealthCheck - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Queries the health check configuration of a virtual border router (VBR) in a specified region.

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.

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:DescribeCenVbrHealthCheck	READ	CenInstance acs:cen::{#accountId}:ceninstance/ CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} virtualborderrouter acs:vpc::{#accountId}:virtualborderrouter/* virtualborderrouter acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The ID of the CEN instance.	cen-6hpdgj7ni6pz1k****
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-hangzhou
VbrInstanceId	string	No	The ID of the VBR.	vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId	long	No	The ID of the Alibaba Cloud account that owns the VBR.	1250123456123456
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of entries returned.	1
VbrHealthChecks	object []	The health check configuration of the VBR.
HealthCheckTargetIp	string	The destination IP address of the health check.	192.XX.XX.1
VbrInstanceId	string	The ID of the VBR.	vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId	string	The ID of the region where the VBR is deployed.	cn-hangzhou
CenId	string	The ID of the CEN instance.	cen-6hpdgj7ni6pz1k****
HealthyThreshold	integer	The number of probe packets that are sent during the health check.	8
HealthCheckInterval	integer	The time interval at which probe packets are sent during the health check. Unit: seconds.	2
HealthCheckSourceIp	string	The source IP address of the health check.	172.XX.XX.1
HealthCheckOnly	boolean	Indicates whether probing is enabled. Valid values: true: yes If probing is enabled, the system does not switch to another route when the detected route is not reachable. false: no If probing is disabled and a redundant route is specified, the system switches to the redundant route when the detected route is not reachable.	false

Examples

Sample success responses

JSONformat

{
  "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
      }
    ]
  }
}

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.

For a list of error codes, visit the Service error codes.