DescribeVirtualBorderRouters - Express Connect

呼叫 DescribeVirtualBorderRouters 介面查詢已建立的 VBR 執行個體。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVirtualBorderRouters

list

*VirtualBorderRouter

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	VBR 所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-shanghai
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的行數，最大值為 50，預設值為 10。	10
Filter	array<object>	否	過濾資訊。
	object	否	過濾資訊。
Key	string	否	過濾條件，最多可提供 5 個過濾條件。支援如下過濾條件： PhysicalConnectionId：實體專線執行個體 ID。 VbrId：邊界路由器執行個體 ID。 Status：邊界路由器狀態。 Name：邊界路由器名稱。 AccessPointId：接入點 ID。 eccId：高速上雲端服務執行個體 ID。 type：實體專線類型。	Status
Value	array	否	根據 Key 指定過濾值。一個 Key 支援指定多個過濾值，每個過濾值之間是或的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。	Active
	string	否	根據 Key 指定過濾值。一個 Key 支援指定多個過濾值，每個過濾值之間是或的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。	Active
IncludeCrossAccountVbr	boolean	否	是否包含跨帳號的邊界路由器。 true：包含。 false（預設值）：不包含。	false
ResourceGroupId	string	否	資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。	rg-acfmxazb4ph6aiy****
Tags	array<object>	否	資源的標籤。
	object	否	標籤。
Key	string	否	資源的標籤鍵。至少輸入 1 個標籤鍵，最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入空字串。一個標籤鍵最多支援 128 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入空字串。最多支援 128 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	VBR 資訊。
RequestId	string	請求 ID。	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumber	integer	列表的頁碼，預設值為 1。	1
PageSize	integer	分頁查詢時每頁的行數，最大值為 50，預設值為 10。	10
TotalCount	integer	列表條目數。	1
VirtualBorderRouterSet	object
VirtualBorderRouterType	array<object>	查詢到的 VBR 合集。
	array<object>	VBR 的建立時間。
CreationTime	string	VBR 的建立時間。	2020-06-08T12:20:55
Status	string	VBR 執行個體狀態。 unconfirmed：等待他人確認。 active：正常。 terminating：終止接入中。 terminated：已終止接入。 recovering：恢複中。 deleting：刪除中。	active
Type	string	VBR 類型。	pconnVBR
MinTxInterval	integer	配置 BFD 報文的發送間隔，取值：200～1000，單位為 ms。	300
PeerIpv6GatewayIp	string	VBR 執行個體的客戶側互聯 IPv6 地址。	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PConnVbrExpireTime	string	計費 VBR 的超期時間。	2021-06-08T12:20:55
PhysicalConnectionOwnerUid	string	物理專線所屬的帳號 ID。	1688000000000****
ActivationTime	string	VBR 第一次啟用的時間。	2021-06-08T12:20:55
PhysicalConnectionBusinessStatus	string	物理專線業務狀態。 Normal：正常。 FinancialLocked：欠費鎖定。	Normal
Description	string	VBR 的描述資訊。	desc
TerminationTime	string	VBR 最近一次被終止的時間。	2021-06-08T12:20:55
MinRxInterval	integer	配置 BFD 報文的接收間隔，取值：200～1000，單位為 ms。	300
PeerGatewayIp	string	VBR 執行個體的客戶側互聯 IPv4 地址。	192.168.XX.XX
Name	string	VBR 執行個體名稱。	test
VbrId	string	VBR 執行個體 ID。	vbr-bp1jcg5cmxjbl9xgc****
VlanId	integer	VBR 執行個體的 VLAN ID。	10
VlanInterfaceId	string	VBR 的路由器介面的 ID。	ri-2zeo3xzyf38r4xx****
CircuitCode	string	電訊廠商為物理專線提供的電路編碼。	longtel0****
LocalIpv6GatewayIp	string	VBR 執行個體的阿里雲側互聯 IPv6 地址。	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalGatewayIp	string	VBR 執行個體的阿里雲側互聯 IPv4 地址。	192.168.XX.XX
PeeringSubnetMask	string	VBR 執行個體的阿里雲側互聯 IPv4 和客戶側互聯 IPv4 的子網路遮罩。	255.255.255.252
EnableIpv6	boolean	是否啟用 IPv6。 true：開啟。 false：關閉。	false
RouteTableId	string	VBR 的路由表 ID。	rtb-bp1****
DetectMultiplier	integer	檢測時間倍數。即接收方允許發送方發送報文的最大串連丟包數，用來檢測鏈路是否正常。取值：3～10。	3
EccId	string	Express Cloud Connect 執行個體 ID。	ecc-h****
CloudBoxInstanceId	string	雲盒執行個體 ID。	cb-****
RecoveryTime	string	VBR 最近一次從 terminated 狀態恢複到 active 狀態的時間。	2021-05-08T12:20:55
PhysicalConnectionStatus	string	物理專線狀態。 Initial：申請中。 Approved：審批通過。 Allocating：正在分配資源。 Allocated：接入施工中。 Confirmed：等待使用者確認。 Enabled：已開通。 Rejected：申請被拒絕。 Canceled：已取消。 Allocation Failed：資源分派失敗。 Terminated：已終止。	Normal
PeeringIpv6SubnetMask	string	VBR 執行個體的阿里雲側互聯 IPv6 與客戶側互聯 IPv6 的子網路遮罩。	2000:1234:0:a000::/55
AccessPointId	string	物理專線存取點的 ID。	ap-cn-kojok1x****
PConnVbrChargeType	string	物理專線綁定的邊界路由器付費類型。 PrePaid：預付費，訂用帳戶。選擇該類付費方式時，您必須確認自己的帳號支援餘額支付或信用支付。 PostPaid：隨用隨付。	PrePaid
PhysicalConnectionId	string	VBR 所屬的物理專線的 ID。	pc-119mfjzm7x****
AssociatedPhysicalConnections	object
AssociatedPhysicalConnection	array<object>	關聯的物理專線資訊。
	object	關聯的物理專線資訊。
Status	string	VBR 執行個體狀態。 unconfirmed：等待他人確認。 active：正常。 terminating：終止接入中。 terminated：已終止接入。 recovering：恢複中。 deleting：刪除中。	active
VlanInterfaceId	string	VBR 的路由器介面 ID，可以作為 VBR 路由的下一跳。	ri-kojok19x3j0q6k****
CircuitCode	string	電訊廠商為物理專線提供的電路編碼。	longtel0**
PeerIpv6GatewayIp	string	VBR 執行個體的客戶側互聯 IPv6 地址。	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalIpv6GatewayIp	string	VBR 執行個體的阿里雲側互聯 IPv6 地址。	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PhysicalConnectionOwnerUid	string	物理專線所有者的帳號 ID。	12345678****
LocalGatewayIp	string	VBR 執行個體的阿里雲側互聯 IPv4 地址。	192.168.XX.XX
PhysicalConnectionBusinessStatus	string	物理專線業務狀態。 Normal：正常。 FinancialLocked：欠費鎖定。	Normal
PeeringSubnetMask	string	VBR 執行個體的阿里雲側和客戶側互聯 IPv4 的子網路遮罩。兩個 IPv4 地址必須位於同一個子網。	255.255.255.252
EnableIpv6	boolean	是否啟用 IPv6。 true：開啟。 false：關閉。	true
PhysicalConnectionStatus	string	物理專線狀態。 Initial：申請中。 Approved：審批通過。 Allocating：正在分配資源。 Allocated：接入施工中。 Confirmed：等待使用者確認。 Enabled：已開通。 Rejected：申請被拒絕。 Canceled：已取消。 Allocation Failed：資源分派失敗。 Terminated：已終止。	Enabled
PeerGatewayIp	string	VBR 執行個體的客戶側互聯 IPv4 地址。	116.62.XX.XX
PeeringIpv6SubnetMask	string	VBR 執行個體的阿里雲側和客戶側互聯 IPv6 的子網路遮罩。兩個 IPv6 地址必須位於同一個子網。	2408:4004:cc:400::/56
PhysicalConnectionId	string	物理專線 ID。	pc-119mfjzm7****
VlanId	string	VBR 執行個體的 VLAN ID。	0
AssociatedCens	object
AssociatedCen	array<object>	關聯的雲企業網執行個體資訊。
	object	執行個體資訊。
CenOwnerId	integer	雲企業網執行個體所屬帳號的 ID。	1688000000000****
CenId	string	雲企業網執行個體 ID。	cen-kojok19xxx****
CenStatus	string	雲企業網狀態。 Attached：已關聯。 Attaching：關聯中。 Detached：已取消關聯。 Detaching：取消關聯中。空：未關聯。	Attached
Bandwidth	integer	VBR 執行個體的頻寬值，單位：Mbps。	50
ResourceGroupId	string	資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	資源的標籤。
	object	標籤。
Key	string	資源的標籤鍵。	FinanceDept
Value	string	資源的標籤值。	FinanceJoshua
EcrId	string	關聯的專線網關執行個體 ID。	ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnable	boolean	是否允許 IDC 間業務訪問。取值： true：是。 false：否。說明如果不傳入任何取值表示不允許 IDC 間業務訪問。	false
EcrAttatchStatus	string	專線網關關聯狀態。 Attached：已關聯。 Attaching：關聯中。 Detached：已取消關聯。 Detaching：取消關聯中。空：未關聯。	Attached
EcrOwnerId	string	ECR 執行個體所屬阿里雲帳號（主帳號）ID。	192732132151xxxx
Mtu	integer	VBR 支援的 MTU 值，取值範圍：1500 和 8500。	1500

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。