调用CreateVirtualBorderRouter接口创建边界路由器VBR(Virtual Border Router)实例。
接口说明
创建 VBR 实例后,VBR 实例状态为 active。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:CreateVirtualBorderRouter | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 物理专线所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
PhysicalConnectionId | string | 是 | 物理专线实例 ID。 可以为独享专线创建 VBR 实例,也可以为共享专线创建 VBR 实例。 | pc-2zextbehcx**** |
VbrOwnerId | long | 否 | VBR 实例所有者的账号 ID。 默认为登录的阿里云账号 ID。 | 168811111**** |
VlanId | integer | 是 | VBR 实例的 VLAN ID,取值范围:0~2999。 说明
只有物理专线的所有者可以指定该参数,同一条物理专线下的两个 VBR 的 VLAN ID 不能相同。
| 0 |
CircuitCode | string | 否 | 运营商为物理专线提供的电路编码。 说明
只有物理专线所有者可以指定该参数。
| longtel001 |
LocalGatewayIp | string | 是 | VBR 实例的阿里云侧互联 IP。 该属性只允许 VBR 所有者指定或者修改。 为物理专线所有者创建 VBR 实例时必填。 | 192.168.XX.XX |
PeerGatewayIp | string | 是 | VBR 实例的客户侧互联 IP。该属性只允许 VBR 所有者指定或者修改。 为物理专线所有者创建 VBR 实例时必填。 | 116.62.XX.XX |
PeeringSubnetMask | string | 是 | VBR 实例的阿里云侧和客户侧互联 IP 的子网掩码。 两个 IP 地址必须位于同一个子网中。 | 255.255.255.252 |
Description | string | 否 | VBR 实例的描述信息。 长度为 2~256 个字符,必须以字母或中文开头,但不能以 | desc |
Name | string | 否 | VBR 实例的名称。 长度为 2~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。 | test |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 由客户端生成该参数值,要保证在不同请求间唯一。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
LocalIpv6GatewayIp | string | 否 | VBR 实例的阿里云侧互联 IPv6 地址。该属性只允许 VBR 所有者指定或者修改。 为物理专线所有者创建 VBR 实例时必填。 | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
PeerIpv6GatewayIp | string | 否 | VBR 实例的客户侧互联 IPv6 地址。该属性只允许 VBR 所有者指定或者修改。 为物理专线所有者创建 VBR 实例时必填。 | 2001:XXXX:4:4:4:4:4:4 |
PeeringIpv6SubnetMask | string | 否 | VBR 实例的阿里云侧和客户侧互联 IPv6 的子网掩码。 两个 IPv6 地址必须位于同一个子网中。 | 2408:4004:cc:400::/56 |
EnableIpv6 | boolean | 否 | 是否启用 IPv6 功能。取值:
| true |
Bandwidth | long | 否 | VBR 实例的带宽值,单位:Mbps。
| 100 |
ResourceGroupId | string | 否 | 资源组 ID。 关于资源组的更多信息,请参见什么是资源组。 | rg-acfmxazb4ph6aiy**** |
Tags | array<object> | 否 | 资源的标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 资源的标签键。至少输入 1 个标签键,最多支持输入 20 个标签键。如需传入该值,不能输入空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。 最多支持 128 个字符,不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON
格式
{
"VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationFailed.PconnAllocateVlan0 | Vlan 0 Vbr cannot share the physical connection with another Vbr. | 物理专线上Vlan 0 不能和其他Vbr共存 |
400 | IllegalParam.IpAddress | The specified IpAddress (%s) is illegal. | IpAddress参数不合法 |
400 | IllegalParam.CidrBlock | The specified CidrBlock (%s) is illegal. | CidrBlock参数不合法 |
400 | InvalidPhysicalConnectionId.NotFound | The specified PhysicalConnectionId is not found. | 该物理专线ID不存在。 |
400 | InvalidVlanId.Used | The specified VlanId has been used. | 该VLAN已经被占用。 |
400 | MissingParameter | The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied. | 必须指定参数PhysicalConnectionId。 |
400 | InvalidPhysicalConnectionId.NotEnabled | The specified PhysicalConnectionId is not in Enabled state. | 该物理专线当前未处于正常状态,请检查物理专线后再创建。 |
400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | 参数VlanId的值不合法。 |
400 | InvalidCircuitCode.Malformed | The specified CircuitCode is not valid. | 该CircuitCode不合法。 |
400 | MissingParameter | The input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied. | 必须指定参数LocalGatewayIp。 |
400 | InvalidLocalGatewayIp.Malformed | The specified LocalGatewayIp is not valid. | 该本端网关的IP不合法。 |
400 | MissingParameter | The input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied. | 必须指定参数PeerGatewayIp。 |
400 | MissingParameter | The input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied. | 必须指定参数PeeringSubnetMask。 |
400 | InvalidPeeringSubnetMask.Malformed | The specified PeeringSubnetMask is not valid. | 指定的PeeringSubnetMask不合法,请您检查该参数是否正确。 |
400 | InvalidName.Malformed | The specified ?Name? is not valid. | 该名称格式不合法。 |
400 | InvalidDescription.Malformed | The specifid ?Description? is not valid. | 指定的资源描述格式不合法。长度为2~256个字符,不能以http://和https://开头。 |
400 | QuotaExceeded.vbrPerpConn | Virtual boarder router per PhysicalConnection quota exceed. | 超过了每个物理专线上的边界路由器配额上限,请您减少该物理专线上的边界路由器数量后再试。 |
400 | QuotaExceeded.freevbr | Free virtual boarder router quota exceed. | 超过边界路由器配额。 |
400 | MissingParameter | LocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null. | 参数缺失LocalGatewayIp,peerGatewayIp,peeringSubnetMask不能为空 |
400 | InvalidIp.NotSameSubnet | Local gateway ip and peer gateway ip are not in the same subnet. | 本地网关IP地址与对端网关IP地址不在同一个子网内。 |
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. | vlanId已经被使用 |
400 | QuotaExceeded.SameAccountVBRPerPconn | Same account virtual boarder router per physicalConnection quota exceed. | VBR超过配额 |
400 | QuotaExceeded.VbrPerPconnPortSpec | Quota exceed for current port spec | quota超限 |
400 | QuotaExceeded.VbrPerAccessDevice | Virtual boarder router per access device quota exceed. | 设备配额超限 |
400 | OperationUnsupported.IPV6ForThisRegion | This Region do not support IPV6. | 地域不支持IPV6 |
400 | VbrBandwidthExceed | VBR bandwidth exceed for this physical connection. | 虚拟边界路由器带宽超过物理专线阈值。 |
400 | OperationFailed.PconnExistVlan0Vbr | The physical connection has VLAN 0 VBR. You cannot create another VBR. | 专线上已经存在VLAN 0 VBR,不允许创建其它VBR。 |
400 | OperationFailed.Vlan0VbrUnSharePconn | VLAN 0 VBR cannot share the physical connection with another VBR. | 专线已有其它VLAN 0 VBR,不允许在此专线创建VLAN 0 VBR。 |
400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失败,因为出方向流量未开通。 |
400 | ResourceNotEnough.Bandwidth | The specified resource of Bandwidth is not enough. | 带宽资源不足 |
400 | OperationUnsupported.VirtualBorderRouterEnableIPv6 | The operation failed. The device or region does not support IPv6 functions. | 操作失败,设备或region不支持IPv6功能 |
400 | IllegalParam.OwnerAliUid | The param of VbrOwnerId is illegal. | 资源拥有者阿里用户ID不合法。 |
400 | Forbidden.OwnerAliUid | RAM account or Partner account is forbidden to be OwnerAliUid. | VbrOwnerId为RAM账号或合作伙伴账号,禁止作为VBR所属账号 |
400 | OperationDenied.VPconn | Vpconn is forbidden to create vbr for another account. | 共享专线不允许为其他账号创建VBR |
400 | OperationFailed.NotConsistentWithVpconn | VBR bandwidth is not consistent with vpconn | VBR带宽值与所属共享专线带宽值不一致 |
400 | IllegalParam.Bandwidth | The param of bandwidth is illegal. | Bandwidth参数非法 |
400 | OperationFailed.VirtualPhysicalConnectionExistVBR | The virtual physical connect has already created another VBR. | 共享专线已创建一个VBR,无法继续创建 |
400 | ResourceNotInResourceGroup | The specified resource is not in the specified ResourceGroup. | 输入的资源不在输入的资源组内 |
400 | IncorrectStatus.VirtualPhysicalConnection | The status of PhysicalConnection [%s] is incorrect. | 共享物理专线 [%s] 状态不正确。 |
400 | EcAssociatedQoSPconnNotAllowCreateCrossAccountVbr | The specified Pconn associated with Qos is not allowed to create cross account VBR.Please contact the business manager. | 绑定了Qos策略的共享物理专线不允许创建跨账号虚拟边界路由器,请联系商务经理。 |
403 | Forbidden.LocalGatewayIpNotAllowedByCaller | The caller is not allowed to specify the LocalGatewayIp parameter. | 不允许指定LocalGatewayIp参数。 |
403 | Forbidden.PeerGatewayIpNotAllowedByCaller | The caller is not allowed to specify the PeerGatewayIp parameter. | 不允许指定PeerGatewayIp参数。 |
403 | Forbidden.PeeringSubnetMaskNotAllowedByCaller | The caller is not allowed to specify the PeeringSubnetMask parameter. | 不允许指定PeeringSubnetMask参数。 |
403 | Forbidden.NameNotAllowedByCaller | The caller is not allowed to specify the Name parameter. | 不允许指定Name参数。 |
403 | Forbidden.DescriptionNotAllowedByCaller | The caller is not allowed to specify the Description parameter. | 不允许指定Description参数。 |
404 | InvalidRegionId.NotFound | The specified RegionId is not found. | 指定的RegionId不存在,请您检查此产品在该地域是否可用。 |
404 | InvalidVbrOwnerId.NotFound | The specified VbrOwnerId is not valid. | 参数VbrOwnerId的值不合法。 |
404 | CROSS_BID.FORBIDDEN | Create VBR across bid is illegal | 禁止为其他站点的用户创建VBR。 |
404 | OperationFailed.AccessDeviceDisabled | Access device is disabled and can not create vbr. | 访问设备已禁用,无法创建vbr。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-01 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-09-11 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-07-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |