文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 查询指定安全配置项的检查结果
更新时间:2025-01-17 GMT+08:00
分享

查询指定安全配置项的检查结果

功能介绍

查询指定安全配置项的检查结果

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/baseline/risk-config/{check_name}/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

check_name

String

配置检查(基线)的名称,例如SSH、CentOS 7、Windows

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

开通企业项目功能后才需要配置企业项目。

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

standard

String

标准类型,包含如下:

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

host_id

String

主机ID,不赋值时,查租户所有主机

limit

Integer

每页数量

offset

Integer

偏移量:指定返回记录的开始位置

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

severity

String

风险等级,包含如下:

  • Low : 低危

  • Medium : 中危

  • High : 高危

check_type

String

配置检查(基线)的类型,例如SSH、CentOS 7、Windows Server 2019 R2、Windows Server 2016 R2、MySQL5-Windows

check_type_desc

String

对配置检查(基线)类型的描述信息,概括当前基线包含的检查项是根据什么标准制定的,能够审计哪些方面的问题。

check_rule_num

Integer

当前配置检查(基线)类型下,用户共检测了多少个检查项。例如标准类型为hw_standard的SSH基线,主机安全提供了17个检查项,但用户所有主机都只检测了SSH基线的其中5个检查项,check_rule_num就是5。用户有一台主机进行了全量检查项检测,check_rule_num就是17。

failed_rule_num

Integer

未通过的检查项数量,check_rule_num中只要有一台主机没通过某个检查项,这个检查项就会被计算在failed_rule_num中

passed_rule_num

Integer

已通过的检查项数量,check_rule_num中只要有一台主机通过了某个检查项,这个检查项就会被计算在passed_rule_num中

ignored_rule_num

Integer

已忽略的检查项数量,check_rule_num中只要有一台主机忽略了某个检查项,这个检查项就会被计算在ignored_rule_num中

host_num

Long

受影响的服务器的数量,进行了当前基线检测的服务器数量

请求示例

查询企业项目id为xxx下的基线名称为SSH、标准类型是“云安全实践”标准的配置检测结果列表。

GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/detail?standard=hw_standard&enterprise_project_id=xxx

响应示例

状态码: 200

请求已成功

{
  "check_rule_num" : 17,
  "check_type_desc" : "This policy checks the basic security configuration items of the SSH service to improve the security of the SSH service.",
  "failed_rule_num" : 15,
  "host_num" : 2,
  "ignored_rule_num" : 1,
  "passed_rule_num" : 14,
  "severity" : "Medium"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档