Queries virtual border routers (VBRs) that are associated with an Express Connect circuit. The VBRs can be created by the owner of the Express Connect circuit 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 Express Connect circuit.

RegionId String Yes cn-shanghai

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.

Filter.N.Key String No Status

Specifies 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 VBR type.
Filter.N.Value.N RepeatList 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.

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
VirtualBorderRouterForPhysicalConnectionSet Array of VirtualBorderRouterForPhysicalConnectionType

The information about VBRs.

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

The first time when the VBR was activated.

Bandwidth String 10

The bandwidth of the VBR associated with the Express Connect circuit. Unit: Mbit/s.

BandwidthStatus String Active

The status of the bandwidth. Valid values:

  • Active: working as expected
  • Inactive: not working as expected
CircuitCode String longtel0**

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

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

The time when the VBR was created.

EccId String ecc-sjghe****

The ID of the ECC instance.

EnableIpv6 Boolean true

Indicates whether IPv6 is enabled.

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

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

LocalIpv6GatewayIp String 2001:0db8:3c4d:0015:0000:00**:****:1a2b

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

PConnVbrBussinessStatus String Normal

The state of the VBR associated with the Express Connect circuit. Valid values:

  • Normal: working as expected
  • FinancialLocked: locked due to overdue payments
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 you Alibaba Cloud account supports balance payments or credit payments.
  • PostPaid: pay-as-you-go
PConnVbrExpireTime String 2021-06-10T12:20:55

The time when the VBR associated with the Express Connect circuit expires.

PeerGatewayIp String 162.62.XX.XX

The IPv4 address of the VBR on the client side.

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

The IPv6 address of the VBR on the client 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.0

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.

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

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

Status String Active

The state of the VBR.

  • 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-07T12:20:55

The last time when the VBR was disabled.

Type String pconnVBR

The type of the VBR.

VbrId String vbr-bp16ksp61j7e0tk*****

The ID of the VBR.

VbrOwnerUid Long 1234567890

The ID of the Alibaba Cloud account that owns the VBR.

If the owner of the VBR is the same as that of the Express Connect circuit, this parameter is empty.

VlanId Integer 1678

The VLAN ID of the VBR.

TotalCount Integer 2

The total number of entries returned.

PageNumber Integer 1

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

PageSize Integer 10

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

RequestId String 7C5AE8B3-A2D8-428D-A2FF-93A225C0821E

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeVirtualBorderRoutersForPhysicalConnectionResponse>
      <TotalCount>2</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>7C5AE8B3-A2D8-428D-A2FF-93A225C0821E</RequestId>
      <PageNumber>1</PageNumber>
      <VirtualBorderRouterForPhysicalConnectionSet>
            <VirtualBorderRouterForPhysicalConnectionType>
                  <Status>Active</Status>
                  <PeerGatewayIp>162.62.XX.XX</PeerGatewayIp>
                  <ActivationTime>2017-06-08T12:20:55</ActivationTime>
                  <VbrOwnerUid>1234567890</VbrOwnerUid>
                  <CircuitCode>longtel0**</CircuitCode>
                  <PeerIpv6GatewayIp>2001:XXXX:3c4d:0015:0000:0000:0000:1a2b</PeerIpv6GatewayIp>
                  <VbrId>vbr-bp16ksp61j7e0tk*****</VbrId>
                  <PConnVbrChargeType>PrePaid</PConnVbrChargeType>
                  <PeeringSubnetMask>255.255.255.0</PeeringSubnetMask>
                  <TerminationTime>2021-06-07T12:20:55</TerminationTime>
                  <EnableIpv6>true</EnableIpv6>
                  <PeeringIpv6SubnetMask>2408:4004:cc:400::/56</PeeringIpv6SubnetMask>
                  <RecoveryTime>2021-06-08T12:20:55</RecoveryTime>
                  <LocalGatewayIp>192.168.XX.X</LocalGatewayIp>
                  <Type>pconnVBR</Type>
                  <Bandwidth>10</Bandwidth>
                  <CreationTime>2021-06-08T12:20:55</CreationTime>
                  <BandwidthStatus>Active</BandwidthStatus>
                  <EccId>ecc-sjghe****</EccId>
                  <PConnVbrExpireTime>2021-06-10T12:20:55</PConnVbrExpireTime>
                  <LocalIpv6GatewayIp>2001:0db8:3c4d:0015:0000:00**:****:1a2b</LocalIpv6GatewayIp>
                  <VlanId>1678</VlanId>
                  <PConnVbrBussinessStatus>Normal</PConnVbrBussinessStatus>
            </VirtualBorderRouterForPhysicalConnectionType>
      </VirtualBorderRouterForPhysicalConnectionSet>
</DescribeVirtualBorderRoutersForPhysicalConnectionResponse>

JSON format 

{
    "DescribeVirtualBorderRoutersForPhysicalConnection": {
        "TotalCount": 2,
        "PageSize": 10,
        "RequestId": "7C5AE8B3-A2D8-428D-A2FF-93A225C0821E",
        "PageNumber": 1,
        "VirtualBorderRouterForPhysicalConnectionSet": {
            "VirtualBorderRouterForPhysicalConnectionType": {
                "Status": "Active",
                "PeerGatewayIp": "162.62.XX.XX",
                "ActivationTime": "2017-06-08T12:20:55",
                "VbrOwnerUid": 1234567890,
                "CircuitCode": "longtel0**",
                "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
                "VbrId": "vbr-bp16ksp61j7e0tk*****",
                "PConnVbrChargeType": "PrePaid",
                "PeeringSubnetMask": "255.255.255.0",
                "TerminationTime": "2021-06-07T12:20:55",
                "EnableIpv6": true,
                "PeeringIpv6SubnetMask": "2408:4004:cc:400::/56",
                "RecoveryTime": "2021-06-08T12:20:55",
                "LocalGatewayIp": "192.168.XX.X",
                "Type": "pconnVBR",
                "Bandwidth": 10,
                "CreationTime": "2021-06-08T12:20:55",
                "BandwidthStatus": "Active",
                "EccId": "ecc-sjghe****",
                "PConnVbrExpireTime": "2021-06-10T12:20:55",
                "LocalIpv6GatewayIp": "2001:0db8:3c4d:0015:0000:00**:****:1a2b",
                "VlanId": 1678,
                "PConnVbrBussinessStatus": "Normal"
            }
        }
    }
}

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 Express Connect circuit does not belong to your Alibaba Cloud account.
400 InvalidPhysicalConnectionId.NotFound The specified physicalConnection is not found. The error message returned because the Express Connect circuit that corresponds to the ID is not found.

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