DescribeVpnConnection - VPN Gateway

呼叫 DescribeVpnConnection 介面查詢指定的 IPsec 連線資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeVpnConnection

get

*VpnConnection

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 連線所在的地域 ID。	cn-hangzhou
VpnConnectionId	string	是	IPsec 連線的 ID。	vco-bp1bbi27hojx80nck****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
Status	string	IPsec 連線的狀態。 ike_sa_not_established：第一階段協商失敗。 ike_sa_established：第一階段協商成功。 ipsec_sa_not_established：第二階段協商失敗。 ipsec_sa_established：第二階段協商成功。	ike_sa_not_established
RemoteCaCertificate	string	對端的 CA 憑證。	-----BEGIN CERTIFICATE----- MIIB7zCCAZW****
EnableNatTraversal	boolean	IPsec 連線是否已啟用 NAT 穿越功能。 true：啟用 NAT 穿越功能。 false：不啟用 NAT 穿越功能。啟用 NAT 穿越功能後，IKE 協商過程會移除對 UDP 連接埠號碼的驗證程序，同時實現對 VPN 通道中 NAT 閘道器裝置的探索功能。	true
CreateTime	integer	建立 IPsec 連線的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 IPsec 連線時的總時長。	1492753817000
EffectImmediately	boolean	IPsec 連線的設定是否立即生效。	true
VpnGatewayId	string	VPN 閘道器的執行個體 ID。	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	IPsec 連線阿里雲側的網段。	10.0.0.0/8
RequestId	string	請求 ID。	F2310D45-BCF6-4E2E-9082-B4503844BA4C
VpnConnectionId	string	IPsec 連線的 ID。	vco-bp1bbi27hojx80nck****
RemoteSubnet	string	本機資料中心側的網段。	192.168.0.0/16
CustomerGatewayId	string	IPsec 連線關聯的使用者閘道器 ID。	cgw-bp1mvj4g9kogwwcxk****
Name	string	IPsec 連線的名稱。	ipsec1
EnableDpd	boolean	IPsec 連線是否已啟用 DPD（對等體存活偵測）功能。 false：未啟用。 true：已啟用。啟用 DPD 功能後，IPsec 發起端會傳送 DPD 封包用來偵測對端裝置是否存活，若在設定時間內未收到正確回應則認為對端已經斷線，IPsec 將刪除 ISAKMP SA 和相應的 IPsec SA，安全通道同樣也會被刪除。	true
IkeConfig	object	第一階段協商的設定。
RemoteId	string	IPsec 連線本機資料中心側的識別碼。	139.34.XX.XX
IkeLifetime	integer	IKE 階段存留時間。單位：秒。	86400
IkeEncAlg	string	IKE 階段加密演算法。	aes
LocalId	string	IPsec 連線阿里雲側的識別碼。	116.28.XX.XX
IkeMode	string	IKE 協商模式。	main
IkeVersion	string	IKE 通訊協定版本。	ikev1
IkePfs	string	IKE 階段 DH 群組。	group2
Psk	string	預先共用金鑰。	pgw6dy****
IkeAuthAlg	string	IKE 階段驗證演算法。	sha1
IpsecConfig	object	第二階段協商的設定。
IpsecAuthAlg	string	IPsec 階段驗證演算法。	sha1
IpsecLifetime	integer	IPsec 階段存留時間。單位：秒。	86400
IpsecEncAlg	string	IPsec 階段加密演算法。	aes
IpsecPfs	string	IPsec 階段 DH 群組。	group2
VcoHealthCheck	object	IPsec 連線的健康檢查資訊。
Status	string	健康檢查狀態。	failed
Dip	string	目標 IP 位址。	10.0.0.1
Interval	integer	健康檢查的重試間隔時間，單位：秒。	3
Retry	integer	健康檢查的重試封包傳送次數。	3
Sip	string	來源 IP 位址。	192.168.1.1
Enable	string	IPsec 連線是否已啟用健康檢查。	true
Policy	string	健康檢查失敗時是否撤銷已發佈的路由。	revoke_route
VpnBgpConfig	object	IPsec 連線 BGP 路由通訊協定的設定資訊。
Status	string	BGP 路由協定的協商狀態。	success
PeerBgpIp	string	對端 BGP 位址。	169.254.11.1
TunnelCidr	string	IPsec 連線 BGP 網段。該網段是一個在 169.254.0.0/16 內的子網路遮罩長度為 30 的網段。	169.254.11.0/30
EnableBgp	string	BGP 路由通訊協定的啟用狀態。	true
LocalBgpIp	string	阿里雲側 BGP 位址。	169.254.11.2
PeerAsn	integer	對端自治系統號。	65530
LocalAsn	integer	阿里雲側自治系統號。	65531
AuthKey	string	BGP 路由通訊協定的驗證金鑰。	AuthKey****
AttachType	string	IPsec 連線綁定的資源類型。 CEN：表示 IPsec 連線已綁定雲企業網執行個體下的轉發路由器執行個體。 NO_ASSOCIATED：表示 IPsec 連線未綁定任何資源。 VPNGW：表示 IPsec 連線綁定了 VPN 閘道器執行個體。	CEN
NetworkType	string	IPsec 連線的網路類型。 public：公網，表示 IPsec 連線透過公網建立加密通訊通道。 private：私網，表示 IPsec 連線透過私網建立加密通訊通道。	public
AttachInstanceId	string	轉送路由器執行個體所屬的雲企業網執行個體 ID。	cen-lxxpbpalc776qz****
Spec	string	IPsec 連線的頻寬規格。單位：Mbps。	1000M
State	string	IPsec 連線與轉送路由器執行個體的繫結狀態。 active：IPsec 連線已與 VPN 閘道器執行個體繫結，狀態正常。 init：IPsec 連線未繫結任何資源，IPsec 連線初始化。 attaching：IPsec 連線與轉送路由器執行個體繫結中。 attached：IPsec 連線已與轉送路由器執行個體繫結。 detaching：IPsec 連線與轉送路由器執行個體解除繫結中。 financialLocked：欠費鎖定。 provisioning：資源準備中。 updating：更新中。 upgrading：升級中。 deleted：已刪除。	attached
ZoneNo	string	IPsec 連線被部署的可用區 ID。	cn-hangzhou-h
InternetIp	string	IPsec 連線的閘道器 IP 位址。	47.XX.XX.162
TransitRouterId	string	IPsec 連線綁定的轉送路由器執行個體 ID。	tr-p0we2edef9qr44a85****
TransitRouterName	string	轉送路由器執行個體的名稱。	nametest
CrossAccountAuthorized	boolean	IPsec 連線是否綁定了跨帳號的轉發路由器執行個體。	false
Tags	object
Tag	array<object>	IPsec 連線綁定的標籤清單。
	object	標籤資訊。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
TunnelOptionsSpecification	object
TunnelOptions	array<object>	IPsec 連線的通道設定資訊。
	array<object>	通道的設定資訊。
TunnelId	string	通道 ID。	tun-opsqc4d97wni27****
CustomerGatewayId	string	通道關聯的使用者閘道器 ID。	cgw-p0wy363lucf1uyae8****
EnableDpd	string	通道是否已啟用 DPD（對等體存活偵測）功能。 false：未啟用。 true：已啟用。	true
EnableNatTraversal	string	通道是否已啟用 NAT 穿越功能。 false：未啟用。 true：已啟用。	true
InternetIp	string	通道的 IP 位址。	47.21.XX.XX
RemoteCaCertificate	string	通道對端的 CA 憑證。僅 VPN 閘道器執行個體的類型為國密型時才會返回當前參數。	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
Role	string	通道的角色。 master：表示當前通道為主通道。 slave：表示當前通道為備用通道。	master
TunnelIndex	integer	通道的建立順序。 1：第一條通道。 2：第二條通道。說明僅 IPsec 連線綁定轉送路由器時會返回該參數。	1
State	string	通道的狀態。 active：狀態正常。 updating：更新中。 deleting：刪除中。	active
Status	string	IPsec 連線的狀態。 ike_sa_not_established：第一階段協商失敗。 ike_sa_established：第一階段協商成功。 ipsec_sa_not_established：第二階段協商失敗。 ipsec_sa_established：第二階段協商成功。	ipsec_sa_established
TunnelBgpConfig	object	通道的 BGP 設定資訊。
BgpStatus	string	BGP 的協商狀態。 success：正常。 failed：異常。	success
LocalAsn	string	通道本端（阿里雲側）的自治系統號。	65530
LocalBgpIp	string	通道本端（阿里雲側）的 BGP 位址。	169.254.10.1
PeerAsn	string	通道對端的自治系統號。	65531
PeerBgpIp	string	通道對端的 BGP 位址。	169.254.10.2
TunnelCidr	string	通道的 BGP 網段。	169.254.10.0/30
TunnelIkeConfig	object	第一階段協商的設定。
IkeAuthAlg	string	IKE 階段驗證演算法。	sha1
IkeEncAlg	string	IKE 階段加密演算法。	aes
IkeLifetime	string	IKE 階段存留時間。單位：秒。	86400
IkeMode	string	IKE 協商模式。 main：主模式，協商過程安全性高。 aggressive：積極模式，協商快速且協商成功率高。	main
IkePfs	string	IKE 階段 DH 群組。	group2
IkeVersion	string	IKE 通訊協定版本。	ikev1
LocalId	string	通道本端（阿里雲側）的識別碼。	47.21.XX.XX
Psk	string	預先共用金鑰。	123456****
RemoteId	string	通道對端的識別碼。	47.42.XX.XX
TunnelIpsecConfig	object	第二階段協商的設定。
IpsecAuthAlg	string	IPsec 階段驗證演算法。	sha1
IpsecEncAlg	string	IPsec 階段加密演算法。	aes
IpsecLifetime	string	IPsec 階段存留時間。單位：秒。	86400
IpsecPfs	string	IPsec 階段 DH 群組。	group2
ZoneNo	string	通道部署的可用區。您可以呼叫 DescribeZones 介面查詢可用區 ID 和可用區的對應關係。	cn-hangzhou-i
EnableTunnelsBgp	boolean	通道 BGP 的啟用狀態。	true
ResourceGroupId	string	IPsec 連線所屬資源群組 ID。	rg-acfmzs372yg****
TunnelBandwidth	string	用於說明 VPN 單條隧道的頻寬規格，取值：	Standard

樣本

正常返回樣本

JSON格式

{
  "Status": "ike_sa_not_established",
  "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.0.0.0/8",
  "RequestId": "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet": "192.168.0.0/16",
  "CustomerGatewayId": "cgw-bp1mvj4g9kogwwcxk****",
  "Name": "ipsec1",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.34.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.28.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Status": "failed",
    "Dip": "10.0.0.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "192.168.1.1",
    "Enable": "true",
    "Policy": "revoke_route"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.1",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.2",
    "PeerAsn": 65530,
    "LocalAsn": 65531,
    "AuthKey": "AuthKey****"
  },
  "AttachType": "CEN",
  "NetworkType": "public",
  "AttachInstanceId": "cen-lxxpbpalc776qz****",
  "Spec": "1000M",
  "State": "attached",
  "ZoneNo": "cn-hangzhou-h",
  "InternetIp": "47.XX.XX.162",
  "TransitRouterId": "tr-p0we2edef9qr44a85****",
  "TransitRouterName": "nametest",
  "CrossAccountAuthorized": false,
  "Tags": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "TunnelId": "tun-opsqc4d97wni27****",
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": "true",
        "EnableNatTraversal": "true",
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "TunnelIndex": 1,
        "State": "active",
        "Status": "ipsec_sa_established",
        "TunnelBgpConfig": {
          "BgpStatus": "success",
          "LocalAsn": "65530",
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": "65531",
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelIkeConfig": {
          "IkeAuthAlg": "sha1",
          "IkeEncAlg": "aes",
          "IkeLifetime": "86400",
          "IkeMode": "main",
          "IkePfs": "group2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": "86400",
          "IpsecPfs": "group2"
        },
        "ZoneNo": "cn-hangzhou-i"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****",
  "TunnelBandwidth": "Standard"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbbiden.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 是否可被您呼叫。
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	指定的 VPN 連線不存在，請您檢查該 VPN 連線 ID 是否正確。

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

變更歷史

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