CreateVirtualBorderRouter - Create a virtual border router - Express Connect

Creates a Virtual Border Router (VBR) instance by calling the CreateVirtualBorderRouter operation.

Operation description

After a VBR instance is created, the VBR instance status is active.

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:CreateVirtualBorderRouter

create

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

*VirtualBorderRouter

acs:vpc:{#regionId}:{#AccountId}:virtualborderrouter/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
PhysicalConnectionId	string	Yes	The instance ID of the Express Connect circuit. You can create a VBR instance for a dedicated Express Connect circuit or for shared Express Connect circuits.	pc-2zextbehcx****
VbrOwnerId	integer	No	The account ID of the VBR instance owner. The default value is the Alibaba Cloud account ID used to logon.	168811111****
VlanId	integer	Yes	The VLAN ID of the VBR instance. Valid values: 0 to 2999. Note Only the owner of the Express Connect circuit can specify this parameter. The VLAN IDs of two VBR instances on the same Express Connect circuit must be different.	0
CircuitCode	string	No	The circuit code provided by the carrier for the Express Connect circuit. Note Only the owner of the Express Connect circuit can specify this parameter.	longtel001
LocalGatewayIp	string	No	The Alibaba Cloud-side IP address of the VBR instance. Only the VBR owner can specify or modify this property. This parameter is required when you create a VBR instance for the owner of the Express Connect circuit.	192.168.XX.XX
PeerGatewayIp	string	No	The customer-side IP address of the VBR instance. Only the VBR owner can specify or modify this property. This parameter is required when you create a VBR instance for the owner of the Express Connect circuit.	116.62.XX.XX
PeeringSubnetMask	string	No	The subnet mask for the Alibaba Cloud-side and customer-side IP addresses of the VBR instance. The two IP addresses must be in the same subnet.	255.255.255.252
Description	string	No	The description of the VBR instance. 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://`.	desc
Name	string	No	The name of the VBR instance. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, underscores (_), and hyphens (-). It cannot start with `http://` or `https://`.	test
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter. Make sure that the value is unique among different requests. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	123e4567-e89b-12d3-a456-426655440000
LocalIpv6GatewayIp	string	No	The Alibaba Cloud-side IPv6 address of the VBR instance. Only the VBR owner can specify or modify this property. This parameter is required when you create a VBR instance for the owner of the Express Connect circuit.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PeerIpv6GatewayIp	string	No	The customer-side IPv6 address of the VBR instance. Only the VBR owner can specify or modify this property. This parameter is required when you create a VBR instance for the owner of the Express Connect circuit.	2001:XXXX:4:4:4:4:4:4
PeeringIpv6SubnetMask	string	No	The subnet mask for the Alibaba Cloud-side and customer-side IPv6 addresses of the VBR instance. The two IPv6 addresses must be in the same subnet.	2408:4004:cc:400::/56
EnableIpv6	boolean	No	Specifies whether to enable IPv6. Valid values: true: Enabled. false (default): Disabled.	true
Bandwidth	integer	No	The bandwidth value of the VBR instance. Unit: Mbit/s. When you create a VBR instance for a dedicated Express Connect circuit, valid values are 50, 100, 200, 300, 400, 500, 1000, 2048, 5120, 8192, 10240, 20480, 40960, 50120, 61440, and 102400. When you create a VBR instance for shared Express Connect circuits, you do not need to configure this parameter. The bandwidth of the VBR is the bandwidth of the shared Express Connect circuits that was specified in Settings when the shared Express Connect circuits were created.	100
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	The tags of the resource.
	object	No	The tag.
Key	string	No	The tag key of the resource. You must specify at least 1 tag key and can specify at most 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
VbrId	string	The VBR instance ID.	vbr-bp1jcg5cmxjbl9xgc****

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "VbrId": "vbr-bp1jcg5cmxjbl9xgc****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.PconnAllocateVlan0	Vlan 0 Vbr cannot share the physical connection with another Vbr.	The operation failed because VLAN 0 is set to a VBR associated with the Express Connect circuit and you cannot set VLAN 0 to other VBRs.
400	IllegalParam.IpAddress	The specified IpAddress (%s) is illegal.	The IpAddress parameter is set to an invalid value.
400	IllegalParam.CidrBlock	The specified CidrBlock (%s) is illegal.	The CidrBlock parameter is set to an invalid value.
400	InvalidPhysicalConnectionId.NotFound	The specified PhysicalConnectionId is not found.	The specified Express Connect circuit ID does not exist.
400	InvalidVlanId.Used	The specified VlanId has been used.
400	MissingParameter	The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied.
400	InvalidPhysicalConnectionId.NotEnabled	The specified PhysicalConnectionId is not in Enabled state.
400	InvalidVlanId.Malformed	The specified VlanId is not valid.
400	InvalidCircuitCode.Malformed	The specified CircuitCode is not valid.
400	InvalidLocalGatewayIp.Malformed	The specified LocalGatewayIp is not valid.
400	InvalidPeeringSubnetMask.Malformed	The specified PeeringSubnetMask is not valid.	PeeringSubnetMask is set to an invalid value.
400	InvalidName.Malformed	The specified ?Name? is not valid.
400	InvalidDescription.Malformed	The specifid ?Description? is not valid.	The error message returned because the specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	QuotaExceeded.vbrPerpConn	Virtual boarder router per PhysicalConnection quota exceed.
400	QuotaExceeded.freevbr	Free virtual boarder router quota exceed.
400	InvalidIp.NotSameSubnet	Local gateway ip and peer gateway ip are not in the same subnet.	The IP addresses of the local gateway and the peer gateway do not fall within the same subnet.
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	Your requests are too frequent. Try again later.
400	QuotaExceeded.CrossUserVBRPerUser	Cross virtual boarder router per user quota exceed.	The upper limit is reached.
400	OperationFailed.VlanIdInUse	Operation failed because vlanId is in use.	The VLAN ID is already used.
400	QuotaExceeded.SameAccountVBRPerPconn	Same account virtual boarder router per physicalConnection quota exceed.	The number of VBRs exceeds the upper limit.
400	QuotaExceeded.VbrPerPconnPortSpec	Quota exceed for current port spec	The upper limit is reached.
400	QuotaExceeded.VbrPerAccessDevice	Virtual boarder router per access device quota exceed.	The number of devices exceeds the upper limit.
400	OperationUnsupported.IPV6ForThisRegion	This Region do not support IPV6.	The region does not support IPv6.
400	VbrBandwidthExceed	VBR bandwidth exceed for this physical connection.	The bandwidth of the VBR exceeds the upper limit supported by the Express Connect circuit.
400	OperationFailed.PconnExistVlan0Vbr	The physical connection has VLAN 0 VBR. You cannot create another VBR.	You cannot create other VBRs for this Express Connect circuit because a VBR with VLAN 0 is already created for this Express Connect circuit.
400	OperationFailed.Vlan0VbrUnSharePconn	VLAN 0 VBR cannot share the physical connection with another VBR.	You cannot create a VBR with VLAN 0 for this Express Connect circuit because another VBR with VLAN 0 is already created for this Express Connect circuit.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.
400	ResourceNotEnough.Bandwidth	The specified resource of Bandwidth is not enough.	The specified resource of Bandwidth is insufficient.
400	OperationUnsupported.VirtualBorderRouterEnableIPv6	The operation failed. The device or region does not support IPv6 functions.	The operation failed because the device or region does not support IPv6.
400	IllegalParam.OwnerAliUid	The param of VbrOwnerId is illegal.	The UID of the resource owner is invalid.
400	Forbidden.OwnerAliUid	RAM account or Partner account is forbidden to be OwnerAliUid.	You must set VbrOwnerId to the ID of a RAM user or a partner account. You cannot use the VBR owner account.
400	OperationDenied.VPconn	Vpconn is forbidden to create vbr for another account.	You cannot create a VBR for another account.
400	OperationFailed.NotConsistentWithVpconn	VBR bandwidth is not consistent with vpconn	The bandwidth value of the VBR is not the same as the bandwidth value of the hosted connection to which the VBR belongs.
400	IllegalParam.Bandwidth	The param of bandwidth is illegal.	The Bandwidth parameter is set to an invalid value.
400	OperationFailed.VirtualPhysicalConnectionExistVBR	The virtual physical connect has already created another VBR.	You cannot create another VBR for the hosted connection because a VBR is already created.
400	ResourceNotInResourceGroup	The specified resource is not in the specified ResourceGroup.	The specified resource does not belong to the resource group.
400	IncorrectStatus.VirtualPhysicalConnection	The status of PhysicalConnection [%s] is incorrect.	The status of the shared Express Connect circuit [%s] is invalid.
400	EcAssociatedQoSPconnNotAllowCreateCrossAccountVbr	The specified Pconn associated with Qos is not allowed to create cross account VBR.Please contact the business manager.	Shared physical lines bound with QoS policies do not allow cross-account virtual border routers to be created. Contact the business manager.
400	OperationFailed.VbrBandWidthMust0InVlan0Vbr	The operation is failed because of VbrBandWidthMust0InVlan0Vbr.	Operation failed, speed limit configuration is not allowed.
400	OperationDenied.PhysicalConnectionNotSupportMPBGPAndMPBGP-v6	The operation is not allowed because this physical connection not support MPBGP and MPBGP-v6.	The operation is not allowed because the current physical port does not support advanced capabilities such as MPBGP and MPBGP-v6.
400	IncorrectBusinessStatus.PhysicalConnection	Invalid physical connection business status.	The current business status of the physical connection does not support operations.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred.
403	Forbidden.LocalGatewayIpNotAllowedByCaller	The caller is not allowed to specify the LocalGatewayIp parameter.
403	Forbidden.PeerGatewayIpNotAllowedByCaller	The caller is not allowed to specify the PeerGatewayIp parameter.
403	Forbidden.PeeringSubnetMaskNotAllowedByCaller	The caller is not allowed to specify the PeeringSubnetMask parameter.
403	Forbidden.NameNotAllowedByCaller	The caller is not allowed to specify the Name parameter.
403	Forbidden.DescriptionNotAllowedByCaller	The caller is not allowed to specify the Description parameter.
404	InvalidRegionId.NotFound	The specified RegionId is not found.
404	InvalidVbrOwnerId.NotFound	The specified VbrOwnerId is not valid.
404	CROSS_BID.FORBIDDEN	Create VBR across bid is illegal	You are not allowed to create a VBR for another Alibaba Cloud account.
404	OperationFailed.AccessDeviceDisabled	Access device is disabled and can not create vbr.	You cannot create a VBR because the access device is disabled.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.