ModifyVpnConnectionAttribute - 修改IPsec串連的配置資訊 - VPN Gateway

調用ModifyVpnConnectionAttribute介面修改IPsec串連的配置資訊。

介面說明

如果要修改雙隧道模式的 IPsec-VPN 串連，調用ModifyVpnConnectionAttribute介面時除支援配置必填參數外，還支援配置以下請求參數：

ClientToken、Name、 LocalSubnet、RemoteSubnet、EffectImmediately、AutoConfigRoute、TunnelOptionsSpecification 數組、EnableTunnelsBgp。
如果要修改單隧道模式的 IPsec-VPN 串連，調用ModifyVpnConnectionAttribute介面時除支援配置必填參數外，還支援配置以下請求參數：

ClientToken、Name、LocalSubnet、RemoteSubnet、EffectImmediately、IkeConfig、IpsecConfig、HealthCheckConfig、AutoConfigRoute、EnableDpd、EnableNatTraversal、BgpConfig、RemoteCaCertificate。
ModifyVpnConnectionAttribute 介面屬於非同步介面，即系統返回一個請求 ID，但該 IPsec 串連的配置資訊未修改成功，系統背景修改任務仍在進行。您可以調用 DescribeVpnGateway 查詢 VPN 閘道執行個體狀態，來確定 IPsec 串連的配置資訊的修改狀態：
- 當 VPN 閘道執行個體處於 updating 狀態時，表示 IPsec 串連的配置資訊正在修改中。
- 當 VPN 閘道執行個體處於 active 狀態時，表示 IPsec 串連的配置資訊修改成功。
ModifyVpnConnectionAttribute 介面不支援在同一 VPN 閘道下並發修改 IPsec 串連的配置資訊。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 串連所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-shanghai
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	02fb3da4-130e-11e9-8e44-0016e04115b
VpnConnectionId	string	是	IPsec 串連的 ID。	vco-bp1bbi27hojx80nck****
Name	string	否	IPsec 串連的名稱。長度為 1～100 個字元，不能以`http://`或`https://`開頭。	nametest
LocalSubnet	string	否	需要和本機資料中心互連的 VPC 側的網段，用於第二階段協商。多個網段之間用半形逗號（,）分隔，例如：192.168.1.0/24,192.168.2.0/24。關於 IPsec 連線路由模式的說明：如果 LocalSubnet 和 RemoteSubnet 均輸入為 0.0.0.0/0，則表示您使用目的路由模式。如果 LocalSubnet 和 RemoteSubnet 均輸入具體的網段，則表示您使用感興趣流模式。	10.1.1.0/24,10.1.2.0/24
RemoteSubnet	string	否	本機資料中心側的網段，用於第二階段協商。多個網段之間用半形逗號（,）分隔，例如：192.168.3.0/24,192.168.4.0/24。關於 IPsec 連線路由模式的說明：如果 LocalSubnet 和 RemoteSubnet 均輸入為 0.0.0.0/0，則表示您使用目的路由模式。如果 LocalSubnet 和 RemoteSubnet 均輸入具體的網段，則表示您使用感興趣流模式。	10.2.1.0/24,10.2.2.0/24
EffectImmediately	boolean	否	選擇 IPsec 串連的配置是否立即生效。取值： true：是，配置完成後系統立即進行 IPsec 協議協商。 false：否，當有流量進入時系統才進行 IPsec 協議協商。	false
IkeConfig	string	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。第一階段協商的配置資訊： IkeConfig.Psk：預先共用金鑰，用於 VPN 閘道與本機資料中心之間的身份認證。密鑰長度為 1~100 個字元，支援數字、大小寫英文字母以及右側字元，不能包含空格。~!`@#$%^&()_-+={}[]\|;:',.<>/? 若您未指定預先共用金鑰，系統會隨機產生一個 16 位的字串作為預先共用金鑰。您可以調用 DescribeVpnConnection 介面查詢系統自動產生的預先共用金鑰。說明 IPsec 串連側的預先共用金鑰需和本機資料中心側的認證密鑰一致，否則本機資料中心和 VPN 閘道之間無法建立串連。 IkeConfig.IkeVersion：IKE 協議的版本。取值：ikev1* 或 ikev2。相對於 IKEv1 版本，IKEv2 版本簡化了 SA 的協商過程並且對於多網段的情境提供了更好的支援。 IkeConfig.IkeMode：IKE 版本的協商模式。取值：main 或 aggressive。 main：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。 IkeConfig.IkeEncAlg：第一階段協商的密碼編譯演算法。取值：aes、aes192、aes256、des 或 3des。 IkeConfig.IkeAuthAlg：第一階段協商的認證演算法。取值：md5、sha1、sha256、sha384、sha512。 IkeConfig.IkePfs：第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值：group1、group2、group5、group14。 IkeConfig.IkeLifetime：第一階段協商出的 SA 的生存周期。單位：秒。取值範圍：0~86400。 IkeConfig.LocalId：VPN 閘道的標識。長度限制為 100 個字元，不能包含空格。預設值為 VPN 閘道的 IP 位址。 IkeConfig.RemoteId：使用者網關的標識。長度限制為 100 個字元，不能包含空格。預設值為使用者網關的 IP 位址。	{"Psk":"pgw6dy7d1i8i****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"116.64.XX.XX","RemoteId":"139.18.XX.XX"}
IpsecConfig	string	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。第二階段協商的配置資訊： IpsecConfig.IpsecEncAlg：第二階段協商的密碼編譯演算法。取值：aes、aes192、aes256、des 或 3des。 IpsecConfig. IpsecAuthAlg：第二階段協商的認證演算法。取值：md5、sha1、sha256、sha384、sha512。 IpsecConfig. IpsecPfs：轉寄所有協議的報文，第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值：disabled、group1、group2、group5、group14。 IpsecConfig. IpsecLifetime：第二階段協商出的 SA 的生存周期。單位：秒。取值範圍：0~86400。	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
HealthCheckConfig	string	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。健全狀態檢查配置資訊： HealthCheckConfig.enable：是否開啟健全狀態檢查。取值：true 或 false。 HealthCheckConfig.dip：健全狀態檢查的目的 IP 位址。 HealthCheckConfig.sip：健全狀態檢查的源 IP 位址。 HealthCheckConfig.interval：健全狀態檢查的稍候再試時間，單位：秒。 HealthCheckConfig.retry：健全狀態檢查的重試發包次數。	{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3"}
AutoConfigRoute	boolean	否	是否自動發布路由。取值： true：自動發布。 false：不自動發布。	true
EnableDpd	boolean	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。是否開啟 DPD（對等體存活檢測）功能。取值： true：開啟 DPD 功能。IPsec 發起端會發送 DPD 報文用來檢測對端的裝置是否存活，如果在設定時間內未收到正確回應則認為對端已經斷線，IPsec 將刪除 ISAKMP SA 和相應的 IPsec SA，安全隧道同樣也會被刪除。 false：不開啟 DPD 功能，IPsec 發起端不會發送 DPD 探測報文。	true
EnableNatTraversal	boolean	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。是否開啟 NAT 穿越功能。取值： true：開啟 NAT 穿越功能。開啟後，IKE 協商過程會刪除對 UDP 連接埠號碼的驗證過程，同時實現對 VPN 隧道中 NAT Gateway裝置的發現功能。 false：不開啟 NAT 穿越功能。	true
BgpConfig	string	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。 BGP 的配置資訊： BgpConfig.EnableBgp：是否開啟 BGP 功能。取值：true 或 false。 BgpConfig.LocalAsn：阿里雲側的自治系統號。自治系統號取值範圍：1~4294967295。支援按照兩段位的格式進行輸入，即：前 16 位位元.後 16 位位元。每個段位使用十進位輸入。例如輸入 123.456，則表示自治系統號：12365536+456=8061384。 BgpConfig.TunnelCidr：IPsec 隧道網段。該網段需是一個在 169.254.0.0/16 內的掩碼長度為 30 的網段，且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。說明一個 VPN 閘道執行個體下每個 IPsec 串連的 IPsec 隧道網段需保持唯一。 LocalBgpIp*：阿里雲側的 BGP 地址。該地址為 IPsec 隧道網段內的一個 IP 位址。說明當您的 VPN 閘道啟用 BGP 動態路由功能時需要配置該參數。在添加 BGP 配置前，建議您先瞭解 BGP 動態路由功能的工作機制和使用限制。更多資訊，請參見配置 BGP 動態路由。建議您使用自治系統號的私人號碼與阿里雲建立 BGP 串連。自治系統號的私人號碼範圍請自行查閱文檔。	{"EnableBgp":"true","LocalAsn":"65530","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}
RemoteCaCertificate	string	否	修改單隧道模式的 IPsec-VPN 串連時支援配置該參數。如果當前 VPN 閘道執行個體為國密型 VPN 閘道，您可以修改對端的 CA 憑證。如果當前 VPN 閘道執行個體為普通型 VPN 閘道，不支援配置本參數。	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelOptionsSpecification	array<object>	否	修改隧道的配置。僅修改雙隧道模式的 IPsec-VPN 串連時支援配置 TunnelOptionsSpecification 數組下的參數。您可以同時修改 IPsec-VPN 串連主隧道和備隧道的配置。
	array<object>	否	修改隧道配置。
TunnelId	string	否	隧道 ID。	tun-opsqc4d97wni27****
CustomerGatewayId	string	否	隧道關聯的使用者網關執行個體 ID。	cgw-1nmwbpgrp7ssqm1yn****
Role	string	否	隧道的角色。 master：表示當前隧道為主隧道。 slave：表示當前隧道為備隧道。	master
EnableDpd	boolean	否	是否為隧道開啟 DPD（對等體存活檢測）功能。取值： true：開啟 DPD 功能。IPsec 發起端會發送 DPD 報文用來檢測對端的裝置是否存活，如果在設定時間內未收到正確回應則認為對端已經斷線，IPsec 將刪除 ISAKMP SA 和相應的 IPsec SA，安全隧道同樣也會被刪除。 false：不開啟 DPD 功能，IPsec 發起端不會發送 DPD 探測報文。	true
EnableNatTraversal	boolean	否	是否為隧道開啟 NAT 穿越功能。取值： true：開啟 NAT 穿越功能。開啟後，IKE 協商過程會刪除對 UDP 連接埠號碼的驗證過程，同時實現對 VPN 隧道中 NAT Gateway裝置的發現功能。 false：不開啟 NAT 穿越功能。	true
RemoteCaCertificate	string	否	如果當前 VPN 閘道執行個體為國密型 VPN 閘道，您可以隧道修改對端的 CA 憑證。如果當前 VPN 閘道執行個體為普通型 VPN 閘道，不支援配置本參數。	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelBgpConfig	object	否	修改隧道的 BGP 配置。
LocalAsn	integer	否	隧道本端（阿里雲側）的自治系統號。自治系統號取值範圍：1~4294967295。預設值：45104。說明當您為 IPsec 串連開啟 BGP 功能後（即指定 EnableTunnelsBgp 參數的值為 true）支援配置或修改本參數。在添加 BGP 配置前，建議您先瞭解 BGP 動態路由功能的工作機制和使用限制。更多資訊，請參見配置 BGP 動態路由。建議您使用自治系統號的私人號碼與阿里雲建立 BGP 串連。自治系統號的私人號碼範圍請自行查閱文檔。	65530
LocalBgpIp	string	否	隧道本端（阿里雲側）的 BGP 地址。該地址為 BGP 網段內的一個 IP 位址。	169.254.10.1
TunnelCidr	string	否	隧道的 BGP 網段。該網段需是一個在 169.254.0.0/16 內的掩碼長度為 30 的網段，且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。說明在一個 VPN 閘道執行個體下，每個隧道的 BGP 網段需保持唯一。	169.254.10.0/30
TunnelIkeConfig	object	否	第一階段協商的配置資訊。
IkeAuthAlg	string	否	第一階段協商的認證演算法。取值：md5、sha1、sha256、sha384、sha512。	md5
IkeEncAlg	string	否	第一階段協商的密碼編譯演算法。取值：aes、aes192、aes256、des 或 3des。	aes
IkeLifetime	integer	否	第一階段協商出的 SA 的生存周期。單位：秒。取值範圍：0~86400。	86400
IkeMode	string	否	IKE 版本的協商模式。取值： main：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。	main
IkePfs	string	否	第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值：group1、group2、group5、group14。	group2
IkeVersion	string	否	IKE 協議的版本。取值：ikev1 或 ikev2。相對於 IKEv1 版本，IKEv2 版本簡化了 SA 的協商過程並且對於多網段的情境提供了更好的支援。	ikev1
LocalId	string	否	隧道本端（阿里雲側）的標識，用於第一階段的協商。長度限制為 100 個字元，不能包含空格。預設值為隧道的 IP 位址。 LocalId 支援 FQDN 格式，如果您使用 FQDN 格式，協商模式建議選擇為 aggressive（野蠻模式）。	47.21.XX.XX
Psk	string	否	預先共用金鑰，用於隧道與隧道對端之間的身份認證。密鑰長度為 1~100 個字元，支援數字、大小寫英文字母以及右側字元，不能包含空格。~!\`@#$%^&*()_-+={}[]\|;:',.<>/? 若您未指定預先共用金鑰，系統會隨機產生一個 16 位的字串作為預先共用金鑰。您可以調用 DescribeVpnConnection 介面查詢系統自動產生的預先共用金鑰。說明隧道及隧道對端的預先共用金鑰需一致，否則系統無法正常建立隧道。	123456****
RemoteId	string	否	隧道對端的標識，用於第一階段的協商。長度限制為 100 個字元，不能包含空格。預設值為隧道關聯的使用者網關的 IP 位址。 RemoteId 支援 FQDN 格式，如果您使用 FQDN 格式，協商模式建議選擇為 aggressive（野蠻模式）。	47.42.XX.XX
TunnelIpsecConfig	object	否	第二階段協商的配置資訊。
IpsecAuthAlg	string	否	第二階段協商的認證演算法。取值：md5、sha1、sha256、sha384、sha512。	md5
IpsecEncAlg	string	否	第二階段協商的密碼編譯演算法。取值：aes、aes192、aes256、des 或 3des。	aes
IpsecLifetime	integer	否	第二階段協商出的 SA 的生存周期。單位：秒。取值範圍：0~86400。	86400
IpsecPfs	string	否	第二階段協商使用的 Diffie-Hellman 金鑰交換演算法。取值：disabled、group1、group2、group5、group14。	group2
EnableTunnelsBgp	boolean	否	修改雙隧道模式的 IPsec-VPN 串連時支援配置該參數。是否為隧道開啟 BGP 功能。取值：true 或 false。	true

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
EnableNatTraversal	boolean	IPsec 串連是否已開啟 NAT 穿越功能。取值： false：未開啟。 true：已開啟。僅單隧道模式的 IPsec-VPN 串連會返回該參數。	true
CreateTime	integer	IPsec 串連的建立時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 IPsec 串連時的總時間長度。	1492753817000
EffectImmediately	boolean	IPsec 串連的配置是否立即生效。 true：是，配置完成後系統立即進行 IPsec 協議協商。 false：否，當有流量進入時系統才進行 IPsec 協議協商。	false
VpnGatewayId	string	VPN 閘道執行個體的 ID。	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	VPC 側的網段。	10.1.1.0/24,10.1.2.0/24
RequestId	string	請求 ID。	7DB79D0C-5F27-4AB5-995B-79BE55102F90
VpnConnectionId	string	IPsec 串連的 ID。	vco-bp1bbi27hojx80nck****
Description	string	IPsec 串連的描述資訊。	description
RemoteSubnet	string	本機資料中心側的網段。	10.2.1.0/24,10.2.2.0/24
CustomerGatewayId	string	IPsec 串連關聯的使用者網關 ID。僅單隧道模式的 IPsec-VPN 串連會返回該參數。	cgw-p0w2jemrcj5u61un8****
Name	string	IPsec 串連的名稱。	nametest
EnableDpd	boolean	IPsec 串連是否已開啟 DPD（對等體存活檢測）功能。 false：未開啟。 true：已開啟。僅單隧道模式的 IPsec-VPN 串連會返回該參數。	true
IkeConfig	object	第一階段協商的配置。僅單隧道模式的 IPsec-VPN 串連會返回 IkeConfig 數組下的參數。
RemoteId	string	本機資料中心側的標識。支援 FQDN 和 IP 格式，預設為當前選取的使用者網關的 IP 位址。	139.18.XX.XX
IkeLifetime	integer	IKE 階段存留時間。單位：秒。	86400
IkeEncAlg	string	IKE 階段密碼編譯演算法。	aes
LocalId	string	VPC 側的標識。支援 FQDN 和 IP 格式，預設為當前選取的 VPN 閘道的 IP 位址。	116.64.XX.XX
IkeMode	string	IKE 協商模式。 main：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。	main
IkeVersion	string	IKE 協議版本。 ikev1 ikev2 相對於 IKEv1 版本，IKEv2 版本簡化了 SA 的協商過程並且對於多網段的情境提供了更好的支援。	ikev1
IkePfs	string	IKE 階段 DH 分組。	group2
Psk	string	預先共用金鑰。	pgw6dy7d1i8i****
IkeAuthAlg	string	IKE 階段認證演算法。	sha1
IpsecConfig	object	第二階段協商的配置。僅單隧道模式的 IPsec-VPN 串連會返回 IpsecConfig 數組下的參數。
IpsecAuthAlg	string	IPsec 階段認證演算法。	sha1
IpsecLifetime	integer	IPsec 階段存留時間。單位：秒。	86400
IpsecEncAlg	string	IPsec 階段密碼編譯演算法。	aes
IpsecPfs	string	IPsec 階段 DH 分組。	group2
VcoHealthCheck	object	健全狀態檢查配置。僅單隧道模式的 IPsec-VPN 串連會返回 VcoHealthCheck 數組下的參數。
Dip	string	目標 IP。	192.168.1.1
Interval	integer	健全狀態檢查的稍候再試時間，單位：秒。	3
Retry	integer	健全狀態檢查的重試發包次數。	3
Sip	string	源 IP。	10.1.1.1
Enable	string	IPsec 串連是否已開啟健全狀態檢查功能。 true：已開啟。 false：未開啟。	true
VpnBgpConfig	object	BGP 配置資訊。僅單隧道模式的 IPsec-VPN 串連會返回 VpnBgpConfig 數組下的參數。
Status	string	BGP 的協商狀態。 success：正常。 false：異常。	success
PeerBgpIp	string	本地 IDC 側的 BGP 地址。	169.254.11.2
TunnelCidr	string	IPsec 串連的 BGP 網段。	169.254.11.0/30
EnableBgp	string	BGP 的開啟狀態。 true：已開啟。 false：未開啟。	true
LocalBgpIp	string	阿里雲側的 BGP 地址。	169.254.11.1
PeerAsn	integer	本機資料中心側的自治系統號。	65531
LocalAsn	integer	阿里雲側的自治系統號。	65530
TunnelOptionsSpecification	object
TunnelOptions	array<object>	IPsec 串連的隧道配置資訊。僅雙隧道模式的 IPsec-VPN 串連會返回 TunnelOptionsSpecification 數組下的參數。
	array<object>	隧道的配置資訊。
CustomerGatewayId	string	隧道關聯的使用者網關 ID。	cgw-p0wy363lucf1uyae8****
EnableDpd	boolean	隧道是否已開啟 DPD（對等體存活檢測）功能。 false：未開啟。 true：已開啟。	true
EnableNatTraversal	boolean	隧道是否已開啟 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
State	string	隧道的狀態。 active：狀態正常。 updating：更新中。 deleting：刪除中。	active
TunnelBgpConfig	object	隧道的 BGP 配置資訊。
LocalAsn	integer	隧道本端（阿里雲側）的自治系統號。	65530
LocalBgpIp	string	隧道本端（阿里雲側）的 BGP 地址。	169.254.10.1
PeerAsn	integer	隧道對端的自治系統號。	65531
PeerBgpIp	string	隧道對端的 BGP 地址。	169.254.10.2
TunnelCidr	string	隧道的 BGP 網段。	169.254.10.0/30
TunnelId	string	隧道 ID。	tun-opsqc4d97wni27****
TunnelIkeConfig	object	第一階段協商的配置。
IkeAuthAlg	string	IKE 階段認證演算法。	sha1
IkeEncAlg	string	IKE 階段密碼編譯演算法。	aes
IkeLifetime	integer	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	integer	IPsec 階段存留時間。單位：秒。	86400
IpsecPfs	string	IPsec 階段 DH 分組。	group2
ZoneNo	string	隧道部署的可用性區域。	ap-southeast-5a
EnableTunnelsBgp	boolean	隧道 BGP 的開啟狀態。 true：已開啟。 false：未開啟。僅雙隧道模式的 IPsec-VPN 串連會返回該參數。	true
ResourceGroupId	string	IPsec 串連所屬的資源群組 ID。 IPsec 串連與其關聯的 VPN 閘道執行個體的資源群組相同。您可以調用 ListResourceGroups 介面查詢資源群組資訊。	rg-acfmzs372yg****

樣本

正常返回樣本

JSON格式

{
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": false,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.1.1.0/24,10.1.2.0/24",
  "RequestId": "7DB79D0C-5F27-4AB5-995B-79BE55102F90",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "Description": "description",
  "RemoteSubnet": "10.2.1.0/24,10.2.2.0/24",
  "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
  "Name": "nametest",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.18.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.64.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy7d1i8i****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Dip": "192.168.1.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "10.1.1.1",
    "Enable": "true"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "LocalAsn": 65530
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": true,
        "EnableNatTraversal": true,
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "State": "active",
        "TunnelBgpConfig": {
          "LocalAsn": 65530,
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": 65531,
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelId": "tun-opsqc4d97wni27****",
        "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": "ap-southeast-5a"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	InvalidName	The name is not valid
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	該路由已存在。
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	路由條目存在衝突。
400	NotSupportVpnConnectionParameter.IpsecPfs	The specified vpn connection ipsec Ipsec Pfs is not support.	IPsec串連中指定的Pfs參數不支援
400	NotSupportVpnConnectionParameter.IpsecAuthAlg	The specified vpn connection ipsec Auth Alg is not support.	IPsec串連中指定的認證演算法不支援
400	VpnRouteEntry.ConflictSSL	The specified route entry has conflict with SSL client.	路由條目與SSL用戶端衝突。
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	主備路由條目校正失敗。
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	路由權重值不合法
400	QuotaExceeded.PBR	The policy-based routes has reached the upper limit.	建立的策略路由條數已達上限
400	OperationUnsupported.SetDPD	Current version of the VPN does not support setting DPD.	當前VPN網關版本不支援DPD功能。
400	OperationUnsupported.SetNatTraversal	Current version of the VPN does not support setting NAT traversal.	當前VPN網關版本不支援NAT穿越功能。
400	QuotaExceeded.PolicyBasedRoute	The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s.	策略路由條數已達上限，當前已有%s條，本次將建立%s條，上限為%s條。
400	MissingParameter.TunnelCidr	The parameter TunnelCidr is mandatory when BGP is enabled.	開啟BGP時，隧道CIDR參數是必填項
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	目前的版本的VPN不支援開啟BGP
400	MissingParam.CustomerGatewayAsn	Asn of customer gateway is mandatory when BGP is enabled.	開啟BGP時，客戶網關的自治系統號不可以為空白。
400	IllegalParam.LocalAsn	The specified LocalAsn is invalid.	本端自治系統號不合法。
400	IllegalParam.BgpConfig	The specified BgpConfig is invalid.	指定的BGP配置不合法
400	IllegalParam.EnableBgp	VPN connection must enable BGP when VPN gateway has enabled BGP.	當 VPN 閘道啟用 BGP 時，VPN 串連必須啟用 BGP。
400	IllegalParam.TunnelCidr	The specified TunnelCidr is invalid.	參數TunnelCidr不合法。
400	InvalidLocalBgpIp.Malformed	The specified LocalBgpIp is malformed.	指定的本端BGP的IP異常
400	IllegalParam.LocalBgpIp	The specified LocalBgpIp is invalid.	本端BGP地址不合法。
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	本端網段(%s)不合法。
400	IllegalParam.RemoteSubnet	The specified "RemoteSubnet" (%s) is invalid.	對端網段(%s)不合法。
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	當VPN網關所屬VPC加入到的雲企業網且開啟了路由同步時，VPN網關不能開啟BGP。
400	InvalidTunnelCidr.Malformed	The specified TunnelCidr is malformed.	指定的隧道CIDR異常
400	CustomerGateway.ConflictRouteEntry	The specified customer gateway has conflict with route entry.	目前使用者網關和路由存在衝突。
400	VpnTask.CONFLICT	Vpn task has conflict.	Vpn操作存在衝突，請稍後重試。
400	OperationFailed.RouteConflictWithIPsecServer	Operation failed because the route to create conflicts with the client IP pool of the IPsec server.	路由的目標網段和IPsec服務端的用戶端網段衝突。
400	IllegalParam.TunnelId	The specified TunnelId is invalid.	TunnelId參數非法。
400	IllegalParam.Role	The specified Role is invalid.	Role參數不合法。
400	VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs	IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration.	檢測到多個IPsec串連關聯了相同的VPN網關和使用者網關，多個IPsec串連的預先共用金鑰和IKE階段的配置參數需保持相同。
400	VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap	Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap.	檢測到多個IPsec串連關聯了相同的VPN網關和使用者網關，多個IPsec串連的感興趣流網段不能重疊。
400	ModifyIkeV1WithMultiRoutes.Invalid	Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.	修改VPN串連參數失敗，在使用IkeV1協議的同時配置了多網端。
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	當前的執行個體狀態不支援該操作
400	IkeVersionInvalid.GcmIncompatible	Ikev1 does not support IkeEncAlg of gcm16.	Ikev1不支援IKE密碼編譯演算法僅配置gcm16演算法。
400	EncAlgInvalid.DesIncompatible	Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.	Ike密碼編譯演算法以及IPsec密碼編譯演算法中，des/3des不支援多演算法相容。
400	CustomerGateway.ConflictVpnIp	The specified customer gateway has conflict with vpn gateway ip.	使用者網關的ip與VPN網關ip衝突。
500	OperationFailed.RouteConflictWithIPsecServer	Operation failed because the specified route conflicts with IPsec server.	路由配置與IPsec服務端衝突。
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是否正確。

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

變更歷史

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