Creates a virtual border router (VBR).

Description

After you create a VBR, the VBR is in the Enabled state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-shanghai

The ID of the region where the Express Connect circuit is deployed.

You can call the DescribeRegions operation to query the most recent region list.

PhysicalConnectionId String Yes pc-2zextbehcx****

The ID of the Express Connect circuit.

VbrOwnerId Long No 168811111****

The ID of the Alibaba Cloud account to which the VBR belongs.

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 the Express Connect circuit must be different.
CircuitCode String No longtel001

The circuit code of the Express Connect circuit. The circuit code is predefined by the connectivity provider.

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.

When you create a VBR for the owner of the Express Connect circuit, 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.

When you create a VBR for the owner of the Express Connect circuit, this parameter is required.

PeeringSubnetMask String Yes 255.255.255.252

The subnet mask for the IP addresses of the gateway devices on the Alibaba Cloud side and on the user 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 http:// or https://.

Name String No test

The name of the VBR.

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. It cannot start with http:// or https://.

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 value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API 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.

When you create a VBR for the owner of the Express Connect circuit, 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.

When you create a VBR for the owner of the Express Connect circuit, this parameter is required.

PeeringIpv6SubnetMask String No 2408:4004:cc:400::/56

The subnet mask for the IPv6 addresses of the gateway devices on the Alibaba Cloud side and on the user side.

The two IPv6 addresses must fall within the same subnet.

EnableIpv6 Boolean No true

Specifies whether to enable IPv6. Valid values:

  • true: yes
  • false (default): no
Bandwidth Long No 100

The bandwidth value. Unit: Mbit/s.

Response parameters

Parameter Type Example Description
VbrId String vbr-bp1jcg5cmxjbl9xgc****

The ID of the VBR.

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

The ID of the request.

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
&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. The error message returned because a VBR with the VLAN ID 0 already exists. You cannot set the VLAN ID of another VBR to 0 for the Express Connect circuit.
400 InvalidPhysicalConnectionId.NotFound The specified PhysicalConnectionId is not found. The error message returned because the specified Express Connect circuit ID does not exist.
400 InvalidVlanId.Used The specified VlanId has been used. The error message returned because the VLAN ID is being used.
400 MissingParameter The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied. The error message returned because the PhysicalConnectionId parameter is not specified.
400 InvalidPhysicalConnectionId.NotEnabled The specified PhysicalConnectionId is not in Enabled state. The error message returned because 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. The error message returned because the value of VlanId is invalid.
400 InvalidCircuitCode.Malformed The specified CircuitCode is not valid. The error message returned because CircuitCode is set to an invalid value.
400 MissingParameter The input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied. The error message returned because LocalGatewayIp is not set.
400 InvalidLocalGatewayIp.Malformed The specified LocalGatewayIp is not valid. The error message returned because 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. The error message returned because PeerGatewayIp is not set.
400 MissingParameter The input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied. The error message returned because PeeringSubnetMask is not set.
400 InvalidPeeringSubnetMask.Malformed The specified PeeringSubnetMask is not valid. The error message returned because 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 error message returned because the format of the name is invalid.
400 InvalidDescription.Malformed The specifid ?Description? is not valid. The error message returned because the format of 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 error message returned because 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 error message returned because the number of VBRs has reached the upper limit.
400 InvalidIp.NotSameSubnet Local gateway ip and peer gateway ip are not in the same subnet. The error message returned because the IP addresses of the local gateway and the peer gateway do not fall within the same subnet.
400 OperationFailed.PconnExistVlan0Vbr The physical connection has VLAN 0 VBR. You cannot create another VBR. The error message returned because 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. The error message returned because a VBR with the VLAN ID 0 already exists. You cannot set the VLAN ID of another VBR to 0 for the Express Connect circuit.
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The error message returned because outbound traffic is disabled.
400 ResourceNotEnough.Bandwidth The specified resource of Bandwidth is not enough. The error message returned because bandwidth resources are insufficient.
400 OperationUnsupported.VirtualBorderRouterEnableIPv6 The operation failed. The device or region does not support IPv6 functions. The error message returned because the device or region does not support IPv6.
403 Forbidden.LocalGatewayIpNotAllowedByCaller The caller is not allowed to specify the LocalGatewayIp parameter. The error message returned because you are not allowed to set LocalGatewayIp.
403 Forbidden.PeerGatewayIpNotAllowedByCaller The caller is not allowed to specify the PeerGatewayIp parameter. The error message returned because you are not allowed to set PeerGatewayIp.
403 Forbidden.PeeringSubnetMaskNotAllowedByCaller The caller is not allowed to specify the PeeringSubnetMask parameter. The error message returned because you are not allowed to set PeeringSubnetMask.
403 Forbidden.NameNotAllowedByCaller The caller is not allowed to specify the Name parameter. The error message returned because you are not allowed to set Name.
403 Forbidden.DescriptionNotAllowedByCaller The caller is not allowed to specify the Description parameter. The error message returned because you are not allowed to set Description.
404 InvalidRegionId.NotFound The specified RegionId is not found. The error message returned because 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. The error message returned because VbrOwnerId is set to an invalid value.
404 CROSS_BID.FORBIDDEN Create VBR across bid is illegal The error message returned because you are not allowed to create a VBR for another Alibaba Cloud account.

For a list of error codes, visit the API Error Center.