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 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 RepeatList No Active

The filter values of 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
VirtualBorderRouterSet Array of VirtualBorderRouterType

The information about the queried VBRs.

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

The ID of the access point.

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

The first time when the VBR was activated.

AssociatedCens Array of AssociatedCen

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

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

The ID of the CEN instance.

CenOwnerId Long 1234567890

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

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.
AssociatedPhysicalConnections Array of AssociatedPhysicalConnection

The information about the Express Connect circuits that are associated with the VBR.

AssociatedPhysicalConnection
CircuitCode String longtel0**

The circuit code provided by the Internet service provider (ISP) for the Express Connect circuit.

EnableIpv6 Boolean true

Indicates whether IPv6 is enabled. Valid values:

  • true: enabled
  • false: disabled
LocalGatewayIp String 192.168.XX.XX

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

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

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

PeerGatewayIp String 192.168.XX.XX

The IPv4 address of the VBR on the user side.

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

The IPv6 address of the VBR on the user side.

Only the owner of the VBR can set or modify this parameter.

This parameter is required when you create a VBR for the owner of the Express Connect circuit. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.

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

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

The two IPv6 addresses must fall within the same subnet.

PeeringSubnetMask String 255.255.255.252

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

The two IPv4 addresses must fall within the same subnet.

PhysicalConnectionBusinessStatus String Normal

The business status of the Express Connect circuit.

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
PhysicalConnectionId String pc-119mfjzm7*********

The ID of the Express Connect circuit.

PhysicalConnectionOwnerUid String 12345678****

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

PhysicalConnectionStatus String Enabled

The status of the Express Connect circuit. Valid values:

  • Initial: application in progress
  • Approved: approved
  • Allocating: resource allocation in progress
  • Allocated: under construction
  • Confirmed: waiting for user confirmation
  • Enabled: enabled
  • Rejected: rejected
  • Canceled: canceled
  • Allocation Failed: resource allocation failed
  • Terminated: disabled
Status String active

The status of the VBR. Valid values:

  • unconfirmed: pending confirmation from other users
  • active: working as expected
  • terminating: being disabled
  • terminated: disabled
  • recovering: being enabled
  • deleting: being deleted
VlanId String 0

The VLAN ID of the VBR.

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 provided by the ISP for the Express Connect circuit.

CloudBoxInstanceId String cb-*********

The ID of the cloud box.

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

The time when the VBR was created.

Description String desc

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

The ID of the ECC instance.

EnableIpv6 Boolean false

Indicates whether IPv6 is enabled. Valid values:

  • true: enabled
  • false (default): disabled
LocalGatewayIp String 192.168.XX.XX

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

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

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

MinRxInterval Long 300

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

MinTxInterval Long 300

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

Name String test

The name of the VBR.

PConnVbrChargeType String PrePaid

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

  • 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 2021-06-08T12:20:55

The time when the VBR expires.

PeerGatewayIp String 192.168.XX.XX

The IPv4 address of the VBR on the user side.

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

The IPv6 address of the VBR on the user side.

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

The subnet mask of the IPv6 addresses configured on the user side and 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.

PhysicalConnectionBusinessStatus String Normal

The business status of the Express Connect circuit.

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
PhysicalConnectionId String pc-119mfjzm7x******

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

PhysicalConnectionOwnerUid String 12345678****

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

PhysicalConnectionStatus String Normal

The status of the Express Connect circuit. Valid values:

  • Initial: application in progress
  • Approved: approved
  • Allocating: resource allocation in progress
  • Allocated: under construction
  • Confirmed: waiting for user confirmation
  • Enabled: enabled
  • Rejected: rejected
  • Canceled: canceled
  • Allocation Failed: resource allocation failed
  • Terminated: disabled
RecoveryTime String 2021-05-08T12:20:55

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

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

The ID of the route table of the VBR.

Status String active

The status of the VBR. Valid values:

  • unconfirmed: pending confirmation from other users
  • active: working as expected
  • terminating: being disabled
  • terminated: disabled
  • recovering: being enabled
  • deleting: being deleted
TerminationTime String 2021-06-08T12:20:55

The last time when the VBR was disabled.

Type String pconnVBR

The type 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.

TotalCount Integer 1

The total number of entries returned.

PageNumber Integer 1

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

PageSize Integer 10

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

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

<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-bp1nxxxxxxxx*******</RouteTableId>
                  <ActivationTime>2021-06-08T12:20:55</ActivationTime>
                  <PhysicalConnectionId>pc-119mfjzm7x******</PhysicalConnectionId>
                  <PhysicalConnectionStatus>Normal</PhysicalConnectionStatus>
                  <VlanInterfaceId>ri-2zeo3xzyf38r4xx*******</VlanInterfaceId>
                  <VbrId>vbr-bp1jcg5cmxjbl9xgc****</VbrId>
                  <PhysicalConnectionOwnerUid>12345678****</PhysicalConnectionOwnerUid>
                  <PeeringSubnetMask>255.255.255.252</PeeringSubnetMask>
                  <TerminationTime>2021-06-08T12:20:55</TerminationTime>
                  <EnableIpv6>true</EnableIpv6>
                  <PeeringIpv6SubnetMask>2000:1234:0:a000::/55</PeeringIpv6SubnetMask>
                  <Name>test</Name>
                  <RecoveryTime>2017-06-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>2021-06-08T12:20:55</CreationTime>
                  <PConnVbrExpireTime>2021-06-08T12:20:55</PConnVbrExpireTime>
                  <CloudBoxInstanceId>cb-*********</CloudBoxInstanceId>
                  <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
                  <AssociatedPhysicalConnections>
                        <AssociatedPhysicalConnection>
                              <Status>active</Status>
                              <PeerGatewayIp>192.168.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>1234567890</CenOwnerId>
                              <CenId>cen-kojok19xxx******</CenId>
                        </AssociatedCen>
                  </AssociatedCens>
            </VirtualBorderRouterType>
      </VirtualBorderRouterSet>
</DescribeVirtualBorderRoutersResponse>

JSON format

{
    "DescribeVirtualBorderRoutersResponse": {
        "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-bp1nxxxxxxxx*******",
                "ActivationTime": "2021-06-08T12:20:55",
                "PhysicalConnectionId": "pc-119mfjzm7x******",
                "PhysicalConnectionStatus": "Normal",
                "VlanInterfaceId": "ri-2zeo3xzyf38r4xx*******",
                "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
                "PhysicalConnectionOwnerUid": "12345678****",
                "PeeringSubnetMask": "255.255.255.252",
                "TerminationTime": "2021-06-08T12:20:55",
                "EnableIpv6": true,
                "PeeringIpv6SubnetMask": "2000:1234:0:a000::/55",
                "Name": "test",
                "RecoveryTime": "2017-06-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": "2021-06-08T12:20:55",
                "PConnVbrExpireTime": "2021-06-08T12:20:55",
                "CloudBoxInstanceId": "cb-*********",
                "PhysicalConnectionBusinessStatus": "Normal",
                "AssociatedPhysicalConnections": {
                    "AssociatedPhysicalConnection": {
                        "Status": "active",
                        "PeerGatewayIp": "192.168.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": 1234567890,
                        "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.