工作台列表查询 - ListWorkbenches

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID，用于明确工作空间归属，可以通过调用API获取，也可以从控制台获取。获取工作空间ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

offset

是

Integer

参数解释：

分页查询的偏移量，表示从第几条数据开始查询，偏移量从0开始

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

是

Integer

参数解释：

分页参数中的页大小，一般理解为本次请求获取的最大数据量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

global_search_text

否

String

参数解释：

全局搜索关键字搜索、过滤

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

creator_type

否

String

参数解释：

创建类型，系统创建的工作台、我创建的工作台、其他人创建的工作台

约束限制：

不涉及

取值范围：

• system：系统创建的工作台

• mine：我创建的工作台

• others：其他人创建的工作台

默认取值：

不涉及

status

否

String

参数解释：

工作台状态，已发布、未发布

约束限制：

不涉及

取值范围：

• publish：已发布

• unpublish：未发布

默认取值：

不涉及

name

否

String

参数解释：

工作台名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

否

String

参数解释：

工作台类型，场景工作台、防线工作台

约束限制：

不涉及

取值范围：

• scenario：场景工作台

• defense：防线工作台

默认取值：

不涉及

url

否

String

参数解释：

工作台url

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tags

否

String

参数解释：

工作台标签，可以输入多个标签中的一个进行查询

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

from_date

否

String

参数解释：

查询工作台创建时间区间的开始，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ+0800，例如2024-01-01T00:00:00Z+0800

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

to_date

否

String

参数解释：

查询工作台创建时间区间的结束，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ+0800，例如2024-12-31T23:59:59Z+0800

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

请求头中内容格式，一般为application/json;charset=UTF-8

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

code

String

参数解释:

请求成功的编码

取值范围:

• SecMaster.000000

默认值:

不涉及

msg

String

参数解释:

请求成功的消息

取值范围:

不涉及

默认值:

不涉及

total

Integer

参数解释：

返回的数据总数

取值范围：

不涉及

limit

Integer

参数解释：

当前页大小

取值范围：

不涉及

offset

Integer

参数解释：

当前页码

取值范围：

不涉及

data

Array of ListWorkbenchResponse objects

参数解释：

工作台列表数据集

name

String

参数解释：

工作台名称

取值范围：

不涉及

type

String

参数解释：

工作台的分类，防线工作台(DEFENSE)或者场景工作台(SCENARIO)

取值范围：

• DEFENSE: 防线工作台

• SCENARIO: 场景工作台

url

String

参数解释：

工作台主页地址，可以选择云脑中已有的工作台布局，也可以选择云上console上的URL页面地址

取值范围：

不涉及

url_openwith_type

String

参数解释：

工作台主页打开方式, NEW_PAGE 新页面打开， CURRENT_PAGE 原页面打开

取值范围：

• NEW_PAGE: 新页面打开工作台

CURRENT_PAGE: 原页面打开工作台

tags

String

参数解释：

工作台标签，多个标签以逗号隔开，最多不超过10个标签

取值范围：

不涉及

description

String

参数解释：

工作台的描述，长度不超过512个字符

取值范围：

不涉及

icon

String

参数解释：

工作台的图标，在页面上选择一个图片图标作为工作台图标，限制像素为16X16，大小小于2KB。

取值范围：

不涉及

basic_properties

String

参数解释：

工作台的基础属性，用于展示工作台的基本配置信息

取值范围：

不涉及

domain_id

String

参数解释：

账号ID，用于明确当前资源所属账号，配置后可通过该ID查询账号下资产，可以通过调用API获取，也可以从控制台获取。获取账号ID

取值范围：

不涉及

region_id

String

参数解释：

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

取值范围：

不涉及

workspace_id

String

参数解释：

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

取值范围：

不涉及

create_time

String

参数解释：

工作台创建时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ+0800，例如2024-04-26T16:08:09Z+0800

取值范围：

不涉及

id

String

参数解释：

工作台ID，通常是UUID

取值范围：

不涉及

creator_id

String

参数解释：

工作台的创建人，通常为IAM用户ID

取值范围：

不涉及

creator_name

String

参数解释：

工作台的创建人名称，通常为当前用户的用户名

取值范围：

不涉及

is_deleted

Boolean

参数解释：

工作台的删除状态

取值范围：

• true：工作台已删除

• false：工作台未删除

is_favorite

Boolean

参数解释：

工作台的收藏状态

取值范围：

• true：工作台已收藏

• false：工作台未收藏

status

String

参数解释：

工作台发布状态

取值范围：

• PUBLISH：已发布

• UNPUBLISH：未发布

update_time

String

参数解释：

工作台更新时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ+0800，例如2024-04-26T16:08:09Z+0800

取值范围：

不涉及

modifier_id

String

参数解释：

工作台的修改人，通常为IAM的用户ID

取值范围：

不涉及

modifier_name

String

参数解释：

工作台的修改人名称，通常为用户名称

取值范围：

不涉及

error_code

String

参数解释：

错误码

取值范围：

Secmaster.000000~Secmaster.99999

error_msg

String

参数解释：

错误描述

取值范围：

无

error_code

String

参数解释：

错误码

取值范围：

Secmaster.000000~Secmaster.99999

error_msg

String

参数解释：

错误描述

取值范围：

无

200

请求成功

400

请求参数有误

500

请求失败