DescribeVpnAttachments - VPN Gateway

呼叫 DescribeVpnAttachments 介面查詢已繫結轉發路由器執行個體的 IPsec 連線的配置資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVpnAttachments

list

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 連線所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的條目數。預設值：10。取值範圍：1~50。	10
VpnConnectionId	string	否	IPsec 連線 ID。說明如果您不輸入 IPsec 連線 ID，系統預設查詢當前地域下所有已繫結轉發路由器執行個體的 IPsec 連線的資訊。	vco-p0w2jpkhi2eeop6q6****
AttachType	string	否	IPsec 連線繫結的資源類型。預設值：CEN。僅取值：CEN，表示查詢已繫結轉發路由器執行個體的 IPsec 連線的資訊。	CEN

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	9F0725BB-186A-3564-91C3-AAE48042F853
PageSize	integer	分頁查詢時每頁的條目數。	10
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	1
VpnAttachments	array<object>	已繫結轉發路由器執行個體的 IPsec 連線的資訊列表。
	array<object>	已繫結轉發路由器執行個體的 IPsec 連線的資訊。
InstanceId	string	IPsec 連線 ID。	vco-p0w2jpkhi2eeop6q6****
Name	string	IPsec 連線的名稱。	nametest1
Description	string	IPsec 連線的描述資訊。	desctest
AttachType	string	IPsec 連線繫結的資源類型。僅取值：CEN，表示當前 IPsec 連線繫結了轉發路由器執行個體。	CEN
TransitRouterId	string	IPsec 連線繫結的轉發路由器執行個體 ID。	tr-p0wkh4yryb1dnanqw****
TransitRouterName	string	轉發路由器執行個體的名稱。	nametest2
CrossAccountAuthorized	boolean	IPsec 連線是否繫結了跨帳號的轉發路由器執行個體。 true：是。 false：否。	false
Tag	string	IPsec 連線的系統標籤。透過系統標籤您可以瞭解 IPsec 連線是否支援 BGP 功能，其餘屬性無需關注。 BGPSupport：表示 IPsec 連線是否支援 BGP 功能。 true：支援。 false：不支援。	{\"description\":\"转发1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}
Tags	array<object>	IPsec 連線繫結的標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
TunnelBandwidth	string	用於說明 VPN 單條隧道的頻寬規格，取值： Standard（預設值）：標準型，預設頻寬 1Gbps Large（大型）：大型，預設頻寬 3Gbps。	Standard

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9F0725BB-186A-3564-91C3-AAE48042F853",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnAttachments": [
    {
      "InstanceId": "vco-p0w2jpkhi2eeop6q6****",
      "Name": "nametest1",
      "Description": "desctest",
      "AttachType": "CEN",
      "TransitRouterId": "tr-p0wkh4yryb1dnanqw****",
      "TransitRouterName": "nametest2",
      "CrossAccountAuthorized": false,
      "Tag": "{\\\"description\\\":\\\"转发1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TunnelBandwidth": "Standard"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.

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

變更歷史

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