查询指定安全配置项的检查项列表
功能介绍
查询指定安全配置项的检查项列表
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID |
| check_name | 是 | String | 配置检查(基线)的名称,例如SSH、CentOS 7、Windows |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目ID,查询所有企业项目时填写:all_granted_eps |
| standard | 是 | String | 标准类型,包含如下:
|
| result_type | 否 | String | 结果类型,包含如下:
|
| check_rule_name | 否 | String | 检查项(检查规则)名称,支持模糊匹配 |
| severity | 否 | String | 风险等级,包含如下:
|
| host_id | 否 | String | 主机ID,不赋值时,查租户所有主机 |
| limit | 否 | Integer | 每页数量 |
| offset | 否 | Integer | 偏移量:指定返回记录的开始位置 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Long | 风险总数 |
| data_list | Array of CheckRuleRiskInfoResponseInfo objects | 数据列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| severity | String | 风险等级,包含如下:
|
| check_name | String | 配置检查(基线)的名称,例如SSH、CentOS 7、Windows |
| check_type | String | 配置检查(基线)的类型,Linux系统支持的基线一般check_type和check_name相同,例如SSH、CentOS 7。 Windows系统支持的基线一般check_type和check_name不相同,例如check_name为Windows的配置检查(基线),它的check_type包含Windows Server 2019 R2、Windows Server 2016 R2等。 |
| standard | String | 标准类型,包含如下:
|
| check_rule_name | String | 检查项(检查规则)名称 |
| check_rule_id | String | 检查项ID |
| host_num | Integer | 受影响的服务器的数量,进行了当前基线检测的服务器数量 |
| scan_result | String | 检测结果,包含如下:
|
| status | String | 状态,包含如下:
|
| enable_fix | Integer | 是否支持一键修复,1:支持一键修复,0:不支持 |
| enable_click | Boolean | 该检查项的修复&忽略&验证按钮是否可单击,true:按钮可单击,false:按钮不可单击 |
| rule_params | Array of CheckRuleFixParamInfo objects | 支持传递参数修复的检查项可传递参数的范围,只有支持传递参数修复的检查项才返回此数据 |
请求示例
查询企业项目id为xxx下的基线名称为SSH、检查标准为“云安全实践”的检查项列表。
GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx
{
"standard" : "hw_standard"
} 响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"check_rule_id" : "1.1",
"check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.",
"check_type" : "SSH",
"host_num" : 2,
"standard" : "hw_standard",
"scan_result" : "failed",
"severity" : "High",
"status" : "unhandled",
"enable_fix" : 1,
"enable_click" : true,
"rule_params" : [ {
"rule_param_id" : 1,
"rule_desc" : "设置超时时间",
"default_value" : 5,
"range_min" : 1,
"range_max" : 10
}, {
"rule_param_id" : 2,
"rule_desc" : "设置重启次数",
"default_value" : 10,
"range_min" : 1,
"range_max" : 20
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。