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 VBRs are deployed. You can call the DescribeRegions operation to query the most recent region list.

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 Status

The filter conditions. You can specify at most five filter conditions. The following filter conditions are supported:

  • PhysicalConnectionId: Filter by Express Connect circuit ID.
  • VbrId: Filter by VBR ID.
  • Status: Filter by VBR status.
  • Name: Filter by VBR name.
  • AccessPointId: Filter by access point ID.
  • eccId: Filter by Express Cloud Connect (ECC) instance ID.
  • type: Filter by Express Connect circuit type.
Filter.N.Value.N String No Active

Specifies filter values based on keys. You can specify multiple filter values for one key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched.

Response parameters

Parameter Type Example Description
RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The ID of the request.

PageNumber Integer 1

The page number of the returned page. Default value: 1.

PageSize Integer 10

The number of entries returned per page. Maximum value: 50. Default value: 10.

TotalCount Integer 1

The number of entries returned.

VirtualBorderRouterSet Array of VirtualBorderRouterType

The information about the queried VBRs.

VirtualBorderRouterType
CreationTime String 2020-06-08T12:20:55

The time when the VBR was created.

Status String active

The status of the VBR. Valid values:

  • Unconfirmed: pending confirmation from other users
  • active: normal
  • Terminating: being disabled
  • Terminated: disabled
  • Recovering: being enabled
  • deleting: being deleted
Type String pconnVBR

The type of the VBR.

MinTxInterval Long 300

The time interval to send Bidirectional Forwarding Detection (BFD) packets. Valid values: 200 to 1000. Unit: milliseconds.

PeerIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

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

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

The time when the VBR expires.

PhysicalConnectionOwnerUid String 1688000000000****

The UID of the Alibaba Cloud account to which the Express Connect circuit belongs.

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

The first time when the VBR was activated.

PhysicalConnectionBusinessStatus String Normal

The business status of the Express Connect circuit.

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
Description String desc

The description of the VBR.

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

The last time when the VBR was disabled.

MinRxInterval Long 300

The time interval to receive Bidirectional Forwarding Detection (BFD) packets. Valid values: 200 to 1000. Unit: milliseconds.

PeerGatewayIp String 192.168.XX.XX

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

Name String test

The name of the VBR.

VbrId String vbr-bp1jcg5cmxjbl9xgc****

The ID of the VBR.

VlanId Integer 10

The VLAN ID of the VBR.

VlanInterfaceId String ri-2zeo3xzyf38r4xx****

The ID of the VBR interface.

CircuitCode String longtel0****

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

LocalIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

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

LocalGatewayIp String 192.168.XX.XX

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

PeeringSubnetMask String 255.255.255.252

The subnet mask of the IPv4 addresses configured on the user side and Alibaba Cloud side.

EnableIpv6 Boolean false

Indicates whether IPv6 is enabled. Valid values:

  • true: yes
  • false: no
RouteTableId String rtb-bp1****

The ID of the VBR route table.

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

The ID of the ECC instance.

CloudBoxInstanceId String cb-****

The ID of the CloudBox instance.

RecoveryTime String 2021-05-08T12:20:55

The last time when the status of the VBR changed from terminated to active.

PhysicalConnectionStatus String Normal

The status of the Express Connect circuit. Valid values:

  • Initial: The application is under review.
  • Approved: The application is approved.
  • Allocating: The system is allocating resources.
  • Allocated: The Express Connect circuit is under construction.
  • Confirmed: The Express Connect circuit is pending for user confirmation.
  • Enabled: The Express Connect circuit is enabled.
  • Rejected: The application is rejected.
  • Canceled: The application is canceled.
  • Allocation Failed: The system failed to allocate resources.
  • Terminated: The Express Connect circuit is disabled.
PeeringIpv6SubnetMask String 2000:1234:0:a000::/55

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

AccessPointId String ap-cn-kojok1x****

The ID of the access point.

PConnVbrChargeType String PrePaid

The billing method of the VBR that is associated with the Express Connect circuit.

  • PrePaid: subscription If you choose this billing method, make sure that your Alibaba Cloud account supports balance payments or credit payments.
  • PostPaid: pay-as-you-go
PhysicalConnectionId String pc-119mfjzm7x****

The ID of the Express Connect circuit to which the VBR belongs.

AssociatedPhysicalConnections Array of AssociatedPhysicalConnection

The information about the Express Connect circuit that is associated with the VBR.

AssociatedPhysicalConnection
Status String active

The status of the VBR. Valid values:

  • Unconfirmed: pending confirmation from other users
  • active: normal
  • Terminating: being disabled
  • Terminated: disabled
  • Recovering: being enabled
  • deleting: being deleted
VlanInterfaceId String ri-kojok19x3j0q6k****

The ID of the VBR interface, which can be used as the next hop of a VBR route.

CircuitCode String longtel0**

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

PeerIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

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

LocalIpv6GatewayIp String 2001:XXXX:3c4d:0015:0000:0000:0000:1a2b

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

PhysicalConnectionOwnerUid String 12345678****

The UID of the Alibaba Cloud account to which the Express Connect circuit belongs.

LocalGatewayIp String 192.168.XX.XX

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

PhysicalConnectionBusinessStatus String Normal

The business status of the Express Connect circuit.

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
PeeringSubnetMask String 255.255.255.252

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

The two IPv4 addresses must fall within the same subnet.

EnableIpv6 Boolean true

Indicates whether IPv6 is enabled. Valid values:

  • true: yes
  • false: no
PhysicalConnectionStatus String Enabled

The status of the Express Connect circuit. Valid values:

  • Initial: The application is under review.
  • Approved: The application is approved.
  • Allocating: The system is allocating resources.
  • Allocated: The Express Connect circuit is under construction.
  • Confirmed: The Express Connect circuit is pending for user confirmation.
  • Enabled: The Express Connect circuit is enabled.
  • Rejected: The application is rejected.
  • Canceled: The application is canceled.
  • Allocation Failed: The system failed to allocate resources.
  • Terminated: The Express Connect circuit is disabled.
PeerGatewayIp String 116.62.XX.XX

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

PeeringIpv6SubnetMask String 2408:4004:cc:400::/56

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

The two IPv6 addresses must fall within the same subnet.

PhysicalConnectionId String pc-119mfjzm7****

The ID of the Express Connect circuit.

VlanId String 0

The VLAN ID of the VBR.

AssociatedCens Array of AssociatedCen

The information about the Cloud Enterprise Network (CEN) instance to which the VBR is attached.

AssociatedCen
CenOwnerId Long 1688000000000****

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

CenId String cen-kojok19xxx****

The ID of the CEN instance.

CenStatus String Attached

The status of the CEN instance. Valid values:

  • Attached: The VBR is attached to the CEN instance.
  • Attaching: The VBR is being attached to the CEN instance.
  • Detached: The VBR is detached from the CEN instance.
  • Detaching: The VBR is being detached from the CEN instance.
  • If no value is returned, the VBR is not attached to a CEN instance.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVirtualBorderRoutersResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
    <PageNumber>1</PageNumber>
    <VirtualBorderRouterSet>
        <VirtualBorderRouterType>
            <MinRxInterval>300</MinRxInterval>
            <PeerGatewayIp>192.168.XX.XX</PeerGatewayIp>
            <Description>desc</Description>
            <RouteTableId>rtb-bp1******</RouteTableId>
            <ActivationTime>2021-06-08T12:20:55</ActivationTime>
            <PhysicalConnectionId>pc-119mfjzm7x******</PhysicalConnectionId>
            <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
            <VlanInterfaceId>ri-2zeo3xzyf38r4xx*******</VlanInterfaceId>
            <VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
            <PhysicalConnectionOwnerUid>16880000000000000</PhysicalConnectionOwnerUid>
            <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
            <TerminationTime>2021-06-08T12:20:55</TerminationTime>
            <EnableIpv6>false</EnableIpv6>
            <PeeringIpv6SubnetMask>2000:1234:0:a000::/55</PeeringIpv6SubnetMask>
            <Name>test</Name>
            <RecoveryTime>2021-05-08T12:20:55</RecoveryTime>
            <EccId>ecc-h*********</EccId>
            <LocalIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</LocalIpv6GatewayIp>
            <VlanId>10</VlanId>
            <Status>active</Status>
            <CircuitCode>longtel0**</CircuitCode>
            <MinTxInterval>300</MinTxInterval>
            <PeerIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</PeerIpv6GatewayIp>
            <DetectMultiplier>3</DetectMultiplier>
            <PConnVbrChargeType>PrePaid</PConnVbrChargeType>
            <Type>pconnVBR</Type>
            <LocalGatewayIp>192.168.XX.XX</LocalGatewayIp>
            <AccessPointId>ap-cn-kojok1x******</AccessPointId>
            <CreationTime>2020-06-08T12:20:55</CreationTime>
            <PConnVbrExpireTime>2021-06-08T12:20:55</PConnVbrExpireTime>
            <CloudBoxInstanceId>cb-*********</CloudBoxInstanceId>
            <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
            <AssociatedPhysicalConnections>
                <AssociatedPhysicalConnection>
                    <Status>active</Status>
                    <PeerGatewayIp>116.62.XX.XX</PeerGatewayIp>
                    <CircuitCode>longtel0**</CircuitCode>
                    <PhysicalConnectionId>pc-119mfjzm7******</PhysicalConnectionId>
                    <PhysicalConnectionStatus>Enabled</PhysicalConnectionStatus>
                    <VlanInterfaceId>ri-kojok19x3j0q6k****</VlanInterfaceId>
                    <PeerIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</PeerIpv6GatewayIp>
                    <PhysicalConnectionOwnerUid>12345678****</PhysicalConnectionOwnerUid>
                    <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                    <EnableIpv6>true</EnableIpv6>
                    <PeeringIpv6SubnetMask>2408:4004:cc:400::/56</PeeringIpv6SubnetMask>
                    <LocalGatewayIp>192.168.XX.XX</LocalGatewayIp>
                    <LocalIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</LocalIpv6GatewayIp>
                    <VlanId>0</VlanId>
                    <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
                </AssociatedPhysicalConnection>
            </AssociatedPhysicalConnections>
            <AssociatedCens>
                <AssociatedCen>
                    <CenStatus>Attached</CenStatus>
                    <CenOwnerId>16880000000000000</CenOwnerId>
                    <CenId>cen-kojok19xxx******</CenId>
                </AssociatedCen>
            </AssociatedCens>
        </VirtualBorderRouterType>
    </VirtualBorderRouterSet>
</DescribeVirtualBorderRoutersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber" : 1,
  "VirtualBorderRouterSet" : {
    "VirtualBorderRouterType" : {
      "MinRxInterval" : 300,
      "PeerGatewayIp" : "192.168.XX.XX",
      "Description" : "desc",
      "RouteTableId" : "rtb-bp1******",
      "ActivationTime" : "2021-06-08T12:20:55",
      "PhysicalConnectionId" : "pc-119mfjzm7x******",
      "PhysicalConnectionStatus" : "Normal",
      "VlanInterfaceId" : "ri-2zeo3xzyf38r4xx*******",
      "VbrId" : "vbr-bp1jcg5cmxjbl9xgc****",
      "PhysicalConnectionOwnerUid" : 16880000000000000,
      "PeeringSubnetMask" : "255.255.255.252",
      "TerminationTime" : "2021-06-08T12:20:55",
      "EnableIpv6" : false,
      "PeeringIpv6SubnetMask" : "2000:1234:0:a000::/55",
      "Name" : "test",
      "RecoveryTime" : "2021-05-08T12:20:55",
      "EccId" : "ecc-h*********",
      "LocalIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
      "VlanId" : 10,
      "Status" : "active",
      "CircuitCode" : "longtel0**",
      "MinTxInterval" : 300,
      "PeerIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
      "DetectMultiplier" : 3,
      "PConnVbrChargeType" : "PrePaid",
      "Type" : "pconnVBR",
      "LocalGatewayIp" : "192.168.XX.XX",
      "AccessPointId" : "ap-cn-kojok1x******",
      "CreationTime" : "2020-06-08T12:20:55",
      "PConnVbrExpireTime" : "2021-06-08T12:20:55",
      "CloudBoxInstanceId" : "cb-*********",
      "PhysicalConnectionBusinessStatus" : "Normal",
      "AssociatedPhysicalConnections" : {
        "AssociatedPhysicalConnection" : {
          "Status" : "active",
          "PeerGatewayIp" : "116.62.XX.XX",
          "CircuitCode" : "longtel0**",
          "PhysicalConnectionId" : "pc-119mfjzm7******",
          "PhysicalConnectionStatus" : "Enabled",
          "VlanInterfaceId" : "ri-kojok19x3j0q6k****",
          "PeerIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
          "PhysicalConnectionOwnerUid" : "12345678****",
          "PeeringSubnetMask" : "255.255.255.252",
          "EnableIpv6" : true,
          "PeeringIpv6SubnetMask" : "2408:4004:cc:400::/56",
          "LocalGatewayIp" : "192.168.XX.XX",
          "LocalIpv6GatewayIp" : "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
          "VlanId" : 0,
          "PhysicalConnectionBusinessStatus" : "Normal"
        }
      },
      "AssociatedCens" : {
        "AssociatedCen" : {
          "CenStatus" : "Attached",
          "CenOwnerId" : 16880000000000000,
          "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.