调用ModifyVirtualBorderRouterAttribute接口修改边界路由器VBR(Virtual Border Router)的配置。
接口说明
-
VlanId 只允许物理专线的所有者修改。
-
同一物理专线下的同一 VLAN ID 不允许被两个 VBR 同时使用。
-
进入 terminated 状态的 VBR 会在 7 天内自动保留其 VLAN ID,不允许其他 VBR 使用。7 天后可以被其他 VBR 使用。
-
其他账号的 VBR 实例,不能配置 LocalGatewayIp、PeerGatewayIp 和 PeeringSubnetMask。
-
PeeringSubnetMask 支持 24~30 位(255.255.255.0~255.255.255.252)。
-
LocalGatewayIp 和 PeerGatewayIp 必须在同一个网段内。例如,LocalGatewayIp:192.168.XX.XX,PeerGatewayIp:192.168.XX.XX,PeeringSubnetMask:255.255.255.248。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:ModifyVirtualBorderRouterAttribute | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VBR 所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
VbrId | string | 是 | VBR 实例 ID。 | vbr-bp1lhl0taikrte**** |
VlanId | integer | 否 | VBR 的 VLAN ID,取值范围:0~2999。 说明
只有物理专线的所有者可以指定该参数,同一条物理专线下的两个 VBR 的 VLAN ID 不能相同。
| 0 |
CircuitCode | string | 否 | 运营商为物理专线提供的电路编码。 说明
只有物理专线的所有者可以指定该参数。
| longtel001 |
LocalGatewayIp | string | 否 | VBR 实例的阿里云侧互联 IP。 该属性只允许 VBR 所有者指定或修改。 | 192.168.XX.XX |
PeerGatewayIp | string | 否 | VBR 实例的客户侧互联 IP。 该属性只允许 VBR 所有者指定或修改。 | 192.168.XX.X |
PeeringSubnetMask | string | 否 | VBR 实例的阿里云侧和客户侧互联 IP 的子网掩码。该属性只允许 VBR 所有者指定或修改。 两个 IP 地址必须位于同一个子网中。 | 255.255.255.252 |
MinTxInterval | long | 否 | 配置 BFD 报文的发送间隔,取值:200~1000,单位:ms。 | 300 |
MinRxInterval | long | 否 | 配置 BFD 报文的接收间隔,取值:200~1000,单位:ms。 | 300 |
DetectMultiplier | long | 否 | 检测时间倍数,即接收方允许发送方发送报文的最大连接丢包数,用来检测链路是否正常。 取值:3~10。 | 3 |
Description | string | 否 | VBR 的描述信息。 长度为 2~256 个字符,必须以字母或中文开头,但不能以 | desc |
Name | string | 否 | VBR 的名称。 长度为 2~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-)。但不能以 | VBR |
AssociatedPhysicalConnections | string | 否 | VBR 关联的物理专线的列表信息,包含以下参数:
| [ { "CircuitCode ": "longtel001", " LocalGatewayIp ": "192.168.XX.XX", "PeerGatewayIp" : "192.168.XX.XX", " PeeringSubnetMask ": "255.255.255.252", " PhysicalConnectionId ": "pc-kojok19****" } ] |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-00**** |
LocalIpv6GatewayIp | string | 否 | VBR 实例的阿里云侧互联 IPv6 地址。 | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
PeerIpv6GatewayIp | string | 否 | VBR 实例的客户侧互联 IPv6 地址。
| 2001:XXXX:3c4d:0015:0000:0000:0000:2a2b |
PeeringIpv6SubnetMask | string | 否 | VBR 实例的阿里云侧和客户侧互联 IPv6 的子网掩码。 两个 IPv6 地址必须位于同一个子网中。 | 2408:4004:cc:400::/56 |
EnableIpv6 | boolean | 否 | 是否启用 IPv6。
| false |
Bandwidth | integer | 否 | 带宽值。单位:Mbps。 | 100 |
SitelinkEnable | boolean | 否 | 是否允许 IDC 间业务访问。
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.AssociatedPhysicalConnections | The specified AssociatedPhysicalConnections is illegal. | 指定的AssociatedPhysicalConnections不合法。 |
400 | IllegalParam.IpAddress | The specified IpAddress is illegal. | 指定的IpAddress不合法 |
400 | IllegalParam.CidrBlock | The specified CidrBlock is illegal. | CidrBlock参数非法。 |
400 | InvalidVbrId.NotFound | The specified VirutalBorderRouter is not found. | 该边界路由器不存在,请您检查输入的边界路由器是否正确。 |
400 | IllegalParam.MinTxInterval | The specified MinTxInterval is not in proper range. | 指定的 MinTxInterval 不在适当的范围内。 |
400 | IllegalParam.MinRxInterval | The specified MinRxInterval is not in proper range. | 指定的 MinRxInterval 不在适当的范围内。 |
400 | IllegalParam.DetectMultiplier | The specified DetectMultiplier is not in proper range. | DetectMultiplier参数不在适当范围内。 |
400 | InvalidVlanId.Used | The specified VlanId has been used. | 该VLAN已经被占用。 |
400 | Duplicated.LocalGatewayIp | The specified LocalGatewayIps are duplicated. | - |
400 | Duplicated.PeerGatewayIp | The specified PeerGatewayIp are duplicated. | - |
400 | IllegalParam.LocalGatewayIp | The specified LocalGatewayIp already exists. | - |
400 | IllegalParam.PeerGatewayIp | The specified PeerGatewayIp already exists. | - |
400 | InvalidCircuitCode.Malformed | The specified CircuitCode is not valid. | 该CircuitCode不合法。 |
400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | 参数VlanId的值不合法。 |
400 | InvalidIp.Malformed | The specified ip address is not valid. | 指定的私网 IP 不合法,请您检查该私网IP是否正确。 |
400 | InvalidPeeringSubnetMask.Malformed | The specified PeeringSubnetMask is not valid. | 指定的PeeringSubnetMask不合法,请您检查该参数是否正确。 |
400 | InvalidName.Malformed | The specified Name is not valid. | 参数Name值不合法 |
400 | InvalidDescription.Malformed | The specifid Description is not valid. | 参数Description值不合法 |
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 | InvalidParameter | %s | - |
400 | OperationFailed.VlanIdInUse | Operation failed because vlanId is in use. | vlanId已经被使用 |
400 | IncorrectStatus.VirtualBorderRouter | %s | - |
400 | OperationUnsupported.IPV6ForThisRegion | This Region do not support IPV6. | 地域不支持IPV6 |
400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | 操作失败,因为出方向流量未开通。 |
400 | OperationDenied.VBRAssociateVPconn | The operation is not allowed because of VBRAssociateVPconn. | VBR不允许绑定Vpconn |
400 | OperationFailed.PhysicalConnectionFinancialLocked | Update failed, the physical connection is financial locked. | 共享端口为欠费锁定状态,无法修改vlan。 |
400 | OperationFailed.PhysicalConnectionTerminated | Update failed, the physical connection is terminated. | 共享端口为已终止状态,无法修改vlan。 |
400 | DuplicatedParam.LocalGatewayIp | The LocalGatewayIp values are duplicated. | 互联IP重复,请更换后重试。 |
400 | Forbidden.VbrNotAllowModifySiteLink | Can not modify virtualBorderRouter site link, please call PD to authorize. | - |
400 | OperationUnsupported.VirtualBorderRouterEnableIPv6 | The operation failed. The device or region does not support IPv6 functions. | 操作失败,设备或region不支持IPv6功能 |
400 | OperationFailed.PconnAllocateVlan0 | Vlan 0 Vbr cannot share the physical connection with another Vbr. | 物理专线上Vlan 0 不能和其他Vbr共存 |
403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to modify. | 不允许修改CircuitCode参数。 |
403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to specify the CircuitCode parameter. | 不允许指定CircuitCode参数。 |
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.VlanIdNotAllowedByCaller | The caller is not allowed to specify the VlanId. | 不允许指定VLAN ID。 |
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不存在,请您检查此产品在该地域是否可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-05-08 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-01-04 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-26 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |