DescribeCenVbrHealthCheck - 查询边界路由器（VBR）健康检查信息 - 云企业网

查询指定地域内边界路由器（VBR）健康检查信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cen:DescribeCenVbrHealthCheck	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
CenId	string	否	云企业网实例 ID。	cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId	string	是	VBR 实例所在的地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-hangzhou
VbrInstanceId	string	否	VBR 实例 ID。	vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId	long	否	VBR 实例所属的阿里云账号（主账号）ID。	1250123456123456
PageNumber	integer	否	查询页码。默认值：1。	1
PageSize	integer	否	分页查询时每页显示的条目数。取值范围：1~50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
PageSize	integer	分页查询时每页显示的条目数。	10
RequestId	string	请求 ID。	B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber	integer	查询页码。	1
TotalCount	integer	总条目数。	1
VbrHealthChecks	array<object>	VBR 实例的健康检查配置信息。
VbrHealthCheck	object
HealthCheckTargetIp	string	健康检查的目标 IP 地址。	192.XX.XX.1
VbrInstanceId	string	VBR 实例 ID。	vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId	string	VBR 实例所在的地域 ID。	cn-hangzhou
CenId	string	云企业网实例 ID。	cen-6hpdgj7ni6pz1k****
HealthyThreshold	integer	健康检查发送探测报文的个数。	8
HealthCheckInterval	integer	健康检查发送连续探测报文的时间间隔。单位：秒。	2
HealthCheckSourceIp	string	健康检查的源 IP 地址。	172.XX.XX.1
HealthCheckOnly	boolean	是否只开启了健康检查的检测功能。 true：是。 `若只开启健康检查的检测功能，健康检查检测到链路不通时不会触发路由切换。` false：否。 `若未开启本功能，健康检查检测到链路不通时，如果云企业网实例中存在冗余的路由，健康检查会立刻触发路由切换使用可用链路。`	false
Description	string	描述信息。	healthcheck_description

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间	变更内容概要	操作
2023-12-13	OpenAPI 返回结构发生变更	查看变更详情