All Products
Search
Document Center

Virtual Private Cloud:DescribeVirtualBorderRoutersForPhysicalConnection

Last Updated:Jul 11, 2024

Queries the 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region in which the Express Connect circuit is deployed. You can call the DescribeRegions operation to obtain the region ID.

cn-shanghai
PhysicalConnectionIdstringYes

The ID of the Express Connect circuit.

pc-119mfj****
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

10
Filterarray<object>No

The filter keys.

objectNo
KeystringNo

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

  • PhysicalConnectionId: filter VBRs by the Express Connect circuit ID.
  • VbrId: filter VBRs by ID.
  • Status: filter VBRs by status.
  • Name: filter VBRs by name.
  • AccessPointId: filter VBRs by access point ID.
  • eccId: filter VBRs by ID of Express Cloud Connect (ECC) instance.
  • type: filter VBRs by type.
Status
ValuearrayNo

The filter value for the key. You can specify multiple filter values for one key. The logical operator among filter values is OR. If one filter value is matched, the filter condition is matched.

stringNo

The filter value for the key. You can specify multiple filter values for one key. The logical operator among filter values is OR. If one filter value is matched, the filter condition is matched.

Active

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7C5AE8B3-A2D8-428D-A2FF-93A225C0821E
PageNumberinteger

The page number. Default value: 1.

1
PageSizeinteger

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

10
TotalCountinteger

The number of entries returned.

1
VirtualBorderRouterForPhysicalConnectionSetarray<object>

The information about VBRs.

object
Statusstring

The status of the VBR. Valid values:

  • unconfirmed
  • active
  • terminating
  • terminated
  • recovering
  • deleting
Active
CreationTimestring

The time when the VBR was created.

2021-06-08T12:20:55
Typestring

The VBR type.

pconnVBR
PeerIpv6GatewayIpstring

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

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.

2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
CircuitCodestring

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

longtel0**
LocalIpv6GatewayIpstring

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

ipv6bw-uf6hcyzu65v98v3du****
PConnVbrExpireTimestring

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

2021-06-10T12:20:55
LocalGatewayIpstring

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

192.168.XX.X
BandwidthStatusstring

The status of the bandwidth. Valid values:

  • Active
  • Inactive
Active
ActivationTimestring

The time when the VBR was first activated.

2021-06-08T12:20:55
VbrOwnerUidlong

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.

253460731706911258
PeeringSubnetMaskstring

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

The two IPv4 addresses must fall within the same subnet.

255.255.255.0
EnableIpv6boolean

Indicates whether IPv6 is enabled. Valid values:

  • true
  • false
true
EccIdstring

The ID of the ECC instance.

ecc-sjghe****
Bandwidthstring

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

10
RecoveryTimestring

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

2021-06-08T12:20:55
TerminationTimestring

The last time when the VBR was disabled.

2021-06-07T12:20:55
PConnVbrBussinessStatusstring

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

  • Normal
  • FinancialLocked
Normal
PeerGatewayIpstring

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

162.62.XX.XX
PeeringIpv6SubnetMaskstring

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.

2408:4004:cc:400::/56
VbrIdstring

The VBR ID.

vbr-bp16ksp61j7e0tk****
PConnVbrChargeTypestring

The billing method of the VBR. Valid values:

  • PrePaid: subscription. If you choose this billing method, make sure that your Apsara Stack account supports balance payments or credit payments.
  • PostPaid: pay-as-you-go.
PrePaid
VlanIdinteger

The VLAN ID of the VBR.

1678

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C5AE8B3-A2D8-428D-A2FF-93A225C0821E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterForPhysicalConnectionSet": {
    "VirtualBorderRouterForPhysicalConnectionType": [
      {
        "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

HTTP status codeError codeError messageDescription
400InvalidPhysicalConnectionId.NotFoundThe specified physicalConnection is not found.The specified physicalConnection is not found.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId does not belong to user.The specified physical connection does not belong to your account.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-11API Description Update. The Error code has changedView Change Details