全部产品
Search

搜索本产品

    云企业网：EnableCenVbrHealthCheck - 开启边界路由器（VBR）健康检查功能

    文档中心

    云企业网：EnableCenVbrHealthCheck - 开启边界路由器（VBR）健康检查功能

    更新时间：Oct 22, 2024

    开启边界路由器（VBR）的健康检查功能，确保及时发现出现故障的物理专线，也可修改VBR的健康检查配置。

    接口说明

    您可以通过为 VBR 实例设置健康检查，监测本地数据中心与阿里云之间物理专线的连接状况，以便及时发现问题。

    在使用健康检查功能前，请先了解以下信息：

    • 如果您的边界路由器实例使用的是静态路由，那么在您设置完健康检查后，您需要在边界路由器实例连接的本地数据中心中添加一条静态路由条目。 静态路由的目标网段为健康检查的源 IP 地址，网段掩码为 32 位，下一跳为边界路由器实例的阿里云侧 IP 地址。

    • 如果您的边界路由器实例使用的是 BGP 动态路由协议，则无需在本地数据中心添加路由条目。

    • EnableCenVbrHealthCheck 接口属于异步接口，即系统会先返回一个 RequestId，但该健康检查实例并未创建或修改完成，系统后台的创建任务或修改任务仍在进行。您可以调用 DescribeCenVbrHealthCheck 接口查询健康检查的配置信息，如果可以查到健康检查的配置信息，则表示健康检查创建或者修改完成。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    CenIdstring是

    云企业网实例 ID。

    		cen-hahhfskfkseig****
    VbrInstanceRegionIdstring是

    VBR 实例所在的地域 ID。

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

    		cn-shenzhen
    VbrInstanceIdstring是

    VBR 实例 ID。

    		vbr-wz95o9aylj181n5mzk****
    HealthCheckSourceIpstring是

    指定健康检查源 IP 地址。支持以下两种配置方式：

    • 自动生成源 IP（推荐）：系统将自动分配 100.96.0.0/16 网段内的 IP 地址。

    • 自定义源 IP：源 IP 地址可以是 10.0.0.0/8、192.168.0.0/16、172.16.0.0/12 三个网段内任意一个没有被使用的 IP 地址。但不能与云企业网中要互通的地址冲突，也不能与 VBR 实例的阿里云侧、客户侧 IP 地址冲突。

    		192.XX.XX.1
    HealthCheckTargetIpstring是

    指定健康检查的目标 IP 地址。

    目标 IP 地址为 VBR 实例客户侧 IP 地址。

    		10.XX.XX.1
    VbrInstanceOwnerIdlong否

    VBR 实例所属的阿里云账号（主账号）ID。

    说明 如果 VBR 实例和云企业网实例不属于同一个账号，本参数必填。
    		1250123456123456
    HealthCheckIntervalinteger否

    指定健康检查发送连续探测报文的时间间隔。单位：秒。 默认值：2。取值范围：2~3。

    		2
    HealthyThresholdinteger否

    指定健康检查发送探测报文的个数。单位：个。 取值范围：3~8。默认值：8。

    		8
    HealthCheckOnlyboolean否

    是否只开启健康检查的检测功能。取值：

    • true：是。

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

  > 请确保您有其他方式保证链路的冗余性，否则开启本功能后，可能会导致链路中断。

    • false（默认值）：否。

        系统默认关闭本功能。健康检查检测到链路不通时，如果云企业网实例中存在冗余的路由，则健康检查会立刻触发路由切换使用可用链路。
    		false
    Descriptionstring否

    描述。

    长度为 1~256 个字符，但不能以http:// 或https://开头。

    		testdesc

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		1F59F19C-EFD2-40B1-94D5-65B40CA8E34A

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "1F59F19C-EFD2-40B1-94D5-65B40CA8E34A"
}

    错误码

    HTTP status code错误码错误信息描述
    400RouteConflictThe specified route already exists.输入的路由已存在。
    400Illegal.SourceIpOrTargetIpThe specified source IP address or destination IP address is invalid. 源IP或者目的IP非法。
    400OperationFailed.StatusNotSupportThe VBR or VPC instance to CBN attachment is not in a valid state for the operation.当前VBR或VPC的状态不支持该操作，请稍后重试。
    400OperationFailed.SourceIpUnSupportedThe specified source IP address is unsupported.不支持参数中指定的源IP地址，请修改后重试。
    400InvalidStatus.HealthCheckCan not modify, please delete health check config first.不能修改，请先删除健康检查配置。
    400OperationFailed.IpAddressExhaustedNo IP addresses are available for allocation.可分配的IP地址已耗尽，无法操作。
    400InvalidParameterInvalid parameter.参数不合法。
    400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

    变更历史

    变更时间变更内容概要操作
    2024-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2023-03-27OpenAPI 错误码发生变更查看变更详情
    2023-03-09OpenAPI 错误码发生变更查看变更详情