You can call this operation to query the health check status of a virtual border router (VBR) instance 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 No DescribeCenVbrHealthCheck

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

VbrInstanceRegionId String Yes cn-hangzhou

The ID of the region where the VBR instance is deployed. You can call the DescribeRegions operation to query region IDs of the region where the VBR instance is deployed.

CenId String No cen-kojok19x3j0q****

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

VbrInstanceId String No vbr-wz95o9aylj181****

The ID of the VBR instance.

VbrInstanceOwnerId Long No 123465253556777

The User ID (UID) of the account to which the VBR instance belongs.

PageNumber Integer No 2

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

PageSize Integer No 2

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageNumber Integer 2

The page number of the returned page.

PageSize Integer 2

The number of entries returned per page.

RequestId String A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A

The ID of the request.

TotalCount Integer 2

The total number of entries returned.

VbrHealthChecks Array

The health check status of the VBR instance.

VbrHealthCheck
CenId String cen-kojok19x3j0q6****

The ID of the CEN instance.

HealthCheckInterval Integer 2

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

HealthCheckSourceIp String 192.168.XX.1

The source IP address of the health check.

HealthCheckTargetIp String 192.168.XX.2

The destination IP address of the health check.

HealthyThreshold Integer 8

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

VbrInstanceId String vbr-il7ldy0ux6rb15l****

The ID of the VBR instance.

VbrInstanceRegionId String cn-hangzhou

The ID of the region where the VBR instance is deployed.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeCenVbrHealthCheck
&VbrInstanceRegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

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