Queries the health check status of the physical connections in a specified region.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
VbrInstanceRegionId String  Yes cn-hangzhou

The ID of the region to which the VBR belongs. To query the region ID, call DescribeRegions.

Action String No DescribeCenVbrHealthCheck

Optional. The name of this action. Value: DescribeCenVbrHealthCheckRequest

CenId String No cen-kojok19x3j0q****

Optional. The ID of the CEN instance.

PageNumber Integer No 2

Optional. The page number. Default value: 1

PageSize Integer No 2

Optional. The number of entries per page in the case of a paged query result. Maximum value: 50. Default value: 10

VbrInstanceId String No vbr-wz95o9aylj181****

Optional. The ID of the VBR.

VbrInstanceOwnerId Long No 123465253556777

Optional. The ID of the account to which the VBR belongs.

Response parameters

Parameter Type Example value Description
PageNumber Integer   2

The current page number.

PageSize Integer   2

The number of entries per page.

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

 The ID of the request.

TotalCount Integer 2

The total number of queried entries.

VbrHealthChecks

The details of VBR health checks.

CenId String cen-kojok19x3j0q6****

The ID of the CEN instance.

Delay Long 12

The delay.

HealthCheckSourceIp String 192.168.1.xx

The source IP address of the health check.

HealthCheckTargetIp String 192.168.1.xx

The destination IP address of the health check.

LinkStatus String Active

The health status of the physical connection.

PacketLoss Long 5

The packet loss rate.

VbrInstanceId String vbr-il7ldy0ux6rb15l****

The ID of the VBR.

Examples

Request example


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

Response examples

XML format

<DescribeCenVbrHealthCheckResponse>
      <HealthChecks>
            <HealthCheck>
                  <CenId>Cen-atlpf6evc5kqch****</CenId>
                  <VbrInstanceId>vbr-il7ldy0ux6rb15lc2s****</VbrInstanceId>
                  <HealthCheckSourceIp>10.10.10.xx</HealthCheckSourceIp>
                  <HealthCheckTargetIp>10.10.10.xx</HealthCheckTargetIp>
                  <Delay>3ms</Delay>
                  <Packetloss>5%</Packetloss>
            </HealthCheck>
      </HealthChecks>
      <PageNumber>1</PageNumber>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A</RequestId>
</DescribeCenVbrHealthCheckResponse>

JSON format

{
	"DescribeCenVbrHealthCheckResponse":{
		"PageNumber":"1",
		"TotalCount":"1",
		"PageSize":"10",
		"RequestId":"A278B8A6-A5B8-4FDE-9F70-95F0F6A1D68A",
		"HealthChecks":{
			"HealthCheck":{
				"Delay":"3ms",
				"VbrInstanceId":"vbr-il7ldy0ux6rb15lc2s****",
				"Packetloss":"5%",
				"CenId":"Cen-atlpf6evc5kqch****",
				"HealthCheckSourceIp":"10.10.10.xx",
				"HealthCheckTargetIp":"10.10.10.xx"
			}
		}
	}
}

Errors

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