文档首页/ 安全云脑 SecMaster/ API参考/ API V2/ 基线检查/ 查询检查项列表
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询检查项列表

功能介绍

查询检查项列表

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制：

不涉及

取值范围：

  • application/json;charset=UTF-8

默认取值：

不涉及

X-Language

是

String

参数解释：

语言，参考值：zh-cn、en-us

约束限制：

不涉及

取值范围：

zh-cn：中文环境

en-us：英文环境

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

limit

是

Integer

分页大小

offset

是

Integer

偏移量，表示查询该偏移量后面的记录

sort_by

否

String

排序关键字

order

否

String

降序或升序, DESC|ESC

name

否

String

按照检查项名称进行筛选

description

否

String

按照检查项描述进行筛选

type

否

Integer

按照检查项对的类型进行筛选。0：内置；1：自定义

source_list

否

Array of integers

按照检查项对的执行方式进行筛选。0：kotlin; 2：剧本流程；3：手动；4：主机接入

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

limit

Integer

分页大小

offset

Integer

偏移量，表示查询该偏移量后面的记录

sort_by

String

排序关键字

order

String

降序或升序, DESC|ESC

name

String

按照检查项名称进行筛选

description

String

按照检查项描述进行筛选

type

Integer

按照检查项对的类型进行筛选。0：内置；1：自定义

source_list

Array of integers

按照检查项对的执行方式进行筛选。0：kotlin; 2：剧本流程；3：手动；4：主机接入

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码：401

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码：500

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

查询检查项列表请求样例，例如查询内置检查项，返回第一页，每页10条数据

{
  "limit" : 10,
  "offset" : 0,
  "type" : 0
}

响应示例

状态码：400

请求失败

{
  "error_code" : "SecMaster.00040006",
  "error_msg" : "Invalid request parameters"
}

状态码：401

权限不足

{
  "error_code" : "SecMaster.90010015",
  "error_msg" : "Unauthorized request"
}

状态码：500

请求失败

{
  "error_code" : "SecMaster.00040011",
  "error_msg" : "Internal system error"
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

权限不足

500

请求失败

错误码

请参见错误码。

父主题： 基线检查

相关文档