Creates a virtual border router (VBR).
Usage notes
When you create a VBR, the VBR is in the Enabled state by default.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
| RegionId | String | Yes | cn-shanghai | The ID of the region where the connection is established over the Express Connect circuit. You can call the DescribeRegions operation to query the most recent region list. |
| PhysicalConnectionId | String | Yes | pc-2zextbehcx**** | The Express Connect circuit ID. You can create a VBR for a dedicated connection or a hosted connection. |
| VbrOwnerId | Long | No | 168811111**** | The account ID of the VBR owner. The default value is the ID of the current Alibaba Cloud account. |
| VlanId | Integer | Yes | 0 | 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 of the same Express Connect circuit must be different. |
| CircuitCode | String | No | longtel001 | The circuit code of the Express Connect circuit. The circuit code is provided by the Internect service provider (ISP). Note Only the owner of the Express Connect circuit can set this parameter. |
| LocalGatewayIp | String | Yes | 192.168.XX.XX | The IP address of the gateway device on the Alibaba Cloud side. Only the owner of the VBR can set or modify this parameter. This parameter is required. |
| PeerGatewayIp | String | Yes | 116.62.XX.XX | The IP address of the gateway device on the user side. Only the owner of the VBR can set or modify this parameter. This parameter is required. |
| PeeringSubnetMask | String | Yes | 255.255.255.252 | The subnet mask of the IP addresses of the gateway devices on the user side and Alibaba Cloud side. The two IP addresses must fall within the same subnet. |
| Description | String | No | desc | The description of the VBR. The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with |
| Name | String | No | test | The VBR name. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. |
| ClientToken | String | No | 123e4567-e89b-12d3-a456-426655440000 | 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. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request. |
| Action | String | Yes | CreateVirtualBorderRouter | The operation that you want to perform. Set the value to CreateVirtualBorderRouter. |
| LocalIpv6GatewayIp | String | No | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b | The IPv6 address of the gateway device on the Alibaba Cloud side. Only the owner of the VBR can set or modify this parameter. This parameter is required. |
| PeerIpv6GatewayIp | String | No | 2001:XXXX:4:4:4:4:4:4 | The IPv6 address of the gateway device on the user side. Only the owner of the VBR can set or modify this parameter. This parameter is required. |
| PeeringIpv6SubnetMask | String | No | 2408:4004:cc:400::/56 | The subnet mask of the IPv6 addresses of the gateway devices on the user side and Alibaba Cloud side. The two IPv6 addresses must fall within the same subnet. |
| EnableIpv6 | Boolean | No | true | Specifies whether to enable IPv6. Valid values:
|
| Bandwidth | Long | No | 100 | The bandwidth of the VBR. Unit: Mbit/s.
|
| ResourceGroupId | String | No | rg-acfmxazb4ph6aiy**** | The resource group ID. For more information about resource groups, see the "Resource Group" section of the What is Resource Management? topic. |
| Tags.N.Key | String | No | FinanceDept | The key of tag N to add to the resource. You must enter at least one tag key and at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain |
| Tags.N.Value | String | No | FinanceJoshua | The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, but cannot contain |
Response parameters
| Parameter | Type | Example | Description |
| VbrId | String | vbr-bp1jcg5cmxjbl9xgc**** | The VBR ID. |
| RequestId | String | 4EC47282-1B74-4534-BD0E-403F3EE64CAF | The request ID. |
Examples
Sample requests
http(s)://[Endpoint]/?RegionId=cn-shanghai
&PhysicalConnectionId=pc-2zextbehcx****
&VlanId=0
&CircuitCode=longtel001
&LocalGatewayIp=192.168.XX.XX
&PeerGatewayIp=116.62.XX.XX
&PeeringSubnetMask=255.255.255.252
&Description=desc
&Name=test
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&Action=CreateVirtualBorderRouter
&LocalIpv6GatewayIp=2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
&PeerIpv6GatewayIp=2001:XXXX:4:4:4:4:4:4
&PeeringIpv6SubnetMask=2408:4004:cc:400::/56
&EnableIpv6=true
&Bandwidth=100
&ResourceGroupId=rg-acfmxazb4ph6aiy****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&<Common request parameters>Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateVirtualBorderRouterResponse>
<VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
<RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</CreateVirtualBorderRouterResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"VbrId" : "vbr-bp1jcg5cmxjbl9xgc****",
"RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}Error codes
| HttpCode | Error code | Error message | Description |
| 400 | OperationFailed.PconnAllocateVlan0 | Vlan 0 Vbr cannot share the physical connection with another Vbr. | A VBR whose VLAN ID is 0 already exists in the Express Connect circuit. You are not allowed to create another VBR whose VLAN ID is 0. |
| 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. | CidrBlock 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. | The specified VLAN ID is being used. |
| 400 | MissingParameter | The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied. | PhysicalConnectionId is not specified. |
| 400 | InvalidPhysicalConnectionId.NotEnabled | The specified PhysicalConnectionId is not in Enabled state. | The Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again. |
| 400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | VlanId is set to an invalid value. |
| 400 | InvalidCircuitCode.Malformed | The specified CircuitCode is not valid. | CircuitCode is set to an invalid value. |
| 400 | MissingParameter | The input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied. | LocalGatewayIp is not specified. |
| 400 | InvalidLocalGatewayIp.Malformed | The specified LocalGatewayIp is not valid. | The IP address of the local gateway is invalid. |
| 400 | MissingParameter | The input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied. | PeerGatewayIp is not specified. |
| 400 | MissingParameter | The input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied. | PeeringSubnetMask is not specified. |
| 400 | InvalidPeeringSubnetMask.Malformed | The specified PeeringSubnetMask is not valid. | PeeringSubnetMask is set to an invalid value. Check whether PeeringSubnetMask is set to a valid value. |
| 400 | InvalidName.Malformed | The specified ?Name? is not valid. | The format of the name is invalid. |
| 400 | InvalidDescription.Malformed | The specifid ?Description? is not valid. | The specified 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. | The number of VBRs of each Express Connect circuit has reached the upper limit. Reduce the number of VBRs and try again. |
| 400 | QuotaExceeded.freevbr | Free virtual boarder router quota exceed. | The number of VBRs has reached the upper limit. |
| 400 | MissingParameter | LocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null. | The following parameters are not specified: LocalGatewayIp, peerGatewayIp, and peeringSubnetMask. |
| 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 quota is exceeded. |
| 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 quota is exceeded. |
| 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 | OperationFailed.PconnExistVlan0Vbr | The physical connection has VLAN 0 VBR. You cannot create another VBR. | A VBR whose VLAN ID is 0 already exists in the Express Connect circuit. You are not allowed to create other VBRs. |
| 400 | OperationFailed.Vlan0VbrUnSharePconn | VLAN 0 VBR cannot share the physical connection with another VBR. | A VBR whose VLAN ID is 0 already exists in the Express Connect circuit. You are not allowed to create another VBR whose VLAN ID is 0. |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | The outbound data transfer billing is disabled. |
| 400 | ResourceNotEnough.Bandwidth | The specified resource of Bandwidth is not enough. | The bandwidth resources are insufficient. |
| 400 | OperationUnsupported.VirtualBorderRouterEnableIPv6 | The operation failed. The device or region does not support IPv6 functions. | The device or region does not support IPv6. |
| 400 | Forbidden.OwnerAliUid | RAM account or Partner account is forbidden to be OwnerAliUid. | You cannot set the VbrOwnerId as the VBR owner account. You must set VbrOwnerId to the ID of a RAM user or a partner 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 when 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. |
| 403 | Forbidden.LocalGatewayIpNotAllowedByCaller | The caller is not allowed to specify the LocalGatewayIp parameter. | You are not allowed to set LocalGatewayIp. |
| 403 | Forbidden.PeerGatewayIpNotAllowedByCaller | The caller is not allowed to specify the PeerGatewayIp parameter. | You are not allowed to set PeerGatewayIp. |
| 403 | Forbidden.PeeringSubnetMaskNotAllowedByCaller | The caller is not allowed to specify the PeeringSubnetMask parameter. | You are not allowed to set PeeringSubnetMask. |
| 403 | Forbidden.NameNotAllowedByCaller | The caller is not allowed to specify the Name parameter. | You are not allowed to set Name. |
| 403 | Forbidden.DescriptionNotAllowedByCaller | The caller is not allowed to specify the Description parameter. | You are not allowed to set Description. |
| 404 | InvalidRegionId.NotFound | The specified RegionId is not found. | The specified RegionId is invalid. Check whether the service is available in the specified region. |
| 404 | InvalidVbrOwnerId.NotFound | The specified VbrOwnerId is not valid. | VbrOwnerId is set to an invalid value. |
| 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 when the access device is disabled. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. |
For a list of error codes, see Service error codes.