调用DescribeCenVbrHealthCheck查询指定地域内边界路由器VBR(Virtual Border Router)实例的健康检查配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCenVbrHealthCheck

系统规定参数。取值:DescribeCenVbrHealthCheck

CenId String cen-6hpdgj7ni6pz1k****

云企业网实例ID。

VbrInstanceRegionId String cn-hangzhou

VBR实例所在的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

VbrInstanceId String vbr-bp1kznorjeembsuhl****

VBR实例ID。

VbrInstanceOwnerId Long 253460731706911258

VBR实例所属的阿里云账号(主账号)ID。

说明 如果VBR实例和云企业网实例不属于同一个账号,本参数必填。
PageNumber Integer 1

查询页码。默认值:1

PageSize Integer 10

分页查询时每页显示的条目数。取值范围:1~50。默认值:10

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页显示的条目数。

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

请求ID。

PageNumber Integer 1

查询页码。

TotalCount Integer 1

总条目数。

VbrHealthChecks Array of VbrHealthCheck

VBR实例的健康检查配置信息。

VbrHealthCheck
HealthCheckTargetIp String 192.XX.XX.1

健康检查的目标IP地址。

VbrInstanceId String vbr-bp1kznorjeembsuhl****

VBR实例ID。

VbrInstanceRegionId String cn-hangzhou

VBR实例所在的地域ID。

CenId String cen-6hpdgj7ni6pz1k****

云企业网实例ID。

HealthyThreshold Integer 8

健康检查发送探测报文的个数。

HealthCheckInterval Integer 2

健康检查发送连续探测报文的时间间隔。单位:秒。

HealthCheckSourceIp String 172.XX.XX.1

健康检查的源IP地址。

HealthCheckOnly Boolean false

是否只开启了健康检查的检测功能。

  • true:是。

    若只开启健康检查的检测功能,健康检查检测到链路不通时不会触发路由切换。

  • false:否。

    若未开启本功能,健康检查检测到链路不通时,如果云企业网实例中存在冗余的路由,健康检查会立刻触发路由切换使用可用链路。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCenVbrHealthCheck
&CenId=cen-6hpdgj7ni6pz1k****
&VbrInstanceRegionId=cn-hangzhou
&VbrInstanceId=vbr-bp1kznorjeembsuhl****
&VbrInstanceOwnerId=253460731706911258
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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格式

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

错误码

访问错误中心查看更多错误码。