VBR Overview for Express Connect Circuits - Express Connect - Alibaba Cloud - Express Connect

Queries the Virtual Border Routers (VBRs) under a specified Express Connect circuit, including VBRs owned by the circuit owner and VBRs owned by other accounts.

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:DescribeVirtualBorderRoutersForPhysicalConnection

list

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

vpc:PhysicalConnection

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the Express Connect circuit resides. You can call the DescribeRegions operation to obtain the region ID.	cn-shanghai
PhysicalConnectionId	string	Yes	The ID of the Express Connect circuit.	pc-119mfj****
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 list of filter conditions.
	object	No	The list of filter conditions.
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 Virtual Border Router.	Status
Value	array	No	The filter values based on the specified Key. You can specify multiple filter values for a single Key. The relationship between multiple filter values is OR, which means that a match with any one of the filter values is considered a match for the filter condition.	Active
	string	No	The filter values based on the specified Key. You can specify multiple filter values for a single Key. The relationship between multiple filter values is OR, which means that a match with any one of the filter values is considered a match for the filter condition.	Active

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7C5AE8B3-A2D8-428D-A2FF-93A225C0821E
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 in the list.	1
VirtualBorderRouterForPhysicalConnectionSet	object
VirtualBorderRouterForPhysicalConnectionType	array<object>	The collection of queried VBR instance information.
	object
Status	string	The instance status of the VBR. Valid values: unconfirmed: waiting for confirmation from another party. active: Normal. terminating: being stopped. terminated: stopped. recovering: being recovered. deleting: being deleted.	Active
CreationTime	string	The time when the VBR was created. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, where Z indicates UTC.	2021-06-08T12:20:55
Type	string	The type of the VBR.	pconnVBR
PeerIpv6GatewayIp	string	The IPv6 address on the customer side of the VBR instance. This parameter is required when creating a VBR instance for the Express Connect circuit owner, and is not required when creating a VBR instance for other accounts.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel0**
LocalIpv6GatewayIp	string	The IPv6 address on the Alibaba Cloud side of the VBR instance.	ipv6bw-uf6hcyzu65v98v3du****
PConnVbrExpireTime	string	The expiration time of the VBR bound to the Express Connect circuit. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, where Z indicates UTC.	2021-06-10T12:20:55
LocalGatewayIp	string	The IPv4 address on the Alibaba Cloud side of the VBR instance.	192.168.XX.X
BandwidthStatus	string	The bandwidth status. Valid values: Active: Normal. Inactive: abnormal.	Active
ActivationTime	string	The time when the VBR was first activated. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, where Z indicates UTC.	2021-06-08T12:20:55
VbrOwnerUid	integer	The account ID of the VBR owner. This parameter is empty when the VBR and the Express Connect circuit have the same owner.	253460731706911258
PeeringSubnetMask	string	The subnet mask for the IPv4 addresses on the Alibaba Cloud side and the customer side of the VBR instance. The two IPv4 addresses must be in the same subnet.	255.255.255.0
EnableIpv6	boolean	Indicates whether IPv6 is enabled. Valid values: true: enabled. false: disabled.	true
EccId	string	The instance ID of the Express Cloud Connect instance.	ecc-sjghe****
Bandwidth	string	The bandwidth value of the Virtual Border Router bound to the Express Connect circuit. Unit: Mbit/s.	10
RecoveryTime	string	The most recent time when the VBR was recovered from the Terminated state to the Active state. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, where Z indicates UTC.	2021-06-08T12:20:55
TerminationTime	string	The most recent time when the VBR was terminated. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, where Z indicates UTC.	2021-06-07T12:20:55
PConnVbrBussinessStatus	string	The business status of the VBR bound to the Express Connect circuit. Valid values: Normal: Normal. FinancialLocked: financial lock.	Normal
PeerGatewayIp	string	The IPv4 address on the customer side of the VBR instance.	162.62.XX.XX
PeeringIpv6SubnetMask	string	The subnet mask for the IPv6 addresses on the Alibaba Cloud side and the customer side of the VBR instance. The two IPv6 addresses must be in the same subnet.	2408:4004:cc:400::/56
VbrId	string	The instance ID of the VBR.	vbr-bp16ksp61j7e0tk****
PConnVbrChargeType	string	The billing method of the Virtual Border Router bound to the Express Connect circuit. Valid values: PrePaid: subscription. If you select this billing method, make sure that your account supports balance payment or credit payment. PostPaid: pay-as-you-go.	PrePaid
VlanId	integer	The VLAN ID of the VBR instance.	1678
VbrName	string	The name of the VBR instance.	aliyun-to-bin-10G-A-QOS

Examples

Success response

JSON format

{
  "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,
        "VbrName": "aliyun-to-bin-10G-A-QOS"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPhysicalConnectionId.NotFound	The specified physicalConnection is not found.	The specified physicalConnection is not found.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The parameter is invalid.
404	InvalidPhysicalConnectionId.NotFound	The specified PhysicalConnectionId does not belong to user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.