接口功能介绍
用户执行基线检测后,展示检测的统计结果。主要展示元素:检测服务器数、检测项、风险项、通过率等
接口约束
此功能为收费功能。确认已经购买系统配额,并且开启基线扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/sca/event/baseLevel//
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
currentNum | 是 | Integer | 列表当前页 | 1 | |
pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
scaRuleId | 是 | Integer | 基线策略Id | 1 | |
scaName | 否 | String | 基线策略名 | 基本检测 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000:成功 CTCSSCN_000001:失败 CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 CTCSSCN_000004:鉴权错误 CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | ScaEventResponse |
表 ScaEventResponse
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
agents | Integer | 检测服务器数 | 1 | |
totalTitle | Integer | 检测项总数 | 20 | |
totalFailed | Integer | 风险项数 | 2 | |
totalPassingRate | Double | 通过率 | 0.23 | |
baseScaMongoDtoPageInfo | Object | 分页列表 | baseScaMongoDtoPageInfo |
表 baseScaMongoDtoPageInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页记录数 | 10 | |
pages | Integer | 总页数 | 2 | |
total | Integer | 总记录数 | 20 | |
isFirstPage | Boolean | 是否为首页 | false | |
isLastPage | Boolean | 是否为末页 | false | |
list | Object | 基线列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | 基线名称 | 1 | |
itemTotal | Integer | 基线检查项 | 20 | |
failed | Integer | 风险项数量 | 2 | |
relationAgent | Double | 影响服务器数 | 0.23 | |
timestamp | String | 最后检测时间 | 2022-05-26 16:55:50 | |
scaId | Integer | 基线id | 1 | |
strategyId | Integer | 基线策略id | 3 | |
scanId | Integer | 扫描id | 1606786530 | |
scaStatus | Integer | 扫描状态 1:通过 2:未通过 3:失败 |
1 | |
scaStatusDesc | String | 基线状态解释 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"scaRuleId":"230"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"agents": 1,"checks": 0,"totalPassingRate": 0.39,"totalPassed": 23,"totalFailed": 36,"totalInvalid": 38,"totalTitle": 97,"baseScaMongoDtoPageInfo": {"total": 1,"list": [{"id": "61dd2171b3aa31714094dff2","checkId": null,"white": null,"title": null,"result": null,"failed": 36,"passingRate": 0.39,"total": 97,"itemTotal": 97,"file": "sca_win_audit.yml","invalid": 38,"passed": 23,"totalChecks": 71,"strategyId": 230,"scanId": 1606786530,"timestamp": "2022-01-11T06:15:09.000+00:00","scaId": 9,"name": "Windows审计基线"}],"pageNum": 1,"pageSize": 10,"size": 0,"startRow": 0,"endRow": 0,"pages": 1,"prePage": 0,"nextPage": 0,"isFirstPage": false,"isLastPage": false,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 0,"navigatepageNums": null,"navigateFirstPage": 0,"navigateLastPage": 0}}}
状态码
请参考 状态码
错误码
请参考 错误码