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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeVbrHa

要执行的操作。

取值：DescribeVbrHa。

RegionId String 是 cn-shanghai

VBR所属的地域ID。
ClientToken String 否 CBCE910E-D396-4944-8****

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

由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符。

DryRun Boolean 否 false

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

  • true：发送检查请求，不会启动实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回DRYRUN.SUCCESS。
  • false（默认值）：发送正常请求，通过检查后直接启动实例。
VbrId String 否 vbr-bp1jcg5cmxjbl9xgc****

VBR实例ID。
VbrHaId String 否 vbrha-sa1sxheuxtd98****

VBR倒换组实例ID。

返回数据

名称 类型 示例值 描述
CreationTime String 2021-06-08T12:20:55

VBR的创建时间。
Description String desc

VBR倒换组的描述信息。

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

Name String VBRHa

VBR倒换组名称。
PeerVbrId String vbr-bp12mw1f8k3jgygk9****

VBR倒换组中另一个VBR的实例ID。
RegionId String cn-hangzhou

VBR所属的地域ID。
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。
Status String Active

VBR倒换组的状态。

  • Creating：创建中。
  • Active：正常。
VbrHaId String vbrha-sa1sxheuxtd98****

VBR倒换组实例ID。
VbrId String vbr-bp1jcg5cmxjbl9xgc****

VBR实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVbrHa
&RegionId=cn-shanghai
&VbrHaId=vbrha-sa1******
&VbrId=vbr-bp1jcg5cm******
&<公共请求参数>

正常返回示例

XML格式 

<DescribeVbrHaResponse>
      <Status>Active</Status>
      <VbrHaId>vbrha-sa1sxheuxtd98****</VbrHaId>
      <Description>desc</Description>
      <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
      <CreationTime>2021-06-08T12:20:55</CreationTime>
      <VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
      <RegionId>cn-hangzhou</RegionId>
      <PeerVbrId>vbr-bp12mw1f8k3jgygk9****</PeerVbrId>
      <Name>VBRHa</Name>
</DescribeVbrHaResponse>

JSON格式 

{
    "DescribeVbrHaResponse": {
        "Status": "Active",
        "VbrHaId": "vbrha-sa1sxheuxtd98****",
        "Description": "desc",
        "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
        "CreationTime": "2021-06-08T12:20:55",
        "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
        "RegionId": "cn-hangzhou",
        "PeerVbrId": "vbr-bp12mw1f8k3jgygk9****",
        "Name": "VBRHa"
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound.VbrHa The VBR HA resource is not found. VBR HA资源没有找到。

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