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

查询插件定义列表 - ListComponents

功能介绍

查询插件定义列表

调用方法

请参见如何调用API

授权信息

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

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/components

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Integer

参数解释:

数据量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

String

参数解释:

响应的返回码

约束限制:

不涉及

total

Integer

参数解释:

数据总条数

约束限制:

不涉及

size

Integer

参数解释:

当前页大小

约束限制:

不涉及

page

Integer

参数解释:

当前页码

约束限制:

不涉及

message

String

参数解释:

响应的错误信息

约束限制:

不涉及

success

Boolean

参数解释:

是否响应成功

约束限制:

不涉及

request_id

String

参数解释:

请求id

约束限制:

不涉及

data

Array of ComponentInfo objects

列表

表4 ComponentInfo

参数

参数类型

描述

id

String

插件ID

name

String

插件名称

dev_language

String

插件的实现语言

dev_language_version

String

插件的实现语言版本

alliance_id

String

插件集ID

alliance_name

String

插件集名称

description

String

插件描述

logo

String

插件图标

label

String

插件的标签信息

create_time

String

创建时间

update_time

String

更新时间

creator_name

String

创建者名称

operate_history

Array of operate_history objects

插件操作历史

versions

Array of ComponentVersionInfo objects

插件版本信息,兼容之前java的以插件为粒度的版本

component_type

String

插件类型,subscribe/custom/system,对应订阅/自定义开发/系统内置

表5 operate_history

参数

参数类型

描述

operate_name

String

操作

operate_time

String

时间点

表6 ComponentVersionInfo

参数

参数类型

描述

id

String

版本ID

version_num

String

版本号

version_desc

String

版本描述

status

String

状态

package_name

String

插件所属包

component_attachment_id

String

插件的附件id

sub_version_id

String

订阅版本id

connection_config

String

操作连接配置List

状态码:400

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

响应成功返回对象

400

响应错误返回对象

错误码

请参见错误码

相关文档