查询布局页面详情 - ShowLayoutWizardByField
功能介绍
查询布局页面详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/wizards
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
layout_id |
是 |
String |
布局ID |
|
field_id |
是 |
String |
布局字段ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
Error message |
|
data |
WizardDetailInfo object |
Information of layout wizard detail |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
安全云脑版本 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
布局页面详情返回信息 |
|
400 |
Error response |
错误码
请参见错误码。