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

分页查询可选插件列表

功能介绍

分页查询可选插件列表

调用方法

请参见如何调用API。

URI

POST /v1/{domain_id}/relation/plugins

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释：

租户ID，用户的domainId。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

limit

是

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 请求Body参数

参数

是否必选

参数类型

描述

use_condition

否

String

参数解释：

用于区分插件为流水线可使用/模板可使用。

约束限制：

不涉及。

取值范围：

  • pipeline：流水线可使用。

  • template：模板可使用。

默认取值：

不涉及。

input_repo_type

否

String

参数解释：

用于区分源的代码仓类型codehub/gitlab/github等。

约束限制：

不涉及。

取值范围：

  • codehub。

  • gitee。

  • github。

  • gitcode。

  • gitlab。

默认取值：

不涉及。

input_source_type

否

String

参数解释：

用于区分单源/多源的情况。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

business_type

否

String

参数解释：

业务类型。

约束限制：

不涉及。

取值范围：

  • Build。

  • Gate。

  • Deploy。

  • Test。

  • Normal。

默认取值：

不涉及。

regex_name

否

String

参数解释：

匹配名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

offset

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

limit

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

total

Integer

参数解释：

总条目数量。

取值范围：

大于等于0。

data

Array of data objects

参数解释：

结果集。

取值范围：

不涉及。
表6 data

参数

参数类型

描述

business_type

String

参数解释：

业务类型。

取值范围：

  • Build。

  • Gate。

  • Deploy。

  • Test。

  • Normal。

display_name

String

参数解释：

展示名。

取值范围：

不涉及。

unique_id

String

参数解释：

唯一ID。

取值范围：

不涉及。

editable

Boolean

参数解释：

是否可编辑。

取值范围：

  • true：可编辑。

  • false：不可编辑。

removable

Boolean

参数解释：

是否可移除。

取值范围：

  • true：可移除。

  • false：不可移除。

cloneable

Boolean

参数解释：

是否可复制。

取值范围：

  • true：可复制。

  • false：不可复制。

disabled

Boolean

参数解释：

是否禁用。

取值范围：

  • true：禁用。

  • false：未禁用。

addables

Array of Map<String,Boolean> objects

参数解释：

是否可添加。

取值范围：

不涉及。

conditions

Array of strings

参数解释：

条件。

取值范围：

不涉及。

plugins_list

Array of plugins_list objects

参数解释：

插件列表。

取值范围：

不涉及。
表7 plugins_list

参数

参数类型

描述

unique_id

String

参数解释：

唯一ID。

取值范围：

不涉及。

display_name

String

参数解释：

展示名。

取值范围：

不涉及。

plugin_name

String

参数解释：

插件名。

取值范围：

不涉及。

disabled

Boolean

参数解释：

是否禁用。

取值范围：

  • true：禁用。

  • false：未禁用。

group_name

String

参数解释：

组名。

取值范围：

不涉及。

group_type

String

参数解释：

组类型。

取值范围：

不涉及。

standard

Boolean

参数解释：

是否标准化的插件。

取值范围：

  • true：是。

  • false：否。

db_record_name

String

参数解释：

插件记录名称。

取值范围：

不涉及。

plugin_attribution

String

参数解释：

插件属性。

取值范围：

不涉及。

plugin_composition_type

String

参数解释：

组合插件。

取值范围：

  • single：单step插件。

  • multi：组合插件。

runtime_attribution

String

参数解释：

插件运行属性。

取值范围：

不涉及。

all_steps

Array of all_steps objects

参数解释：

基础插件列表。

取值范围：

不涉及。

description

String

参数解释：

插件描述。

取值范围：

不涉及。

version_attribution

String

参数解释：

插件版本属性。

取值范围：

不涉及。

icon_url

String

参数解释：

插件图标URL。

取值范围：

不涉及。

multi_step_editable

Integer

参数解释：

插件可编辑。

取值范围：

不涉及。

location

String

参数解释：

插件地址。

取值范围：

不涉及。

publisher_unique_id

String

参数解释：

插件发布商ID。

取值范围：

不涉及。

manifest_version

String

参数解释：

插件版本。

取值范围：

不涉及。
表8 all_steps

参数

参数类型

描述

plugin_name

String

参数解释：

插件名。

取值范围：

不涉及。

display_name

String

参数解释：

展示名。

取值范围：

不涉及。

version

String

参数解释：

版本。

取值范围：

不涉及。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugins?limit=4&offset=0

{
  "input_repo_type" : "codehub",
  "input_source_type" : "single",
  "use_condition" : "pipeline",
  "business_type" : "",
  "regex_name" : ""
}

响应示例

状态码：200

OK

{
  "offset" : 0,
  "limit" : 4,
  "total" : 246,
  "data" : {
    "plugins_list" : [ {
      "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f",
      "display_name" : "1030测试",
      "plugin_name" : "132132132231",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "84b6d96b240644b8a9c529981759a6d2",
      "display_name" : "插件发布",
      "plugin_name" : "create_test_2",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "816c527f9ba34904b84823718633ecdf",
      "display_name" : "插件创建测试",
      "plugin_name" : "create_test.plugin_draft",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "draft",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "6e7a5fe5e7214ce6858087357a4bf79b",
      "display_name" : "插件版本描述测试",
      "plugin_name" : "plugin_version_test",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "插件版本描述测试",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    } ],
    "display_name" : "代码检查",
    "business_type" : "Gate",
    "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12",
    "conditions" : null,
    "editable" : false,
    "removable" : false,
    "cloneable" : false,
    "disabled" : false
  }
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 扩展插件管理