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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCenVbrHealthCheck

The operation that you want to perform. Set the value to DescribeCenVbrHealthCheck.

CenId String No cen-6hpdgj7ni6pz1k****

The ID of the CEN instance.

VbrInstanceRegionId String Yes cn-hangzhou

The ID of the region where the VBR is deployed.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

VbrInstanceId String No vbr-bp1kznorjeembsuhl****

The ID of the VBR.

VbrInstanceOwnerId Long No 253460731706911258

The ID of the Alibaba Cloud account that owns the VBR.

Note The parameter is required if the VBR and the CEN instance belong to different Alibaba Cloud accounts.
PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String B8C9702E-304A-4E18-AC89-BE2D91C2C176

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The total number of entries returned.

VbrHealthChecks Array of VbrHealthCheck

The health check configuration of the VBR.

VbrHealthCheck
HealthCheckTargetIp String 192.XX.XX.1

The destination IP address of the health check.

VbrInstanceId String vbr-bp1kznorjeembsuhl****

The ID of the VBR.

VbrInstanceRegionId String cn-hangzhou

The ID of the region where the VBR is deployed.

CenId String cen-6hpdgj7ni6pz1k****

The ID of the CEN instance.

HealthyThreshold Integer 8

The number of probe packets that are sent during the health check.

HealthCheckInterval Integer 2

The time interval at which probe packets are sent during the health check. Unit: seconds.

HealthCheckSourceIp String 172.XX.XX.1

The source IP address of the health check.

HealthCheckOnly Boolean false

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCenVbrHealthCheck
&CenId=cen-6hpdgj7ni6pz1k****
&VbrInstanceRegionId=cn-hangzhou
&VbrInstanceId=vbr-bp1kznorjeembsuhl****
&VbrInstanceOwnerId=253460731706911258
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCenVbrHealthCheckResponse>
    <PageSize>10</PageSize>
    <RequestId>B8C9702E-304A-4E18-AC89-BE2D91C2C176</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VbrHealthChecks>
        <HealthCheckTargetIp>192.XX.XX.1</HealthCheckTargetIp>
        <VbrInstanceId>vbr-bp1kznorjeembsuhl****</VbrInstanceId>
        <VbrInstanceRegionId>cn-hangzhou</VbrInstanceRegionId>
        <CenId>cen-6hpdgj7ni6pz1k****</CenId>
        <HealthyThreshold>8</HealthyThreshold>
        <HealthCheckInterval>2</HealthCheckInterval>
        <HealthCheckSourceIp>172.XX.XX.1</HealthCheckSourceIp>
        <HealthCheckOnly>false</HealthCheckOnly>
    </VbrHealthChecks>
</DescribeCenVbrHealthCheckResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "B8C9702E-304A-4E18-AC89-BE2D91C2C176",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VbrHealthChecks" : [ {
    "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

For a list of error codes, visit the API Error Center.