IPsec連接創建
更新時間 2025-04-03 11:12:03
最近更新時間: 2025-04-03 11:12:03
分享文章
創建IPsec連接。
接口功能介紹
IPsec vpn連接創建
接口約束
支持集群模式資源池。
URI
POST /v4/vpn/ipsec-vpn-connection/create
路徑參數
無
Query參數
無
請求參數
請求header參數
無
請求body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnConnectionName | 是 | String | VPN連接名稱 | ipsec-test | |
| vpnServiceID | 是 | String | VPN實例ID | d333cfba-b0b7-501c-8ae3-89d6aa9c79e0 | |
| ipsecServiceID | 是 | String | VPN用戶服務ID | fef53895-e8ae-471c-a6db-dca7f98dc36d | |
| srcSubnet | 是 | Array of Strings | 本端子網 | ["172.16.1.0/24"] | |
| dstCidr | 是 | Array of Strings | 對端網絡 | ["192.168.1.0/24"] | |
| psk | 是 | String | 預共享密鑰 | ZmZuRkZ2ZV95UmU5OA== | |
| ikeAuthAlgorithm | 是 | String | IKE策略:IKE認證算法,取值范圍為:["sha1","sha256","sha384","sha512"] | sha1 | |
| ikeVersion | 是 | String | IKE策略:IKE版本,取值范圍為:["v1","v2"] | v1 | |
| ikeEncryptionAlgorithm | 是 | String | IKE策略:IKE加密算法,取值范圍為:["aes-128","aes-192","aes-256","3des"] | aes-128 | |
| ikeLifeTime | 是 | Integer | IKE策略:IKE生命周期,單位為秒 | 86400 | |
| ikePfs | 是 | String | IKE策略:DH算法,取值范圍為:["group2","group5","group14"] | group2 | |
| phaseNegotiationMode | 是 | String | IPsec策略:協商模式,取值范圍為:["main","aggressive"] | main | |
| ipsecAuthAlgorithm | 是 | String | IPsec策略:IPsec認證算法,取值范圍為:["sha1","sha256","sha384","sha512"] | sha1 | |
| transformProtocol | 是 | String | IPsec策略:傳輸協議,其取值為"esp" | esp | |
| ipsecEncryptionAlgorithm | 是 | String | IPsec策略:IPsec策略算法,取值范圍為:["aes-128","aes-192","aes-256","3des"] | aes-128 | |
| ipsecLifeTime | 是 | Integer | IPsec策略:IPsec生命周期,單位為秒 | 3600 | |
| ipsecPfs | 是 | String | IPsec策略:PFS,取值范圍為:["group2","group5","group14"] | group2 | |
| selfSign | 是 | Boolean | 是否自簽 | false | |
| localID | 是 | String | 本地識別ID | 100.126.9.128 | |
| remoteID | 是 | String | 遠端識別ID | 122.12.1.1 | |
| policyMode | 否 | Boolean | 路由模式,默認值:true | true | |
| triggerMode | 否 | Boolean | 協商生效模式,默認值為false | false | |
| authType | 否 | String | 認證方式 | pwd | |
| dpdSwitch | 否 | Boolean | dpd開關,默認值:true | true | |
| vpnGatewayID | 否 | String | VPN網關ID | a2a603dc-5f3c-4b5e-92bd-295f90ab96b7 | |
| certID | 否 | String | 證書ID | ||
| selfSigncertID | 否 | String | 自簽證書ID | ||
| srcSubnetType | 否 | String | 本端子網輸入類型 | local_subnet | |
| projectID | 否 | String | 企業項目ID | "0" |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | 否 | String | 業務細分碼,為product.module.code三段式碼 | ||
| message | 否 | String | 失敗時的錯誤描述,一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述,一般為中文描述 | ||
| returnObj | 否 | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 鏈路追蹤ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnConnectionName": "ipsec-test",
"vpnServiceID": "d333cfba-b0b7-501c-8ae3-89d6aa9c79e0",
"ipsecServiceID": "fef53895-e8ae-471c-a6db-dca7f98dc36d",
"srcSubnet": [
"172.16.1.0/24"
],
"dstCidr": [
"192.168.1.0/24"
],
"psk": "ZmZuRkZ2ZV95UmU5OA==",
"localID": "100.126.9.128",
"remoteID": "122.12.1.1",
"vpnGatewayID": "a2a603dc-5f3c-4b5e-92bd-295f90ab96b7",
"selfSign": true,
"ikeAuthAlgorithm": "sha1",
"ikeVersion": "v1",
"ikeEncryptionAlgorithm": "aes-128",
"ikeLifeTime": 86400,
"ikePfs": "group5",
"ipsecAuthAlgorithm": "sha1",
"phaseNegotiationMode": "main",
"transformProtocol": "esp",
"ipsecEncryptionAlgorithm": "aes-128",
"ipsecLifeTime": 3600,
"ipsecPfs": "group5",
"triggerMode": false,
"policyMode": true,
"authType": "pwd",
"dpdSwitch": true,
"srcSubnetType": "local_subnet",
"projectID": "0"
}
響應示例
{
"returnObj": {
"logMark": "903059872913"
},
"errorCode": "",
"message": "success",
"description": "",
"statusCode": 800
}
狀態碼
| 狀態碼 | 含義 |
|---|---|
| 800 | 請求成功 |
| 900 | 請求未成功 |
錯誤碼
| errorCode | 含義 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| Openapi.Vpn.UpdateError | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單 |