All Products
Search
Document Center

Virtual Private Cloud:CreateVbrHa

Last Updated:Dec 02, 2023

Creates a virtual border router (VBR) failover group.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CreateVbrHaWrite
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DescriptionstringNo

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://.

VBRHa
NamestringNo

The name of the VBR failover group.

VBRHa
ClientTokenstringNo

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.

CBCE910E-D396-4944-8****
DryRunbooleanNo

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.
false
VbrIdstringYes

The ID of the VBR.

vbr-bp1jcg5cmxjbl9xgc****
PeerVbrIdstringYes

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

vbr-bp12mw1f8k3jgygk9****
RegionIdstringYes

The ID of the region where the VBR is deployed.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
VbrHaIdstring

The ID of the VBR failover group.

vbrha-sa1sxheuxtd98****
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400OperationFailed.VbrCenNotConsistentThe VBR and the peer VBR are attached to different CENs.
400OperationFailed.VbrAliUidNotConsistentThe VBR and the peer VBR belong to different AliUids.
400OperationFailed.VbrAccessDeviceSameThe VBR and the peer VBR are in the same device.
400OperationFailed.VbrBandWidthExceedThe VBR bandwidth exceeds the limit.
400OperationFailed.VbrInUsedByOtherHaThe VBR is used by another VBR HA.
400OperationFailed.VbrBgpPeerNotEnableBfdThe VBR BGP has not enabled BFD.
400OperationFailed.VbrCenNotRelationThe VBR is not attached to any CEN.
404ResourceNotFound.VbrThe VBR resource is not found.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-11API Description Update,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404