更新时间:2026-01-09 GMT+08:00

创建基础插件

功能介绍

创建基础插件

调用方法

请参见如何调用API

URI

POST /v3/{domain_id}/extension/info/add

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID,用户的domainId。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

unique_id

String

参数解释

扩展插件UUID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

icon_url

String

参数解释

扩展插件图标URL。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

runtime_attribution

String

参数解释

运行属性。

约束限制

不涉及。

取值范围

  • agent:基于agent运行。

  • agentless:无需agent运行。

默认取值

不涉及。

plugin_name

String

参数解释

扩展插件唯一标识。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

display_name

String

参数解释

扩展插件展示名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

business_type

String

参数解释

扩展插件业务类型。

约束限制

不涉及。

取值范围

  • Build。

  • Gate。

  • Deploy。

  • Test。

  • Normal。

默认取值

不涉及。

business_type_display_name

String

参数解释

扩展插件业务类型展示名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

扩展插件描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_private

Integer

参数解释

是否私有。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

region

String

参数解释

局点。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

maintainers

String

参数解释

维护者。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

plugin_composition_type

String

参数解释

标识是否为多个step组成的组。

约束限制

不涉及。

取值范围

  • single:单step插件。

  • multi:组合插件。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

-

String

参数解释

是否调用成功。

取值范围

  • true:调用成功。

  • false:调用失败。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

POST https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/info/add

{
  "plugin_name" : "basic_plugin",
  "display_name" : "basic_plugin",
  "business_type" : "Normal",
  "description" : "",
  "maintainers" : "",
  "business_type_display_name" : "通用",
  "icon_url" : "",
  "plugin_composition_type" : "single"
}

响应示例

状态码:200

OK

true

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码