DescribeVpnGateways - VPN Gateway

呼叫 DescribeVpnGateways 介面查詢指定地域下已建立的 VPN 閘道器。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVpnGateways

list

VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/*

VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	VPN 閘道器所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
VpcId	string	否	VPN 閘道器所屬專有網路 VPC（Virtual Private Cloud）的 ID。	vpc-bp1m3i0kn1nd4wiw9****
VpnGatewayId	string	否	VPN 閘道器的 ID。	vpn-bp17lofy9fd0dnvzv****
Status	string	否	VPN 閘道器的狀態。取值： init：初始化。 provisioning：準備中。 active：正常。 updating：更新中。 deleting：刪除中。	active
BusinessStatus	string	否	VPN 閘道器的付費狀態。取值： Normal：正常。 FinancialLocked：欠費鎖定。	Normal
PageNumber	integer	否	清單的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的條目數。取值範圍：1~50。預設值：10。	10
IncludeReservationData	boolean	否	是否包含未生效的訂購資料。取值： false（預設值）：不包含未生效的訂購資料。 true：包含未生效的訂購資料。	true
Tag	array<object>	否	VPN 閘道器綁定的標籤清單。
	object	否	VPN 閘道器綁定的標籤。
Key	string	否	標籤鍵。一次最多支援輸入 20 個標籤鍵。	FinanceDept
Value	string	否	標籤值。一個標籤鍵對應一個標籤值。一次最多支援輸入 20 個標籤值。	FinanceJoshua
ResourceGroupId	string	否	VPN 閘道器所屬的資源群組 ID。您可以呼叫 ListResourceGroups 介面查詢資源群組 ID。	rg-acfmzs372yg****
GatewayType	string	否	VPN 閘道器類型，取值： Traditional：傳統型 VPN 閘道器，涵蓋 IPsec 功能和 SSL 功能 Enhanced.SiteToSite：增強型網站入雲 VPN，僅涵蓋 IPsec 功能	Enhanced.SiteToSite

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
PageSize	integer	分頁查詢時每頁的條目數。	10
RequestId	string	請求 ID。	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
PageNumber	integer	清單的頁碼。	1
TotalCount	integer	清單條目數。	1
VpnGateways	object
VpnGateway	array<object>	VPN 閘道器資訊清單。
	array<object>	VPN 閘道器的資訊。
VpnType	string	VPN 閘道器類型。取值：Normal，表示普通型。	Normal
Status	string	VPN 閘道器的狀態。 init：初始化。 provisioning：準備中。 active：正常。 updating：更新中。 deleting：刪除中。	active
VpcId	string	VPN 閘道器所屬 VPC 的 ID。	vpc-bp1m3i0kn1nd4wiw9****
SslMaxConnections	integer	VPN 閘道器 SSL 連線數的規格。	5
Spec	string	VPN 閘道器的頻寬峰值。M 表示單位為 Mbps。	5M
InternetIp	string	在 VPN 閘道器執行個體支援建立單隧道模式 IPsec-VPN 連線的情境下，該地址為 VPN 閘道器執行個體的 IP 地址，可用於建立 IPsec-VPN 連線或 SSL-VPN 連線。在 VPN 閘道器執行個體支援建立雙隧道模式 IPsec-VPN 連線的情境下，該地址為用於建立 IPsec-VPN 連線的第一個 IP 地址，不能用於建立 SSL-VPN 連線。在 VPN 閘道器執行個體支援建立雙隧道模式 IPsec-VPN 連線的情境下，系統會為 VPN 閘道器執行個體分配兩個 IPsec 地址，用於建立雙隧道模式的 IPsec-VPN 連線。	47.12.XX.XX
CreateTime	integer	建立 VPN 閘道器的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 VPN 閘道器執行個體時的總時長。	1515383700000
AutoPropagate	boolean	是否已開啟 VPN 閘道器的路由自動傳播功能。 true：已開啟。 false：未開啟。	true
ChargeType	string	VPN 閘道器的付費類型。僅取值：POSTPAY，按量計費。	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	VPN 閘道器的 ID。	vpn-bp17lofy9fd0dnvzv****
Tag	string	系統自動產生的 VPN 閘道器標籤。 VpnEnableBgp：表示 VPN 閘道器是否支援 BGP 功能。 true：支援。 false：不支援。 VisuallySsl：表示 VPN 閘道器是否支援檢視 SSL 用戶端的連線資訊。 true：支援。 false：不支援。 PbrPriority：表示 VPN 閘道器是否支援為原則路由設定原則優先順序。 true：支援。 false：不支援。 VpnNewImage：表示 VPN 閘道器是否為新型 VPN 閘道器。 true：是。 false：否。 description：表示 VPN 閘道器的描述資訊，僅供系統內部使用。 VpnVersion：表示 VPN 閘道器的版本號。 IDaaSNewVersion：表示 VPN 閘道器是否支援綁定 EIAM 2.0 執行個體。 true：支援。 false：不支援。	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	VPN 閘道器是否開啟了 IPsec-VPN 功能。 enable：已開啟。 disable：未開啟。	enable
EndTime	integer	VPN 閘道器到期時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至 VPN 閘道器執行個體到期時的總時長。	1518105600000
VSwitchId	string	VPN 閘道器所屬交換器的 ID。	vsw-bp15lbk8sgtr6r5b0****
Description	string	VPN 閘道器的描述資訊。	test
EnableBgp	boolean	VPN 閘道器 BGP 功能的開啟狀態。 true：已開啟。 false：未開啟。	true
BusinessStatus	string	VPN 閘道器的付費狀態。 Normal：正常。 FinancialLocked：欠費鎖定。	Normal
SslVpn	string	VPN 閘道器是否開啟了 SSL-VPN 功能。 enable：已開啟。 disable：未開啟。	enable
Name	string	VPN 閘道器的名稱。	test
NetworkType	string	VPN 閘道器的網路類型。 public：公網 VPN 閘道器。 private：私網 VPN 閘道器。	public
Tags	object
Tag	array<object>	VPN 閘道器綁定的標籤清單。
	object	VPN 閘道器綁定的標籤資訊。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
ReservationData	object	未生效的訂購資料。說明僅當 IncludeReservationData 傳入 true 時才會返回此組參數。
Status	string	未生效訂單狀態。 1：表示續約或續約變更配置的訂單未生效。 2：表示臨時升級配置的訂單已生效。在到達還原時間後，系統會將 VPN 閘道器規格恢復到臨時升級配置前的規格。此時 ReservationIpsec、ReservationMaxConnections、ReservationSpec、ReservationSsl 表示為 VPN 閘道器臨時升級配置前的規格。	1
ReservationOrderType	string	未生效訂單類型。 RENEWCHANGE：續約變更配置。 TEMP_UPGRADE：臨時升級配置。 RENEW：續約。	TEMP_UPGRADE
ReservationIpsec	string	未生效訂單 IPsec-VPN 功能開啟狀態。 enable：已開啟。 disable：未開啟。	enable
ReservationSpec	string	未生效訂單的頻寬規格。單位：Mbps。	5
ReservationSsl	string	未生效訂單 SSL-VPN 功能開啟狀態。 enable：已開啟。 disable：未開啟。	enable
ReservationMaxConnections	integer	未生效訂單 SSL-VPN 並行連線使用者數的規格。	5
ReservationEndTime	string	如果未生效訂單類型為 TEMP_UPGRADE（臨時升級配置）時，此參數表示為臨時升級配置的還原時間。如果未生效訂單類型為 RENEWCHANGE（續約變更配置）或 RENEW（續約）時，此參數表示為續約或續約變更配置開始生效時間。	2021-07-20T16:00:00Z
DisasterRecoveryInternetIp	string	系統為 VPN 閘道器執行個體分配的用於建立 IPsec-VPN 連線的第二個 IP 地址。僅支援建立雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體會返回目前參數。	47.91.XX.XX
DisasterRecoveryVSwitchId	string	VPN 閘道器執行個體關聯的第二個交換器 ID。僅支援建立雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體會返回目前參數。	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	SSL-VPN 連線的 IP 地址。僅支援建立雙隧道模式 IPsec-VPN 連線的公網網路類型的 VPN 閘道器執行個體開啟 SSL-VPN 功能後，才會返回目前參數。	47.74.XX.XX
ResourceGroupId	string	VPN 閘道器所屬的資源群組 ID。您可以呼叫 ListResourceGroups 介面查詢資源群組資訊。	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	系統為 VPN 閘道器執行個體建立的彈性網卡 ENI（Elastic Network Interfaces）清單。
	string	ENI ID。僅支援建立雙隧道模式 IPsec-VPN 連線的 VPN 閘道器執行個體會返回目前參數。	eni-7xvcxgmd4y2ypibn****
GatewayType	string	VPN 閘道器類型，取值： Traditional：傳統型 VPN 閘道器，涵蓋 IPsec 功能和 SSL 功能 Enhanced.SiteToSite：增強型網站入雲 VPN，僅涵蓋 IPsec 功能	Enhanced.SiteToSite

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnGateways": {
    "VpnGateway": [
      {
        "VpnType": "Normal",
        "Status": "active",
        "VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
        "SslMaxConnections": 5,
        "Spec": "5M",
        "InternetIp": "47.12.XX.XX",
        "CreateTime": 1515383700000,
        "AutoPropagate": true,
        "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
        "IpsecVpn": "enable",
        "EndTime": 1518105600000,
        "VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
        "Description": "test",
        "EnableBgp": true,
        "BusinessStatus": "Normal",
        "SslVpn": "enable",
        "Name": "test",
        "NetworkType": "public",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "ReservationData": {
          "Status": "1",
          "ReservationOrderType": "TEMP_UPGRADE",
          "ReservationIpsec": "enable",
          "ReservationSpec": "5",
          "ReservationSsl": "enable",
          "ReservationMaxConnections": 5,
          "ReservationEndTime": "2021-07-20T16:00:00Z"
        },
        "DisasterRecoveryInternetIp": "47.91.XX.XX",
        "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
        "SslVpnInternetIp": "47.74.XX.XX",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "EniInstanceIds": {
          "EniInstanceId": [
            "eni-7xvcxgmd4y2ypibn****"
          ]
        },
        "GatewayType": "Enhanced.SiteToSite"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	指定的參數TagKey不合規範。
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	指定的參數TagValue不合規範。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定的參數 TagKey 重複。
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	您沒有權限操作該資源，請您申請操作權限後再試。
403	Forbidden	User not authorized to operate on the specified resource.	EIP 不屬於當前呼叫者，請您檢查該 EIP 是否可被您呼叫。

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

變更歷史

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