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

查询布局页面列表 - ListLayoutWizards

功能介绍

查询所有页面

调用方法

请参见如何调用API

授权信息

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

URI

GET /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 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页

limit

Integer

参数解释:

数据量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sort_key

String

参数解释:

排序字段,

  • create_time:创建时间

  • update_time:更新时间

约束限制:

不涉及

取值范围:

  • create_time

  • update_time

默认取值:

create_time

sort_dir

String

参数解释:

排序顺序

  • ASC:升序

  • DESC:降序

约束限制:

不涉及

取值范围:

  • ASC:升序

  • DESC:降序

默认取值:

DESC

请求参数

表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

错误码

data

Array of WizardDetailInfo objects

数据列表

message

String

响应信息

offset

Integer

分页

request_id

String

请求ID

limit

Integer

每页个数

success

Boolean

是否响应成功

total

Integer

总数

表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

页面列表查询成功响应

400

错误响应

错误码

请参见错误码

相关文档