Modifies the configurations of a Virtual Border Router (VBR).

Note the following before you call this API:

  • The VLAN ID can only be modified by the owner of the physical connection.
  • A VLAN ID of a physical connection cannot be used by two VBRs at the same time.
  • After a VBR enters the Terminated state, its VLAN ID is retained for seven days and is not allowed to be used by other VBRs during this period. It can be used by other VBRs seven days after the termination of the VBR.
  • You cannot configure the LocalGatewayIp, PeerGatewayIp, and PeeringSubnetMask parameters for VBRs that belong to other accounts.
  • Requirements on LocalGatewayIp, PeerGatewayIp, and PeeringSubnetMask are as follows:
    • PeeringSubnetMask can be in the range of /24 to /30.
    • PeeringSubnetMask supports dotted decimal notation and can be in the range of 255.255.255.0 to 255.255.255.252.
    • LocalGatewayIp and PeerGatewayIp must be in the same CIDR block.

      For example,

    • LocalGatewayIp: 192.168.xx 17
    • PeerGatewayIp: 192.168.xx 18
    • PeeringSubnetMask: 255.255.255.248

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
Action String Yes ModifyVirtualBorderRouterAttribute

The name of this action. Value: ModifyVirtualBorderRouterAttribute

RegionId String Yes cn-shanghai

The ID of the region to which the VBR belongs. To query the region ID, call DescribeRegions.

VbrId String Yes vbr-**************

The ID of the VBR.

AssociatedPhysicalConnections String No pc-kojok19xxxxxxxxx

Optional. The ID of the physical connection.

CircuitCode String No longtel001

Optional. The leased line code provided by the service provider for the physical connection.

Note This parameter can only be specified by the owner of the physical connection.
ClientToken String No 02fb3da4-130e-11e9-8e44-00xxxxxxxx

Optional. The client token. It is used to guarantee the idempotence of the request. The value of this parameter is generated by the client. The value is unique among different requests and is 1 to 64 ASCII characters in length.

Description String No VBR

Optional. The description of the VBR. The description must be 2 to 256 characters in length. It must start with a letter or a Chinese character, and cannot start with http:// or https://.

DetectMultiplier Long No 3

Optional. The multiplier of the detection time, that is, the maximum number of discarded connection packets that the receiver allows from the sender. Value range: 3 to 10.

LocalGatewayIp String No 116.62.xx.xx

Optional. The Alibaba Cloud-side IP address used by the VBR.

MinRxInterval Long No 100

Optional. The time interval between two consecutive BFD packets that are received. Value range: 200 to 1000. Unit: ms

MinTxInterval Long No 100

Optional. The time interval between two consecutive BFD packets that are sent. Value range: 200 to 1000. Unit: ms

Name String No test

The name of the VBR. The name must be 2 and 128 characters in length and can contain letters, numbers, periods (.), underscores (_), and hyphens (-). The name must start with a letter or a Chinese character. It cannot start with http:// or https://.

PeerGatewayIp String No 120.120.xx.xx

Optional. The customer-side IP address used by the VBR. Only the VBR owner can specify or modify this parameter. For VBRs in the Enabled state, you cannot leave this parameter empty.

PeeringSubnetMask String No 255.255.128.0

Optional. The subnet mask of the Alibaba Cloud-side IP address and the customer-side IP address. The two IP addresses must be in the same subnet.

VlanId Integer No 12

Optional. The VLAN ID of the VBR. Value range: 1 to 2999

Note This parameter can only be specified by the owner of the physical connection. The VLAN IDs of two VBRs associated with the same physical connection must be different.

Response parameters

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

The request ID.

Examples

Request example


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

Response examples

XML format

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

JSON format

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

Error codes

HTTP status code Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId is not found. The specified region ID is invalid. Please check if the cloud service is available in the specified region.
400 InvalidVbrId.NotFound The specified VirutalBorderRouter is not found. The specified VBR does not exist.
400 InvalidVlanId.Used The specified VlanId has been used. The specified VLAN is already occupied.
400 InvalidCircuitCode.Malformed The specified CircuitCode is not valid. The specified value of the CircuitCode parameter is invalid.
400 InvalidVlanId.Malformed The specified VlanId is not valid. The specified value of the VlanId parameter is invalid.
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. The specified value of the PeeringSubnetMask parameter is invalid.
403 Forbidden.CircuitCodeNotAllowedByCaller The caller is not allowed to modify. You are not allowed to modify the CircuitCode parameter.
403 Forbidden.CircuitCodeNotAllowedByCaller The caller is not allowed to specify the CircuitCode parameter. You are not allowed to specify the CircuitCode parameter.
403 Forbidden.LocalGatewayIpNotAllowedByCaller The caller is not allowed to specify the LocalGatewayIp parameter. You are not allowed to specify the LocalGatewayIp parameter.
403 Forbidden.PeerGatewayIpNotAllowedByCaller The caller is not allowed to specify the PeerGatewayIp parameter. You are not allowed to specify the PeerGatewayIp parameter.
403 Forbidden.PeeringSubnetMaskNotAllowedByCaller The caller is not allowed to specify the PeeringSubnetMask parameter. You are not allowed to specify the PeeringSubnetMask parameter.
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 are not allowed to specify the Name parameter.
403 Forbidden.DescriptionNotAllowedByCaller The caller is not allowed to specify the Description parameter. You are not allowed to specify the Description parameter.
400 InvalidIp.NotSameSubnet Local gateway ip and peer gateway ip are not in the same subnet. The local gateway IP address and the peer gateway IP address are not in the same subnet.

See common error codes.