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

调试

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

请求参数

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

要执行的操作。取值:DescribeCenVbrHealthCheck

VbrInstanceRegionId String cn-hangzhou

VBR实例所在的地域ID。

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

CenId String cen-6hpdgj7ni6pz1k****

云企业网实例ID。

VbrInstanceId String vbr-bp1kznorjeembsuhl****

VBR实例ID。

VbrInstanceOwnerId Long 1688000000000000

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

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

查询页码。默认值为1

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

查询页码。

PageSize Integer 10

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

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

请求ID。

TotalCount Integer 1

总条目数。

VbrHealthChecks Array of VbrHealthCheck

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

VbrHealthCheck
CenId String cen-6hpdgj7ni6pz1k****

云企业网实例ID。

HealthCheckInterval Integer 2

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

HealthCheckSourceIp String 172.XX.XX.1

健康检查的源IP地址。

HealthCheckTargetIp String 192.XX.XX.1

健康检查的目标IP地址。

HealthyThreshold Integer 8

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

VbrInstanceId String vbr-bp1kznorjeembsuhl****

VBR实例ID。

VbrInstanceRegionId String cn-hangzhou

VBR实例所在的地域ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCenVbrHealthCheck
&VbrInstanceRegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<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>172.XX.XX.1</HealthCheckSourceIp>
              <HealthyThreshold>8</HealthyThreshold>
              <CenId>cen-6hpdgj7ni6pz1k****</CenId>
              <HealthCheckTargetIp>192.XX.XX.1</HealthCheckTargetIp>
        </VbrHealthCheck>
  </VbrHealthChecks>
</DescribeCenVbrHealthCheckResponse>

JSON格式

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

错误码

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