CreateVirtualBorderRouter - Elastic Compute Service - Alibaba Cloud Documentation Center

CreateVirtualBorderRouter

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - CreateVirtualBorderRouter for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Virtual Border Router (VBR) is located. You can call the `DescribeRegions` operation to get the latest list of regions.
PhysicalConnectionId	string	Yes	The ID of the physical connection.
VbrOwnerId	integer	No	The ID of the Alibaba Cloud account that owns the VBR. Specify this parameter when creating a VBR for another account.
VlanId	integer	Yes	The VLAN ID of the VBR. Valid values: 0 to 4095. A value of 0 indicates that the VBR is connected to the physical connection in Layer 3 router mode.
CircuitCode	string	No	The circuit code of the physical connection. This code is provided by your connectivity provider.
LocalGatewayIp	string	No	The IP address of the VBR gateway in Alibaba Cloud.
PeerGatewayIp	string	No	The IP address of the gateway in your on-premises data center.
PeeringSubnetMask	string	No	The peering subnet mask for the IP addresses of the local gateway and the peer gateway.
Description	string	No	The description of the VBR. The description must be 2 to 256 characters long and cannot start with `http://` or `https://`.
Name	string	No	The name of the VBR. The name must be 2 to 128 characters long, start with a letter, and can contain only letters, digits, periods (.), underscores (_), and hyphens (-).
ClientToken	string	Yes	A client token to ensure that the request is idempotent. You can generate this token on your client, but you must ensure that it is unique for each request. The token can contain only ASCII characters and cannot be longer than 64 characters.
ClientToken	string	No	A client token to ensure that the request is idempotent. You can generate this token on your client, but you must ensure that it is unique for each request. The token can contain only ASCII characters and cannot be longer than 64 characters.
UserCidr	string	No	The CIDR block of your on-premises network. Required when the VBR is connected to a Cloud Enterprise Network (CEN) instance.

Response elements

Element	Type	Description	Example
	object	The response data.
VbrId	string	The ID of the virtual border router.
RequestId	string	The ID of the request.

Examples

Success response

JSON format

{
  "VbrId": "",
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPhysicalConnectionId.NotFound	The specified PhysicalConnectionId is not found.
400	InvalidVlanId.Used	The specified VlanId has been used.	The specified VLAN ID is already 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.	The specified VlanId is invalid.
400	InvalidCircuitCode.Malformed	The specified CircuitCode is not valid.	The specified CircuitCode parameter is invalid.
400	InvalidLocalGatewayIp.Malformed	The specified LocalGatewayIp is not valid.	The specified LocalGatewayIp parameter is invalid.
400	InvalidPeeringSubnetMask.Malformed	The specified PeeringSubnetMask is not valid.	The specified PeeringSubnetMask parameter is invalid.
400	InvalidName.Malformed	The specified Name is not valid.	The specified Name parameter is invalid.
400	InvalidDescription.Malformed	The specifid Description is not valid.	The 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.	The maximum number of VBRs that can be associated with a physical connection has been reached.
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.
400	QuotaExceeded.CrossUserVBRPerUser	Cross virtual boarder router per user quota exceed.
400	OperationFailed.VlanIdInUse	Operation failed because vlanId is in use.
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.	You are not allowed to set the PeerGatewayIp parameter.
403	Forbidden.PeeringSubnetMaskNotAllowedByCaller	The caller is not allowed to specify the PeeringSubnetMask parameter.	You are not allowed to set the PeeringSubnetMask parameter.
403	Forbidden.NameNotAllowedByCaller	The caller is not allowed to specify the Name parameter.	You are not allowed to use the Name parameter.
403	Forbidden.DescriptionNotAllowedByCaller	The caller is not allowed to specify the Description parameter.	The caller is not allowed to specify the Description.
404	InvalidRegionId.NotFound	The specified RegionId is not found.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.
404	InvalidVbrOwnerId.NotFound	The specified VbrOwnerId is not valid.
404	OperationFailed.AccessDeviceDisabled	Access device is disabled and can not create vbr.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.