All Products
Search

This Product

    Virtual Private Cloud:CreateVirtualBorderRouter

    Document Center

    Virtual Private Cloud:CreateVirtualBorderRouter

    Last Updated:Dec 02, 2023

    Creates a virtual border router (VBR).

    Operation Description

    When you create a VBR, the VBR is in the active state by default.

    debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    debugging

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:CreateVirtualBorderRouterWrite
    • PhysicalConnection
      acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}
    • VirtualBorderRouter
      acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the Express Connect circuit.

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

    		cn-shanghai
    PhysicalConnectionIdstringYes

    The ID of the Express Connect circuit.

    You can create a VBR for a dedicated connection or a hosted connection.

    		pc-2zextbehcx****
    VbrOwnerIdlongNo

    The account ID of the VBR owner.

    The default value is the ID of the current Alibaba Cloud account.

    		168811111****
    VlanIdintegerYes

    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.
    		0
    CircuitCodestringNo

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

    Note Only the owner of the Express Connect circuit can set this parameter.
    		longtel001
    LocalGatewayIpstringYes

    The IP address of the VBR. 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.

    		192.168.XX.XX
    PeerGatewayIpstringYes

    The IP address of the gateway device in the data center. 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.

    		116.62.XX.XX
    PeeringSubnetMaskstringYes

    The subnet mask of the IP addresses of the VBR and the gateway device in the data center.

    The two IP addresses must fall within the same subnet.

    		255.255.255.252
    DescriptionstringNo

    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://.

    		desc
    NamestringNo

    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.

    		test
    ClientTokenstringNo

    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.

    Note If you do not set this parameter, the system automatically sets ClientToken to the value of RequestId. The value of RequestId may be different for each API request.
    		123e4567-e89b-12d3-a456-426655440000
    LocalIpv6GatewayIpstringNo

    The IPv6 address of the VBR. 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.

    		2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
    PeerIpv6GatewayIpstringNo

    The IPv6 address of the gateway device in the data center. 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.

    		2001:XXXX:4:4:4:4:4:4
    PeeringIpv6SubnetMaskstringNo

    The subnet mask of the IPv6 addresses of the VBR and the gateway device in the data center.

    The two IPv6 addresses must fall within the same subnet.

    		2408:4004:cc:400::/56
    EnableIpv6booleanNo

    Specifies whether to enable IPv6. Valid values:

    • true: enables IPv6.
    • false (default): disables IPv6.
    		true
    BandwidthlongNo

    The bandwidth of the VBR. Unit: Mbit/s.

    • When you create a VBR for a dedicated connection, valid values are 50, 100, 200, 300, 400, 500, 1000, 2048, 5120, 8192, 10240, 20480, 40960, 50120, 61440, and 102400.
    • You do not need to set this parameter when you create a VBR for a hosted connection. The bandwidth is already configured when the hosted connection is created.
    		100
    ResourceGroupIdstringNo

    The ID of the resource group.

    For more information about resource group, see What is Resource Management?

    		rg-acfmxazb4ph6aiy****
    Tagsobject []No

    The tag list.

    KeystringNo

    The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.

    The key cannot exceed 128 characters in length, and cannot start with aliyun or acs:. The key cannot contain http:// or https://.

    		FinanceDept
    ValuestringNo

    The tag value. You can specify at most 20 tag values. It can be an empty string.

    The tag value cannot exceed 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

    		FinanceJoshua

    Response parameters

    ParameterTypeDescriptionExample
    object
    VbrIdstring

    The ID of the VBR.

    		vbr-bp1jcg5cmxjbl9xgc****
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

    {
  "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400OperationFailed.PconnAllocateVlan0Vlan 0 Vbr cannot share the physical connection with another Vbr.The operation failed because VLAN 0 is set to a VBR associated with the Express Connect circuit and you cannot set VLAN 0 to other VBRs.
    400IllegalParam.IpAddressThe specified IpAddress (%s) is illegal.The IpAddress parameter is set to an invalid value.
    400IllegalParam.CidrBlockThe specified CidrBlock (%s) is illegal.The CidrBlock parameter is set to an invalid value.
    400InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId is not found.The specified Express Connect circuit ID does not exist.
    400InvalidVlanId.UsedThe specified VlanId has been used.The VLAN ID is in use.
    400MissingParameterThe input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied.PhysicalConnectionId is not specified.
    400InvalidPhysicalConnectionId.NotEnabledThe specified PhysicalConnectionId is not in Enabled state.The Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again.
    400InvalidVlanId.MalformedThe specified VlanId is not valid.VlanId is set to an invalid value.
    400InvalidCircuitCode.MalformedThe specified CircuitCode is not valid.CircuitCode is set to an invalid value.
    400MissingParameterThe input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied.LocalGatewayIp is not specified.
    400InvalidLocalGatewayIp.MalformedThe specified LocalGatewayIp is not valid.The IP address of the local gateway is invalid.
    400MissingParameterThe input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied.PeerGatewayIp is not specified.
    400MissingParameterThe input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied.PeeringSubnetMask is not specified.
    400InvalidPeeringSubnetMask.MalformedThe specified PeeringSubnetMask is not valid.PeeringSubnetMask is set to an invalid value.
    400InvalidName.MalformedThe specified ?Name? is not valid.The error message returned because the name format is invalid.
    400InvalidDescription.MalformedThe specifid ?Description? is not valid.The error message returned because the specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    400QuotaExceeded.vbrPerpConnVirtual 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.
    400QuotaExceeded.freevbrFree virtual boarder router quota exceed.The number of VBRs exceeds the upper limit.
    400MissingParameterLocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null.The following parameters are required but not set: LocalGatewayIp, peerGatewayIp, and peeringSubnetMask.
    400InvalidIp.NotSameSubnetLocal 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.
    400TaskConflictThe operation is too frequent, please wait a moment and try again.Your requests are too frequent. Try again later.
    400QuotaExceeded.CrossUserVBRPerUserCross virtual boarder router per user quota exceed.The upper limit is reached.
    400OperationFailed.VlanIdInUseOperation failed because vlanId is in use.The VLAN ID is already used.
    400QuotaExceeded.SameAccountVBRPerPconnSame account virtual boarder router per physicalConnection quota exceed.The number of VBRs exceeds the upper limit.
    400QuotaExceeded.VbrPerPconnPortSpecQuota exceed for current port specThe upper limit is reached.
    400QuotaExceeded.VbrPerAccessDeviceVirtual boarder router per access device quota exceed.The number of devices exceeds the upper limit.
    400OperationUnsupported.IPV6ForThisRegionThis Region do not support IPV6.The region does not support IPv6.
    400VbrBandwidthExceedVBR bandwidth exceed for this physical connection.The bandwidth of the VBR exceeds the upper limit supported by the Express Connect circuit.
    400OperationFailed.PconnExistVlan0VbrThe physical connection has VLAN 0 VBR. You cannot create another VBR.You cannot create other VBRs for this Express Connect circuit because a VBR with VLAN 0 is already created for this Express Connect circuit.
    400OperationFailed.Vlan0VbrUnSharePconnVLAN 0 VBR cannot share the physical connection with another VBR.You cannot create a VBR with VLAN 0 for this Express Connect circuit because another VBR with VLAN 0 is already created for this Express Connect circuit.
    400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
    400ResourceNotEnough.BandwidthThe specified resource of Bandwidth is not enough.The specified resource of Bandwidth is insufficient.
    400OperationUnsupported.VirtualBorderRouterEnableIPv6The operation failed. The device or region does not support IPv6 functions.The operation failed because the device or region does not support IPv6.
    400IllegalParam.OwnerAliUidThe param of VbrOwnerId is illegal.The UID of the resource owner is invalid.
    400Forbidden.OwnerAliUidRAM account or Partner account is forbidden to be OwnerAliUid.You must set VbrOwnerId to the ID of a RAM user or a partner account. You cannot use the VBR owner account.
    400OperationDenied.VPconnVpconn is forbidden to create vbr for another account.You cannot create a VBR for another account.
    400OperationFailed.NotConsistentWithVpconnVBR bandwidth is not consistent with vpconnThe bandwidth value of the VBR is not the same as the bandwidth value of the hosted connection to which the VBR belongs.
    400IllegalParam.BandwidthThe param of bandwidth is illegal.The Bandwidth parameter is set to an invalid value.
    400OperationFailed.VirtualPhysicalConnectionExistVBRThe virtual physical connect has already created another VBR.You cannot create another VBR for the hosted connection because a VBR is already created.
    400ResourceNotInResourceGroupThe specified resource is not in the specified ResourceGroup.The specified resource does not belong to the resource group.
    400IncorrectStatus.VirtualPhysicalConnectionThe status of PhysicalConnection [%s] is incorrect.The status of the shared Express Connect circuit [%s] is invalid.
    403Forbidden.LocalGatewayIpNotAllowedByCallerThe caller is not allowed to specify the LocalGatewayIp parameter.You are not allowed to specify LocalGatewayIp.
    403Forbidden.PeerGatewayIpNotAllowedByCallerThe caller is not allowed to specify the PeerGatewayIp parameter.You do not have permissions to set the PeerGatewayIp parameter.
    403Forbidden.PeeringSubnetMaskNotAllowedByCallerThe caller is not allowed to specify the PeeringSubnetMask parameter.You are not allowed to specify PeeringSubnetMask.
    403Forbidden.NameNotAllowedByCallerThe caller is not allowed to specify the Name parameter.You do not have the permissions to set the Name parameter.
    403Forbidden.DescriptionNotAllowedByCallerThe caller is not allowed to specify the Description parameter.You are not allowed to set Description.
    404InvalidRegionId.NotFoundThe specified RegionId is not found.The specified region ID is invalid. Check whether the service is available in the specified region.
    404InvalidVbrOwnerId.NotFoundThe specified VbrOwnerId is not valid.VbrOwnerId is set to an invalid value.
    404CROSS_BID.FORBIDDENCreate VBR across bid is illegalYou are not allowed to create a VBR for another Alibaba Cloud account.
    404OperationFailed.AccessDeviceDisabledAccess device is disabled and can not create vbr.You cannot create a VBR because the access device is disabled.
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error occurred.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-11API Description Update,The error codes of the API operation change.see changesets
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-07-24The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-07-20The error codes of the API operation change.,The input parameters of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: ResourceGroupId
      Added Input Parameters: Tags