文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线检查/ 查询基线检查执行操作时影响的范围 - ListHandleAffectBaseline
更新时间:2025-10-31 GMT+08:00
分享

查询基线检查执行操作时影响的范围 - ListHandleAffectBaseline

功能介绍

查询基线检查执行操作时影响的范围

授权信息

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

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

URI

POST /v5/{project_id}/baseline/check-rule/handle-affect-baseline

表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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释

基线检查执行的操作

约束限制

不涉及

取值范围

  • add_to_whitelist: 加白名单

  • ignore : 忽略

  • unignore : 取消忽略

  • fix : 修复

  • verify : 验证

默认取值

不涉及

handle_status

String

参数解释

当前检查项的状态

约束限制

不涉及

取值范围

  • unhandled : 未处理

  • fix-failed: 修复失败

  • fixing : 修复中

  • verifying : 验证中

  • ignored : 忽略

  • safe : 安全

默认取值

不涉及

host_id

String

参数解释

主机id,没有该字段则代表该检查项影响的部分主机

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

check_rule_list

Array of check_rule_list objects

参数解释

需要进行操作的检查项列表

约束限制

列表范围0-200条

表5 check_rule_list

参数

是否必选

参数类型

描述

check_name

String

参数解释

基线检查的名称

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

check_rule_id

String

参数解释

检查项id

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

standard

String

参数解释

基线检查标准类型

约束限制

不涉及

取值范围

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

  • cis_standard : 通用安全标准

默认取值

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

total_rule_num

Integer

参数解释

该操作影响的范围的总数

取值范围

取值0-5000

rule_num

Integer

参数解释

该操作影响的检查项数

取值范围

取值0-5000

host_num

Integer

参数解释

该操作影响的主机数

取值范围

取值0-5000

data_list

Array of HandleAffectBaselineInfo objects

参数解释

该操作影响范围的详细信息的列表

表7 HandleAffectBaselineInfo

参数

参数类型

描述

host_id

String

参数解释

主机id

取值范围

字符长度1-256位

host_name

String

参数解释

服务器名称

取值范围

字符长度1-64位

public_ip

String

参数解释

服务器公网ip

取值范围

字符长度0-128位

private_ip

String

参数解释

服务器私网ip

取值范围

字符长度0-2048位

asset_value

String

参数解释

资产重要性,包含如下3种

取值范围

  • important :重要资产

  • common :一般资产

  • test :测试资产

check_type

String

参数解释

基线检查的基线名称

取值范围

字符长度0-255位

standard

String

参数解释

标准类型,包含如下3种

取值范围

  • cn_standard : 等保合规标准

  • hw_standard : 云安全实践标准

  • cis_standard : 通用安全标准

tag

String

参数解释

基线检查中检查项的检查类型

取值范围

字符长度0-128位

check_rule_name

String

参数解释

基线检查中检查项的名称

取值范围

字符长度0-2048位

请求示例

响应示例

状态码:200

请求已成功

{
  "total_rule_num" : 3,
  "rule_num" : 2,
  "host_num" : 2,
  "data_list" : [ {
    "host_id" : "40371a5d-11df-30fc-80fb-a7b61715cd92",
    "host_name" : "DESKTOP-Q3H4UP1",
    "asset_value" : "common",
    "public_ip" : "10.122.112.21",
    "private_ip" : "192.168.10.5",
    "check_type" : "SSH",
    "standard" : "hw_standard",
    "tag" : "访问控制",
    "check_rule_name" : "规则:需限制/etc/ssh/sshd_config的访问权限"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档