文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 查询指定安全配置项的检查项列表 - ListRiskConfigCheckRules
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询指定安全配置项的检查项列表 - ListRiskConfigCheckRules

功能介绍

查询指定安全配置项的检查项列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

check_name

是

String

参数解释:

配置检查（基线）的名称，例如SSH、CentOS 7、Windows

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

standard

是

String

参数解释:

标准类型

约束限制:

不涉及

取值范围:

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

默认取值:

不涉及

result_type

否

String

参数解释:

结果类型

约束限制:

不涉及

取值范围:

  • safe : 已通过

  • unhandled : 未通过，且未忽略的

  • ignored : 未通过，且已忽略的

默认取值:

unhandled

check_rule_name

否

String

参数解释:

检查项（检查规则）名称，支持模糊匹配

约束限制:

不涉及

取值范围:

字符长度0-2048位

默认取值:

不涉及

severity

否

String

参数解释:

风险等级

约束限制:

不涉及

取值范围:

  • Security : 安全

  • Low : 低危

  • Medium : 中危

  • High : 高危

  • Critical : 危急

默认取值:

不涉及

host_id

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

否

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

默认为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Long

参数解释:

风险总数

取值范围:

不涉及

data_list

Array of CheckRuleRiskInfoResponseInfo objects

参数解释:

数据列表

取值范围:

不涉及
表5 CheckRuleRiskInfoResponseInfo

参数

参数类型

描述

severity

String

参数解释:

风险等级

取值范围:

  • Low：低危

  • Medium：中危

  • High：高危

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

参数解释:

标准类型

取值范围:

  • cn_standard：等保合规标准

  • hw_standard：云安全实践标准

check_rule_name

String

参数解释:

检查项（检查规则）名称

取值范围:

不涉及

check_rule_id

String

参数解释:

检查项ID

取值范围:

不涉及

host_num

Integer

参数解释:

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

取值范围:

不涉及

scan_result

String

参数解释:

检测结果

取值范围:

  • pass : 检测通过

  • failed : 检测不通过

status

String

参数解释:

检测项状态

取值范围:

  • safe : 无需处理

  • ignored : 已忽略

  • unhandled : 未处理

  • fixing : 修复中

  • fix-failed : 修复失败

  • verifying : 验证中

enable_fix

Integer

参数解释:

是否支持一键修复

取值范围:

  • 1：支持一键修复

  • 0：不支持

enable_click

Boolean

参数解释:

该检查项的修复&忽略&验证按钮是否可单击

取值范围:

  • true：按钮可单击

  • false：按钮不可单击

rule_params

Array of CheckRuleFixParamInfo objects

参数解释:

支持传递参数修复的检查项可传递参数的范围，只有支持传递参数修复的检查项才返回此数据

取值范围:

不涉及
表6 CheckRuleFixParamInfo

参数

参数类型

描述

rule_param_id

Integer

参数解释

检查项参数ID

取值范围

取值0-10

rule_desc

String

参数解释

检查项参数描述

取值范围

字符长度0-256位

default_value

Integer

参数解释

检查项参数默认值

取值范围

取值0-2147483647

range_min

Integer

参数解释

检查项参数可取最小值

取值范围

取值0-2147483647

range_max

Integer

参数解释

检查项参数可取最大值

取值范围

取值0-2147483647

请求示例

查询企业项目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

请求已成功

错误码

请参见错误码。

父主题： 基线管理

相关文档