文档

DescribeVbrHa - 查询VBR倒换组

更新时间:

调用DescribeVbrHa接口查询已创建的VBR倒换组。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
CBCE910E-D396-4944-8****
DryRunboolean

是否只预检此次请求。取值范围:

  • true:发送检查请求,不会启动实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过,则返回对应错误。如果检查通过,则返回DRYRUN.SUCCESS

  • false(默认值):发送正常请求,通过检查后直接启动实例。

false
VbrIdstring

VBR 实例 ID。

vbr-bp1jcg5cmxjbl9xgc****
VbrHaIdstring

VBR 倒换组实例 ID。

vbrha-sa1sxheuxtd98****
RegionIdstring

VBR 所属的地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object
CreationTimestring

VBR 的创建时间。

2021-06-08T12:20:55
Statusstring

VBR 倒换组的状态。

  • Creating:创建中。

  • Active:正常。

Active
RequestIdstring

请求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF
Descriptionstring

VBR 倒换组的描述信息。

长度为 2~256 个字符,必须以字母或中文开头,但不能以http://https://开头。

desc
VbrHaIdstring

VBR 倒换组实例 ID。

vbrha-sa1sxheuxtd98****
PeerVbrIdstring

VBR 倒换组中另一个 VBR 的实例 ID。

vbr-bp12mw1f8k3jgygk9****
Namestring

VBR 倒换组名称。

VBRHa
VbrIdstring

VBR 实例 ID。

vbr-bp1jcg5cmxjbl9xgc****
RegionIdstring

VBR 所属的地域 ID。

cn-hangzhou

示例

正常返回示例

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错误码错误信息描述
400MissingParam.VbrHaIdOrVbrIdMissing parameter VBR switch group instance ID or VBR instance ID.缺少参数 VBR 倒换组实例 ID 或者 VBR 实例 ID。
404ResourceNotFound.VbrHaThe VBR HA resource is not found.VBR HA资源没有找到。

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

变更历史

变更时间变更内容概要操作
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情