Creates a virtual border router (VBR).
Operation description
After you create a VBR, the VBR is in the active state.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the Express Connect circuit. Call the DescribeRegions operation to query the most recent region list. |
cn-shanghai |
| PhysicalConnectionId |
string |
Yes |
The ID of the Express Connect circuit. You can create a VBR for a dedicated or hosted connection. |
pc-2zextbehcx**** |
| VbrOwnerId |
integer |
No |
The account ID of the VBR owner. Default: the current Alibaba Cloud account ID. |
168811111**** |
| VlanId |
integer |
Yes |
The VLAN ID of the VBR. Valid values: 0 to 2999. Note
Only the owner of the Express Connect circuit can set this parameter. The VLAN IDs of two VBRs on the same Express Connect circuit must be different. |
0 |
| CircuitCode |
string |
No |
The circuit code of the Express Connect circuit, provided by the connectivity provider. Note
Only the owner of the Express Connect circuit can set this parameter. |
longtel001 |
| LocalGatewayIp |
string |
No |
The IP address of the VBR. Only the VBR owner can set or modify this parameter. Required when you create a VBR for the Express Connect circuit owner. |
192.168.XX.XX |
| PeerGatewayIp |
string |
No |
The IP address of the gateway device in the data center. Only the VBR owner can set or modify this parameter. Required when you create a VBR for the Express Connect circuit owner. |
116.62.XX.XX |
| PeeringSubnetMask |
string |
No |
The subnet mask for the VBR and data center gateway IP addresses. Both IP addresses must be in the same subnet. |
255.255.255.252 |
| Description |
string |
No |
The description of the VBR. Must be 2 to 256 characters in length and start with a letter. Cannot start with |
desc |
| Name |
string |
No |
The name of the VBR. Must be 2 to 128 characters in length and start with a letter. Can contain letters, digits, underscores (_), and hyphens (-). |
test |
| ClientToken |
string |
No |
The client token that ensures the idempotence of the request. You can use the client to generate the token, but it must be unique across requests. Note
If you do not set this parameter, the system automatically sets ClientToken to the value of RequestId. The value of RequestId may be different for each API request. |
123e4567-e89b-12d3-a456-426655440000 |
| LocalIpv6GatewayIp |
string |
No |
The IPv6 address of the VBR. Only the VBR owner can set or modify this parameter. Required when you create a VBR for the Express Connect circuit owner. |
2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
| PeerIpv6GatewayIp |
string |
No |
The IPv6 address of the gateway device in the data center. Only the VBR owner can set or modify this parameter. Required when you create a VBR for the Express Connect circuit owner. |
2001:XXXX:4:4:4:4:4:4 |
| PeeringIpv6SubnetMask |
string |
No |
The subnet mask for the VBR and data center gateway IPv6 addresses. Both IPv6 addresses must be in the same subnet. |
2408:4004:cc:400::/56 |
| EnableIpv6 |
boolean |
No |
Whether to enable IPv6. Valid values:
|
true |
| Bandwidth |
integer |
No |
The bandwidth of the VBR. Unit: Mbit/s.
|
100 |
| ResourceGroupId |
string |
No |
The resource group ID. For more information about resource group, see What is Resource Management? |
rg-acfmxazb4ph6aiy**** |
| Tags |
array<object> |
No |
The tags. |
|
|
object |
No |
Tag details. |
||
| Key |
string |
No |
The tag key. You must enter at least one tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. Maximum 128 characters. Cannot start with |
FinanceDept |
| Value |
string |
No |
The tag value. You can specify up to 20 tag values. The tag value can be an empty string. Maximum 128 characters. Cannot start with |
FinanceJoshua |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| VbrId |
string |
The ID of the VBR. |
vbr-bp1jcg5cmxjbl9xgc**** |
| RequestId |
string |
The ID of the request. |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
Examples
Success response
JSON format
{
"VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}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. |
| 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. | The specified region ID is invalid. Check whether the service is available in the specified region. |
| 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.