更新时间:2025-08-30 GMT+08:00
分享

新建布局页面

功能介绍

create wizard.

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}/wizards

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

layout_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参数

参数

是否必选

参数类型

描述

id

String

Id value

name

String

The name, display only

description

String

The description, display only

layout_id

String

layout id

project_id

String

Project id value

workspace_id

String

workspace id

wizard_json

String

布局页面相关信息

is_binding

Boolean

是否已绑定按钮

binding_button

Array of binding_button objects

绑定按钮

boa_version

String

BOA底座版本

表4 binding_button

参数

是否必选

参数类型

描述

button_id

String

按钮id

button_name

String

按钮名称

响应参数

状态码:200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表6 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

request_id

String

Request id

success

Boolean

请求结果

data

WizardDetailInfo object

Information of layout wizard detail

表7 WizardDetailInfo

参数

参数类型

描述

create_time

String

Create time

creator_id

String

Creator id value

description

String

The description, display only

en_description

String

english description of layout wizard

id

String

Id value

wizard_json

String

布局页面相关信息

name

String

The name, display only

en_name

String

english name of layout module

update_time

String

Update time

project_id

String

Project id value

workspace_id

String

workspace id

is_binding

Boolean

是否已绑定按钮

binding_button

Array of binding_button objects

绑定按钮

is_built_in

Boolean

是否为系统页面

boa_version

String

BOA底座版本

version

String

安全云脑版本

表8 binding_button

参数

参数类型

描述

button_id

String

按钮id

button_name

String

按钮名称

状态码:400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

Response of create wizard informations

400

Error response

错误码

请参见错误码

相关文档