調用CreateIpsecServer接口創建IPsec服務端。
接口說明
- 創建 IPsec 服務端前，您需要先創建 VPN 網關并確保已開啟 VPN 網關的 SSL-VPN 功能。具體操作，請參見 CreateVpnGateway 。
- 創建 IPsec 服務端前，需確保 VPN 網關實例下不存在 IPsec 連接。具體操作，請參見 DeleteVpnConnection 。
- CreateIpsecServer 接口屬于異步接口，即系統先返回一個實例 ID，但該 IPsec 服務端尚未創建成功，系統后臺的創建任務仍在進行。您可以調用 DescribeVpnGateway 查詢 VPN 網關實例的狀態，來確定 IPsec 服務端的創建狀態：
- 當 VPN 網關實例處于 updating 狀態時，表示 IPsec 服務端正在創建中。
- 當 VPN 網關實例處于 active 狀態時，表示 IPsec 服務端創建成功。
- CreateIpsecServer 接口不支持在同一 VPN 網關下并發創建 IPsec 服務端。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateIpsecServer | create | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網關所屬地域 ID。 | cn-hangzhou |
| VpnGatewayId | string | 是 | VPN 網關實例 ID。 | vpn-bp17lofy9fd0dnvzv**** |
| LocalSubnet | string | 是 | 本端網段，指需要和客戶端網段互連的 VPC 側的網段。 多個網段之間用半角逗號（,）分隔，例如：192.168.1.0/24,192.168.2.0/24。 | 192.168.0.0/24 |
| ClientIpPool | string | 是 | 客戶端網段，指給客戶端虛擬網卡分配訪問地址的地址段。 說明
客戶端網段不能和 VPC 側網段沖突。
| 10.0.0.0/24 |
| IpSecServerName | string | 否 | IPsec 服務端名稱。 名稱長度為 1～100 個字符。 | test |
| EffectImmediately | boolean | 否 | 配置是否立即生效。取值：
| true |
| IkeConfig | string | 否 | 第一階段協商參數配置。取值：
| {"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400} |
| IpsecConfig | string | 否 | 第二階段協商參數配置。取值：
| {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
| PskEnabled | boolean | 否 | 是否開啟預共享密鑰認證方式。取值：true，表示開啟預共享密鑰認證方式。 說明
本參數必填。
| true |
| Psk | string | 否 | 預共享密鑰。 用于 IPsec 服務端與客戶端之間的身份認證。密鑰長度為 1~100 個字符。 若您未指定預共享密鑰，系統會隨機生成一個 16 位的字符串作為預共享密鑰。您可以調用 ListIpsecServers 接口查詢系統生成的密鑰信息。 說明
IPsec 服務端的預共享密鑰需和客戶端的認證密鑰一致，否則 IPsec 服務端和客戶端之間無法建立連接。
| Cfd123**** |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| d7d24a21-f4ba-4454-9173-b38**** |
| DryRun | string | 否 | 是否只預檢此次請求，取值：
| false |
返回參數
示例
正常返回示例
JSON格式
{
"CreationTime": "2021-02-22T03:24:28Z",
"IpsecServerId": "iss-bp1jougp8cfsbo8y9****",
"RequestId": "690A967E-D4CD-4B69-8C78-94FE828BA10B",
"IpsecServerName": "test",
"VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
"RegionId": "cn-hangzhou"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | OperationUnsupported.IPsecServer | The current version of the VPN gateway does not support IPsec server. | 當前VPN網關版本不支持IPsec服務端。 |
| 400 | VpnGateway.SslVpnDisabled | The VPN gateway has not enabled SSL VPN. | VPN網關沒有開啟SSL VPN功能。 |
| 400 | VpnGateway.Configuring | The specified service is configuring. | 服務正在配置中，請您稍后再試。 |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | 該服務已欠費，請您先充值再操作。 |
| 400 | OperationFailed.IPsecServerExist | An IPsec server already exists in the VPN gateway. | VPN網關中已經存在一個IPsec服務端。 |
| 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. | 客戶端網段（%s）不合法。 |
| 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 | 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 | OperationFailed.AddVpcRoute | It is failed to add VPC route after this operation. | 此操作后添加 VPC 路由失敗。 |
| 400 | QuotaExceeded.VpnRouteEntry | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. | VPC路由表中指向VPN網關的路由條目已經達到配額限制。 |
| 400 | SystemBusy | The system is busy. Please try again later. | 當前系統繁忙，請稍后重試。 |
| 400 | EnableHaCheck.IpsecServerCidrContainsVpcRouteDest | Ipsec server client cidr contains vpc route prefix. The vpc route prefix is %s. | vpc路由表中存在路由的前綴%s被包含在ipsec server 客戶端 cidr 中。 |
| 400 | VpnGateway.IPsecServerAndVpnConnectionConflict | The IPSec connection and IPSec server cannot be configured on the same VPN gateway at the same time. | 一個VPN網關不支持同時配置IPSec服務端與IPSec連接。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源，請申請權限后再操作。 |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 網關不存在，請您檢查 VPN 網關是否正確。 |
| 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. | 對該實例的操作過于頻繁，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |