DescribeVpnConnection - 查詢已建立的IPsec串連的詳細資料 - VPN Gateway

調用DescribeVpnConnection介面查詢指定的IPsec串連的資訊。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 串連所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 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 Gateway裝置的發現功能。	true
CreateTime	integer	建立 IPsec 串連的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 IPsec 串連時的總時間長度。	1492753817000
EffectImmediately	boolean	IPsec 串連的配置是否立即生效。 true：是，配置變更完成後觸發重連。 false：否，有流量時觸發重連。	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：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。	main
IkeVersion	string	IKE 協議版本。 ikev1 ikev2 相對於 IKEv1 版本，IKEv2 版本簡化了 SA 的協商過程並且對於多網段的情境提供了更好的支援。	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：異常。 success：正常。	failed
Dip	string	目標 IP 位址。	10.0.0.1
Interval	integer	健全狀態檢查的稍候再試時間，單位：秒。	3
Retry	integer	健全狀態檢查的重試發包次數。	3
Sip	string	源 IP 位址。	192.168.1.1
Enable	string	IPsec 串連是否已開啟健全狀態檢查。 false：未開啟。 true：已開啟。	true
Policy	string	健全狀態檢查失敗時是否撤銷發行的路由。 revoke_route：撤銷路由。 reserve_route：不撤銷路由。	revoke_route
VpnBgpConfig	object	IPsec 串連 BGP 路由協議的配置資訊。
Status	string	BGP 路由協議的協商狀態。 success：正常。 failed：異常。	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：已開啟。 false：未開啟。	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。您可以調用 DescribeZones 介面查詢可用性區域 ID 和可用性區域的對應關係。	cn-hangzhou-h
InternetIp	string	IPsec 串連的網關 IP 位址。	47.XX.XX.162
TransitRouterId	string	IPsec 串連綁定的轉寄路由器執行個體 ID。	tr-p0we2edef9qr44a85****
TransitRouterName	string	轉寄路由器執行個體的名稱。	nametest
CrossAccountAuthorized	boolean	IPsec 串連是否綁定了跨帳號的轉寄路由器執行個體。 true：是。 false：否。	false
Tags	object
Tag	array<object>	IPsec 串連綁定的標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
TunnelOptionsSpecification	object
TunnelOptions	array<object>	IPsec 串連的隧道配置資訊。僅查詢雙隧道模式的 IPsec 串連會返回 TunnelOptionsSpecification 數組下的參數。
	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：已開啟。 false：未開啟。	true
ResourceGroupId	string	IPsec 串連所屬資源群組 ID。您可以調用 ListResourceGroups 介面查詢資源群組資訊。	rg-acfmzs372yg****
TunnelBandwidth	string	用於說明 VPN 單條隧道的頻寬規格，取值： Standard（預設值）：標準型，預設頻寬 1Gbps Large（大型）：大型，預設頻寬 3Gbps	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.	您沒有許可權操作指定資源，請申請許可權後再操作。
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	指定的VPN串連不存在，請您檢查該VPN串連ID是否正確。

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

變更歷史

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