全部產品
Search
文件中心

VPN Gateway:UpdateIpsecServer

更新時間:Aug 07, 2026

呼叫 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對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:UpdateIpsecServer

update

*全部資源。

*

請求參數

名稱

類型

必填

描述

樣本值

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 協定的版本。取值:ikev1ikev2

  • 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. EIP 不屬於目前呼叫者,請您檢查該 EIP 是否可被您呼叫。
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. 請求衝突,請稍後重試。

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

變更歷史

更多資訊,參考變更詳情