DescribeVirtualBorderRouters - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeVirtualBorderRouters for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

get

*VirtualBorderRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes
PageNumber	integer	No
PageSize	integer	No
Filter	array<object>	No
	object	No
Key	string	No
Value	array	No
	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string
PageNumber	integer
PageSize	integer
TotalCount	integer
VirtualBorderRouterSet	object
VirtualBorderRouterType	array<object>
	object
VlanInterfaceId	string	The ID of the VBR interface.
Status	string	The status of the VBR. Valid values: `active` `deactivating` `creating` `terminating` `terminated`
CreationTime	string	The time when the VBR was created, in UTC.
CircuitCode	string	The circuit code of the physical connection, provided by the connectivity provider.
PhysicalConnectionOwnerUid	string	The owner account ID of the physical connection.
LocalGatewayIp	string	The IP address of the local gateway in your on-premises data center.
ActivationTime	string	The time when the VBR was first activated, in UTC.
PhysicalConnectionBusinessStatus	string	The business status of the physical connection. Valid values: `Normal`: The physical connection is running as expected. `FinancialLocked`: The physical connection is locked due to overdue payments.
PeeringSubnetMask	string	The subnet mask for the peering IP addresses of the VBR and the on-premises gateway device.
RouteTableId	string	The ID of the route table associated with the VBR.
Description	string	The description of the VBR.
PhysicalConnectionStatus	string	The status of the physical connection. Valid values: `Initial` `Approved` `Allocating` `Allocated` `Confirmed` `Enabled` `Rejected` `Canceled` `Allocation Failed` `Terminated`
RecoveryTime	string	The time when the VBR last recovered from a fault, in UTC.
TerminationTime	string	The time when the VBR was terminated, in UTC.
PeerGatewayIp	string	The IP address of the peer gateway on the Alibaba Cloud side.
Name	string	The name of the VBR.
AccessPointId	string	The ID of the access point.
VbrId	string	The ID of the VBR.
PhysicalConnectionId	string	The ID of the physical connection.
VlanId	integer	The VLAN ID of the VBR.

Examples

Success response

JSON format

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "VlanInterfaceId": "",
        "Status": "",
        "CreationTime": "",
        "CircuitCode": "",
        "PhysicalConnectionOwnerUid": "",
        "LocalGatewayIp": "",
        "ActivationTime": "",
        "PhysicalConnectionBusinessStatus": "",
        "PeeringSubnetMask": "",
        "RouteTableId": "",
        "Description": "",
        "PhysicalConnectionStatus": "",
        "RecoveryTime": "",
        "TerminationTime": "",
        "PeerGatewayIp": "",
        "Name": "",
        "AccessPointId": "",
        "VbrId": "",
        "PhysicalConnectionId": "",
        "VlanId": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.