接口功能介绍
基线检查项白名单列表分页查询
接口约束
此功能为收费功能。确认已经购买系统配额,并且开启基线扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/sca/check/whiteList//
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
currentNum | 是 | Integer | 列表当前页 | 1 | |
pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
searchname | 否 | String | 基线名称 | System audit for Unix based systems | |
paramType | 是 | String | SCA_NAME-基线名称,SCA_CHECK_NAME-检查项名称 | SCA_NAME |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000:成功 CTCSSCN_000001:失败 CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 CTCSSCN_000004:鉴权错误 CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | baseScaMongoDtoPageInfo |
表 baseScaMongoDtoPageInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
pageNum | Integer | 当前页 | 1 | |
pageSize | Integer | 每页记录数 | 10 | |
pages | Integer | 总页数 | 2 | |
total | Integer | 总记录数 | 20 | |
isFirstPage | Boolean | 是否为首页 | false | |
isLastPage | Boolean | 是否为末页 | false | |
list | Array of Objects | 基线列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | Integer | 白名单id | 1 | |
name | String | 基线中文名称 | MySQL 5.6企业版基线检测 | |
scaEnName | String | 基线英文名称 | CIS benchmark for Oracle MySQL Enterprise 5.6 | |
checkid | Integer | 基线检查项Id | 10002 | |
enName | String | 基线检查项英文名 | 测试 | |
zhName | String | 基线检查项中文名 | Verify That 'MYSQL_PWD' Is Not Set In Users' Profiles |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"searchname":"System audit for Unix based systems"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"total": 4,"list": [{"id": 17,"checkid": 10001,"administratorid": null,"ctyunUserId": "638afb6861b140fa8906516cf57e16c4","createtime": null,"name": "MySQL 5.6企业版基线检测","scaEnName": "CIS benchmark for Oracle MySQL Enterprise 5.6","enName": "Disable Interactive Login","zhName": "测试"},{"id": 16,"checkid": 10002,"ctyunUserId": "638afb6861b140fa8906516cf57e16c4","name": "MySQL 5.6企业版基线检测","scaEnName": "CIS benchmark for Oracle MySQL Enterprise 5.6","enName": "Verify That 'MYSQL_PWD' Is Not Set In Users' Profiles","zhName": "测试"}],"pageNum": 1,"pageSize": 2,"size": 2,"startRow": 1,"endRow": 2,"pages": 2,"prePage": 0,"nextPage": 2,"isFirstPage": true,"isLastPage": false,"hasPreviousPage": false,"hasNextPage": true,"navigatePages": 8,"navigatepageNums": [1,2],"navigateFirstPage": 1,"navigateLastPage": 2}}
状态码
请参考 状态码
错误码
请参考 错误码