Queries virtual border routers (VBRs).

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 DescribeVirtualBorderRouters

The operation that you want to perform.

Set the value to DescribeVirtualBorderRouters.

RegionId String Yes cn-shanghai

The ID of the region where the VBR is deployed. You can call the DescribeRegions operation to query region IDs.

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.

Filter.N.Key String No 1

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

Valid values of filter conditions:

  • PhysicalConnectionId: Filter by physical connection ID.
  • VbrId: Filter by VBR ID.
  • Status: Filter by VBR status.
  • Name: Filter by VBR name.
  • AccessPointId: Filter by access point ID.
  • type: Filter by physical connection type.
Filter.N.Value.N RepeatList No 1

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

Response parameters

Parameter Type Example Description
VirtualBorderRouterSet Array of VirtualBorderRouterType

The information about the queried VBRs.

VirtualBorderRouterType
AccessPointId String ap-cn-kojok1x*********

The ID of the access point that is associated with the physical connection.

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

The first time when the VBR was activated.

AssociatedCens Array of AssociatedCen

Cloud Enterprise Network (CEN).

AssociatedCen
CenId String cen-kojok19xxx******

The ID of the CEN instance.

CenOwnerId Long 12345678

The user ID (UID) of the Alibaba Cloud account to which the CEN instance belongs.

CenStatus String Attached

The state of the CEN instance.

AssociatedPhysicalConnections Array of AssociatedPhysicalConnection

The associated physical connection.

AssociatedPhysicalConnection
CircuitCode String 12

The circuit code of the Internet service provider (ISP) that corresponds to the router interface of the VBR.

EnableIpv6 Boolean true
LocalGatewayIp String 116.**. **. **

The IP address of the local router interface of the VBR.

LocalIpv6GatewayIp String 2000:1234:0:a000::5

The IPv6 address of the local router interface of the VBR.

PeerGatewayIp String 116.62.**. **

The IP address of the peer router interface of the VBR.

PeerIpv6GatewayIp String 2000:1234:0:a000::6

The IPv6 address of the peer router interface of the VBR.

PeeringIpv6SubnetMask String 2000:1234:0:a000::/56

The subnet mask of the peer router interface of the VBR.

PeeringSubnetMask String 255.255.255.252

The subnet mask of the connection between the local router interface and the peer router interface of the VBR.

PhysicalConnectionBusinessStatus String Normal

The business state of the physical connection.

PhysicalConnectionId String pc-119mfjzm7*********

The ID of the physical connection.

PhysicalConnectionOwnerUid String qfrgrg******

The UID of the Alibaba Cloud account to which the physical connection belongs.

PhysicalConnectionStatus String Normal

The state of the physical connection.

Status String active

The state of the physical connection. Valid values:

  • Initial: in progress
  • Approved: approved
  • Allocating: resource allocation in progress
  • Allocated: under construction
  • Confirmed: pending for user confirmation
  • Enabled: enabled
  • Rejected: rejected
  • Canceled: canceled
  • Allocation Failed: resource allocation failed
  • Terminated: terminated
VlanId String 0

The VLAN ID of the VBR.

VlanInterfaceId String ri-kojok19x3j0q6kxxxxxxxxx

The ID of the router interface of the VBR. This ID can be used as the next hop of a route entry of the VBR.

CircuitCode String longtel001

The circuit code provided by the ISP for the physical connection.

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

The time when the VBR was created.

Description String VBR

The description of the VBR.

DetectMultiplier Long 3

The multiple of the detection time.

This value indicates 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 the connection works as expected.

Valid values: 3 to 10.

EccId String ecc-h*********

EnableIpv6 Boolean true

The IPv6 address.

LocalGatewayIp String 116.62.**. **

The IP address configured on the Alibaba Cloud side.

LocalIpv6GatewayIp String 2000:1234:0:a000::3

The IPv6 address configured on the Alibaba Cloud side.

MinRxInterval Long 100

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

MinTxInterval Long 100

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

Name String test

The name of the VBR.

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

The time when the VBR expires.

PeerGatewayIp String 116.62.**. **

The IP address configured on the user side.

PeerIpv6GatewayIp String 2000:1234:0:a000::4

The IPv6 address configured on the user side.

PeeringIpv6SubnetMask String 2000:1234:0:a000::/55

The subnet masks of the IPv6 addresses configured on the user side and Alibaba Cloud side.

PeeringSubnetMask String 255.255.255.252

The subnet masks of the IP addresses configured on the user side and Alibaba Cloud side.

PhysicalConnectionBusinessStatus String Normal

The business state of the physical connection.

PhysicalConnectionId String pc-119mfjzm7x******

The ID of the physical connection to which the VBR belongs.

PhysicalConnectionOwnerUid String usdgbh123f******

The UID of the Alibaba Cloud account to which the physical connection belongs.

PhysicalConnectionStatus String Normal

The status of the physical connection.

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

The last time when the state of the VBR changes from Terminated to Active.

RouteTableId String rtb-bp1nxxxxxxxx*******

The ID of the route table of the VBR.

Status String active

The state of the VBR. Valid values:

  • Unconfirmed: pending confirmation from other users
  • Active: running as expected
  • Terminating: terminating
  • Terminated: terminated
  • Recovering: recovering
  • Deleting: being deleted
TerminationTime String 2017-06-08T12:20:55

The last time when the VBR was terminated.

Type String ecc

The type of the physical connection.

VbrId String vbr-kojok19xx******

The ID of the VBR.

VlanId Integer 10

The VLAN ID of the VBR.

VlanInterfaceId String ri-2zeo3xzyf38r4xx*******

The ID of the router interface of the VBR.

TotalCount Integer 1

The number of entries returned.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeVirtualBorderRouters
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<TotalCount>1</TotalCount>
<RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<VirtualBorderRouterSet>
    <VirtualBorderRouterType>
        <PeerGatewayIp>116.62. **. **</PeerGatewayIp>
        <MinRxInterval>100</MinRxInterval>
        <RouteTableId>rtb-bp1nxxxxxxxx*******</RouteTableId>
        <Description>VBR</Description>
        <ActivationTime>2017-06-08T12:20:55</ActivationTime>
        <PhysicalConnectionId>pc-119mfjzm7x******</PhysicalConnectionId>
        <VlanInterfaceId>ri-2zeo3xzyf38r4xx*******</VlanInterfaceId>
        <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
        <VbrId>vbr-kojok19xx******</VbrId>
        <TerminationTime>2017-06-08T12:20:55</TerminationTime>
        <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
        <PhysicalConnectionOwnerUid>usdgbh123f******</PhysicalConnectionOwnerUid>
        <RecoveryTime>2017-06-08T12:20:55</RecoveryTime>
        <Name>test</Name>
        <PeeringIpv6SubnetMask>2000:1234:0:a000::/55</PeeringIpv6SubnetMask>
        <EnableIpv6>true</EnableIpv6>
        <EccId>ecc-h*********</EccId>
        <LocalIpv6GatewayIp>2000:1234:0:a000::3</LocalIpv6GatewayIp>
        <VlanId>10</VlanId>
        <Status>active</Status>
        <CircuitCode>longtel001</CircuitCode>
        <MinTxInterval>100</MinTxInterval>
        <DetectMultiplier>3</DetectMultiplier>
        <PeerIpv6GatewayIp>2000:1234:0:a000::4</PeerIpv6GatewayIp>
        <LocalGatewayIp>116.62. **. **</LocalGatewayIp>
        <Type>ecc</Type>
        <CreationTime>2017-06-08T12:20:55</CreationTime>
        <AccessPointId>ap-cn-kojok1x*********</AccessPointId>
        <PConnVbrExpireTime>2017-06-08T12:20:55</PConnVbrExpireTime>
        <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
    </VirtualBorderRouterType>
    <VirtualBorderRouterType>
        <AssociatedPhysicalConnections>
            <AssociatedPhysicalConnection>
                <Status>active</Status>
                <PeerGatewayIp>116.62. **. **</PeerGatewayIp>
                <CircuitCode>12</CircuitCode>
                <PhysicalConnectionId>pc-119mfjzm7*********</PhysicalConnectionId>
                <VlanInterfaceId>ri-kojok19x3j0q6kxxxxxxxxx</VlanInterfaceId>
                <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
                <PeerIpv6GatewayIp>2000:1234:0:a000::6</PeerIpv6GatewayIp>
                <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                <PhysicalConnectionOwnerUid>qfrgrg******</PhysicalConnectionOwnerUid>
                <PeeringIpv6SubnetMask>2000:1234:0:a000::/56</PeeringIpv6SubnetMask>
                <LocalGatewayIp>116. **. **. **</LocalGatewayIp>
                <LocalIpv6GatewayIp>2000:1234:0:a000::5</LocalIpv6GatewayIp>
                <VlanId>0</VlanId>
                <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            </AssociatedPhysicalConnection>
            <AssociatedPhysicalConnection>
                <CenStatus>Attached</CenStatus>
                <CenOwnerId>12345678</CenOwnerId>
                <CenId>cen-kojok19xxx******</CenId>
            </AssociatedPhysicalConnection>
        </AssociatedPhysicalConnections>
        <AssociatedCens>
            <AssociatedCen>
                <Status>active</Status>
                <PeerGatewayIp>116.62. **. **</PeerGatewayIp>
                <CircuitCode>12</CircuitCode>
                <PhysicalConnectionId>pc-119mfjzm7*********</PhysicalConnectionId>
                <VlanInterfaceId>ri-kojok19x3j0q6kxxxxxxxxx</VlanInterfaceId>
                <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
                <PeerIpv6GatewayIp>2000:1234:0:a000::6</PeerIpv6GatewayIp>
                <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                <PhysicalConnectionOwnerUid>qfrgrg******</PhysicalConnectionOwnerUid>
                <PeeringIpv6SubnetMask>2000:1234:0:a000::/56</PeeringIpv6SubnetMask>
                <LocalGatewayIp>116. **. **. **</LocalGatewayIp>
                <LocalIpv6GatewayIp>2000:1234:0:a000::5</LocalIpv6GatewayIp>
                <VlanId>0</VlanId>
                <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            </AssociatedCen>
            <AssociatedCen>
                <CenStatus>Attached</CenStatus>
                <CenOwnerId>12345678</CenOwnerId>
                <CenId>cen-kojok19xxx******</CenId>
            </AssociatedCen>
        </AssociatedCens>
    </VirtualBorderRouterType>
</VirtualBorderRouterSet>

JSON format

{"TotalCount":"1","RequestId":"DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6","PageSize":"10","PageNumber":"1","VirtualBorderRouterSet":{"VirtualBorderRouterType":[{"PeerGatewayIp":"116.62. **. **","MinRxInterval":"100","RouteTableId":"rtb-bp1nxxxxxxxx*******","Description":"VBR","ActivationTime":"2017-06-08T12:20:55","PhysicalConnectionId":"pc-119mfjzm7x******","VlanInterfaceId":"ri-2zeo3xzyf38r4xx*******","PhysicalConnectionStatus":"Normal","VbrId":"vbr-kojok19xx******","TerminationTime":"2017-06-08T12:20:55","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"usdgbh123f******","RecoveryTime":"2017-06-08T12:20:55","Name":"test","PeeringIpv6SubnetMask":"2000:1234:0:a000::/55","EnableIpv6":"true","EccId":"ecc-h*********","LocalIpv6GatewayIp":"2000:1234:0:a000::3","VlanId":"10","Status":"active","CircuitCode":"longtel001","MinTxInterval":"100","DetectMultiplier":"3","PeerIpv6GatewayIp":"2000:1234:0:a000::4","LocalGatewayIp":"116.62. **. **","Type":"ecc","CreationTime":"2017-06-08T12:20:55","AccessPointId":"ap-cn-kojok1x*********","PConnVbrExpireTime":"2017-06-08T12:20:55","PhysicalConnectionBusinessStatus":"Normal"},{"AssociatedPhysicalConnections":{"AssociatedPhysicalConnection":[{"Status":"active","PeerGatewayIp":"116.62. **. **","CircuitCode":"12","PhysicalConnectionId":"pc-119mfjzm7*********","VlanInterfaceId":"ri-kojok19x3j0q6kxxxxxxxxx","PhysicalConnectionStatus":"Normal","PeerIpv6GatewayIp":"2000:1234:0:a000::6","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"qfrgrg******","PeeringIpv6SubnetMask":"2000:1234:0:a000::/56","LocalGatewayIp":"116. **. **. **","LocalIpv6GatewayIp":"2000:1234:0:a000::5","VlanId":"0","PhysicalConnectionBusinessStatus":"Normal"},{"CenStatus":"Attached","CenOwnerId":"12345678","CenId":"cen-kojok19xxx******"}]},"AssociatedCens":{"AssociatedCen":[{"Status":"active","PeerGatewayIp":"116.62. **. **","CircuitCode":"12","PhysicalConnectionId":"pc-119mfjzm7*********","VlanInterfaceId":"ri-kojok19x3j0q6kxxxxxxxxx","PhysicalConnectionStatus":"Normal","PeerIpv6GatewayIp":"2000:1234:0:a000::6","PeeringSubnetMask":"255.255.255.252","PhysicalConnectionOwnerUid":"qfrgrg******","PeeringIpv6SubnetMask":"2000:1234:0:a000::/56","LocalGatewayIp":"116. **. **. **","LocalIpv6GatewayIp":"2000:1234:0:a000::5","VlanId":"0","PhysicalConnectionBusinessStatus":"Normal"},{"CenStatus":"Attached","CenOwnerId":"12345678","CenId":"cen-kojok19xxx******"}]}}]}}

Error codes

HttpCode Error code Error message Description
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The error message returned because Filter.X.key is not supported.

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