白名单机器列表查询接口
更新时间 2025-12-24 16:56:12
最近更新时间: 2025-12-24 16:56:12
接口功能介绍
告警中心-查询白名单主机列表
接口约束
无
URI
POST /v1/instrusion/whitelist/hostlist
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentAgentGuids | 否 | Array of Strings | 当前机器id列表,排在前面 | ["test-agentGuid"] | |
| currentPage | 是 | Integer | 当前页码 | 1 | |
| pageSize | 是 | Integer | 每页大小 | 10 | |
| osType | 否 | String | 操作系统 Linux/Windows | Linux | |
| param | 否 | String | 查询参数 | test | |
| regionId | 否 | String | 资源池id | 1001 | |
| quotaVersion | 否 | String | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| selectAgentGuids | 否 | Array of Strings | 选择的机器id列表，排在前面 | ["test-agentGuid"] | |
| bgGroupIds | 否 | Array of Strings | 业务分组id列表 | ["test-bgGroupId"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000：成功 | ||||
| CTCSSCN_000001：失败 | ||||
| CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004：鉴权错误 | ||||
| CTCSSCN_000005：用户没有付费版配额，功能不可用 | 0 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | asaadasd11111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| agentGuid | String | agentGuid | test-agentGuid | |
| custName | String | 主机名称 | test-custName | |
| publicIp | String | 公网ip | 192.168.1.1 | |
| displayName | String | 实例名称 | test-displayName | |
| agentIp | String | 私有ip | 192.168.1.1 | |
| status | String | 状态 已关机 | 运行中 | 其他 |
| osType | String | 操作系统类型 Windows Linux | Windows | |
| statusCode | Integer | 服务器状态 4-已关机 5-运行中 40-其他 | 5 | |
| isCurrentHost | Boolean | 是否是当前机器 |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"currentAgentGuids": ["test-agentGuid"], "currentPage": 1, "pageSize": 10, "osType": "Linux", "param": "test", "regionId": "1001", "quotaVersion": "1", "selectAgentGuids": ["test-agentGuid"], "bgGroupIds": ["test-bgGroupId"]}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "0", "returnObj": {"total": 100, "list": [{"agentGuid": "test-agentGuid", "custName": "test-custName", "publicIp": "192.168.1.1", "displayName": "test-displayName", "agentIp": "192.168.1.1", "status": "", "osType": "Windows", "statusCode": 5, "isCurrentHost": ""}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码
