Set Up VBR High Availability with CreateVbrHa API - Express Connect - Alibaba Cloud - Express Connect

Creates a VBR failover group by calling the CreateVbrHa operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateVbrHa

create

*VirtualBorderRouter

acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

None

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the VBR failover group. The description must be 2 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`.	VBRHa
Name	string	No	The name of the VBR failover group.	VBRHa
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId as the ClientToken. The RequestId may be different for each API request.	CBCE910E-D396-4944-8****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and instance status. If the check fails, the corresponding error is returned. If the check succeeds, `DRYRUN.SUCCESS` is returned. false (default): sends the request. After the request passes the check, the instance is started.	false
VbrId	string	Yes	The instance ID of the VBR.	vbr-bp1jcg5cmxjbl9xgc****
PeerVbrId	string	Yes	The instance ID of the other VBR in the VBR failover group.	vbr-bp12mw1f8k3jgygk9****
RegionId	string	Yes	The region ID of the VBR.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
VbrHaId	string	The instance ID of the VBR failover group.	vbrha-sa1sxheuxtd98****
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.VbrCenNotConsistent	The VBR and the peer VBR are attached to different CENs.
400	OperationFailed.VbrAliUidNotConsistent	The VBR and the peer VBR belong to different AliUids.
400	OperationFailed.VbrAccessDeviceSame	The VBR and the peer VBR are in the same device.
400	OperationFailed.VbrBandWidthExceed	The VBR bandwidth exceeds the limit.
400	OperationFailed.VbrInUsedByOtherHa	The VBR is used by another VBR HA.
400	OperationFailed.VbrBgpPeerNotEnableBfd	The VBR BGP has not enabled BFD.
400	OperationFailed.VbrCenNotRelation	The VBR is not attached to any CEN.
400	OperationFailed.BgpGroupLocalAsnMustSameEachOther	VBR bgpGroup local asn must same each other.	The BGP group AS numbers of the VBRs in the switching group must be consistent with each other.
400	IllegalParam.BgpGroupLocalAsn	Vbr bgp group local asn must same with ecr asn.	The Alibaba Cloud BGP AS number of the BGP group must be the same as that of the ECR.
404	ResourceNotFound.Vbr	The VBR resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.