查詢SSL客戶端
更新時間 2025-04-03 11:20:23
最近更新時間: 2025-04-03 11:20:23
分享文章
查詢SSL客戶端。
接口功能介紹
查詢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 | |
| projectID | 否 | String | 企業項目ID | "0" |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 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 | |
| projectID | 否 | String | 企業項目ID | "0" |
請求示例
請求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",
"projectID": "0"
}
],
"logMark":"935736636400"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
