Creates a virtual border router (VBR) failover group.

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 CreateVbrHa

The operation that you want to perform.

Set the value to CreateVbrHa.

PeerVbrId String Yes vbr-bp12mw1f8k3jgygk9****

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

RegionId String Yes cn-hangzhou

The ID of the region where the VBR is deployed.

VbrId String Yes vbr-bp1jcg5cmxjbl9xgc****

The ID of the VBR.

Description String No VBRHa

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 No VBRHa

The name of the VBR failover group.

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

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

The client token must be unique among different requests. It 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.

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

VbrHaId String vbrha-sa1sxheuxtd98****

The ID of the VBR failover group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateVbrHa
&PeerVbrId=vbr-bp12mw1f8k3jgygk9****
&RegionId=cn-hangzhou
&VbrId=vbr-bp1jcg5cmxjbl9xgc****
&<Common request parameters>

Sample success responses

XML format 

<CreateVbrHaResponse>
      <VbrHaId>vbrha-sa1sxheuxtd98****</VbrHaId>
      <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</CreateVbrHaResponse>

JSON format 

{
    "CreateVbrHaResponse": {
        "VbrHaId": "vbrha-sa1sxheuxtd98****",
        "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
    }
}

Error codes

HttpCode Error code Error message Description
404 ResourceNotFound.Vbr The VBR resource is not found. The error message returned because the VBR is not found.
400 OperationFailed.VbrCenNotConsistent The VBR and the peer VBR are attached to different CENs. The error message returned because the VBRs are attached to different Cloud Enterprise Network (CEN) instances.
400 OperationFailed.VbrAliUidNotConsistent The VBR and the peer VBR belong to different AliUids. The error message returned because the VBRs belong to different accounts.
400 OperationFailed.VbrAccessDeviceSame The VBR and the peer VBR are in the same device. The error message returned because the VBRs belong to the same device.
400 OperationFailed.VbrBandWidthExceed The VBR bandwidth exceeds the limit. The error message returned because the bandwidth of the VBR has reached the upper limit.
400 OperationFailed.VbrInUsedByOtherHa The VBR is used by another VBR HA. The error message returned because the VBRs are already used in another VBR failover group.
400 OperationFailed.VbrBgpPeerNotEnableBfd The VBR BGP has not enabled BFD. The error message returned because Border Gateway Protocol (BGP) groups of the VBR do not have Bidirectional Forwarding Detection (BFD) enabled.
400 OperationFailed.VbrCenNotRelation The VBR is not attached to any CEN. The error message returned because the VBR is not attached to a CEN instance.

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