调用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 错误码发生变更 | 查看变更详情 |