Creates a virtual border router (VBR).

If you create a VBR for the current Alibaba Cloud account, the state of the VBR becomes Enabled after it is created. If you create a VBR for another Alibaba Cloud account, the state of the VBR becomes Unconfirmed after it is created. The Unconfirmed state indicates that the other Alibaba Cloud account must confirm the operation.

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
Action String Yes CreateVirtualBorderRouter

The operation that you want to perform.

Set the value to CreateVirtualBorderRouter.

PhysicalConnectionId String Yes pc-xxxxxxxxx

The ID of the physical connection.

RegionId String Yes cn-shanghai

The ID of the region where the physical connection is deployed. You can call the DescribeRegions operation to query region IDs.

VlanId Integer Yes 10

The VLAN ID of the VBR. Valid values: 1 to 2999.

Note Only the owner of the physical connection can set this parameter. The VLAN IDs of two VBRs of the same physical connection must be different.
VbrOwnerId Long No 10

The ID of the Alibaba Cloud account that owns the VBR. The default value is the ID of the current account, which indicates the VBR is to be created for the current account.

CircuitCode String No longtel001

The circuit code provided by the Internet service provider (ISP) for the physical connection.

Note Only the owner of the physical connection can set this parameter.
LocalGatewayIp String No 116.62.222.XX

The IP address of the VBR on the Alibaba Cloud side.

PeerGatewayIp String No 116.62.222.XX

The IP address of the peer router interface of the VBR.

Only the owner of the VBR can set or modify the value.

This parameter is required when you create a VBR for the owner of the physical connection. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.

PeeringSubnetMask String No 255.255.255.252

The subnet mask for the IP addresses of the VBR on the Alibaba Cloud side and on the user side.

The two IP addresses must fall within the same subnet.

Description String No Description

The description of the VBR.

The description must be 2 to 256 characters in length. It 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, digits, periods (.), underscores (_), and hyphens (-). The name cannot start with http:// or https://.

ClientToken String No 02fb3da4-130e-11e9-8e44-0016e04*****

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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

LocalIpv6GatewayIp String No 2001:0db8:3c4d:0015:0000:00**:****:1a2b

The IPv6 address of the VBR on the Alibaba Cloud side.

PeerIpv6GatewayIp String No 2001:0db8:3c4d:0015:0000:0000:*****:1***

The IPv6 address of the peer router interface of the VBR.

Only the owner of the VBR can set or modify the value.

This parameter is required when you create a VBR for the owner of the physical connection. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.

PeeringIpv6SubnetMask String No 255.255.255.0

The subnet mask for the IPv6 addresses of the VBR 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 CIDR blocks.

  • true: enables IPv6 CIDR blocks.
  • false: disables IPv6 CIDR blocks.

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]/? Action=CreateVirtualBorderRouter
&PhysicalConnectionId=pc-xxxxxxxxx
&RegionId=cn-shanghai
&VlanId=10
&<Common request parameters>

Sample success responses

XML format

<CreateRouterInterfaceResponse>
      <RequestId>980960B0-2969-40BF-8542-EBB34FD358AB</RequestId>
      <VbrId>vbr-2zecmmvg5gvu8i4t****</VbrId>
</CreateRouterInterfaceResponse>

JSON format

{
    "CreateRouterInterfaceResponse": {
        "RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB",
        "VbrId": "vbr-2zecmmvg5gvu8i4te****"
    }
}

Error codes

HttpCode Error code Error message 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.
400 InvalidPhysicalConnectionId.NotFound The specified PhysicalConnectionId is not found. The error message returned because the specified ID of the physical connection does not exist.
400 InvalidVlanId.Used The specified VlanId has been used. The error message returned because the sepecified 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 PhysicalConnectionId is not set.
400 InvalidPhysicalConnectionId.NotEnabled The specified PhysicalConnectionId is not in Enabled state. The error message returned because the state of the physical connection is invalid. Check the physical connection and try again.
404 InvalidVbrOwnerId.NotFound The specified VbrOwnerId is not valid. The error message returned because VbrOwnerId is set to an invalid value.
400 InvalidVlanId.Malformed The specified VlanId is not valid. The error message returned because VlanId is set to an invalid value.
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.
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.
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 resource description is invalid. The value 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 the current physical connection 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 VBR quota is exhausted.
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.
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.