全部產品
Search

搜尋本產品

    Cloud Enterprise Network：DescribeCenVbrHealthCheck - 查詢邊界路由器（VBR）健全狀態檢查資訊

    文件中心

    Cloud Enterprise Network：DescribeCenVbrHealthCheck - 查詢邊界路由器（VBR）健全狀態檢查資訊

    更新時間：Aug 07, 2025

    查詢指定地區內邊界路由器（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

    integer

    否

    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

    object

    VbrHealthCheck

    array<object>

    VBR 執行個體的健全狀態檢查配置資訊。

    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. 帳號無許可權操作。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。