接口功能介绍
查询SSL客户端
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/ssl-client/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
get请求包含body参数,报文头指定application/json,且body结构对象需要转json。
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| queryContent | 否 | String | Query Content模糊查询 | ssl001 | |
| projectID | 否 | String | project ID | 0 | |
| vpnServiceID | 否 | String | VPN实例ID | 856fdef8-7e55-50b3-824b-db6ab66e6064 | |
| isOnline | 否 | String | 是否在线 取值范围: false:不在线 true:在线 |
true | |
| pageSize | 否 | Integer | 每页行数 | 1 | |
| pageNo | 否 | Integer | 页码 | 1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800：成功 900：失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| currentCount | 否 | Integer | 当前页记录数 | 2 | |
| logMark | 否 | String | 链路追踪ID | 616797965481 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnServiceID | 否 | String | VPN实例ID | 856fdef8-7e55-50b3-824b-db6ab66e6064 | |
| sslClientName | 否 | String | SSL客户端名称 | ssl-client-f6ee | |
| sslClientID | 否 | String | SSL客户端ID | c81b17f3-2073-4092-95e3-cfd78bf49444 | |
| sslServerID | 否 | String | vpn服务端uuid | 7958302a-c3b8-4ab6-8e7e-de4fea8c8b82 | |
| sslServerName | 否 | String | SSL服务端名称 | ssl-server-f6ee | |
| status | 否 | String | 状态 | normal | |
| isLimitSpeed | 否 | Boolean | 是否限速 取值范围: false:不限速 true:限速 |
false | |
| upBandwidth | 否 | Integer | 上行带宽 | 10 | |
| downBandwidth | 否 | Integer | 下行带宽 | 10 | |
| upBandwidthUnit | 否 | String | 上行带宽单位 | Kbps | |
| downBandwidthUnit | 否 | String | 下行带宽单位 | Kbps | |
| totalBandwidth | 否 | String | ssl网关实例的带宽，单位为Mbps | 100 | |
| certID | 否 | String | 证书ID | d477cf0e-91e5-4688-9893-c1fb8e80962c | |
| isOnline | 否 | Boolean | 是否在线 取值范围: false:不在线 true:在线 |
false | |
| onlineDuration | 否 | Integer | 在线时长 | 10 | |
| createTime | 否 | String | create time | 2023-06-18 13:00:28 |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002"
}
响应示例
{
"returnObj":{
"totalCount":1,
"currentCount":1,
"results":[
{
"status":"normal",
"isOnline":false,
"downBandwidth":null,
"sslClientID":"c81b17f3-2073-4092-95e3-cfd78bf49444",
"totalBandwidth":"100",
"certID":"d477cf0e-91e5-4688-9893-c1fb8e80962c",
"vpnServiceID":"856fdef8-7e55-50b3-824b-db6ab66e6064",
"sslServerName":"ssl-server-f6ee",
"downBandwidthUnit":"k",
"upBandwidth":null,
"sslServerID":"7958302a-c3b8-4ab6-8e7e-de4fea8c8b82",
"onlineDuration":0,
"upBandwidthUnit":"k",
"createTime":"2023-06-18 13:00:28",
"isLimitSpeed":false,
"sslClientName":"ssl-server-f6ee"
}
],
"logMark":"935736636400"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
