接口功能介绍
创建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 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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"
}
响应示例
{
"returnObj":{
"results":[]
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.Vpn.UpdateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
