DescribeVirtualBorderRouters-阿里云帮助中心

Queries Virtual Border Router (VBR) instances that you have created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVirtualBorderRouters

list

*VirtualBorderRouter

acs:vpc:{#regionId}:{#AccountId}:virtualborderrouter/{#VbrId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VBR. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Maximum value: 50. Default value: 10.	10
Filter	array<object>	No	The filter information.
	object	No	The filter information.
Key	string	No	The filter condition. You can specify up to 5 filter conditions. The following filter conditions are supported: PhysicalConnectionId: instance ID of the Express Connect circuit instance. VbrId: instance ID of the Virtual Border Router instance. Status: the status of the Virtual Border Router. Name: the name of the Virtual Border Router. AccessPointId: instance ID of the access point. eccId: instance ID of the Express Cloud Connect instance. type: the type of the Express Connect circuit.	Status
Value	array	No	The filter value based on the specified Key. You can specify multiple filter values for a Key. The relationship between filter values is OR, which means that a match is found if any of the filter values is met.	Active
	string	No	The filter value based on the specified Key. You can specify multiple filter values for a Key. The relationship between filter values is OR, which means that a match is found if any of the filter values is met.	Active
IncludeCrossAccountVbr	boolean	No	Specifies whether to include cross-account Virtual Border Routers. true: Included. false (default): Not included.	false
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	The tags of the resource.
	object	No	The tag.
Key	string	No	The tag key of the resource. You must specify at least 1 tag key and can specify up to 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The VBR information.
RequestId	string	The request ID.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumber	integer	The page number of the list. Default value: 1.	1
PageSize	integer	The number of entries per page in a paged query. Maximum value: 50. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	1
VirtualBorderRouterSet	object
VirtualBorderRouterType	array<object>	The list of queried VBRs.
	array<object>	The time when the VBR was created.
CreationTime	string	Creation Time of the virtual border router.	2020-06-08T12:20:55
Status	string	The instance status of the VBR. unconfirmed: Awaiting confirmation from another party. active: Normal. terminating: Stopping connectivity. terminated: Connectivity stopped. recovering: Recovering. deleting: Deleting.	active
Type	string	Type of the virtual border router.	pconnVBR
MinTxInterval	integer	The transmission interval of BFD messages. Valid values: 200 to 1000, in milliseconds.	300
PeerIpv6GatewayIp	string	The peer IPv6 address on the customer side of the virtual border router instance.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PConnVbrExpireTime	string	The expiration time of the billed VBR.	2021-06-08T12:20:55
PhysicalConnectionOwnerUid	string	The Account ID of the owner of the Express Connect circuit.	1688000000000****
ActivationTime	string	The time when the VBR was first activated.	2021-06-08T12:20:55
PhysicalConnectionBusinessStatus	string	The business status of the Express Connect circuit. Normal: Normal. FinancialLocked: Financial lock.	Normal
Description	string	The description of the VBR.	desc
TerminationTime	string	The time when the VBR was most recently stopped.	2021-06-08T12:20:55
MinRxInterval	integer	The configured minimum receive interval for BFD messages. Valid values: 200–1000, in milliseconds.	300
PeerGatewayIp	string	The customer-side peer IPv4 address of the VBR instance.	192.168.XX.XX
Name	string	The name of the VBR instance.	test
VbrId	string	The instance ID of the VBR.	vbr-bp1jcg5cmxjbl9xgc****
VlanId	integer	The VLAN ID of the VBR instance.	10
VlanInterfaceId	string	The ID of the router interface of the VBR.	ri-2zeo3xzyf38r4xx****
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel0****
LocalIpv6GatewayIp	string	The Alibaba Cloud side peer IPv6 address of the VBR instance.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalGatewayIp	string	The peer IPv4 address on the Alibaba Cloud side of the virtual border router instance.	192.168.XX.XX
PeeringSubnetMask	string	The subnet mask for the peer IPv4 address on the Alibaba Cloud side and the peer IPv4 address on the Customer side of the VBR instance.	255.255.255.252
EnableIpv6	boolean	Indicates whether IPv6 is enabled. true: Enabled. false: Disabled.	false
RouteTableId	string	The route table ID of the VBR.	rtb-bp1****
DetectMultiplier	integer	Detection multiplier. This value represents the maximum number of consecutive packet losses allowed by the receiver from the sender to determine whether the link is normal. Valid values: 3 to 10.	3
EccId	string	The Express Cloud Connect instance ID.	ecc-h****
CloudBoxInstanceId	string	The CloudBox instance ID.	cb-****
RecoveryTime	string	The time when the VBR was most recently recovered from the terminated status to the active status.	2021-05-08T12:20:55
PhysicalConnectionStatus	string	The status of the Express Connect circuit. Initial: The request is being submitted. Approved: The request has passed approval. Allocating: Resources are being assigned. Allocated: Installation is in progress. Confirmed: Waiting for User confirmation. Enabled: The service is activated. Rejected: The request was denied. Canceled: The request was canceled. Allocation Failed: Resource allocation failed. Terminated: The service was stopped.	Normal
PeeringIpv6SubnetMask	string	The subnet mask for the peering IPv6 addresses on both the Alibaba Cloud side and the Customer side of the VBR instance.	2000:1234:0:a000::/55
AccessPointId	string	The ID of the Express Connect circuit access point.	ap-cn-kojok1x****
PConnVbrChargeType	string	Billing method of the virtual border router attached to the Express Connect circuit. PrePaid: subscription. If you select this billing method, you must confirm that your account supports balance payment or credit payment. PostPaid: pay-as-you-go.	PrePaid
PhysicalConnectionId	string	The ID of the Express Connect circuit to which the VBR belongs.	pc-119mfjzm7x****
AssociatedPhysicalConnections	object
AssociatedPhysicalConnection	array<object>	Information about the associated Express Connect circuits.
	object	Information about the associated Express Connect circuits.
Status	string	The instance status of the Virtual Border Router (VBR). unconfirmed: Awaiting confirmation from another party. active: Normal. terminating: Stopping connection. terminated: Connection stopped. recovering: Recovering. deleting: Deleting.	active
VlanInterfaceId	string	The router interface ID of the VBR, which can be used as the next hop for VBR routes.	ri-kojok19x3j0q6k****
CircuitCode	string	The circuit code assigned by the carrier for the Express Connect circuit.	longtel0**
PeerIpv6GatewayIp	string	The Customer-side peer IPv6 address of the VBR instance.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalIpv6GatewayIp	string	The peer IPv6 address on the Alibaba Cloud side of the VBR instance.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PhysicalConnectionOwnerUid	string	The Account ID of the Express Connect circuit owner.	12345678****
LocalGatewayIp	string	The IPv4 peer IP address on the Alibaba Cloud side of the VBR instance.	192.168.XX.XX
PhysicalConnectionBusinessStatus	string	The business status of the Express Connect circuit. Normal: Normal. FinancialLocked: Financial lock.	Normal
PeeringSubnetMask	string	The subnet mask of the IPv4 peer IP addresses on the Alibaba Cloud side and the Customer side of the VBR instance. The two IPv4 addresses must reside in the same subnet.	255.255.255.252
EnableIpv6	boolean	Indicates whether IPv6 is enabled. true: Enabled. false: Shutdown.	true
PhysicalConnectionStatus	string	The status of the Express Connect circuit. Initial: Request in progress. Approved: Approval passed. Allocating: Resource allocation in progress. Allocated: Access deployment in progress. Confirmed: Awaiting User confirmation. Enabled: Activated. Rejected: Request denied. Canceled: Canceled. Allocation Failed: Resource allocation failed. Terminated: Stopped.	Enabled
PeerGatewayIp	string	The customer-side peer IPv4 address of the VBR instance.	116.62.XX.XX
PeeringIpv6SubnetMask	string	The subnet mask of the IPv6 peer IP addresses on the Alibaba Cloud side and the Customer side of the VBR instance. The two IPv6 addresses must reside in the same subnet.	2408:4004:cc:400::/56
PhysicalConnectionId	string	The ID of the Express Connect circuit.	pc-119mfjzm7****
VlanId	string	The VLAN ID of the VBR instance.	0
AssociatedCens	object
AssociatedCen	array<object>	Information about the associated Cloud Enterprise Network (CEN) instances.
	object	Instance information.
CenOwnerId	integer	The ID of the Account to which the CEN instance belongs.	1688000000000****
CenId	string	The CEN instance ID.	cen-kojok19xxx****
CenStatus	string	The status of the Cloud Enterprise Network (CEN). Attached: The CEN instance is associated. Attaching: The CEN instance is being associated. Detached: The CEN instance is disassociated. Detaching: The CEN instance is being disassociated. empty: The CEN instance is not associated.	Attached
Bandwidth	integer	The bandwidth value of the VBR instance, in Mbps.	50
ResourceGroupId	string	The resource group ID. For more information about resource groups, see What is a resource group.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	The tags of the resource.
	object	A tag.
Key	string	The tag key of the resource.	FinanceDept
Value	string	The tag value of the resource.	FinanceJoshua
EcrId	string	The instance ID of the associated Express Connect Router (ECR).	ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnable	boolean	Specifies whether inter-IDC business access is allowed. Valid values: true: Yes. false: No. Note If no value is specified, inter-IDC business access is not allowed.	false
EcrAttatchStatus	string	The association status of the Express Connect Router (ECR). Attached: Associated. Attaching: Associating. Detached: Disassociated. Detaching: Disassociating. empty: Not associated.	Attached
EcrOwnerId	string	The Alibaba Cloud account (primary account) ID to which the ECR instance belongs.	192732132151xxxx
Mtu	integer	The MTU value supported by the VBR. Valid values: 1500 and 8500.	1500

Examples

Success response

JSON format

{
  "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": "192732132151xxxx",
        "Mtu": 1500
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.	Unknown error. Please retry the operation. The error still exists. Please submit the work order for processing.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Filter.X.key is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.