查询模块列表

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

offset

否

Integer

request offset, from 0

limit

否

Integer

参数解释：

数据量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sort_key

否

String

参数解释：

排序字段，

• create_time：创建时间

• update_time：更新时间

约束限制：

不涉及

取值范围：

• create_time

• update_time

默认取值：

create_time

sort_dir

否

String

参数解释：

排序顺序

• ASC：升序

• DESC：降序

约束限制：

不涉及

取值范围：

• ASC：升序

• DESC：降序

默认取值：

DESC

module_type

否

String

模块类型，tab/section

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

默认取值：

不涉及

X-request-id

String

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

code

String

错误码

data

Array of ModuleDetailInfo objects

数据列表

message

String

错误信息

offset

Integer

页码

request_id

String

请求ID

limit

Integer

数量

success

Boolean

是否响应成功

total

Integer

总数

cloud_pack_id

String

订阅包id

cloud_pack_name

String

订阅包名称

cloud_pack_version

String

订阅包版本

create_time

String

Create time

creator_id

String

Creator id value

description

String

描述信息

en_description

String

英文描述

id

String

IID

module_json

String

模块相关信息，当module为指标卡片时，items中的字段id也为指标id

name

String

名称

en_name

String

英文名称

project_id

String

租户ID

workspace_id

String

工作空间ID

update_time

String

更新时间

thumbnail

String

模块缩略图

module_type

String

模块类型,tab/section

tag

String

模块标签

is_built_in

Boolean

是否为系统模块

data_query

String

数据查询方式

boa_version

String

BOA底座版本

version

String

安全云脑版本

X-request-id

String

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

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

200

Response of listing module informations

400

Error response