查询遵从包列表
功能介绍
查询遵从包列表
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages/search
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
X-Language |
是 |
String |
参数解释: 语言,参考值:zh-cn、en-us 约束限制: 不涉及 取值范围: zh-cn:中文环境 en-us:英文环境 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
是 |
Integer |
分页大小 |
offset |
是 |
Integer |
偏移量 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
遵从包总数 |
compliance_packages |
Array of CompliancePackageModel objects |
遵从包列表 |
参数 |
参数类型 |
描述 |
---|---|---|
uuid |
String |
遵从包的uuid |
name |
String |
遵从包的名称 |
version |
String |
遵从包的版本号 |
owner |
String |
遵从包的责任人 |
spec_catalog_vo_list |
Array of BaselineCatalogModel objects |
遵从包的目录列表 |
description |
String |
对遵从包的描述 |
classify |
String |
遵从包的分类 |
areas |
String |
遵从包适用的领域 |
region |
String |
遵从包适用的区域 |
参数 |
参数类型 |
描述 |
---|---|---|
uuid |
String |
目录ID唯一标识,UUID |
serial_number |
Integer |
目录的位置顺序 |
level_number |
Integer |
目录的层级关系 |
root |
String |
该目录所在遵从包UUID |
parent |
String |
该目录的父目录UUID,如果等于为第一层目录,则为遵从包UUID |
is_leaf |
Integer |
该目录是否是叶子节点 0:不是 1:是 |
check_items |
Array of CheckitemCatalogModel objects |
目录关联的检查项 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询遵从包列表请求样例,例如查询内置遵从包,返回第一页,每页10条数据
{ "limit" : 10, "offset" : 0, "type" : 0 }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
查询基线检查遵从包列表返回体 |
400 |
查询基线检查遵从包列表错误返回体 |
错误码
请参见错误码。