Modifies the configuration of a virtual border router (VBR).
Operation description
- Only the owner of an Express Connect circuit can modify the VlanId parameter.
- One VLAN ID of an Express Connect circuit cannot be used only by one VBR at the same time.
- The VLAN ID of a VBR in the Terminated state is reserved for seven days and cannot be used by other VBRs. The VLAN ID can be used by other VBRs after 7 days.
- You cannot set LocalGatewayIp, PeerGatewayIp, or PeeringSubnetMask for VBRs that do not belong to your Alibaba Cloud account.
- Set PeeringSubnetMask to a subnet mask with 24 to 30 bits in length (255.255.255.0～255.255.255.252).
- Set LocalGatewayIp and PeerGatewayIp to IP addresses that belong to the same CIDR block. For example, you can set LocalGatewayIp to 192.168.XX.XX, PeerGatewayIp to 192.168.XX.XX, and PeeringSubnetMask to 255.255.255.248.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the VBR. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
| VbrId | string | Yes | The VBR ID. | vbr-bp1lhl0taikrte**** |
| VlanId | integer | No | The VLAN ID of the VBR. Valid values: 0 to 2999. Note
This parameter is available only to Express Connect owners. The VLAN IDs of VBRs on the same Express Connect circuit must be unique.
| 0 |
| CircuitCode | string | No | 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 property.
| longtel001 |
| LocalGatewayIp | string | No | The IP address of the VBR. Only the owner of the VBR can set or modify this parameter. | 192.168.XX.XX |
| PeerGatewayIp | string | No | The IP address of the gateway device in the data center. Only the owner of the VBR can set or modify this parameter. | 192.168.XX.X |
| PeeringSubnetMask | string | No | The subnet mask for the IP addresses of the gateway devices on the Alibaba Cloud side and on the customer side. Only the owner of the VBR can set or modify this parameter. The two IP addresses must fall within the same subnet. | 255.255.255.252 |
| MinTxInterval | long | No | The time interval to send BFD packets. Valid values: 200 to 1000. Unit: milliseconds. | 300 |
| MinRxInterval | long | No | The time interval to receive BFD packets. Valid values: 200 to 1000. Unit: milliseconds. | 300 |
| DetectMultiplier | long | No | The maximum number of dropped packets that is allowed by the receiver when the initiator transmits packets. This value can be used to check whether a connection works as expected. Valid values: 3 to 10. | 3 |
| Description | string | No | The description of the VBR. It must be 2 to 256 characters in length. It must start with a letter but cannot start with | desc |
| Name | string | No | 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. It cannot start with | VBR |
| AssociatedPhysicalConnections | string | No | The information about the Express Connect circuit associated with the VBR, including the following parameters:
| [ { "CircuitCode ": "longtel001", " LocalGatewayIp ": "192.168.XX.XX", "PeerGatewayIp" : "192.168.XX.XX", " PeeringSubnetMask ": "255.255.255.252", " PhysicalConnectionId ": "pc-kojok19****" } ] |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 02fb3da4-130e-11e9-8e44-00**** |
| LocalIpv6GatewayIp | string | No | The IPv6 address of the VBR. | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
| PeerIpv6GatewayIp | string | No | The IPv6 address of the gateway device in the data center.
| 2001:XXXX:3c4d:0015:0000:0000:0000:2a2b |
| PeeringIpv6SubnetMask | string | No | 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 |
| EnableIpv6 | boolean | No | Specifies whether to enable IPv6. Valid values:
| false |
| Bandwidth | integer | No | The bandwidth value. Unit: Mbit/s. | 100 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "980960B0-2969-40BF-8542-EBB34FD358AB"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalParam.AssociatedPhysicalConnections | The specified AssociatedPhysicalConnections is illegal. | The specified AssociatedPhysicalConnections is illegal. |
| 400 | IllegalParam.IpAddress | The specified IpAddress is illegal. | The specified IpAddress is illegal |
| 400 | IllegalParam.CidrBlock | The specified CidrBlock is illegal. | The operation failed because CidrBlock is set to an invalid value. |
| 400 | InvalidVbrId.NotFound | The specified VirutalBorderRouter is not found. | The VBR does not exist. Check the VBR ID. |
| 400 | IllegalParam.MinTxInterval | The specified MinTxInterval is not in proper range. | The specified MinTxInterval is not in the proper range. |
| 400 | IllegalParam.MinRxInterval | The specified MinRxInterval is not in proper range. | The specified MinRxInterval is not in the proper range. |
| 400 | IllegalParam.DetectMultiplier | The specified DetectMultiplier is not in proper range. | DetectMultiplier parameters are not in the proper range. |
| 400 | InvalidVlanId.Used | The specified VlanId has been used. | The VLAN ID is in use. |
| 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 is set to an invalid value. |
| 400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | VlanId is set to an invalid value. |
| 400 | InvalidIp.Malformed | The specified ip address is not valid. | The specified private IP address is invalid. |
| 400 | InvalidPeeringSubnetMask.Malformed | The specified PeeringSubnetMask is not valid. | PeeringSubnetMask is set to an invalid value. |
| 400 | InvalidName.Malformed | The specified Name is not valid. | The Name parameter is set to an invalid value. |
| 400 | InvalidDescription.Malformed | The specifid Description is not valid. | The Description parameter is set to an invalid value. |
| 400 | MissingParameter | LocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null. | The following parameters are required but not set: LocalGatewayIp, peerGatewayIp, and peeringSubnetMask. |
| 400 | InvalidIp.NotSameSubnet | Local 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. |
| 400 | InvalidParameter | %s | - |
| 400 | OperationFailed.VlanIdInUse | Operation failed because vlanId is in use. | The VLAN ID is already used. |
| 400 | IncorrectStatus.VirtualBorderRouter | %s | - |
| 400 | OperationUnsupported.IPV6ForThisRegion | This Region do not support IPV6. | The region does not support IPv6. |
| 400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | Billing for outbound data transfer is disabled. |
| 400 | OperationDenied.VBRAssociateVPconn | The operation is not allowed because of VBRAssociateVPconn. | The operation failed because you cannot associate a VBR with the hosted connection. |
| 400 | OperationFailed.PhysicalConnectionFinancialLocked | Update failed, the physical connection is financial locked. | The shared port is locked due to overdue payments and you cannot modify the VLAN. |
| 400 | OperationFailed.PhysicalConnectionTerminated | Update failed, the physical connection is terminated. | The shared port is disabled and you cannot modify the VLAN. |
| 400 | DuplicatedParam.LocalGatewayIp | The LocalGatewayIp values are duplicated. | The error message returned because a duplicate IP address is used for communication. Change the IP address and try again. |
| 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. | The operation failed because the device or region does not support IPv6. |
| 400 | OperationFailed.PconnAllocateVlan0 | Vlan 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. |
| 403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to modify. | You are not allowed to modify CircuitCode. |
| 403 | Forbidden.CircuitCodeNotAllowedByCaller | The caller is not allowed to specify the CircuitCode parameter. | You are not allowed to specify CircuitCode. |
| 403 | Forbidden.LocalGatewayIpNotAllowedByCaller | The caller is not allowed to specify the LocalGatewayIp parameter. | You are not allowed to specify LocalGatewayIp. |
| 403 | Forbidden.PeerGatewayIpNotAllowedByCaller | The caller is not allowed to specify the PeerGatewayIp parameter. | You do not have permissions to set the PeerGatewayIp parameter. |
| 403 | Forbidden.PeeringSubnetMaskNotAllowedByCaller | The caller is not allowed to specify the PeeringSubnetMask parameter. | You are not allowed to specify PeeringSubnetMask. |
| 403 | Forbidden.VlanIdNotAllowedByCaller | The caller is not allowed to specify the VlanId. | You are not allowed to specify the VLAN ID. |
| 403 | Forbidden.NameNotAllowedByCaller | The caller is not allowed to specify the Name parameter. | You do not have the permissions to set the Name parameter. |
| 403 | Forbidden.DescriptionNotAllowedByCaller | The caller is not allowed to specify the Description parameter. | You are not allowed to set Description. |
| 404 | InvalidRegionId.NotFound | The specified RegionId is not found. | The specified region ID is invalid. Check whether the service is available in the specified region. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-28 | The Error code has changed | View Change Details |
| 2024-05-08 | The Error code has changed | View Change Details |
| 2024-01-04 | API Description Update. The Error code has changed | View Change Details |
| 2023-12-26 | API Description Update. The Error code has changed. The request parameters of the API has changed | View Change Details |