查詢指定地域內邊界路由器（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 |
返回參數
示例
正常返回示例
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 返回結構發生變更 | 查看變更詳情 |