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.

RegionId String Yes cn-shanghai

The region where the Express Connect circuit is deployed. You can call the DescribeRegions operation to query the most recent region list.

PhysicalConnectionId String Yes pc-119mfj****

The ID of the Express Connect circuit.

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 VBR type.
Filter.N.Value.N String No Active

The filter values for 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 key is matched.

Response parameters

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

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.

VirtualBorderRouterForPhysicalConnectionSet Array of VirtualBorderRouterForPhysicalConnectionType

The information about VBRs.

VirtualBorderRouterForPhysicalConnectionType
Status String Active

The status of the VBR. Valid values: Valid values:

  • Unconfirmed: pending confirmation from other users
  • Active: normal
  • Terminating: being disabled
  • Terminated: disabled
  • Recovering: being enabled
  • Deleting: being deleted
CreationTime String 2021-06-08T12:20:55

The time when the VBR was created.

Type String pconnVBR

The type of the VBR.

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

The IPv6 address of the gateway device in the data center.

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.

CircuitCode String longtel0**

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

LocalIpv6GatewayIp String ipv6bw-uf6hcyzu65v98v3du****

The IPv6 address of the VBR.

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

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

LocalGatewayIp String 192.168.XX.X

The IPv4 address of the VBR.

BandwidthStatus String Active

The status of the bandwidth. Valid values:

  • Active: normal
  • Inactive: abnormal
ActivationTime String 2021-06-08T12:20:55

The first time when the VBR was activated.

VbrOwnerUid Long 253460731706911258

The ID of the Alibaba Cloud account to which the VBR belongs.

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

PeeringSubnetMask String 255.255.255.0

The subnet mask for the IPv4 addresses of the gateway device in the data center and the VBR.

The two IPv4 addresses must fall within the same subnet.

EnableIpv6 Boolean true

Indicates whether IPv6 is enabled. Valid values:

  • true: yes
  • false: no
EccId String ecc-sjghe****

The ID of the ECC instance.

Bandwidth String 10

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

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

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

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

The last time when the VBR was disabled.

PConnVbrBussinessStatus String Normal

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

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
PeerGatewayIp String 162.62.XX.XX

The IPv4 address of the gateway device in the data center.

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

The subnet mask for the IPv6 addresses of the gateway devices in the data center and the VBRs.

The two IPv6 addresses must fall within the same subnet.

VbrId String vbr-bp16ksp61j7e0tk****

The ID of the VBR.

PConnVbrChargeType String PrePaid

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

  • 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
VlanId Integer 1678

The VLAN ID of the VBR.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVirtualBorderRoutersForPhysicalConnection
&RegionId=cn-shanghai
&PhysicalConnectionId=pc-119mfj****
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"Status","Value":["Active"]}]
&Common request parameters

Sample responses

XML format 

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

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

JSON format 

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

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

Error codes

HttpCode Error code Error message Description
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.
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.

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