創建SSL服務端
更新時間 2025-04-03 11:19:21
最近更新時間: 2025-04-03 11:19:21
分享文章
創建SSL服務端。
接口功能介紹
創建SSL服務端
接口約束
支持集群模式資源池。
URI
POST /v4/vpn/ssl-server/create
路徑參數
無
Query參數
無
請求參數
請求header參數
無
請求body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnServiceID | 是 | String | VPN實例ID | e867f3d3-a64f-5cf1-b0a9-35c236cdb4a2 | |
| localSubnets | 是 | String | 本端子網，如有多個子網由逗號分隔 | 192.168.0.0/24 | |
| ipPoolSubnet | 是 | String | 客戶端地址池 | 192.168.13.0 | |
| ipPoolMask | 是 | String | 客戶端地址池掩碼長度，取值范圍為16-29 | 24 | |
| sslServerName | 是 | String | SSL服務端名稱 | ssl-server-f6ee | |
| sslPort | 是 | String | 端口號,取值范圍為:1024-4499,4501-49151 | 1194 | |
| enableDNS | 否 | Boolean | 是否開啟DNS 取值范圍: false:不開啟 true:開啟 |
false | |
| sslProtocol | 否 | String | SSL協議，只能填入tcp | tcp | |
| enableUDP | 否 | Boolean | 是否開啟UDP, 取值范圍: false:不開啟 true:開啟 默認為false |
false | |
| vpnGatewayID | 否 | String | vpn網關ID | 16cc1d81-0a8d-426b-b674-a266d6c4c764 | |
| dns | 否 | String | DNS地址,當enableDNS取值為false時,不傳入dns參數 | 114.114.114.114 | |
| twoFactorVerify | 否 | Boolean | 是否開啟雙因子認證 取值范圍: false:不開啟 true:開啟 |
false | |
| projectID | 否 | String | 企業項目ID | "0" |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼 取值范圍: 800：成功 900：失敗 |
800 | |
| errorCode | 否 | String | 業務細分碼，為product.module.code三段式碼 | ||
| message | 否 | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | 否 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 鏈路追蹤ID | 616797965481 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"vpnServiceID":"e867f3d3-a64f-5cf1-b0a9-35c236cdb4a2",
"localSubnets": "192.168.0.0/24",
"ipPoolSubnet": "192.168.13.0",
"ipPoolMask": "24",
"sslServerName":"ssl-server-f6ee",
"sslPort":"1194",
"enableDns": false,
"enableUDP": false,
"sslProtocol": "tcp",
"vpnGatewayID": "16cc1d81-0a8d-426b-b674-a266d6c4c764",
"projectID": "0"
}
響應示例
{
"returnObj":{
"results":[]
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| Openapi.Vpn.UpdateError | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單 |
