Modifies the configuration of a virtual border router (VBR).

Usage notes

  • Only the owner of an Express Connect circuit can modify the VlanId parameter.
  • One VLAN ID of an Express Connect circuit cannot be used by two VBRs 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 CIDR blocks 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyVirtualBorderRouterAttribute

The operation that you want to perform.

Set the value to ModifyVirtualBorderRouterAttribute.

RegionId String Yes cn-shanghai

The region ID of the VBR.

You can call the DescribeRegions operation to query the most recent region list.

VbrId String Yes vbr-bp1lhl0taikrte****

The ID of the VBR.

VlanId Integer No 0

The VLAN ID of the VBR. Valid values: 0 to 2999.

Note Only the owner of the Express Connect circuit can set this parameter. The VLAN IDs of two VBRs of the same Express Connect circuit must be different.
CircuitCode String No longtel001

The circuit code provided by the Internet service provider (ISP) for the Express Connect circuit.

Note Only the owner of the Express Connect circuit can set this parameter.
LocalGatewayIp String No 192.168.XX.XX

The IP address of the VBR on the Alibaba Cloud side.

PeerGatewayIp String No 192.168.XX.X

The IP address of the VBR on the user side.

  • Only the owner of the VBR can set this parameter.
  • This parameter is required when you create a VBR for the owner of the Express Connect circuit. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.
PeeringSubnetMask String No 255.255.255.252

The subnet mask for the IP addresses of the VBR on the Alibaba Cloud side and on the user side.

The two IP addresses must belong to the same subnet.

MinTxInterval Long No 300

The time interval to send BFD packets. Valid values: 200 to 1000. Unit: milliseconds.

MinRxInterval Long No 300

The time interval to receive BFD packets. Valid values: 200 to 1000. Unit: milliseconds.

DetectMultiplier Long No 3

This value indicates 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 the connection works as expected.

Valid values: 3 to 10.

Description String No desc

The description of the VBR.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.

Name String No VBR

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 http:// or https://.

AssociatedPhysicalConnections String No pc-kojok19******

The ID of the Express Connect circuit.

ClientToken String No 02fb3da4-130e-11e9-8e44-00xxxxxxxx

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

LocalIpv6GatewayIp String No 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

The IPv6 address of the VBR on the Alibaba Cloud side.

PeerIpv6GatewayIp String No 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

The IPv6 address of the VBR on the client side.

  • Only the owner of the VBR can set this parameter.
  • This parameter is required when you create a VBR for the owner of the Express Connect. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.
PeeringIpv6SubnetMask String No 2408:4004:cc:400::/56

The subnet mask for the IPv6 addresses of the VBR on the Alibaba Cloud side and on the user side.

The two IPv6 addresses must fall within the same subnet.

EnableIpv6 Boolean No false

Specifies whether to enable IPv6. Valid values:

  • true: enabled
  • false (default): disabled
Bandwidth Integer No 100

The bandwidth value. Unit: Mbit/s.

Response parameters

Parameter Type Example Description
RequestId String 980960B0-2969-40BF-8542-EBB34FD358AB

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyVirtualBorderRouterAttribute
&RegionId=cn-shanghai
&VbrId=vbr-bp1lhl0taikrte****
&<Common request parameters>

Sample success responses

XML format

<ModifyVirtualBorderRouterAttributeResponse>
      <RequestId>980960B0-2969-40BF-8542-EBB34FD358AB</RequestId>
</ModifyVirtualBorderRouterAttributeResponse>

JSON format

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

Error codes

HttpCode Error code Error message Required
400 IllegalParam.CidrBlock The specified CidrBlock is illegal. The error message returned because CidrBlock is set to an invalid value.
400 InvalidVbrId.NotFound The specified VirutalBorderRouter is not found. The error message returned because the specified VBR does not exist. Check whether the parameter is set to a valid value.
400 InvalidVlanId.Used The specified VlanId has been used. The error message returned because the VLAN ID is being used.
400 InvalidCircuitCode.Malformed The specified CircuitCode is not valid. The error message returned because CircuitCode is set to an invalid value.
400 InvalidVlanId.Malformed The specified VlanId is not valid. The error message returned because VlanId is set to an invalid value.
400 InvalidIp.Malformed The specified ip address is not valid. The error message returned because the specified private IP address is invalid. Check the private IP address.
400 InvalidPeeringSubnetMask.Malformed The specified PeeringSubnetMask is not valid. The error message returned because PeeringSubnetMask is set to an invalid value. Check whether PeeringSubnetMask is set to a valid value.
400 InvalidIp.NotSameSubnet Local gateway ip and peer gateway ip are not in the same subnet. The error message returned because the IP addresses of the local gateway and the peer gateway do not fall within the same subnet.
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The operation failed because outbound traffic is not enabled.
403 Forbidden.CircuitCodeNotAllowedByCaller The caller is not allowed to modify. The error message returned because you are not allowed to modify CircuitCode.
403 Forbidden.CircuitCodeNotAllowedByCaller The caller is not allowed to specify the CircuitCode parameter. The error message returned because you are not allowed to set CircuitCode.
403 Forbidden.LocalGatewayIpNotAllowedByCaller The caller is not allowed to specify the LocalGatewayIp parameter. The error message returned because you are not allowed to set LocalGatewayIp.
403 Forbidden.PeerGatewayIpNotAllowedByCaller The caller is not allowed to specify the PeerGatewayIp parameter. The error message returned because you are not allowed to set PeerGatewayIp.
403 Forbidden.PeeringSubnetMaskNotAllowedByCaller The caller is not allowed to specify the PeeringSubnetMask parameter. The error message returned because you are not allowed to set PeeringSubnetMask.
403 Forbidden.VlanIdNotAllowedByCaller The caller is not allowed to specify the VlanId. The error message returned because you are not allowed to specify the VLAN ID.
403 Forbidden.NameNotAllowedByCaller The caller is not allowed to specify the Name parameter. The error message returned because you are not allowed to set Name.
403 Forbidden.DescriptionNotAllowedByCaller The caller is not allowed to specify the Description parameter. The error message returned because you are not allowed to set Description.
404 InvalidRegionId.NotFound The specified RegionId is not found. The error message returned because the specified region ID is invalid. Check whether the service is available in the specified region.

For a list of error codes, visit the API Error Center.