文档首页/ 流水线 CodeArts Pipeline/ API参考（联盟区域）/ API/ 扩展插件管理/ 查询基础插件列表
更新时间：2026-01-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询基础插件列表

功能介绍

查询基础插件列表

调用方法

请参见如何调用API。

URI

GET /v1/{domain_id}/relation/plugin/single

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释：

租户ID，用户的domainId。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

attribution

是

String

参数解释：

插件属性。

约束限制：

不涉及。

取值范围：

  • official：官方发布的基础插件。

  • published：二方发布的基础插件。

默认取值：

不涉及。

offset

是

String

参数解释：

偏移量，表示从此偏移量开始查询需配合limit一起使用。

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

limit

是

String

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

1到100。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

offset

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

取值范围：

offset大于等于0。

limit

Integer

参数解释：

每次查询的条目数量。

取值范围：

大于等于0。

total

Integer

参数解释：

本次查询的静态规则总数。

取值范围：

不涉及。

data

Array of data objects

参数解释：

结果集。

取值范围：

不涉及。
表5 data

参数

参数类型

描述

name

String

参数解释：

扩展插件唯一标识。

取值范围：

不涉及。

display_name

String

参数解释：

扩展插件在插件市场和流水线显示的名称。

取值范围：

不涉及。

plugin_attribution

String

参数解释：

标识是否为官方插件。

取值范围：

不涉及。

icon_url

String

参数解释：

图标URL。

取值范围：

不涉及。

description

String

参数解释：

插件描述。

取值范围：

不涉及。

publisher_id

String

参数解释：

发布商ID。

取值范围：

不涉及。

manifest_version

String

参数解释：

版本。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugin/single?limit=10&offset=0&attribution=official

响应示例

状态码：200

OK

{
  "offset" : 0,
  "limit" : 10,
  "total" : 3,
  "data" : [ {
    "name" : "official_shell_plugin",
    "display_name" : "执行Shell",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "用于执行用户Shell命令",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "test_plugin_230725",
    "display_name" : "测试新版插件流程2307251",
    "plugin_attribution" : "official",
    "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=test_plugin_230725-b7b10ddbbae14356ab16d649a43d7776-20210811-153521(WeLinkPC).png-ce8df55870164338a72d7e828a966a2a&icon_type=plugin",
    "description" : "这里是描述",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "official_git_clone",
    "display_name" : "official_git_clone",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "下载流水线源中配置的代码库。",
    "publisher_id" : null,
    "manifest_version" : null
  } ]
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 扩展插件管理