ListTransitRouterVbrAttachments查詢企業版轉寄路由器下的VBR串連-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 ListTransitRouterVbrAttachments 介面查詢企業版轉發路由器下的邊界路由器 VBR 總條目數、連線的狀態、連線 ID、網路執行個體的付費方等連線資訊。

介面說明

您可以透過以下三種方式查詢企業版轉發路由器下 VBR 連線的資訊：

透過企業版轉發路由器執行個體 ID 查詢該執行個體下所有 VBR 連線的資訊。
透過雲企業網執行個體 ID 和企業版轉發路由器執行個體所屬地域 ID 查詢該執行個體下所有 VBR 連線的資訊。
可以單獨透過 TransitRouterAttachmentId 參數查詢 VBR 連線資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListTransitRouterVbrAttachments

list

CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouterVbrAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/*

TransitRouterVbrAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

無

請求參數

名稱	類型	必填	描述	樣本值
CenId	string	否	雲企業網執行個體 ID。	cen-j3jzhw1zpau2km****
RegionId	string	否	企業版轉發路由器執行個體所屬地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
TransitRouterAttachmentId	string	否	VBR 連線 ID。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	否	企業版轉發路由器執行個體 ID。	tr-bp1su1ytdxtataupl****
MaxResults	integer	否	分批次查詢時，每次顯示的最大條目數。預設值為 20。	20
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	dd20****
Tag	array<object>	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
	object	否
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	tagtest
Value	string	否	資源的標籤值。標籤值可以為空或輸入不超過 128 個字元的字串，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	tagtest

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	dd20****
RequestId	string	請求 ID。	F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCount	integer	總條目數。	1
MaxResults	integer	分批次查詢時，每次顯示的最大條目數。	20
TransitRouterAttachments	array<object>	VBR 連線資訊列表。
	array<object>
CreationTime	string	VBR 連線的建立時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mmZ。	2021-06-15T15:20Z
Status	string	VBR 連線的狀態。 Attached：已載入。 Attaching：載入中。 Detaching：卸載中。	Attached
TransitRouterAttachmentId	string	VBR 連線 ID。	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	企業版轉發路由器執行個體 ID。	tr-bp1su1ytdxtataupl****
ResourceType	string	連線所屬的資源類型。僅取值：VBR，表示邊界路由器執行個體。	VBR
VbrRegionId	string	VBR 執行個體所屬地域 ID。	cn-hangzhou
TransitRouterAttachmentDescription	string	VBR 連線的描述資訊。	testdesc
VbrOwnerId	integer	VBR 執行個體所屬帳號 ID。	1688111111111111
AutoPublishRouteEnabled	boolean	企業版轉發路由器是否自動發佈路由到 VBR 執行個體。 false：否。 true：是。	false
VbrId	string	VBR 執行個體 ID。	vbr-bp1svadp4lq38janc****
TransitRouterAttachmentName	string	VBR 連線的名稱。	testa
Tags	array<object>	標籤列表。
	object
Key	string	標籤鍵。	test
Value	string	標籤值。	value_A1
CenId	string	雲企業網執行個體 ID。	cen-j3jzhw1zpau2km****
ManagedService	string	標識該 VBR 連線被哪個雲端服務託管。只有該 VBR 連線被雲端服務託管時才會返回對應雲端服務的標準 Code；如果是您自行管理的 VBR 連線，則不返回該欄位值。
OrderType	string	網路執行個體的付費方。取值： PayByCenOwner：表示 VBR 執行個體的連線費和流量處理費由轉發路由器執行個體所屬的帳號承擔。 PayByResourceOwner：表示 VBR 執行個體的連線費和流量處理費由 VBR 執行個體所屬的帳號承擔。	PayByCenOwner

樣本

正常返回樣本

JSON格式

{
  "NextToken": "dd20****",
  "RequestId": "F42D9616-29EB-4E75-8CA8-9654D4E07501",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T15:20Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-oyf70wfuorwx87****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VBR",
      "VbrRegionId": "cn-hangzhou",
      "TransitRouterAttachmentDescription": "testdesc",
      "VbrOwnerId": 1688111111111111,
      "AutoPublishRouteEnabled": false,
      "VbrId": "vbr-bp1svadp4lq38janc****",
      "TransitRouterAttachmentName": "testa",
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "ManagedService": "",
      "OrderType": "PayByCenOwner"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	參數中指定的 NextToken 不合法。
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	參數 TransitRouterId 或 RegionId 無效。
400	IllegalParam.Region	The specified Region is invalid.	參數中指定的 Region 不合法。
400	IllegalParam.CenId	The specified CenId is invalid.	指定的 cenId 不合法。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is invalid.	參數 TransitRouterId 或 RegionId 無效。
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.	指定的 CenId 或 RegionId 不合法。
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults 無效。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。

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

變更歷史

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