修改布局 - UpdateLayout
功能介绍
修改布局
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/{layout_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
workspace_id |
是 |
String |
参数解释： 工作空间id。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
layout_id |
是 |
String |
布局ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
content-type |
是 |
String |
参数解释： 内容类型
约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
布局名称 |
|
description |
否 |
String |
The description, display only |
|
cloud_pack_id |
否 |
String |
订阅包id |
|
cloud_pack_name |
否 |
String |
订阅包名称 |
|
cloud_pack_version |
否 |
String |
订阅包版本 |
|
is_built_in |
否 |
Boolean |
是否内置，true内置，false非内置 |
|
is_template |
否 |
Boolean |
是否为模板 |
|
layout_json |
否 |
Object |
布局信息 |
|
fields_sum |
否 |
Integer |
字段总数；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
wizards_sum |
否 |
Integer |
页面总数；uesd_by为SECURITY_REPORT/DASHBOARD时不返回该字段 |
|
sections_sum |
否 |
Integer |
系统指标总数 |
|
tabs_sum |
否 |
Integer |
自定义指标总数 |
|
boa_version |
否 |
String |
BOA底座版本 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误信息 |
|
request_id |
String |
Request id |
|
success |
Boolean |
请求结果 |
|
data |
LayoutDetailInfo object |
Information of layout detail |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新成功后response |
|
400 |
Error response |
错误码
请参见错误码。
