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

查询布局列表

功能介绍

查询布局列表

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/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

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

布局名称

used_by

否

String

DATACLASS/SECURITY_REPORT/DASHBOARD/LARGE_SCREEN

binding_code

否

String

创建布局选择的数据类的business_code

is_built_in

否

Boolean

是否为系统内置

is_template

否

Boolean

是否为模板

is_default

否

Boolean

是否为默认布局

layout_type

否

String

布局页面类型

offset

否

Integer

request offset, from 0

limit

否

Integer

request limit size

sort_key

否

String

sort by property, create_time.

sort_dir

否

String

sort order, ASC, DESC.

search_txt

否

String

搜索关键字

from_date

否

String

起始时间

to_date

否

String

结束时间

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表5 响应Body参数

参数

参数类型

描述

code

String

错误码

data

Array of LayoutDetailInfo objects

数据列表

message

String

Error message

offset

Integer

request offset, from 0

request_id

String

Request id

limit

Integer

request limit size

success

Boolean

是否响应成功

total

Integer

tatal count
表6 LayoutDetailInfo

参数

参数类型

描述

cloud_pack_id

String

订阅包id

cloud_pack_name

String

订阅包名称

cloud_pack_version

String

订阅包版本

is_built_in

Boolean

是否内置，true内置，false非内置

is_template

Boolean

是否为模板

create_time

String

Create time

creator_id

String

Creator id value

creator_name

String

Creator name value

description

String

The description, display only

en_description

String

english description of layout

id

String

订阅包id

name

String

The name, display only

en_name

String

english name of layout

layout_json

String

布局下的wizard id列表

project_id

String

Project id value

update_time

String

Update time

workspace_id

String

workspace id

region_id

String

region id

domain_id

String

domain id

thumbnail

String

模板缩略图，当布局为模板时不为空

used_by

String

被什么业务使用，DATACLASS/AOP_WORKFLOW/SECURITY_REPORT/DASHBOARD，及对应的字段

layout_cfg

String

前端根据该值绑定图标

layout_type

String

布局类型；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

binding_id

String

数据类ID或流程ID；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

binding_name

String

数据类名称或流程名称；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

binding_code

String

数据类或流程英文名称；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

fields_sum

Integer

字段总数；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

wizards_sum

Integer

页面总数；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段

sections_sum

Integer

系统指标总数

tabs_sum

Integer

自定义指标总数

version

String

安全云脑版本

boa_version

String

BOA底座版本

状态码：400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

查询布局列表，偏移量为10，查询3条

{
  "limit" : 3,
  "offset" : 10
}

响应示例

状态码：200

布局列表返回信息

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "total" : 41,
  "limit" : 2,
  "offset" : 1,
  "success" : true,
  "data" : [ {
    "layout_details" : {
      "binding_code" : "Indicator",
      "binding_id" : "8e6e880c-caba-3511-88f6-545cc9f2a5bd",
      "binding_name" : "Indicator",
      "boa_version" : "v3",
      "create_time" : "2025-06-30T20:01:25Z+0800",
      "creator_id" : "system",
      "creator_name" : "system",
      "description" : "Domain",
      "en_description" : "Built-in layout, indicator management - Domain",
      "en_name" : "Domain",
      "fields_sum" : 17,
      "id" : "fc574642-7a4d-32bb-bb6f-ddcfb74624d9",
      "is_built_in" : true,
      "is_template" : "fals",
      "layout_cfg" : "indicator",
      "layout_json" : [ "28f87ba3-1146-4179-9799-5b5dbeee37ef" ],
      "layout_type" : "Detail",
      "modules_sum" : 0,
      "name" : "domain",
      "parent_id" : "144d0a96-db2c-3140-8a2f-ec30d8cee6c9",
      "project_id" : "15645222e8744afa985c93dab6341da6",
      "sections_sum" : 0,
      "tabs_sum" : 0,
      "update_time" : "2025-06-30T20:01:25Z+0800",
      "used_by" : "DATACLASS",
      "wizards_sum" : 1,
      "workspace_id" : "7e0f8248-5799-465e-9d94-9ff07f4b800d"
    }
  } ]
}

状态码

状态码

描述

200

布局列表返回信息

400

Error response

错误码

请参见错误码。

父主题： 页面布局

相关文档