查詢已建立的邊界路由器(VBR)。

請求參數

名稱 類型 是否必須 描述
Action String

要執行的操作。 取值:

DescribeVirtualBorderRouters

RegionId String

VBR所在的地域。

您可以通過調用 DescribeRegions介面獲取地域ID。

Filter.n.Key String

過濾條件,最多可提供5個過濾條件。n的取值範圍為[1,5]

每個過濾條件(filter key)可以提供多個值,多個值之間是“or”關係,即只要與其中一個值符合則視為符合參數的過濾條件。

各個過濾條件(filter key)之間為“and”邏輯關係,即符合所有參數的過濾條件,才會被查詢出來。

支援的過濾條件如下:
  • PhysicalConnectionId:物理專線ID。

  • VbrId:VBR ID。

  • Status:VBR的狀態。

  • AccessPointId:關聯的物理專線的存取點ID。

  • Name:VBR的名稱。

Filter.n.Value.m String

指定的過濾條件對應的值。m的取值範圍為[1,5]

PageNumber Integer

列表的頁碼,預設值為1

PageSize Integer

分頁查詢時每頁的行數,最大值為50,預設值為10

返回參數

名稱 類型 描述
RequestId String 請求ID。
TotalCount String 列表條條目數。
PageNumber Integer 當前頁碼。
PageSize String 每頁包含多少條目。
VirtualBorderRouterSet List 查詢到的VBR合集,每個VBR的詳細資料參見表 1
表 1. VirtualBorderRouter
名稱 類型 描述
VbrId String VBR的ID。
VbrOwnerUid String VBR所有者的帳號ID,VBR和物理專線的所有者相同時該參數為空。
CreationTime Integer VBR的建立時間。
ActivationTime String VBR第一次啟用的時間。
TerminationTime String VBR最近一次被終止的時間。
RecoveryTime String VBR最近一次從Terminated狀態恢複到Active狀態的時間。
Status String VBR的狀態。
VlanId String VBR的VLAN ID。
CircuitCode String 電訊廠商為物理專線提供的電路編碼。
RouteTableId String VBR的路由表的ID。
VlanInterfaceId String VBR的路由器介面的ID。
LocalGatewayIp String 阿里雲側互聯IP。
PeerGatewayIp String 客戶側互聯IP。
PeeringSubnetMask String 阿里雲側互聯IP和客戶側互聯IP的子網路遮罩。
Name String VBR的名稱。
Description String VBR的描述資訊。
PhysicalConnectionId String VBR所屬的物理專線的ID。
AccessPointId String 物理專線存取點的ID。
Status String 物理專線狀態:
  • Initial:申請中

  • Approved:審批通過

  • Allocating:正在分配資源

  • Allocated:接入施工中。

  • Confirmed:等待使用者確認

  • Enabled:已開通

  • Rejected:申請被拒絕

  • Canceled:已取消

  • Allocation Failed:資源分派失敗

  • Terminated:已終止

BusinessStatus String 物理專線的付費狀態:
  • Normal:正常

  • FinancialLocked:欠費鎖定

  • SecurityLocked:因安全原因被鎖定

樣本

請求樣本

https://vpc.aliyuncs.com/?Action=DescribeVirtualBorderRouters
&RegionId=cn-beijing
&公共請求參數
返回樣本
  • XML格式

    <?xml version="1.0" encoding="UTF-8"?>
    <DescribeVirtualBorderRoutersResponse>
    	<RequestId>AE65530E-8436-4FB1-8217-DCD35712AC89</RequestId>
    	<PageNumber>1</PageNumber>
    	<VirtualBorderRouterSet>
    		<VirtualBorderRouterType>
    			<LocalGatewayIp>10.1.1.1</LocalGatewayIp>
    			<PeerGatewayIp>10.2.2.2</PeerGatewayIp>
    			<Description></Description>
    			<PhysicalConnectionOwnerUid>1231579085529123</PhysicalConnectionOwnerUid>
    			<VlanId>10</VlanId>
    			<RecoveryTime></RecoveryTime>
    			<PhysicalConnectionStatus>Enabled</PhysicalConnectionStatus>
    			<PhysicalConnectionId>pc-2zeoaxkq3jot5p71qcnuy</PhysicalConnectionId>
    			<RouteTableId>vtb-2ze9hmd6yofwvb1dd79j9</RouteTableId>
    			<PeeringSubnetMask>255.0.0.0</PeeringSubnetMask>
    			<TerminationTime></TerminationTime>
    			<Name></Name>
    			<CreationTime>2018-03-06T11:16:34Z</CreationTime>
    			<ActivationTime>2018-03-06T11:16:34Z</ActivationTime>
    			<CircuitCode></CircuitCode>
    			<Status>active</Status>
    			<PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
    			<VlanInterfaceId>ri-2zeum6rgu0586gjrocikm</VlanInterfaceId>
    			<AccessPointId>ap-cn-beijing-dx-A</AccessPointId>
    			<VbrId>vbr-2zecmmvg5gvu8i4telkhw</VbrId>
    		</VirtualBorderRouterType>
    	</VirtualBorderRouterSet>
    	<TotalCount>1</TotalCount>
    	<PageSize>10</PageSize>
    </DescribeVirtualBorderRoutersResponse>
  • JSON格式

    {
      "PageNumber": 1,
      "VirtualBorderRouterSet": {
        "VirtualBorderRouterType": [
          {
            "LocalGatewayIp": "10.1.1.1",
            "PeerGatewayIp": "10.2.2.2",
            "Description": "",
            "PhysicalConnectionOwnerUid": "1231579085xxxx",
            "VlanId": 10,
            "RecoveryTime": "",
            "PhysicalConnectionStatus": "Enabled",
            "PhysicalConnectionId": "pc-2zeoaxkq3jotxxxxx",
            "RouteTableId": "vtb-2ze9hmd6yofwxxxxxx",
            "PeeringSubnetMask": "255.0.0.0",
            "TerminationTime": "",
            "Name": "",
            "CreationTime": "2018-03-06T11:16:34Z",
            "ActivationTime": "2018-03-06T11:16:34Z",
            "CircuitCode": "",
            "Status": "active",
            "PhysicalConnectionBusinessStatus": "Normal",
            "VlanInterfaceId": "ri-2zeum6rgu058xxxxxx",
            "AccessPointId": "ap-cn-beijing-dx-A",
            "VbrId": "vbr-2zecmmvg5gvuxxxxxx"
          }
      "TotalCount": 1,
      "PageSize": 10,
      "RequestId": "98B24329-ADC9-4725-A5F8-6C1B282DA17D"
    }