呼叫 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程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| CreationTime |
string |
IPsec 伺服器端建立時間。 T 表示分隔符號，Z 表示的是 UTC，即世界標準時間。 |
2021-02-22T03:24:28Z |
| IpsecServerId |
string |
IPsec 伺服器端 ID。 |
iss-bp1jougp8cfsbo8y9**** |
| RequestId |
string |
請求 ID。 |
690A967E-D4CD-4B69-8C78-94FE828BA10B |
| IpsecServerName |
string |
IPsec 伺服器端名稱。 |
test |
| VpnGatewayId |
string |
VPN 閘道器執行個體 ID。 |
vpn-bp17lofy9fd0dnvzv**** |
| RegionId |
string |
VPN 閘道器所屬地域 ID。 |
cn-hangzhou |
樣本
正常返回樣本
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. | 建立路由項目失敗，因為 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 連線。 |
| 400 | EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDest | Ssl vpn client cidr contains vpc route prefix. The vpc route prefix is %s. | VPC 路由表中存在路由的前綴 %s 被包含在 SSL VPN 用戶端 CIDR 中。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | EIP 不屬於目前呼叫者，請您檢查該 EIP 是否可被您呼叫。 |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id 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. | 請求衝突，請稍後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。