All Products
Search

This Product

    Virtual Private Cloud:ModifyVirtualBorderRouterAttribute

    Document Center

    Virtual Private Cloud:ModifyVirtualBorderRouterAttribute

    Last Updated:Dec 20, 2024

    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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:ModifyVirtualBorderRouterAttributeupdate
    *VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the VBR.

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

    		cn-shanghai
    VbrIdstringYes

    The VBR ID.

    		vbr-bp1lhl0taikrte****
    VlanIdintegerNo

    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
    CircuitCodestringNo

    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
    LocalGatewayIpstringNo

    The IP address of the VBR.

    Only the owner of the VBR can set or modify this parameter.

    		192.168.XX.XX
    PeerGatewayIpstringNo

    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
    PeeringSubnetMaskstringNo

    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
    MinTxIntervallongNo

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

    		300
    MinRxIntervallongNo

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

    		300
    DetectMultiplierlongNo

    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
    DescriptionstringNo

    The description of the VBR.

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

    		desc
    NamestringNo

    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://.

    		VBR
    AssociatedPhysicalConnectionsstringNo

    The information about the Express Connect circuit associated with the VBR, including the following parameters:

    • CircuitCode: the circuit code provided by the connectivity provider for the Express Connect circuit.
    • LocalGatewayIp: the IP address of the gateway device on the Alibaba Cloud side.
    • PeerGatewayIp: the IP address of the gateway device on the customer side.
    • PeeringSubnetMask: the subnet mask for the IP addresses of gateway devices on the Alibaba Cloud side and the customer side.
    • PhysicalConnectionId: the ID of the Express Connect circuit.
    		[ { "CircuitCode ": "longtel001", " LocalGatewayIp ": "192.168.XX.XX", "PeerGatewayIp" : "192.168.XX.XX", " PeeringSubnetMask ": "255.255.255.252", " PhysicalConnectionId ": "pc-kojok19****" } ]
    ClientTokenstringNo

    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****
    LocalIpv6GatewayIpstringNo

    The IPv6 address of the VBR.

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

    The IPv6 address of the gateway device in the data center.

    • Only the owner of the VBR can set or modify this property.
    • This property is required when you create a VBR for the owner of the Express Connect circuit. You can ignore this property when you create a VBR for another Alibaba Cloud account.
    		2001:XXXX:3c4d:0015:0000:0000:0000:2a2b
    PeeringIpv6SubnetMaskstringNo

    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
    EnableIpv6booleanNo

    Specifies whether to enable IPv6. Valid values:

    • true
    • false (default)
    		false
    BandwidthintegerNo

    The bandwidth value. Unit: Mbit/s.

    		100

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

    		980960B0-2969-40BF-8542-EBB34FD358AB

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.AssociatedPhysicalConnectionsThe specified AssociatedPhysicalConnections is illegal.The specified AssociatedPhysicalConnections is illegal.
    400IllegalParam.IpAddressThe specified IpAddress is illegal.The specified IpAddress is illegal
    400IllegalParam.CidrBlockThe specified CidrBlock is illegal.The operation failed because CidrBlock is set to an invalid value.
    400InvalidVbrId.NotFoundThe specified VirutalBorderRouter is not found.The VBR does not exist. Check the VBR ID.
    400IllegalParam.MinTxIntervalThe specified MinTxInterval is not in proper range.The specified MinTxInterval is not in the proper range.
    400IllegalParam.MinRxIntervalThe specified MinRxInterval is not in proper range.The specified MinRxInterval is not in the proper range.
    400IllegalParam.DetectMultiplierThe specified DetectMultiplier is not in proper range.DetectMultiplier parameters are not in the proper range.
    400InvalidVlanId.UsedThe specified VlanId has been used.The VLAN ID is in use.
    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 is set to an invalid value.
    400InvalidVlanId.MalformedThe specified VlanId is not valid.VlanId is set to an invalid value.
    400InvalidIp.MalformedThe specified ip address is not valid.The specified private IP address is invalid.
    400InvalidPeeringSubnetMask.MalformedThe specified PeeringSubnetMask is not valid.PeeringSubnetMask is set to an invalid value.
    400InvalidName.MalformedThe specified Name is not valid.The Name parameter is set to an invalid value.
    400InvalidDescription.MalformedThe specifid Description is not valid.The Description parameter is set to an invalid value.
    400MissingParameterLocalGatewayIp, peerGatewayIp and peeringSubnetMask must not be null.The following parameters are required but not set: LocalGatewayIp, peerGatewayIp, and peeringSubnetMask.
    400InvalidIp.NotSameSubnetLocal 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.
    400InvalidParameter%s-
    400OperationFailed.VlanIdInUseOperation failed because vlanId is in use.The VLAN ID is already used.
    400IncorrectStatus.VirtualBorderRouter%s-
    400OperationUnsupported.IPV6ForThisRegionThis Region do not support IPV6.The region does not support IPv6.
    400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
    400OperationDenied.VBRAssociateVPconnThe operation is not allowed because of VBRAssociateVPconn.The operation failed because you cannot associate a VBR with the hosted connection.
    400OperationFailed.PhysicalConnectionFinancialLockedUpdate failed, the physical connection is financial locked.The shared port is locked due to overdue payments and you cannot modify the VLAN.
    400OperationFailed.PhysicalConnectionTerminatedUpdate failed, the physical connection is terminated.The shared port is disabled and you cannot modify the VLAN.
    400DuplicatedParam.LocalGatewayIpThe LocalGatewayIp values are duplicated.The error message returned because a duplicate IP address is used for communication. Change the IP address and try again.
    400Forbidden.VbrNotAllowModifySiteLinkCan not modify virtualBorderRouter site link, please call PD to authorize.-
    400OperationUnsupported.VirtualBorderRouterEnableIPv6The operation failed. The device or region does not support IPv6 functions.The operation failed because the device or region does not support IPv6.
    400OperationFailed.PconnAllocateVlan0Vlan 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.
    403Forbidden.CircuitCodeNotAllowedByCallerThe caller is not allowed to modify.You are not allowed to modify CircuitCode.
    403Forbidden.CircuitCodeNotAllowedByCallerThe caller is not allowed to specify the CircuitCode parameter.You are not allowed to specify CircuitCode.
    403Forbidden.LocalGatewayIpNotAllowedByCallerThe caller is not allowed to specify the LocalGatewayIp parameter.You are not allowed to specify LocalGatewayIp.
    403Forbidden.PeerGatewayIpNotAllowedByCallerThe caller is not allowed to specify the PeerGatewayIp parameter.You do not have permissions to set the PeerGatewayIp parameter.
    403Forbidden.PeeringSubnetMaskNotAllowedByCallerThe caller is not allowed to specify the PeeringSubnetMask parameter.You are not allowed to specify PeeringSubnetMask.
    403Forbidden.VlanIdNotAllowedByCallerThe caller is not allowed to specify the VlanId.You are not allowed to specify the VLAN ID.
    403Forbidden.NameNotAllowedByCallerThe caller is not allowed to specify the Name parameter.You do not have the permissions to set the Name parameter.
    403Forbidden.DescriptionNotAllowedByCallerThe caller is not allowed to specify the Description parameter.You are not allowed to set Description.
    404InvalidRegionId.NotFoundThe 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 timeSummary of changesOperation
    2024-06-28The Error code has changedView Change Details
    2024-05-08The Error code has changedView Change Details
    2024-01-04API Description Update. The Error code has changedView Change Details
    2023-12-26API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details