创建插件版本
功能介绍
创建插件版本
调用方法
请参见如何调用API。
URI
POST /v1/{domain_id}/agent-plugin/create
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
domain_id | 是 | String | 参数解释: 租户ID,用户的domainId。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
unique_id | 否 | String | 参数解释: 扩展插件唯一ID。可以通过查询插件版本详情接口,获取响应参数中unique_id。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
icon_url | 否 | String | 参数解释: 插件展示图标URL。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
runtime_attribution | 是 | String | 参数解释: 运行属性。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
plugin_name | 是 | String | 参数解释: 插件名。 约束限制: 仅支持输入大小写英文字母、数字、'-'、'_'。 取值范围: 1到50位字符。 默认取值: 不涉及。 |
display_name | 是 | String | 参数解释: 展示名。 约束限制: 仅支持输入大小写英文字母、中文、空格、数字、'-'、'_'、'.'。 取值范围: 1到50位字符。 默认取值: 不涉及。 |
business_type | 是 | String | 参数解释: 业务类型。 约束限制: 仅支持输入大小写英文字母、数字、'-'、'_'。 取值范围:
默认取值: 不涉及。 |
business_type_display_name | 是 | String | 参数解释: 插件业务类型展示名。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
description | 是 | String | 参数解释: 插件描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_private | 否 | Integer | 参数解释: 是否私有插件。 约束限制: 不涉及。 取值范围:
默认取值: 0。 |
region | 否 | String | 参数解释: 局点。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
maintainers | 否 | String | 参数解释: 插件维护者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
plugin_composition_type | 否 | String | 参数解释: 插件的组合类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
manifest_version | 否 | String | 参数解释: 用于区分新旧版数据版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
version | 是 | String | 参数解释: 插件版本号。 约束限制: 必须是类似 x.xx.xx(例如:1.0.2) 的格式,其中:x 是 1 到 2 位的数字(范围 0 到 99)。xx 是点后跟随的数字部分,且每部分可以是 1 位或 2 位数字。 取值范围: 不涉及。 默认取值: 不涉及。 |
version_description | 否 | String | 参数解释: 插件小版本版本号说明。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
execution_info | 是 | execution_info object | 参数解释: 执行信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
output_info | 否 | Array of output_info objects | 参数解释: 插件输出相关内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
input_info | 否 | Array of input_info objects | 参数解释: 输入信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
inner_execution_info | 是 | inner_execution_info object | 参数解释: 插件执行信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
execution_type | 否 | String | 参数解释: 插件类型。 约束限制: 不涉及。 取值范围: CONTAINER, ZIP, SHELL, COMPOSITE。 默认取值: 不涉及。 |
steps | 否 | Array of steps objects | 参数解释: 步骤列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 否 | String | 参数解释: 任务名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
task | 否 | String | 参数解释: 任务类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
variables | 否 | Map<String,Object> | 参数解释: 参数信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
identifier | 否 | String | 参数解释: step的标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 否 | String | 参数解释: 插件输出配置的唯一标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
version | 否 | String | 参数解释: 插件输出版本号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
description | 否 | String | 参数解释: 插件输出配置的描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
source | 否 | String | 参数解释: 插件输出配置的源。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
type | 否 | String | 参数解释: 插件输出配置的输出类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 否 | String | 参数解释: 插件输入配置的唯一标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
default_value | 否 | String | 参数解释: 插件输入配置的默认值,未填写时默认显示。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
type | 否 | String | 参数解释: 插件输入配置的输入类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
validation | 否 | String | 参数解释: 插件输入配置的输入内容的正则校验规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
layout_content | 否 | String | 参数解释: 样式信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
- | String | 参数解释: 是否创建成功。 取值范围:
|
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/create
{
"plugin_name" : "apie_test",
"display_name" : "apie_test",
"version" : "0.0.2",
"version_description" : "",
"description" : "",
"unique_id" : "ab43c83c2ae04000afd039ad894e953b",
"business_type" : "Normal",
"business_type_display_name" : "通用",
"icon_url" : "",
"runtime_attribution" : "agent",
"input_info" : [ ],
"execution_info" : {
"inner_execution_info" : {
"execution_type" : "COMPOSITE",
"steps" : [ {
"task" : "official_shell_plugin",
"name" : "执行Shell",
"identifier" : "16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a",
"variables" : {
"OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
}
} ]
}
}
} 响应示例
状态码:200
OK
true
状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
错误码
请参见错误码。

