服務器列表
更新時間 2025-07-09 15:31:44
最近更新時間: 2025-07-09 15:31:44
分享文章
接口功能介紹
展示同步資產的數據。
接口約束
防護狀態與agent狀態相關，Agent狀態：在線；防護狀態： 防護中|已關閉； Agent狀態：離線|錯誤；防護狀態：已離線；Agent狀態：未激活；防護狀態：未防護
URI
POST /v1/host/all
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 請求地址類型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 當前頁 | 1 | |
| pageSize | 是 | Integer | 每頁條數 | 10 | |
| guardType | 否 | Integer | 防護狀態：1：防護中，2：已關閉，3：已離線，4：未防護, 0或者不傳代表全部防護狀態 | 1 | |
| riskLevel | 否 | Integer | 風險級別：1：安全，2：未知，3：風險，0或者不傳代表風險級別 | 1 | |
| paramType | 否 | Integer | 1. 服務器名稱；2.服務器ip;5-agentGuid;只需要是正整數即可。 | 1 | |
| param | 否 | String | 具體搜索內容（與paramType同時使用） | test | |
| regionId | 否 | String | 地域ID | 9035c530814611e990660242ac110002 | |
| agentState | 否 | Integer | 1: 在線;2：離線; 3:未激活; 4:錯誤；后續可擴展狀態，故為正整數即可。0或者不傳代表全部狀態 | 1 | |
| quotaVersion | 否 | Integer | 配額版本 1：基礎版；2：企業版 | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 200-成功 | ||
| error | String | 返回碼CTCSSCN_000000 :成功;CTCSSCN_000001:失敗;CTCSSCN_000003：用戶未簽署協議，安全衛士系統無法正常使用;CTCSSCN_000004：鑒權錯誤;CTCSSCN_000005：用戶沒有付費版配額，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回對象 | map |
表 map
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 記錄總數 | 5 | |
| pageSize | Integer | 頁大小 | 10 | |
| pageNum | Integer | 當前頁 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| list | Array of Objects | 服務器列表信息 | serverlist |
表 serverlist
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| agentIp | String | 私網IP | 1.1.1.1 | |
| hostId | Long | 主機ID | 1111 | |
| publicIp | String | 公網IP | 1.1.1.1 | |
| custName | String | 服務器名稱 | cust2016 | |
| osType | String | 操作系統linux/windows | linux | |
| agentGuid | String | agentGuid | aa-bb-cc-dd | |
| type | String | 服務器類型 | ||
| agentStateCode | String | agent狀態,在線/離線/未激活/錯誤 | 在線 | |
| guardStatus | String | 防護狀態，防護中/已關閉/已離線/未防護/未激活 | 防護中 | |
| regionName | String | 地域名稱 | ||
| sshRisk | Integer | 入侵檢測風險數 | 1 | |
| vulRisk | Integer | 漏洞掃描風險數 | 1 | |
| wpRisk | Integer | 網頁防篡改風險數 | 1 | |
| scaRisk | Integer | 安全基線風險數 | 1 | |
| virusRisk | Integer | 病毒查殺風險數 | 1 | |
| riskStatus | String | 風險狀態 風險/安全/未知 | 風險 | |
| quotaVersion | Integer | 配額版本 1：基礎版；2：企業版 | 1 |
枚舉參數
無
請求示例
請求url
無
請求頭header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
請求體body
{"currentPage": 1,"pageSize": 2}
響應示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查詢成功!","returnObj":{"total": 10511,"list": [{"agentIp": "10.104.1.50","publicIp": "","custName": "ecm-waf-lvs-0001","hostName": null,"osType": "linux","agentStateCode": "在線","agentGuid": "00792349-CE6B-42EB-A838-20A00DD86F07","hostId": 131530,"type": "vm","guardStatus": "防護中","regionName": "北京5","sshRisk": 0,"vulRisk": 0,"wpRisk": 0,"scaRisk": 0,"virusRisk": 0,"riskStatus": "安全","quotaVersion": 2},{"agentIp": "10.104.1.226","publicIp": "","custName": "ecm-waf-lvs","hostName": null,"osType": "linux","agentStateCode": "在線","agentGuid": "F091C368-4ED9-4F18-8D48-06610CB5D4FC","hostId": 131529,"type": "vm","guardStatus": "防護中","regionName": "北京5","sshRisk": 0,"vulRisk": 0,"wpRisk": 0,"scaRisk": 0,"virusRisk": 0,"riskStatus": "安全","quotaVersion": 2}],"pageNum": 1,"pageSize": 2,"size": 0,"startRow": 0,"endRow": 0,"pages": 5256,"prePage": 0,"nextPage": 0,"isFirstPage": false,"isLastPage": false,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 0,"navigatepageNums": null,"navigateFirstPage": 0,"navigateLastPage": 0},"success": false}
狀態碼
請參考
錯誤碼
請參考
