All Products
Search
Document Center

Virtual Private Cloud:DescribeVirtualBorderRouters

Last Updated:Aug 29, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which the VBR is deployed. You can call the DescribeRegions operation to obtain the region ID.

cn-shanghai
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 information about the filter.

objectNo
KeystringNo

The filter conditions. You can specify up to five filter conditions. Valid values:

  • 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.
Status
ValuearrayNo

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 condition is matched.

stringNo

The filter value for the key. 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.

Active
IncludeCrossAccountVbrbooleanNo

Specifies whether cross-account VBRs are included.

  • true
  • false (default)
false
ResourceGroupIdstringNo

The resource group ID.

For more information about resource groups, see What is a resource group?

rg-acfmxazb4ph6aiy****
Tagsarray<object>No

The list of tags.

objectNo

The tags.

KeystringNo

The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The key cannot exceed 128 characters in length, and cannot start with aliyun or acs:. The key cannot contain http:// or https://.

FinanceDept
ValuestringNo

The tag value. You can specify at most 20 tag values. The tag value can be an empty string.

The tag value cannot exceed 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

FinanceJoshua

Response parameters

ParameterTypeDescriptionExample
object

The information about each virtual border router (VBR) that is queried.

RequestIdstring

The request ID.

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumberinteger

The page number. Default value: 1.

1
PageSizeinteger

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
TotalCountinteger

The number of entries returned.

1
VirtualBorderRouterSetarray<object>

The information about the VBR.

object
CreationTimestring

The time when the VBR was created.

2020-06-08T12:20:55
Statusstring

The status of the VBR. Valid values:

  • unconfirmed
  • active
  • terminating
  • terminated
  • recovering
  • deleting:
active
Typestring

The VBR type.

pconnVBR
MinTxIntervallong

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

300
PeerIpv6GatewayIpstring

The IPv6 address of the VBR on the user side.

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

The time when the VBR expires.

2021-06-08T12:20:55
PhysicalConnectionOwnerUidstring

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

1688000000000****
ActivationTimestring

The time when the VBR was activated for the first time.

2021-06-08T12:20:55
PhysicalConnectionBusinessStatusstring

The business status of the Express Connect circuit. Valid values:

  • Normal: The Express Connect circuit is running as normal.
  • FinancialLocked: The Express Connect circuit is locked due to overdue payments.
Normal
Descriptionstring

The description of the VBR.

desc
TerminationTimestring

The last time when the VBR was terminated.

2021-06-08T12:20:55
MinRxIntervallong

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

300
PeerGatewayIpstring

The IPv4 address of the VBR on the user side.

192.168.XX.XX
Namestring

The VBR name.

test
VbrIdstring

The VBR ID.

vbr-bp1jcg5cmxjbl9xgc****
VlanIdinteger

The VLAN ID of the VBR.

10
VlanInterfaceIdstring

The ID of the VBR interface.

ri-2zeo3xzyf38r4xx****
CircuitCodestring

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

longtel0****
LocalIpv6GatewayIpstring

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

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

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

192.168.XX.XX
PeeringSubnetMaskstring

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

255.255.255.252
EnableIpv6boolean

Indicates whether IPv6 is enabled. Valid values:

  • true
  • false
false
RouteTableIdstring

The ID of the route table of the VBR.

rtb-bp1****
DetectMultiplierlong

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.

3
EccIdstring

The ID of the Express Cloud Connect (ECC) instance.

ecc-h****
CloudBoxInstanceIdstring

The ID of the cloud box.

cb-****
RecoveryTimestring

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

2021-05-08T12:20:55
PhysicalConnectionStatusstring

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 to be confirmed.
  • 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.
Normal
PeeringIpv6SubnetMaskstring

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

2000:1234:0:a000::/55
AccessPointIdstring

The ID of the access point.

ap-cn-kojok1x****
PConnVbrChargeTypestring

The billing method of the VBR. Valid values:

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

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

pc-119mfjzm7x****
AssociatedPhysicalConnectionsarray<object>

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

object
Statusstring

The status of the VBR. Valid values:

  • unconfirmed
  • active:
  • terminating
  • terminated
  • recovering
  • deleting:
active
VlanInterfaceIdstring

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

ri-kojok19x3j0q6k****
CircuitCodestring

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

longtel0**
PeerIpv6GatewayIpstring

The IPv6 address of the VBR on the user side.

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

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

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

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

12345678****
LocalGatewayIpstring

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

192.168.XX.XX
PhysicalConnectionBusinessStatusstring

The business status of the Express Connect circuit. Valid values:

  • Normal: The Express Connect circuit is running as normal.
  • FinancialLocked: The Express Connect circuit is locked due to overdue payments.
Normal
PeeringSubnetMaskstring

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

Both IPv4 addresses must belong to the same subnet.

255.255.255.252
EnableIpv6boolean

Indicates whether IPv6 is enabled. Valid values:

  • true
  • false
true
PhysicalConnectionStatusstring

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 to be confirmed.
  • 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.
Enabled
PeerGatewayIpstring

The IPv4 address of the VBR on the user side.

116.62.XX.XX
PeeringIpv6SubnetMaskstring

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

Both IPv6 addresses must belong to the same subnet.

2408:4004:cc:400::/56
PhysicalConnectionIdstring

The ID of the Express Connect circuit.

pc-119mfjzm7****
VlanIdstring

The VLAN ID of the VBR.

0
AssociatedCensarray<object>

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

object
CenOwnerIdlong

The ID of the account to which the CEN instance belongs.

1688000000000****
CenIdstring

The CEN instance ID.

cen-kojok19xxx****
CenStatusstring

The status of the CEN instance. Valid values:

  • Attached
  • Attaching
  • Detached
  • Detaching
  • If no value is returned, the VBR is not attached to a CEN instance.
Attached
Bandwidthinteger

The bandwidth value of the VBR. Unit: Mbit/s.

50
ResourceGroupIdstring

The resource group ID.

For more information about resource groups, see Resource groups.

rg-acfmxazb4ph6aiy****
Tagsarray<object>

The tag of the resource.

object

The tag list.

Keystring

The tag key of the resource.

FinanceDept
Valuestring

The tag value of the resource.

FinanceJoshua
EcrIdstring

The ID of the Express Connect Router (ECR).

ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnableboolean

Indicates whether to allow service access between data centers. Valid values:

  • true
  • false
Note If no value is returned, service access between data centers is not allowed.
false
EcrAttatchStatusstring

The status of the ECR. Valid values:

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
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.
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.keyFilter.X.key is not supported.

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

Change history

Change timeSummary of changesOperation
2024-04-17The Error code has changed. The response structure of the API has changedView Change Details
2023-12-26The Error code has changed. The response structure of the API has changedView Change Details
2023-09-11API Description Update. The Error code has changedView Change Details
2023-07-20The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details