Associates a virtual border router (VBR) with a specified Express Connect circuit.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the Express Connect circuit is deployed. You can call the DescribeRegions operation to query the most recent region list. |
VbrId | String | Yes | vbr-bp186tnz6rijyhj****** |
The ID of the VBR. |
PhysicalConnectionId | String | Yes | pc-bp1qrb3044eqixog**** |
The ID of the Express Connect circuit. |
VlanId | String | Yes | 123 |
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 the Express Connect circuit must be different.
|
CircuitCode | String | No | longtel001 |
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 parameter.
|
LocalGatewayIp | String | No | 192.168.XX.XX |
The IP address of the VBR. |
PeerGatewayIp | String | No | 192.168.XX.XX |
The IP address of the gateway device in the data center.
|
PeeringSubnetMask | String | No | 255.255.255.0 |
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. |
Action | String | Yes | AssociatePhysicalConnectionToVirtualBorderRouter |
The operation that you want to perform. Set the value to AssociatePhysicalConnectionToVirtualBorderRouter. |
ClientToken | String | No | 123e4567-e89b-12d3-a456-426655440000 |
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. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
|
LocalIpv6GatewayIp | String | No | 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b |
The IPv6 address of the VBR. |
PeerIpv6GatewayIp | String | No | 2001:XXXX:4:4:4:4:4:4 |
The IPv6 address of the gateway device in the data center.
|
PeeringIpv6SubnetMask | String | No | 2408:4004:cc:400::/56 |
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. |
EnableIpv6 | String | No | false |
Specifies whether to enable IPv6. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 980960B0-2969-40BF-8542-EBB34FD358AB |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?RegionId=cn-hangzhou
&VbrId=vbr-bp186tnz6rijyhj******
&PhysicalConnectionId=pc-bp1qrb3044eqixog****
&VlanId=123
&CircuitCode=longtel001
&LocalGatewayIp=192.168.XX.XX
&PeerGatewayIp=192.168.XX.XX
&PeeringSubnetMask=255.255.255.0
&Action=AssociatePhysicalConnectionToVirtualBorderRouter
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&LocalIpv6GatewayIp=2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
&PeerIpv6GatewayIp=2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
&PeeringIpv6SubnetMask=2408:4004:cc:400::/56
&EnableIpv6=false
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<AssociatePhysicalConnectionToVirtualBorderRouterResponse>
<RequestId>980960B0-2969-40BF-8542-EBB34FD358AB</RequestId>
</AssociatePhysicalConnectionToVirtualBorderRouterResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "980960B0-2969-40BF-8542-EBB34FD358AB"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidOperation.RouterInterfaceNotDeleted | The specified VirutalBorderRouter still has routerInterface. | The error message returned because the VBR is associated with a router interface. |
400 | InvalidOperation.OperationNotAllowedInState | The specified VirutalBorderRouter is in invalid state. | The error message returned because the specified VBR is in an invalid state. Check the status of the VBR. |
400 | InvalidStatus.NotAllowed | Invalid virtual border router status. | The error message returned because the status of the VBR does not support this operation. |
400 | InvalidPhysicalConnectionId.NotFound | The specified PhysicalConnectionId is not found. | The error message returned because the specified Express Connect circuit ID does not exist. |
400 | InvalidVlanId.Used | The specified VlanId has been used. | The error message returned because the VLAN ID is being used. |
400 | MissingParameter | The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied. | The error message returned because the PhysicalConnectionId parameter is not specified. |
400 | InvalidPhysicalConnectionId.NotEnabled | The specified PhysicalConnectionId is not in Enabled state. | The error message returned because the Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again. |
400 | MissingParameter | The input parameter 'VlanId' that is mandatory for processing this request is not supplied. | The error message returned because VlanId is not set. |
400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | The error message returned because the value of VlanId is invalid. |
400 | InvalidCircuitCode.Malformed | The specified CircuitCode is not valid. | The error message returned because CircuitCode is set to an invalid value. |
400 | MissingParameter | The input parameter 'LocalGatewayIp' that is mandatory for processing this request is not supplied. | The error message returned because LocalGatewayIp is not set. |
400 | InvalidLocalGatewayIp.Malformed | The specified LocalGatewayIp is not valid. | The error message returned because the IP address of the VBR is invalid. |
400 | MissingParameter | The input parameter 'PeerGatewayIp' that is mandatory for processing this request is not supplied. | The error message returned because PeerGatewayIp is not set. |
400 | InvalidPeerGatewayIp.Malformed | The specified PeerGatewayIp is not valid. | The error message returned because the value of PeerGatewayIp is invalid. |
400 | MissingParameter | The input parameter 'PeeringSubnetMask' that is mandatory for processing this request is not supplied. | The error message returned because PeeringSubnetMask is not set. |
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 | InvalidName.Malformed | The specified ?Name? is not valid. | The error message returned because the format of the name is invalid. |
400 | InvalidDescription.Malformed | The specifid ?Description? is not valid. | The error message returned because the specified description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
400 | QuotaExceeded.vbrPerpConn | Virtual boarder router per PhysicalConnection quota exceed. | The error message returned because the number of VBRs of each Express Connect circuit has reached the upper limit. Reduce the number of VBRs and try again. |
400 | EXCEED_ASSOCIATE_MAX_NUM | assocaite virtual boarder num too many. | The error message returned because the number of associated VBRs has reached the upper limit. |
400 | InvalidIP.Malformed | Ip malformed. | The error message returned because the format of the IP address is invalid. |
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 VBR and the gateway device in the data center do not fall within the same subnet. |
400 | InvalidStatus.StatusNotEnabled | The physical connection status is invalid. | The error message returned because the status of the Express Connect circuit does not support this operation. Check the status of the Express Connect circuit. |
400 | PHYSICAL_NOT_ALLOW_ASSOCIATE_VBR | The specified operation not allow. | The error message returned because the Express Connect circuit is associated with a VBR and the operation cannot be performed. |
400 | OperationFailed.PconnTrafficNotEnable | The operation is failed because of PconnTrafficNotEnable. | The error message returned because billing for outbound data transfer is disabled. |
403 | Forbidden.OperationNotAllowedByUser | The caller is not allowed to delete the specified VirtualBorderRouter. | The error message returned because you are not allowed to delete the VBR. |
403 | Forbidden.MultiVlanRi | Multiple vlan router interfaces are found. | The error message returned because multiple VLAN router interfaces exist. |
403 | Forbidden.NoRiFound | No vlan router interfaces are found. | The error message returned because no VLAN router interface is available. |
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.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 | InvalidInstanceId.NotFound | The specified Instance does not exist in the specified region. | The error message returned because the instance does not exist in the specified region. |
404 | InvalidVbrId.NotFound | The specified VirutalBorderRouter does not exist in our records. | The error message returned because the specified VBR does not exist. Check whether the parameter is set to a valid value. |
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. |
404 | InvalidVbrOwnerId.NotFound | The specified VbrOwnerId is not valid. | The error message returned because VbrOwnerId is set to an invalid value. |
For a list of error codes, visit the API Error Center.