接口功能介绍
用户执行基线检测后,展示检测的统计结果。主要展示元素:检测服务器数、检测项、风险项、通过率等。
接口约束
此功能为收费功能。请您确认已经购买服务器安全卫士配额,并且开启防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启防护。
URI
POST /v1/sca/event/baseLevel/{currentNum}/{pageSize}
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
currentNum | 是 | Integer | 列表当前页 | 1 | |
pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
accessKey | 是 | String | 鉴权公钥(安全卫士系统提供) | 18ee9b6b63e411e8b4a7186590d96509 | |
contentMD5 | 是 | String | 参数MD5值。默认使用空字符("")计算 | 1B2M2Y8AsgTpgAmY7PhCfg== | |
requestDate | 是 | String | 请求时间 | Mon, 29 Aug 2022 00:59:26 UTC | |
hmac | 是 | String | 使用HMAC算法生成信息摘要。HMAC原始信息中需要的字段:使用HMAC加密是,需要密钥和待加密消息。 1.密钥使用接口方提供的secretKey,作为加密密钥。 2.待加密消息:contentMD5、requestDate 、servicePath(EOP地址,例如:/dev_minerProcessQuery/query参与加密);三个部分通过"\n"进行连接。连接顺序contentMD5\nrequestDate\nservicePath: | mTOyK30c+4Poit2857iXCb8N7Qc= | |
urlType | 否 | String | 请求地址类型。EOPAPI(默认),CTAPI,API | EOPAPI |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
scaRuleId | 是 | Integer | 基线策略Id | 1 | |
scaName | 否 | String | 基线策略名 | 基本检测 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
code | 是 | String | 返回码。取值范围: 0:成功。 -1:失败。 -3:用户未签署协议,安全卫士系统无法正常使用。 -4:鉴权错误。 -5:用户没有付费版配额,功能不可用。 | 0 | |
message | 是 | String | 返回信息 | 成功 | |
data | 是 | Object | 返回对象 | ScaEventResponse |
表ScaEventResponse
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
agents | 是 | Integer | 检测服务器数 | 1 | |
totalTitle | 是 | Integer | 检测项总数 | 20 | |
totalFailed | 是 | Integer | 风险项数 | 2 | |
totalPassingRate | 是 | BigDecimal | 通过率 | 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 | 是 | BigDecimal | 影响服务器数 | 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 | 基线状态解释 |
请求示例
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"accessKey": "18ee9b6b63e411e8b4a7186590d96509",
"contentMD5": "1B2M2Y8AsgTpgAmY7PhCfg==",
"hmac": "mTOyK30c+4Poit2857iXCb8N7Qc=",
"requestDate": "Mon, 29 Aug 2022 00:59:26 UTC"
}
请求体body
{
"scaRuleId":"230"
}
响应示例
{
"code": "0",
"message": "查询成功!",
"data": {
"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
}
}
}
状态码
状态码 | 描述 |
200 | 表示请求成功。 |
错误码
请参考错误码说明。