文档

CreateVirtualBorderRouter - 新建边界路由器(VBR)

更新时间:

调用CreateVirtualBorderRouter接口创建边界路由器VBR(Virtual Border Router)实例。

接口说明

创建 VBR 实例后,VBR 实例状态为 active

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

物理专线所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
PhysicalConnectionIdstring

物理专线实例 ID。

可以为独享专线创建 VBR 实例,也可以为共享专线创建 VBR 实例。

pc-2zextbehcx****
VbrOwnerIdlong

VBR 实例所有者的账号 ID。

默认为登录的阿里云账号 ID。

168811111****
VlanIdinteger

VBR 实例的 VLAN ID,取值范围:0~2999

说明 只有物理专线的所有者可以指定该参数,同一条物理专线下的两个 VBR 的 VLAN ID 不能相同。
0
CircuitCodestring

运营商为物理专线提供的电路编码。

说明 只有物理专线所有者可以指定该参数。
longtel001
LocalGatewayIpstring

VBR 实例的阿里云侧互联 IP。 该属性只允许 VBR 所有者指定或者修改。

为物理专线所有者创建 VBR 实例时必填。

192.168.XX.XX
PeerGatewayIpstring

VBR 实例的客户侧互联 IP。该属性只允许 VBR 所有者指定或者修改。

为物理专线所有者创建 VBR 实例时必填。

116.62.XX.XX
PeeringSubnetMaskstring

VBR 实例的阿里云侧和客户侧互联 IP 的子网掩码。

两个 IP 地址必须位于同一个子网中。

255.255.255.252
Descriptionstring

VBR 实例的描述信息。

长度为 2~256 个字符,必须以字母或中文开头,但不能以http://https://开头。

desc
Namestring

VBR 实例的名称。

长度为 2~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。

test
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-426655440000
LocalIpv6GatewayIpstring

VBR 实例的阿里云侧互联 IPv6 地址。该属性只允许 VBR 所有者指定或者修改。

为物理专线所有者创建 VBR 实例时必填。

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

VBR 实例的客户侧互联 IPv6 地址。该属性只允许 VBR 所有者指定或者修改。

为物理专线所有者创建 VBR 实例时必填。

2001:XXXX:4:4:4:4:4:4
PeeringIpv6SubnetMaskstring

VBR 实例的阿里云侧和客户侧互联 IPv6 的子网掩码。

两个 IPv6 地址必须位于同一个子网中。

2408:4004:cc:400::/56
EnableIpv6boolean

是否启用 IPv6 功能。取值:

  • true:开启。

  • false(默认值):关闭。

true
Bandwidthlong

VBR 实例的带宽值,单位:Mbps。

  • 当为独享专线创建 VBR 实例时,取值分别为 5010020030040050010002048512081921024020480409605012061440102400
  • 当为共享专线创建 VBR 实例时,无需配置,VBR 的带宽即为创建共享物理专线时设置的共享专线带宽。
100
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-acfmxazb4ph6aiy****
Tagsobject []

资源的标签。

Keystring

资源的标签键。至少输入 1 个标签键,最多支持输入 20 个标签键。如需传入该值,不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

返回信息。

VbrIdstring

VBR 实例 ID。

vbr-bp1jcg5cmxjbl9xgc****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationFailed.PconnAllocateVlan0Vlan 0 Vbr cannot share the physical connection with another Vbr.物理专线上Vlan 0 不能和其他Vbr共存
400IllegalParam.IpAddressThe specified IpAddress (%s) is illegal.IpAddress参数不合法
400IllegalParam.CidrBlockThe specified CidrBlock (%s) is illegal.CidrBlock参数不合法
400InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId is not found.该物理专线ID不存在。
400InvalidVlanId.UsedThe specified VlanId has been used.该VLAN已经被占用。
400MissingParameterThe input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied.必须指定参数PhysicalConnectionId。
400InvalidPhysicalConnectionId.NotEnabledThe specified PhysicalConnectionId is not in Enabled state.该物理专线当前未处于正常状态,请检查物理专线后再创建。
400InvalidVlanId.MalformedThe specified VlanId is not valid.参数VlanId的值不合法。
400InvalidCircuitCode.MalformedThe specified CircuitCode is not valid.该CircuitCode不合法。
400MissingParameterThe input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied.必须指定参数LocalGatewayIp。
400InvalidLocalGatewayIp.MalformedThe specified LocalGatewayIp is not valid.该本端网关的IP不合法。
400MissingParameterThe input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied.必须指定参数PeerGatewayIp。
400MissingParameterThe input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied.必须指定参数PeeringSubnetMask。
400InvalidPeeringSubnetMask.MalformedThe specified PeeringSubnetMask is not valid.指定的PeeringSubnetMask不合法,请您检查该参数是否正确。
400InvalidName.MalformedThe specified ?Name? is not valid.该名称格式不合法。
400InvalidDescription.MalformedThe specifid ?Description? is not valid.指定的资源描述格式不合法。长度为2~256个字符,不能以http://和https://开头。
400QuotaExceeded.vbrPerpConnVirtual boarder router per PhysicalConnection quota exceed.超过了每个物理专线上的边界路由器配额上限,请您减少该物理专线上的边界路由器数量后再试。
400QuotaExceeded.freevbrFree virtual boarder router quota exceed.超过边界路由器配额。
400MissingParameterLocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null.参数缺失LocalGatewayIp,peerGatewayIp,peeringSubnetMask不能为空
400InvalidIp.NotSameSubnetLocal gateway ip and peer gateway ip are not in the same subnet.本地网关IP地址与对端网关IP地址不在同一个子网内。
400TaskConflictThe operation is too frequent, please wait a moment and try again.操作过于频繁,请稍等一会再重试
400QuotaExceeded.CrossUserVBRPerUserCross virtual boarder router per user quota exceed.配额超限
400OperationFailed.VlanIdInUseOperation failed because vlanId is in use.vlanId已经被使用
400QuotaExceeded.SameAccountVBRPerPconnSame account virtual boarder router per physicalConnection quota exceed.VBR超过配额
400QuotaExceeded.VbrPerPconnPortSpecQuota exceed for current port specquota超限
400QuotaExceeded.VbrPerAccessDeviceVirtual boarder router per access device quota exceed.设备配额超限
400OperationUnsupported.IPV6ForThisRegionThis Region do not support IPV6.地域不支持IPV6
400VbrBandwidthExceedVBR bandwidth exceed for this physical connection.虚拟边界路由器带宽超过物理专线阈值。
400OperationFailed.PconnExistVlan0VbrThe physical connection has VLAN 0 VBR. You cannot create another VBR.专线上已经存在VLAN 0 VBR,不允许创建其它VBR。
400OperationFailed.Vlan0VbrUnSharePconnVLAN 0 VBR cannot share the physical connection with another VBR.专线已有其它VLAN 0 VBR,不允许在此专线创建VLAN 0 VBR。
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.操作失败,因为出方向流量未开通。
400ResourceNotEnough.BandwidthThe specified resource of Bandwidth is not enough.带宽资源不足
400OperationUnsupported.VirtualBorderRouterEnableIPv6The operation failed. The device or region does not support IPv6 functions.操作失败,设备或region不支持IPv6功能
400IllegalParam.OwnerAliUidThe param of VbrOwnerId is illegal.资源拥有者阿里用户ID不合法。
400Forbidden.OwnerAliUidRAM account or Partner account is forbidden to be OwnerAliUid.VbrOwnerId为RAM账号或合作伙伴账号,禁止作为VBR所属账号
400OperationDenied.VPconnVpconn is forbidden to create vbr for another account.共享专线不允许为其他账号创建VBR
400OperationFailed.NotConsistentWithVpconnVBR bandwidth is not consistent with vpconnVBR带宽值与所属共享专线带宽值不一致
400IllegalParam.BandwidthThe param of bandwidth is illegal.Bandwidth参数非法
400OperationFailed.VirtualPhysicalConnectionExistVBRThe virtual physical connect has already created another VBR.共享专线已创建一个VBR,无法继续创建
400ResourceNotInResourceGroupThe specified resource is not in the specified ResourceGroup.输入的资源不在输入的资源组内
400IncorrectStatus.VirtualPhysicalConnectionThe status of PhysicalConnection [%s] is incorrect.共享物理专线 [%s] 状态不正确。
400EcAssociatedQoSPconnNotAllowCreateCrossAccountVbrThe specified Pconn associated with Qos is not allowed to create cross account VBR.Please contact the business manager.绑定了Qos策略的共享物理专线不允许创建跨账号虚拟边界路由器,请联系商务经理。
403Forbidden.LocalGatewayIpNotAllowedByCallerThe caller is not allowed to specify the LocalGatewayIp parameter.不允许指定LocalGatewayIp参数。
403Forbidden.PeerGatewayIpNotAllowedByCallerThe caller is not allowed to specify the PeerGatewayIp parameter.不允许指定PeerGatewayIp参数。
403Forbidden.PeeringSubnetMaskNotAllowedByCallerThe caller is not allowed to specify the PeeringSubnetMask parameter.不允许指定PeeringSubnetMask参数。
403Forbidden.NameNotAllowedByCallerThe caller is not allowed to specify the Name parameter.不允许指定Name参数。
403Forbidden.DescriptionNotAllowedByCallerThe caller is not allowed to specify the Description parameter.不允许指定Description参数。
404InvalidRegionId.NotFoundThe specified RegionId is not found.指定的RegionId不存在,请您检查此产品在该地域是否可用。
404InvalidVbrOwnerId.NotFoundThe specified VbrOwnerId is not valid.参数VbrOwnerId的值不合法。
404CROSS_BID.FORBIDDENCreate VBR across bid is illegal禁止为其他站点的用户创建VBR。
404OperationFailed.AccessDeviceDisabledAccess device is disabled and can not create vbr.访问设备已禁用,无法创建vbr。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-07-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-07-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
    新增入参:Tags
  • 本页导读 (1)
文档反馈