无风险统计
更新时间 2025-12-24 16:08:20
最近更新时间: 2025-12-24 16:08:20
接口功能介绍
服务器列表-查询服务器列表(不统计风险信息)
接口约束
无
URI
POST /v1/host/CSC/all
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| guardStatus | 否 | Integer | 防护状态 1-防护中 4-未防护 | 1 | |
| agentState | 否 | Integer | agent状态 1:在线;2:离线; | 1 | |
| currentPage | 是 | Integer | 分页当前页码 | 1 | |
| pageSize | 是 | Integer | 每页大小 | 10 | |
| agentGuid | 否 | String | agentGuid | 112113-xxxxx-12131-121311 | |
| riskLevel | 否 | Integer | 风险状态 1-无风险 2-未知 3-风险 | 1 | |
| regionId | 否 | String | 地域 | 1001 | |
| paramType | 否 | Integer | 查询参数类型 1-实例名称/服务器名称 2-服务器ip 5-agentGuid 15-代理地址ip | 1 | |
| param | 否 | String | 查询参数 | test | |
| quotaVersion | 否 | Integer | 配额版本 1:基础版;2:企业版 | 1 | |
| bgGroupId | 否 | String | 业务分组id | BG1001 | |
| serverStatus | 否 | Integer | 服务器状态 4-已关机 5-运行中 40-其他 | 1 | |
| displayName | 否 | String | 实例名称 | test | |
| agentNeedUpgrade | 否 | Integer | agent是否需要升级 1-需要升级 0-不需要升级 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000:成功 | ||||
| CTCSSCN_000001:失败 | ||||
| CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004:鉴权错误 | ||||
| CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | 211111111111111111111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentIp | String | 内网IP | 192.168.1.1 | |
| publicIp | String | 公网IP | 192.168.1.1 | |
| custName | String | 主机名称 | test | |
| hostName | String | 实例名称 | test | |
| displayName | String | 实例名称 | test | |
| osType | String | 操作系统类型 | Windows | |
| bgGroupName | String | 所属分组全路径 | 事业部xx/产品线 | |
| agentStateCode | String | Agent状态 在线/离线 | 在线 | |
| agentGuid | String | agentGuid | 11-11-11-11 | |
| hostId | Integer | 主机ID | 1 | |
| type | String | 服务器类型:vm 虚机;pm 物理机 | vm | |
| guardStatus | String | 防护状态 防护中/未防护 | 1 | |
| regionName | String | 地域 | 华东1 | |
| sshRisk | Integer | 入侵检测风险数 | 0 | |
| vulRisk | Integer | 漏洞扫描风险数 | 0 | |
| wpRisk | Integer | 网页防篡改风险数 | 0 | |
| scaRisk | Integer | 安全基线风险数 | 0 | |
| virusRisk | Integer | 病毒风险数 | 0 | |
| riskStatus | String | 风险状态 无风险/未知/风险 | 1 | |
| quotaVersion | Integer | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| agentStateCodeCode | String | Agent状态 12-在线 13-离线 | 12 | |
| guardStatusCode | Integer | 防护状态 1-防护中 4-未防护 | 1 | |
| riskStatusCode | Integer | 风险状态 1-无风险 2-未知 3-风险 | 1 | |
| osTypeCode | String | 操作系统类型 | Windows | |
| bgGroupId | String | 业务分组id | BG0001 | |
| serverStatus | String | 服务器状态 4-已关机 5-运行中 40-其他 | 5 | |
| baselineCheckCount | Integer | 基线检查风险数量 | 0 | |
| vulnerabilityScanCount | Integer | 漏洞扫描风险数量 | 0 | |
| securityAlertCount | Integer | 安全告警风险数量 | 0 | |
| agentVersion | String | agent版本 | 5.1.1 | |
| needUpgrade | Boolean | * | ||
| 是否需要升级 | true | |||
| upgradeCommand | String | 升级命令 | curl -k -s -L 'http://169.254.169.254:5662/download/eShield-agent/eShield-install-agent.sh' | bash |
| macAddr | Array of Strings | macAddr | ["11-11-11-11"] | |
| proxyAddress | String | 代理地址,安装agent时,用户可配置自己的代理服务,转发agent请求到安全卫士到后台 | 169.254.169.254 |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"guardStatus": 1, "agentState": 1, "currentPage": 1, "pageSize": 10, "agentGuid": "112113-xxxxx-12131-121311", "riskLevel": 1, "regionId": "1001", "paramType": 1, "param": "test", "quotaVersion": 1, "bgGroupId": "BG1001", "serverStatus": 1, "displayName": "test", "agentNeedUpgrade": 0}
响应示例
{"message": "success", "traceId": "211111111111111111111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 100, "list": [{"agentIp": "192.168.1.1", "publicIp": "192.168.1.1", "custName": "test", "hostName": "test", "displayName": "test", "osType": "Windows", "bgGroupName": "事业部xx/产品线", "agentStateCode": "在线", "agentGuid": "11-11-11-11", "hostId": 1, "type": "vm", "guardStatus": "1", "regionName": "华东1", "sshRisk": 0, "vulRisk": 0, "wpRisk": 0, "scaRisk": 0, "virusRisk": 0, "riskStatus": "1", "quotaVersion": 1, "agentStateCodeCode": "12", "guardStatusCode": 1, "riskStatusCode": 1, "osTypeCode": "Windows", "bgGroupId": "BG0001", "serverStatus": "5", "baselineCheckCount": 0, "vulnerabilityScanCount": 0, "securityAlertCount": 0, "agentVersion": "5.1.1", "needUpgrade": "true", "upgradeCommand": "curl -k -s -L 'http://169.254.169.254:5662/download/eShield-agent/eShield-install-agent.sh'|bash", "macAddr": ["11-11-11-11"], "proxyAddress": "169.254.169.254"}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码