調用ListTransitRouterVpnAttachments查詢VPN串連-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 ListTransitRouterVpnAttachment 介面查詢 VPN 連線的狀態、IPsec 連線 ID、VPN 連線的付費類型等資訊。

介面說明

在您呼叫 ListTransitRouterVpnAttachments 介面的過程中支援以下三種查詢方式：

支援單獨輸入 TransitRouterAttachmentId 查詢則查詢指定 VPN 連線的資訊。
支援單獨輸入 TransitRouterId 查詢目前轉發路由器下關聯的所有 VPN 連線的資訊。
支援 CenId、RegionId 查詢目前雲端企業網路中指定地域下的 VPN 連線的資訊。

在呼叫 ListTransitRouterVpnAttachments 介面過程時請確保輸入的參數值無誤。如果您輸入的參數有誤，呼叫介面後仍然會返回 RequestId 等資訊，但不會顯示目標查詢 VPN 連線的資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListTransitRouterVpnAttachments

list

*CenInstance

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

TransitRouterVpnAttachment

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

TransitRouterVpnAttachment

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

無

請求參數

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

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextToken	string	是否擁有下一次查詢的權杖（Token）。取值：如果 NextToken 為空表示沒有下一次查詢。如果 NextToken 有返回值，該取值表示下一次查詢開始的權杖。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	請求 ID。	3D5530D2-3BBB-524E-8E98-59AB06A250E4
TotalCount	integer	清單項目數。	1
MaxResults	integer	分頁查詢時每頁顯示的項目數。	20
TransitRouterAttachments	array<object>	VPN 連線資訊清單。
	array<object>	VPN 連線的資訊。
CreationTime	string	建立 VPN 連線的時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mmZ。	2022-07-08T08:45Z
Status	string	VPN 連線的狀態。 Attached：已載入。 Attaching：載入中。 Detaching：卸載中。	Attached
TransitRouterAttachmentId	string	VPN 連線 ID。	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	轉發路由器執行個體 ID。	tr-p0wm740vjnbaprv0m****
ResourceType	string	VPN 連線所屬的資源類型。僅取值：VPN，表示轉發路由器連線了 IPsec 連線。	VPN
VpnOwnerId	integer	IPsec 連線所屬的阿里雲帳號（主帳號）ID。	1210123456123456
VpnId	string	IPsec 連線 ID。	vco-p0wtu1xgd0l7fjo7k****
TransitRouterAttachmentDescription	string	VPN 連線的描述資訊。	desctest
VpnRegionId	string	IPsec 連線所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
AutoPublishRouteEnabled	boolean	是否允許轉發路由器執行個體自動向 IPsec 連線發佈路由條目。取值： true：允許。 false：不允許。	true
TransitRouterAttachmentName	string	VPN 連線的名稱。	nametest
Zones	array<object>	部署 VPN 連線的可用區清單。
	object	部署 VPN 連線的可用區。
ZoneId	string	可用性區域 ID。您可以通過調用 DescribeZones 介面查詢可用性區域 ID 對應的可用性區域的資訊。	cn-hangzhou-h
Tags	array<object>	標籤清單。
	object
Key	string	標籤鍵。	test
Value	string	標籤的值。	value_A1
ChargeType	string	VPN 連線的付費類型。僅取值：POSTPAY，表示按使用量後付費。	POSTPAY
CenId	string	雲端企業網路執行個體 ID。	cen-j3jzhw1zpau2km****
OrderType	string	網路執行個體的付費方。取值： PayByCenOwner：表示網路執行個體產生的費用由雲端企業網路執行個體所屬的帳號承擔。 PayByResourceOwner：表示網路執行個體產生的費用由網路執行個體所屬的帳號承擔。	PayByCenOwner

樣本

正常返回樣本

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "3D5530D2-3BBB-524E-8E98-59AB06A250E4",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2022-07-08T08:45Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-a6p8voaodog5c0****",
      "TransitRouterId": "tr-p0wm740vjnbaprv0m****",
      "ResourceType": "VPN",
      "VpnOwnerId": 1210123456123456,
      "VpnId": "vco-p0wtu1xgd0l7fjo7k****",
      "TransitRouterAttachmentDescription": "desctest",
      "VpnRegionId": "cn-hangzhou",
      "AutoPublishRouteEnabled": true,
      "TransitRouterAttachmentName": "nametest",
      "Zones": [
        {
          "ZoneId": "cn-hangzhou-h"
        }
      ],
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "ChargeType": "POSTPAY",
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "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.CenIdOrRegionId	The specified CenId or RegionId is invalid.	指定的 CenId 或 RegionId 不合法。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is illegal.	參數 TransitRouterId 或 RegionId 無效。
400	IllegalParam.MaxResults	The specified MaxResults is invalid.	MaxResults 無效。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。

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

變更歷史

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