UpdateIpsecServer - 更新IPsec服務端 - VPN Gateway

調用UpdateIpsecServer介面更新IPsec服務端配置。

介面說明

如果您只修改 IPsec 服務端的 IpsecServerName 資訊時該介面為同步介面，如果您修改了除 IpsecServerName 之外的配置，該介面為非同步介面。
當 UpdateIpsecServer 介面為非同步介面時，系統會先返回一個請求 ID，但該 IPsec 服務端的配置尚未修改成功，系統背景修改任務仍在進行。您可以調用 DescribeVpnGateway 查詢 VPN 閘道執行個體的狀態，來確定 IPsec 服務端配置的修改狀態：
- 當 VPN 閘道執行個體處於 updating 狀態時，表示 IPsec 服務端的配置正在修改中。
- 當 VPN 閘道執行個體處於 active 狀態時，表示 IPsec 服務端的配置修改成功。
UpdateIpsecServer 介面不支援在同一 VPN 閘道下並發修改 IPsec 服務端的配置。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 服務端所屬地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-shanghai
IpsecServerId	string	是	IPsec 服務端 ID。	iss-bp1bo3xuvcxo7ixll****
LocalSubnet	string	否	本端網段，指需要和用戶端網段互連的 VPC 側的網段。多個網段之間用半形逗號（,）分隔，例如：192.168.1.0/24,192.168.2.0/24。	192.168.0.0/24,172.17.0.0/16
ClientIpPool	string	否	用戶端網段，指給用戶端虛擬網卡分配訪問地址的網段。說明用戶端網段不能和 VPC 側網段衝突。	10.0.0.0/24
IpsecServerName	string	否	IPsec 服務端名稱。長度為 1～100 個字元。	test
EffectImmediately	boolean	否	是否刪除當前已協商成功的 IPsec 隧道並重新發起協商。取值： true：配置完成後立即進行協商。 false：當有流量進入時進行協商。	false
IkeConfig	string	否	第一階段協商參數配置。取值： IkeVersion：IKE 協議的版本。取值：ikev1 或 ikev2。 IkeMode：IKE 版本的協商模式。預設值：main。 IkeEncAlg：第一階段協商的密碼編譯演算法。預設值：aes。 IkeAuthAlg：第一階段協商的認證演算法。預設值：sha1。 IkePfs：第一階段協商使用的 Diffie-Hellman 金鑰交換演算法。預設值：group2。 IkeLifetime：第一階段協商出的 SA 的生存周期。單位：秒，取值範圍：0~86400，預設值：86400。 LocalId：IPsec 服務端標識。支援 FQDN 和 IP 位址格式。 RemoteId：對端標識。支援 FQDN 和 IP 位址格式。	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	否	第二階段協商參數配置。取值： IpsecEncAlg：第二階段協商的密碼編譯演算法。預設值：aes。 IpsecAuthAlg：第二階段協商的認證演算法。預設值：sha1。 IpsecPfs：轉寄所有協議的報文。第二階段協商使用的 Diffie-Hellman 金鑰交換演算法。預設值：group2。 IpsecLifetime：第二階段協商出的 SA 的生存周期。單位：秒，取值範圍：0~86400，預設值：86400。	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	否	是否開啟預先共用金鑰認證方式。取值：true，表示開啟預先共用金鑰認證方式。	true
Psk	string	否	預先共用金鑰。用於 IPsec 服務端與用戶端之間的身份認證。密鑰長度為 1~100 個字元。您可以調用 ListIpsecServers 介面查詢系統產生的密鑰資訊。說明 IPsec 服務端的預先共用金鑰需和用戶端的認證密鑰一致，否則 IPsec 服務端和用戶端之間無法建立串連。	Cfd123****
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	e4567-e89b-12d3-a456-42665544****
DryRun	string	否	是否只預檢此次請求，取值： true：只預檢此次請求，不會更改 IPsec 服務端配置。檢查項包括是否填寫了必需參數、請求格式、業務限制等。如果檢查不通過，則返回對應錯誤資訊。如果檢查通過，則返回`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後直接更改 IPsec 服務端配置。	false

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	B61C08E5-403A-46A2-96C1-F7B1216DB10C

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	OperationUnsupported.IpsecPfs	The specified IPsec Pfs is unsupported.	不支援指定的IPsec Pfs
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.	至少有一種認證方法（Psk或者IDaas）應該被指定
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	本端網段(%s)不合法。
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	當開啟雙因子認證時，IDaaS執行個體ID是必填的參數
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	Vpn服務沒有許可權操作您的IDaaS執行個體
400	OperationFailed.AddVpcRoute	It's failed to add VPC route after this operation.
400	ClientIpPool.NetmaskInvalid	The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.	用戶端 IP 池的網路遮罩長度必須大於等於 16 且小於等於 29。
400	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.	指定的用戶端 IP 池與 VPN 串連或 SSL 服務端衝突。
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	當前用戶端網段不可用。
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.	用戶端網段與VPC內其他資源衝突。
400	SystemBusy	The system is busy. Please try again later.
403	Forbidden	User not authorized to operate on the specified resource.	您沒有許可權操作指定資源，請申請許可權後再操作。
404	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	指定的IDaaS執行個體ID不存在
409	OperationConflict	The operation against this instance is too frequent, please try again later.	對該執行個體的操作過於頻繁，請稍後重試。

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

變更歷史

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