查询配置检查项影响到的服务器列表 - ListCheckRuleHost
功能介绍
查询配置检查项影响到的服务器列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/check-rule/hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
check_rule_id |
是 |
String |
参数解释 具体基线检查项id 约束限制 不涉及 取值范围
默认取值 不涉及 |
|
check_name |
否 |
String |
参数解释 配置检查（基线）的名称，如SSH、CentOS 7、Windows，与check_type相比，会多-PID之类的进程信息，通过具体基线维度查询时，传check_name 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
check_type |
否 |
String |
参数解释 配置检查（基线）的类型，如SSH、CentOS 7、Windows，通过检查项维度查询时，传check_type 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
standard |
是 |
String |
参数解释 基线分类 约束限制 不涉及 取值范围
默认取值 不涉及 |
|
result_type |
否 |
String |
参数解释 检测结果类型 约束限制 不涉及 取值范围
默认取值 不涉及 |
|
host_type |
否 |
String |
参数解释 检测结果类型 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
check_cce |
否 |
Boolean |
参数解释 是否校验cce 约束限制 不涉及 取值范围
默认取值 false |
|
cluster_id |
否 |
String |
参数解释 集群ID 约束限制 不涉及 取值范围 字符长度0-64位 默认取值 不涉及 |
|
policy_group_id |
否 |
String |
参数解释 策略组ID，不赋值时，查此检查项租户所有主机，host_id存在时，此值无效 约束限制 不涉及 取值范围 字符长度0-128位 默认取值 不涉及 |
|
host_name |
否 |
String |
参数解释 主机名称或ip 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
参数解释 单个基线检查项影响的主机总量 取值范围 取值0-2147483647 |
|
data_list |
Array of SecurityCheckRuleHostResponseInfo objects |
参数解释 单个基线检查项受影响的主机列表 取值范围 最少0条，最多2147483647条 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释： 主机ID 取值范围： 字符长度1-64位 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 字符长度1-256位 |
|
check_name |
String |
参数解释 配置检查（基线）的名称，例如SSH、CentOS 7、Windows 取值范围 字符长度0-256位 |
|
baseline_name |
String |
参数解释 基线的名称，例如SSH 应用基线检查、CentOS 7 系统基线检查、Windows 系统基线检查 取值范围 字符长度0-256位 |
|
host_public_ip |
String |
参数解释: 服务器公网IP 取值范围: 字符长度0-128位 |
|
host_private_ip |
String |
参数解释 服务器私有IP 取值范围 字符长度0-256位 |
|
scan_time |
Long |
参数解释 扫描时间(ms) 取值范围 取值0-9223372036854775807 |
|
failed_num |
Integer |
参数解释 风险项数量 取值范围 取值0-2147483647 |
|
passed_num |
Integer |
参数解释 通过项数量 取值范围 取值0-2147483647 |
|
diff_description |
String |
参数解释 差异化展示提示信息 取值范围 字符长度0-512位 |
|
description |
String |
参数解释 忽略或加白的备注 取值范围 字符长度0-1024位 |
|
host_type |
String |
参数解释 主机类型 取值范围
|
|
enable_fix |
Integer |
参数解释 是否支持一键修复 取值范围
|
|
enable_click |
Boolean |
参数解释 该检查项的修复&忽略&验证按钮是否可单击 取值范围
|
|
cancel_ignore_enable_click |
Boolean |
参数解释 已忽略检查项是否可点击 取值范围
|
|
result_type |
String |
参数解释 检测结果类型 取值范围
|
|
fix_failed_reason |
String |
参数解释 修复失败原因 取值范围 字符长度0-256位 |
|
cluster_id |
String |
参数解释 集群ID 取值范围 字符长度0-64位 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"host_id" : "852d2054-ae2e-11f0-a086-fa163e358d0a",
"host_name" : "name",
"check_name" : "SSH",
"host_private_ip" : "192.168.0.108",
"result_type" : "unhandled",
"scan_time" : 1760988017640
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
