文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V2/ 基线检查/ 查询检查项列表 - SearchCheckitems
更新时间:2025-12-26 GMT+08:00
分享

查询检查项列表 - SearchCheckitems

功能介绍

查询检查项列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用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参数

参数

是否必选

参数类型

描述

catalog_uuid

String

检查项所属的目录id

compliance_package_id

String

检查项所属的遵从包id

limit

Integer

分页大小

offset

Integer

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

sort_by

String

排序关键字

order

String

降序或升序

DESC:降序

ASC: 升序

name

String

按照检查项名称进行筛选

suggestion

String

按照检查项建议进行筛选

type

Integer

表示该检查项的类型

0:内

1: 自定义

source_list

Array of integers

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

condition

condition object

搜索条件表达式

query_mode

String

按照什么维度进行筛选

severity

String

按照检查项严重等级进行筛选

Fatal:致命

High:高危

Medium:中危

Low:低危

Tips:提示

表4 condition

参数

是否必选

参数类型

描述

conditions

Array of conditions objects

表达式列表

logics

Array of strings

表达式名称列表

表5 conditions

参数

是否必选

参数类型

描述

name

String

表达式名称

data

Array of strings

表达式内容列表

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

builtin_checkitem_num

Number

内置检查项个数

checkitem_num

Number

检查项总数

customized_checkitem_num

Number

自定义检查项个数

count

Number

检查项总数

checkitems

Array of CheckitemModel objects

检查项详情

表7 CheckitemModel

参数

参数类型

描述

uuid

String

检查项的id

aggregation_handle_status

String

检查项结果聚合状态

audit_procedure

String

检查项的检查过程

impact

String

检查项的影响

cloud_server

String

检查项所属云服务

description

String

对检查项的描述

level

String

表示该检查项的严重程度

informational:提示

low: 低危

medium:中危

high: 高危

fatal:致命

method

Integer

表示该检查项的检查方式

0:自动项

3: 剧本流程/logic app

name

String

检查项的名称

source

Integer

表示该检查项的来源

0:默认/default

2: 剧本流程/playbook

workflow_id

String

参数解释:

流程ID

约束限制:

不涉及

spec_checkitem_list

Array of SpecCheckitemModel objects

检查项所属遵从包的信息

表8 SpecCheckitemModel

参数

参数类型

描述

checkitem_uuid

String

检查项的uuid

create_time

String

遵从包创建时间戳

language

String

遵从包创建的语言环境

name

String

遵从包名称

remove_time

String

遵从包删除时间戳

specification_uuid

String

遵从包的uuid

uuid

String

uuid

状态码:400

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码:401

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

状态码:500

表11 响应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

请求失败

错误码

请参见错误码

相关文档