文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线检查/ 查询配置检测策略组列表 - ListSecurityCheckPolicyGroup
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询配置检测策略组列表 - ListSecurityCheckPolicyGroup

功能介绍

查询配置检测策略组列表

授权信息

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

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

URI

GET /v5/{project_id}/baseline/security-checks/policy-groups

表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位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释

配置检测总数

取值范围

取值0-1000000

data_list

Array of SecurityCheckPolicyGroupInfoResponseInfo objects

参数解释

数据列表
表5 SecurityCheckPolicyGroupInfoResponseInfo

参数

参数类型

描述

group_id

String

参数解释

策略组ID

取值范围

字符长度1-64位

group_name

String

参数解释

策略组名称

取值范围

字符长度1-256位

check_rule_num

Integer

参数解释

基线检测项（检测规则）数量

取值范围

取值1-10000

host_num

Integer

参数解释

应用服务器数量

取值范围

取值0-1000000

deletable

Boolean

参数解释

是否支持删除

取值范围

  • true：支持

  • false：不支持

default_group

Boolean

参数解释

是否默认策略组

取值范围

  • true：是

  • false：否

support_os

String

参数解释

策略支持的操作系统类型

取值范围

  • Linux：linux系统

  • Windows：windows系统

policy_info

SecurityCheckPolicyInfoResponseInfo object

参数解释

配置检测策略信息

weak_pwd_policy_info

SecurityCheckPolicyInfoResponseInfo object

参数解释

弱口令、口令复杂度检测策略信息

agent_id_list

Array of strings

参数解释

应用的主机的agentID列表

task_condition

SecurityCheckTaskCondition object

参数解释

定时检测配置

detection_period

String

参数解释

检测周期
表6 SecurityCheckPolicyInfoResponseInfo

参数

参数类型

描述

policy_name

String

参数解释：

策略名称

取值范围：

字符长度1-256位

policy_id

String

参数解释：

策略ID

取值范围：

字符长度0-64位

content

String

策略详情

pwd_policy_content

PwdCheckTagInfo object

口令策略一级标签信息
表7 PwdCheckTagInfo

参数

参数类型

描述

tag

String

参数解释

口令检测一级tag

取值范围

  • weakpwd_pwdcomplexity：弱口令及口令复杂度检测

checked

String

参数解释

检测范围。

取值范围

  • true: 如果tag有值,则一级标签tag下所有的检测项都会检测。

  • false: 如果tag有值，则一级标签tag下所有的检测项都不会检测。

  • indeterminate: 部分检测，具体检测项由sub_tags决定。

sub_tags

Array of PwdCheckSubTagInfo objects

服务器风险TOP5列表
表8 PwdCheckSubTagInfo

参数

参数类型

描述

sub_tag

String

参数解释

口令检测二级tag

取值范围

  • weakpwd

  • pwdcomplexity

checked

String

参数解释

检测范围。

取值范围

  • true: 如果sub_tag有值,则二级标签sub_tag下所有的检测项都会检测

  • false: 如果sub_tag有值，则二级标签sub_tag下所有的检测项都不会检测。

  • indeterminate: 部分检测，由check_rule_ids决定具体检测项。

check_rule_ids

Array of strings

检测项列表
表9 SecurityCheckTaskCondition

参数

参数类型

描述

type

String

定时任务，包含如下:

  • fixed_weekday : 固定工作日

day_of_week

Array of strings

周几触发，可选0或多个

hour

Integer

在此参数表示的小时触发定时任务

minute

Integer

在此参数表示的分钟触发定时任务

random_offset

Integer

随机偏移时间

请求示例

查询配置检测策略组列表

GET https://{endpoint}/v5/{project_id}/baseline/security-checks/policy-groups?limit=10&offset=0&enterprise_project_id=all_granted_ep

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "policy_name" : "policy_name1",
    "policy_id" : "policy_1",
    "content" : "content"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 基线检查

相关文档