All Products
Search

This Product

    Virtual Private Cloud:AssociatePhysicalConnectionToVirtualBorderRouter

    Document Center

    Virtual Private Cloud:AssociatePhysicalConnectionToVirtualBorderRouter

    Last Updated:Mar 22, 2024

    Associates a virtual border router (VBR) with a specified Express Connect circuit.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:AssociatePhysicalConnectionToVirtualBorderRouterWrite
    • PhysicalConnection
      acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}
    • VirtualBorderRouter
      acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the Express Connect circuit.

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

    		cn-hangzhou
    VbrIdstringYes

    The ID of the VBR.

    		vbr-bp186tnz6rijyhj******
    PhysicalConnectionIdstringYes

    The ID of the Express Connect circuit.

    		pc-bp1qrb3044eqixog****
    VlanIdstringYes

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

    Note Only the Express Connect circuit owner can specify this parameter. Two VBRs associated with the same Express Connect circuit cannot use the same VLAN ID.
    		123
    CircuitCodestringNo

    The circuit code of the Express Connect circuit. The circuit code is provided by the connectivity provider.

    Note Only the Express Connect circuit owner can specify this parameter.
    		longtel001
    LocalGatewayIpstringNo

    The IP address of the gateway device on the Alibaba Cloud side.

    		192.168.XX.XX
    PeerGatewayIpstringNo

    The IP address of the gateway device on the user side.

    • Only the owner of the VBR can set or modify this parameter.
    • When you create a VBR for the owner of the Express Connect circuit, this parameter is required.
    		192.168.XX.XX
    PeeringSubnetMaskstringNo

    The subnet mask of the IP addresses of the VBR and the gateway device in the data center.

    The two IP addresses must fall within the same subnet.

    		255.255.255.0
    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 and cannot exceed 64 characters in length.

    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.
    		123e4567-e89b-12d3-a456-426655440000
    LocalIpv6GatewayIpstringNo

    The IPv6 address of the gateway device on the Alibaba Cloud side.

    		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 specify or modify this parameter.
    • When you create a VBR for the owner of the Express Connect circuit, this parameter is required.
    		2001:XXXX:4:4:4:4:4:4
    PeeringIpv6SubnetMaskstringNo

    The subnet mask of the IPv6 addresses of the gateway devices on the user side and Alibaba Cloud side.

    The two IPv6 addresses must fall within the same subnet.

    		2408:4004:cc:400::/56
    EnableIpv6stringNo

    Specifies whether to enable IPv6. Valid values:

    • true
    • false (default)
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    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
    400InvalidOperation.RouterInterfaceNotDeletedThe specified VirutalBorderRouter still has routerInterface.The VBR is associated with a router interface.
    400InvalidOperation.OperationNotAllowedInStateThe specified VirutalBorderRouter is in invalid state.The specified VBR is in an invalid state. Check the status of the VBR.
    400InvalidStatus.NotAllowedInvalid virtual border router status.The current VBR status does not support this operation.
    400InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId is not found.The specified Express Connect circuit ID does not exist.
    400InvalidVlanId.UsedThe specified VlanId has been used.The VLAN ID is in use.
    400MissingParameterThe input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied.PhysicalConnectionId is not specified.
    400InvalidPhysicalConnectionId.NotEnabledThe specified PhysicalConnectionId is not in Enabled state.The Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again.
    400MissingParameterThe input parameter 'VlanId' that is mandatory for processing this request is not supplied.VlanId is not specified.
    400InvalidVlanId.MalformedThe specified VlanId is not valid.VlanId is set to an invalid value.
    400InvalidCircuitCode.MalformedThe specified CircuitCode is not valid.CircuitCode is set to an invalid value.
    400MissingParameterThe input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied.LocalGatewayIp is not specified.
    400InvalidLocalGatewayIp.MalformedThe specified LocalGatewayIp is not valid.The IP address of the local gateway is invalid.
    400MissingParameterThe input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied.PeerGatewayIp is not specified.
    400InvalidPeerGatewayIp.MalformedThe specified PeerGatewayIp is not valid.PeerGatewayIp is set to an invalid value.
    400MissingParameterThe input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied.PeeringSubnetMask is not specified.
    400InvalidPeeringSubnetMask.MalformedThe specified PeeringSubnetMask is not valid.PeeringSubnetMask is set to an invalid value.
    400InvalidName.MalformedThe specified ?Name? is not valid.The error message returned because the name format is invalid.
    400InvalidDescription.MalformedThe specifid ?Description? is not valid.The error message returned because the specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    400QuotaExceeded.vbrPerpConnVirtual boarder router per PhysicalConnection quota exceed.The number of VBRs of each Express Connect circuit has reached the upper limit. Reduce the number of VBRs and try again.
    400EXCEED_ASSOCIATE_MAX_NUMassocaite virtual boarder num too many.The number of associated VBRs has reached the upper limit.
    400InvalidIP.MalformedIp malformed.The format of the IP address is invalid.
    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.
    400InvalidStatus.StatusNotEnabledThe physical connection status is invalid.The status of the Express Connect circuit does not support this operation. Check the status of the Express Connect circuit.
    400InvalidParams.AlreadyExistsphysical connection has already associated with vbr.-
    400PHYSICAL_NOT_ALLOW_ASSOCIATE_VBRThe specified operation not allow.The Express Connect circuit is associated with a VBR and the operation cannot be performed.
    400Forbidden.OperationNotAllowedThe caller must be PhysicalConnection or VirtualBorderRouter's owner.-
    400Forbidden.NotSameAccessDeviceVbr and physicalConnection are not on the same accessDevice.The VBR and Express Connect circuit do not belong to the same device.
    400Duplicated.LocalGatewayIpVbr has conflict local gateway ip.-
    400OperationFailed.VlanIdInUseOperation failed because vlanId is in use.The VLAN ID is already used.
    400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
    400DuplicatedParam.LocalGatewayIpDuplicated LocalGatewayIp values.The local IP address already exists.
    400DuplicatedParam.PeerGatewayIpDuplicated PeerGatewayIp values.The peer IP address already exists.
    400DuplicatedParam.LocalIpv6GatewayIpDuplicated LocalIpv6GatewayIp values.The local IP address already exists.
    400DuplicatedParam.PeerIpv6GatewayIpDuplicated PeerIpv6GatewayIp values.The peer IP address already exists.
    403Forbidden.OperationNotAllowedByUserThe caller is not allowed to delete the specified VirtualBorderRouter.You are not allowed to delete the VBR.
    403Forbidden.MultiVlanRiMultiple vlan router interfaces are found.Multiple VLAN router interfaces exist.
    403Forbidden.NoRiFoundNo vlan router interfaces are found.No VLAN router interface is available.
    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.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.
    404InvalidInstanceId.NotFoundThe specified Instance does not exist in the specified region.The instance does not exist in the region.
    404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
    404InvalidVbrId.NotFoundThe specified VirutalBorderRouter does not exist in our records.The VBR does not exist. Check the VBR ID.
    404InvalidRegionId.NotFoundThe specified RegionId is not found.The specified region ID is invalid. Check whether the service is available in the specified region.
    404InvalidVbrOwnerId.NotFoundThe specified VbrOwnerId is not valid.VbrOwnerId is set to an invalid value.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-02-01API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-04-10The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404