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

查询布局页面详情 - ShowLayoutWizardByField

功能介绍

查询布局页面详情

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/wizards

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

layout_id

是

String

布局ID

field_id

是

String

布局字段ID

请求参数

表3 请求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

默认取值：

不涉及

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

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

参数

参数类型

描述

code

String

错误码

message

String

响应信息

data

WizardDetailInfo object

页面详情
表6 WizardDetailInfo

参数

参数类型

描述

create_time

String

创建时间

creator_id

String

创建者ID

description

String

描述信息

en_description

String

英文描述

id

String

页面ID

wizard_json

String

布局页面相关信息

name

String

页面名称

en_name

String

英文名称

update_time

String

更新时间

project_id

String

租户ID

workspace_id

String

工作空间ID

is_binding

Boolean

是否已绑定按钮

binding_button

Array of binding_button objects

绑定按钮

is_built_in

Boolean

是否为系统页面

boa_version

String

BOA底座版本

version

String

安全云脑版本
表7 binding_button

参数

参数类型

描述

button_id

String

按钮id

button_name

String

按钮名称

状态码：400

表8 响应Header参数

参数

参数类型

描述

X-request-id

String

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

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

无

响应示例

状态码：200

布局页面详情返回信息

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "data" : {
    "binding_buttons" : null,
    "boa_version" : "v3",
    "create_time" : "2025-06-30T20:01:25Z+0800",
    "creator_id" : "system",
    "description" : "域名",
    "en_description" : "Built-in,Domain",
    "en_name" : "Domain",
    "env_params" : null,
    "id" : "fc574642-7a4d-32bb-bb6f-ddcfb74624d9",
    "is_binding" : true,
    "project_id" : "25895222e8744afa985c93dab6341da6",
    "update_time" : "2025-06-30T20:01:25Z+0800",
    "version" : "25.2.0",
    "wizard_json" : "test",
    "workspace_id" : "7e0f8248-5799-465e-9d94-9ff07f4b800d"
  }
}

状态码

状态码

描述

200

布局页面详情返回信息

400

错误响应

错误码

请参见错误码。

父主题： 页面布局

相关文档