查询白名单列表
更新时间 2025-12-25 11:48:29
最近更新时间: 2025-12-25 11:48:29
接口功能介绍
基线检查项白名单列表分页查询
接口约束
此功能为收费功能。确认已经购买系统配额,并且开启基线扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/sca/check/whiteList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageSize | 是 | Integer | |||
| currentNum | 是 | Integer |
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| searchname | 否 | String | 待搜索的基线名称 | test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000:成功 | ||||
| CTCSSCN_000001:失败 | ||||
| CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004:鉴权错误 | ||||
| CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |||
| 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 |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | id | 1111 | |
| checkid | Integer | 检测项id | 1111 | |
| osType | String | 操作系统类型 Linux/Windows | Linux | |
| createtime | String | 创建时间 | 2020-01-01 00:00:00 | |
| effectScope | String | 作用范围 ALL-全部 OPTIONAL-自选机器 | ALL | |
| agentGuid | String | 机器guid,多个机器用英文逗号分隔 | test-agent-guid,test-agent-guid1 | |
| description | String | 描述 | 描述 | |
| name | String | 基线名称 | Unix系统基线检测 | |
| scaEnName | String | 基线英文名称 | System audit for Unix based systems | |
| enName | String | 检测项英文名称 | SSH加固:确保SSH协议设置为2 | |
| zhName | String | 检测项中文名称 | SSH加固:确保SSH协议设置为2 | |
| custName | String | 主机名称 | test | |
| displayName | String | 实例名称 | test | |
| hostName | String | 主机名称 | test | |
| privateIp | String | 主机私网ip | 192.168.0.1 | |
| publicIp | String | 主机公网ip | 192.168.0.1 | |
| agentGuidList | Array of Strings | |||
| count | Integer |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"searchname": "test"}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 100, "list": [{"id": 1111, "checkid": 1111, "osType": "Linux", "createtime": "2020-01-01 00:00:00", "effectScope": "ALL", "agentGuid": "test-agent-guid,test-agent-guid1", "description": "描述", "name": "Unix系统基线检测", "scaEnName": "System audit for Unix based systems", "enName": "SSH加固:确保SSH协议设置为2", "zhName": "SSH加固:确保SSH协议设置为2", "custName": "test", "displayName": "test", "hostName": "test", "privateIp": "192.168.0.1", "publicIp": "192.168.0.1", "agentGuidList": [], "count": ""}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码