文档

ModifyVirtualBorderRouterAttribute - 修改边界路由器(VBR)的配置

更新时间:

调用ModifyVirtualBorderRouterAttribute接口修改边界路由器VBR(Virtual Border Router)的配置。

接口说明

  • VlanId 只允许物理专线的所有者修改。

  • 同一物理专线下的同一 VLAN ID 不允许被两个 VBR 同时使用。

  • 进入 terminated 状态的 VBR 会在 7 天内自动保留其 VLAN ID,不允许其他 VBR 使用。7 天后可以被其他 VBR 使用。

  • 其他账号的 VBR 实例,不能配置 LocalGatewayIpPeerGatewayIpPeeringSubnetMask

  • PeeringSubnetMask 支持 24~30 位(255.255.255.0~255.255.255.252)。

  • LocalGatewayIpPeerGatewayIp 必须在同一个网段内。例如,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:ModifyVirtualBorderRouterAttributeWrite
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}

请求参数

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

VBR 所在的地域 ID。

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

cn-shanghai
VbrIdstring

VBR 实例 ID。

vbr-bp1lhl0taikrte****
VlanIdinteger

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

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

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

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

VBR 实例的阿里云侧互联 IP。

该属性只允许 VBR 所有者指定或修改。

192.168.XX.XX
PeerGatewayIpstring

VBR 实例的客户侧互联 IP。

该属性只允许 VBR 所有者指定或修改。

192.168.XX.X
PeeringSubnetMaskstring

VBR 实例的阿里云侧和客户侧互联 IP 的子网掩码。该属性只允许 VBR 所有者指定或修改。

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

255.255.255.252
MinTxIntervallong

配置 BFD 报文的发送间隔,取值:200~1000,单位:ms。

300
MinRxIntervallong

配置 BFD 报文的接收间隔,取值:200~1000,单位:ms。

300
DetectMultiplierlong

检测时间倍数,即接收方允许发送方发送报文的最大连接丢包数,用来检测链路是否正常。

取值:3~10

3
Descriptionstring

VBR 的描述信息。

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

desc
Namestring

VBR 的名称。

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

VBR
AssociatedPhysicalConnectionsstring

VBR 关联的物理专线的列表信息,包含以下参数:

  • CircuitCode:运营商为物理专线提供的电路编码。
  • LocalGatewayIp:VBR 实例的阿里云侧互联 IP。
  • PeerGatewayIp:VBR 实例的客户侧互联 IP。
  • PeeringSubnetMask:VBR 实例的阿里云侧和客户侧互联 IP 的子网掩码。
  • PhysicalConnectionId:物理专线实例 ID。
[ { "CircuitCode ": "longtel001", " LocalGatewayIp ": "192.168.XX.XX", "PeerGatewayIp" : "192.168.XX.XX", " PeeringSubnetMask ": "255.255.255.252", " PhysicalConnectionId ": "pc-kojok19****" } ]
ClientTokenstring

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-00****
LocalIpv6GatewayIpstring

VBR 实例的阿里云侧互联 IPv6 地址。

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

VBR 实例的客户侧互联 IPv6 地址。

  • 该属性只允许 VBR 所有者指定或者修改。

  • 为物理专线所有者创建 VBR 实例时必填,为其他账号创建 VBR 实例时无需填写。

2001:XXXX:3c4d:0015:0000:0000:0000:2a2b
PeeringIpv6SubnetMaskstring

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

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

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

是否启用 IPv6。

  • true:开启。

  • false(默认值):关闭。

false
Bandwidthinteger

带宽值。单位:Mbps。

100
SitelinkEnableboolean

是否允许 IDC 间业务访问。

  • true:允许。

  • false(默认值):不允许。

false

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

980960B0-2969-40BF-8542-EBB34FD358AB

示例

正常返回示例

JSON格式

{
  "RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.AssociatedPhysicalConnectionsThe specified AssociatedPhysicalConnections is illegal.指定的AssociatedPhysicalConnections不合法。
400IllegalParam.IpAddressThe specified IpAddress is illegal.指定的IpAddress不合法
400IllegalParam.CidrBlockThe specified CidrBlock is illegal.CidrBlock参数非法。
400InvalidVbrId.NotFoundThe specified VirutalBorderRouter is not found.该边界路由器不存在,请您检查输入的边界路由器是否正确。
400IllegalParam.MinTxIntervalThe specified MinTxInterval is not in proper range.指定的 MinTxInterval 不在适当的范围内。
400IllegalParam.MinRxIntervalThe specified MinRxInterval is not in proper range.指定的 MinRxInterval 不在适当的范围内。
400IllegalParam.DetectMultiplierThe specified DetectMultiplier is not in proper range.DetectMultiplier参数不在适当范围内。
400InvalidVlanId.UsedThe specified VlanId has been used.该VLAN已经被占用。
400Duplicated.LocalGatewayIpThe specified LocalGatewayIps are duplicated.-
400Duplicated.PeerGatewayIpThe specified PeerGatewayIp are duplicated.-
400IllegalParam.LocalGatewayIpThe specified LocalGatewayIp already exists.-
400IllegalParam.PeerGatewayIpThe specified PeerGatewayIp already exists.-
400InvalidCircuitCode.MalformedThe specified CircuitCode is not valid.该CircuitCode不合法。
400InvalidVlanId.MalformedThe specified VlanId is not valid.参数VlanId的值不合法。
400InvalidIp.MalformedThe specified ip address is not valid.指定的私网 IP 不合法,请您检查该私网IP是否正确。
400InvalidPeeringSubnetMask.MalformedThe specified PeeringSubnetMask is not valid.指定的PeeringSubnetMask不合法,请您检查该参数是否正确。
400InvalidName.MalformedThe specified Name is not valid.参数Name值不合法
400InvalidDescription.MalformedThe specifid Description is not valid.参数Description值不合法
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地址不在同一个子网内。
400InvalidParameter%s-
400OperationFailed.VlanIdInUseOperation failed because vlanId is in use.vlanId已经被使用
400IncorrectStatus.VirtualBorderRouter%s-
400OperationUnsupported.IPV6ForThisRegionThis Region do not support IPV6.地域不支持IPV6
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.操作失败,因为出方向流量未开通。
400OperationDenied.VBRAssociateVPconnThe operation is not allowed because of VBRAssociateVPconn.VBR不允许绑定Vpconn
400OperationFailed.PhysicalConnectionFinancialLockedUpdate failed, the physical connection is financial locked.共享端口为欠费锁定状态,无法修改vlan。
400OperationFailed.PhysicalConnectionTerminatedUpdate failed, the physical connection is terminated.共享端口为已终止状态,无法修改vlan。
400DuplicatedParam.LocalGatewayIpThe LocalGatewayIp values are duplicated.互联IP重复,请更换后重试。
400Forbidden.VbrNotAllowModifySiteLinkCan not modify virtualBorderRouter site link, please call PD to authorize.-
403Forbidden.CircuitCodeNotAllowedByCallerThe caller is not allowed to modify.不允许修改CircuitCode参数。
403Forbidden.CircuitCodeNotAllowedByCallerThe caller is not allowed to specify the CircuitCode parameter.不允许指定CircuitCode参数。
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.VlanIdNotAllowedByCallerThe caller is not allowed to specify the VlanId.不允许指定VLAN ID。
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不存在,请您检查此产品在该地域是否可用。

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-12-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:SitelinkEnable
  • 本页导读 (1)
文档反馈