文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线检查/ 查询指定策略组的检查项列表 - ListAllRiskConfigCheckRules
更新时间:2025-10-31 GMT+08:00
分享

查询指定策略组的检查项列表 - ListAllRiskConfigCheckRules

功能介绍

查询指定策略组的检查项列表

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

check_type

String

参数解释

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

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

standard

String

参数解释

标准类型,包含如下:

约束限制

不涉及

取值范围

  • cn_standard:等保合规标准

  • hw_standard:云安全实践标准

  • cis_standard:通用安全标准

默认取值

不涉及

statistics_scan_result

String

参数解释

统计结果类型,包含如下:

约束限制

不涉及

取值范围

  • pass:已通过,表示查看主机全部通过的检查项

  • failed:未通过,表示查看主机全部未通过 & 全部未处理的检查项

  • processed:已处理,表示查看主机存在未通过 & 未通过主机已全部处理(忽略、加白)的检查项

默认取值

不涉及

check_rule_name

String

参数解释

检查项(检查规则)名称,支持模糊匹配

约束限制

不涉及

取值范围

字符长度0-2048位

默认取值

不涉及

severity

String

参数解释

风险等级

约束限制

不涉及

取值范围

  • Security : 安全

  • Low : 低危

  • Medium : 中危

  • High : 高危

  • Critical : 危急

默认取值

不涉及

cluster_id

String

参数解释

集群ID

约束限制

不涉及

取值范围

字符长度0-64位

默认取值

不涉及

tag

String

参数解释

基线检查项的类型

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

policy_group_id

String

参数解释

策略组ID,不赋值时,查租户所有主机,host_id存在时,此值无效

约束限制

不涉及

取值范围

字符长度0-128位

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

风险总数

取值范围

取值0-200000

pass_num

Integer

参数解释

已通过检查项数量

取值范围

取值0-200000

failed_num

Integer

参数解释

未通过检查项数量

取值范围

取值0-200000

processed_num

Integer

参数解释

已处理检查项数量

取值范围

取值0-200000

data_list

Array of CheckRulesResponseInfo objects

参数解释

数据列表

表5 CheckRulesResponseInfo

参数

参数类型

描述

tag

String

参数解释

基线检查项的类型

取值范围

字符长度0-256位

check_rule_name

String

参数解释

检查项(检查规则)名称

取值范围

字符长度0-2048位

check_rule_id

String

参数解释

检查项ID

取值范围

字符长度0-64位

severity

String

参数解释

风险等级

取值范围

  • Low : 低危

  • Medium : 中危

  • High : 高危

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等。

取值范围

字符长度0-256位

check_type_name

String

参数解释

配置检查(基线)的类型名称, 一般为check_type + 系统基线检查|应用基线检查

取值范围

字符长度0-256位

standard

String

参数解释

标准类型

取值范围

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

  • cis_standard : 通用安全标准

host_num

Integer

参数解释

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

取值范围

取值0-2147483647

failed_num

Integer

参数解释

此检测项失败,且未忽略且未加白的主机数

取值范围

取值0-2147483647

scan_time

Long

最新检测时间(ms)

statistics_scan_result

String

参数解释

检查项统计结果

取值范围

  • pass:已通过,表示此检查项涉及的主机,全部检查通过。

  • failed:未通过,表示此检查项涉及的主机,存在检查不通过,且不通过的主机中,存在未处理(忽略、加白)主机。

  • processed:已处理,表示此检查项涉及的主机,存在未通过,但所有的未通过主机均已处理(忽略、加白)。

enable_fix

Integer

参数解释

是否支持一键修复

取值范围

  • 1 : 支持一键修复

  • 0 : 不支持

enable_click

Boolean

参数解释

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

取值范围

  • true : 按钮可单击

  • false : 按钮不可单击

cancel_ignore_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

请求已成功

错误码

请参见错误码

相关文档