接口功能介绍
创建SSL客户端
接口约束
支持集群模式资源池。
URI
POST /v4/vpn/ssl-client/create
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnServiceID | 是 | String | VPN实例ID | 856fdef8-7e55-50b3-824b-db6ab66e6064 | |
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| sslClientName | 是 | String | SSL客户端名称 | ssl-client-f6ee | |
| sslServerID | 是 | String | vpn服务端uuid | e867f3d3-a64f-5cf1-b0a9-35c236cdb4a2 | |
| sslServerName | 是 | String | SSL服务端名称 | ssl-server-f6ee | |
| upBandwidth | 否 | Integer | 上行带宽,单位为Kbps或Mbps | 10 | |
| downBandwidth | 否 | Integer | 下行带宽,单位为Kbps或Mbps | 10 | |
| isOnline | 否 | Boolean | 是否在线 取值范围: false:不在线 true:在线 |
true | |
| isLimitSpeed | 否 | Boolean | 是否限速 取值范围: false:不限速 true:限速 |
true | |
| vpnGatewayID | 否 | String | vpn网关ID | 16cc1d81-0a8d-426b-b674-a266d6c4c764 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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",
"sslServerID": "7958302a-c3b8-4ab6-8e7e-de4fea8c8b82",
"vpnServiceID": "856fdef8-7e55-50b3-824b-db6ab66e6064",
"sslServerName": "ssl-server-f6ee",
"sslClientName": "ssl-client-11111",
"isLimitSpeed": true,
"upBandwidth": 11,
"downBandwidth":12,
"isOnline": false,
"vpnGatewayID":"a170c348-2a0f-4191-9060-b8e2d30deb01"
}
响应示例
{
"returnObj":{
"logMark":"901890973174"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
