Queries virtual border router (VBR) failover groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVbrHa

The operation that you want to perform.

Set the value to DescribeVbrHa.

RegionId String Yes cn-shanghai

The ID of the region where the VBR is deployed.

ClientToken String No CBCE910E-D396-4944-8****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun Boolean No false

Specifies whether to precheck the request. Valid values:

  • true: prechecks the request without performing the operation. The system checks the request format, instance status, and whether the required parameters are specified. An error message is returned if the request fails the precheck. If the request passes the precheck, DRYRUN.SUCCESS is returned.
  • false: prechecks the request. After the request passes the precheck, the operation is performed.
VbrId String No vbr-bp1jcg5cmxjbl9xgc****

The ID of the VBR.

VbrHaId String No vbrha-sa1sxheuxtd98****

The ID of the VBR failover group.

Response parameters

Parameter Type Example Description
CreationTime String 2021-06-08T12:20:55

The time when the VBR was created.

Description String desc

The description of the VBR failover group.

The description must be 2 to 256 characters in length. It must start with a letter and cannot start with http://or https://.

Name String VBRHa

The name of the VBR failover group.

PeerVbrId String vbr-bp12mw1f8k3jgygk9****

The ID of the other VBR in the VBR failover group.

RegionId String cn-hangzhou

The ID of the region where the VBR is deployed.

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Status String Active

The state of the VBR failover group.

  • Creating: The VBR failover group is being created.
  • Active: The VBR failover group is running as expected.
VbrHaId String vbrha-sa1sxheuxtd98****

The ID of the VBR failover group.

VbrId String vbr-bp1jcg5cmxjbl9xgc****

The ID of the VBR.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVbrHa
&RegionId=cn-shanghai
&VbrHaId=vbrha-sa1******
&VbrId=vbr-bp1jcg5cm******
&<Common request parameters>

Sample success responses

XML format 

<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 format 

{
    "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"
    }
}

Error codes

HttpCode Error code Error message Description
404 ResourceNotFound.VbrHa The VBR HA resource is not found. The error message returned because the high availability resources of the VBR are not found.

For a list of error codes, visit the API Error Center.