Queries virtual border routers (VBRs) that are associated with a physical connection. The VBRs can be created by the owner of the physical connection and by other Alibaba Cloud accounts.

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 DescribeVirtualBorderRoutersForPhysicalConnection

The operation that you want to perform.

Set the value to DescribeVirtualBorderRoutersForPhysicalConnection.

PhysicalConnectionId String Yes pc-119mfj****

The ID of the physical connection.

RegionId String Yes cn-shanghai

The ID of the region where the physical connection is created. You can call the DescribeRegions operation to query region IDs.

Filter.N.Key String No 1

The key of the filter condition. Valid values of N: 1 to 5.

Valid values:

  • PhysicalConnectionId: the ID of the physical connection
  • VbrId: the ID of the VBR
  • Status: the state of the VBR
  • Name: the name of the VBR
  • AccessPointId: the ID of the access point
  • eccId: the ID of the Express Cloud Connect (ECC) instance
  • type: the type of the VBR
Filter.N.Value.N RepeatList No 1

The value of the filter condition. Valid values of N: 1 to 5.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
RequestId String 7C5AE8B3-A2D8-428D-A2FF-93A225C0821E

The ID of the request.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

TotalCount Integer 2

The total number of entries.

VirtualBorderRouterForPhysicalConnectionSet Array

The VBRs that are queried.

VbrId String vbr-bp16ksp61j7e0tk*****

The ID of the VBR.

VbrOwnerUid Long 1231579085529

The account ID of the VBR owner. When the VBR owner and the physical connection owner are the same, this parameter is empty.

EccId String ecc-sjghe****

The ID of the ECC instance.

Type String pconnVBR

The type of the VBR.

CreationTime String 2017-06-08T12:20:55

The time when the VBR was created.

ActivationTime String 2017-06-08T12:20:55

The first time when the VBR was enabled.

TerminationTime String 2017-06-08T12:20:55

The last time when the VBR was disabled.

RecoveryTime String 2017-06-08T12:20:55

The last time when the VBR was recovered from the Terminated state to the Active state.

VlanId Integer 1678

The VLAN ID of the VBR.

Status String Available

The state of the VBR.

CircuitCode String longtel001

The circuit code provided by the Internet service provider (ISP) for the physical connection.

LocalGatewayIp String 10.0.0.**

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

PeerGatewayIp String 10.0.0.**

The IP address of the VBR on the user side.

PeeringSubnetMask String 255.255.255.0

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

PConnVbrChargeType String PrePaid

The billing method of the VBR that is associated with the physical connection.

  • PrePaid: subscription. If you select subscription, make sure that your Alibaba Cloud account supports balance payments or credit payments
  • PostPaid: pay-as-you-go.
PConnVbrExpireTime String 2017-06-08T12:20:55

The time when the VBR expires.

PConnVbrBussinessStatus String Available

The state of the VBR.

Bandwidth String 10

The bandwidth of the VBR.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeVirtualBorderRoutersForPhysicalConnection
&PhysicalConnectionId=pc-119mfj****
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<? xml version="1.0" encoding="UTF-8"? >
<DescribeVirtualBorderRoutersForPhysicalConnectionResponse>
	<RequestId>03E8CB87-5876-4034-BBB2-6E0851281C37</RequestId>
	<PageNumber>1</PageNumber>
	<TotalCount>2</TotalCount>
	<PageSize>10</PageSize>
	<VirtualBorderRouterForPhysicalConnectionSet>
		<VirtualBorderRouterForPhysicalConnectionType>
			<ActivationTime>2018-03-06T11:16:34Z</ActivationTime>
			<CreationTime>2018-03-06T11:16:34Z</CreationTime>
			<CircuitCode></CircuitCode>
			<VlanId>10</VlanId>
			<RecoveryTime></RecoveryTime>
			<VbrOwnerUxxx231579085529123</VbrOwnerUid>
			<TerminationTime></TerminationTime>
			<VbrId>Vbr-2zecmmvg5gvu8******</VbrId>
		</VirtualBorderRouterForPhysicalConnectionType>
		<VirtualBorderRouterForPhysicalConnectionType>
			<ActivationTime>2018-01-04T13:34:18Z</ActivationTime>
			<CreationTime>2018-01-04T13:34:18Z</CreationTime>
			<CircuitCode></CircuitCode>
			<VlanId>100</VlanId>
			<RecoveryTime></RecoveryTime>
			<VxxxbrOwnerUid>1231579085529123</VbrOwnerUid>
			<TerminationTime></TerminationTime>
			<VbrId>vbr-2zee2e2cwetx4k*****</VbrId>
		</VirtualBorderRouterForPhysicalConnectionType>
</DescribeVirtualBorderRoutersForPhysicalConnectionResponse>

JSON format

{
    "PageNumber": 1, 
    "TotalCount": 2, 
    "PageSize": 10, 
    "RequestId": "03E8CB87-5876-4034-BBB2-6E0851281C37", 
    "VirtualBorderRouterForPhysicalConnectionSet": {
        "VirtualBorderRouterForPhysicalConnectionType": [
            {
                "ActivationTime": "2018-03-06T11:16:34Z", 
                "CreationTime": "2018-03-06T11:16:34Z", 
                "CircuitCode": "", 
                "VlanId": 10, 
                "RecoveryTime": "", 
                "VbrOwnerUid": "1231579085xxxxxx529123", 
                "TerminationTime": "", 
                "VbrId": "vbr-2zecmmvg5gvu8*****"
            }, 
            {
                "ActivationTime": "2018-01-04T13:34:18Z", 
                "CreationTime": "2018-01-04T13:34:18Z", 
                "CircuitCode": "", 
                "VlanId": 100, 
                "RecoveryTime": "", 
                "VbrOwnerUid": "1231579085****", 
                "TerminationTime": "", 
                "VbrId": "vbr-2zee2e2cwetx4k0t*****"
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidPhysicalConnectionId.NotFound The specified PhysicalConnectionId does not belong to user. The error message returned because the specified physical connection does not belong to your Alibaba Cloud account.

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