edit-icon download-icon

CreateVirtualBorderRouter

Last Updated: Apr 09, 2018

Description

Create a Virtual Border Router (VBR).

Each leased line (physical connection) can associate with two VBRs, one belongs to your own account and the other one belongs to another account:

  • If you create a VBR using your account, the status of the VBR is Enabled after the API is called.

  • If you create a VBR using another account, the status of the VBR is Unconfirmed after the API is called.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: CreateVirtualBorderRouter

RegionId String Yes

The region of the physical connection.

You can obtain the region ID by calling the DescribeRegions API.

PhysicalConnectionId String Yes The ID of the physical connection.
VbrOwnerId String No The account ID of the VBR. The default value is account ID of the user who is calling the API.
VlanId Integer Yes

The VLAN ID of the VBR. Valid value: [1, 2999].

The VLAN IDs of two VBRs of the same physical connection must be different.

Note: Only the owner of the physical connection can specify this parameter.

CircuitCode String No

The circuit code provided by the network operator for the physical connection.

Note: Only the owner of the physical connection can specify this parameter.

LocalGatewayIp String No The Alibaba Cloud-Side IP address used as the gateway to connect to the local IDC.
PeerGatewayIp String No The customer-side IP address used as the gateway to connect to VPC.
PeeringSubnetMask String No

The subnet mask of the Alibaba Cloud-side IP address and the customer-side IP address.

The two IP addresses must be in the same subnet.

Name String No

The name of the VBR.

The name must start with an English letter, but cannot start withhttp:// or https://.

The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens.

Description String No

The description of the VBR.

The description must start with English letters, but cannot start with http:// or https://.

The description can contain from 2 to 256 characters.

ClientToken String Yes

A client token used to guarantee the idempotence of requests. This parameter value is generated by the client and must be unique. It cannot exceed 64 ASCII characters.

For more information, see How to ensure idempotence.

Response parameters

Name Type Description
RequestId String The ID of the request.
VbrId String The ID of the VBR.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=CreateVirtualBorderRouter
  2. &PhysicalConnectionId=pc-2zeoaxkq3jotxxxxxxxx
  3. &RegionId=cn-hangzhou
  4. &VlanId=10
  5. &ClientToken=test

Response example

JSON format

  1. {
  2. "RequestId": "91C37558-4F94-4033-B41E-368E2983D53E",
  3. "VbrId": "vbr-2zecmmvg5gvu8i4telkhw"
  4. }
Thank you! We've received your feedback.