調用DescribeVbrHa接口查詢已創建的VBR倒換組。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:DescribeVbrHa | get | *VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| CBCE910E-D396-4944-8**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值范圍：
| false |
| VbrId | string | 否 | VBR 實例 ID。 | vbr-bp1jcg5cmxjbl9xgc**** |
| VbrHaId | string | 否 | VBR 倒換組實例 ID。 | vbrha-sa1sxheuxtd98**** |
| RegionId | string | 是 | VBR 所屬的地域 ID。 | cn-shanghai |
返回參數
示例
正常返回示例
JSON格式
{
"CreationTime": "2021-06-08T12:20:55",
"Status": "Active",
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"Description": "desc",
"VbrHaId": "vbrha-sa1sxheuxtd98****",
"PeerVbrId": "vbr-bp12mw1f8k3jgygk9****",
"Name": "VBRHa",
"VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
"RegionId": "cn-hangzhou"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingParam.VbrHaIdOrVbrId | Missing parameter VBR switch group instance ID or VBR instance ID. | 缺少參數 VBR 倒換組實例 ID 或者 VBR 實例 ID。 |
| 404 | ResourceNotFound.VbrHa | The VBR HA resource is not found. | VBR HA資源沒有找到。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-11 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |