查询指定安全配置项的检查结果 - ShowRiskConfigDetail
功能介绍
查询指定安全配置项的检查结果
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/risk-config/{check_name}/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
check_name |
是 |
String |
参数解释: 配置检查（基线）的名称，例如SSH、CentOS 7、Windows 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
standard |
是 |
String |
参数解释: 标准类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_id |
否 |
String |
参数解释: 主机ID，不赋值时，查租户所有主机 约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
severity |
String |
参数解释: 风险等级 取值范围:
|
|
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 |
请求已成功 |
错误码
请参见错误码。
