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

查询插件版本详情

功能介绍

查询插件版本详情

调用方法

请参见如何调用API

URI

GET /v1/{domain_id}/agent-plugin/detail

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID,用户的domainId。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

plugin_name

String

参数解释

扩展插件名称。

约束限制

仅支持输入大小写英文字母、数字、'-'、'_'。

取值范围

1到50位字符。

默认取值

不涉及。

version

String

参数解释

插件版本号。

约束限制

必须是类似 x.xx.xx 的格式,其中:x 是 1 到 2 位的数字(范围 0 到 99)。xx 是点后跟随的数字部分,且每部分可以是 1 位或 2 位数字。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

plugin_name

String

参数解释

扩展插件名称。

取值范围

1到50位字符。

display_name

String

参数解释

扩展插件展示名称。

取值范围

不涉及。

op_user

String

参数解释

扩展插件最后更新人。

取值范围

不涉及。

op_time

String

参数解释

扩展插件最后更新时间。

取值范围

不涉及。

version

String

参数解释

扩展插件版本号。

取值范围

不涉及。

unique_id

String

参数解释

扩展插件唯一ID。

取值范围

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

version_description

String

参数解释

扩展插件版本说明。

取值范围

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

version_attribution

String

参数解释

扩展插件版本属性。

取值范围

  • draft:草稿版本。

  • formal:正式版本。

plugin_composition_type

String

参数解释

用于标识扩展插件是否为多个step组成的组合插件。

取值范围

  • multi:组合插件。

  • single:非组合插件。

plugin_attribution

String

参数解释

扩展插件属性。

取值范围

  • custom:自定义插件。

  • official:官方插件。

  • published:已发布的发布商插件。

input_info

Array of input_info objects

参数解释

插件输入项详细信息。

取值范围

不涉及。

plugin_execution

PluginExecutionVO object

参数解释

扩展插件执行脚本信息。

取值范围

不涉及。

runtime_attribution

String

参数解释

运行属性。

取值范围

  • agent:运行基于流水线agent。

  • agentLess:运行无需流水线agent。

表5 input_info

参数

参数类型

描述

unique_id

String

参数解释

插件输入项唯一ID。

取值范围

不涉及。

name

String

参数解释

插件输入项名称。

取值范围

不涉及。

default_value

String

参数解释

插件输入项默认值。

取值范围

不涉及。

plugin_name

String

参数解释

扩展插件名称。

取值范围

不涉及。

version

String

参数解释

扩展插件版本号。

取值范围

不涉及。

type

String

参数解释

插件输入项类型。

取值范围

不涉及。

workspace_id

String

参数解释

租户ID,用户的domainId。

取值范围

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

front_data_prop

String

参数解释

前端展示数据属性。

取值范围

不涉及。

label

String

参数解释

插件输入的标签。

取值范围

不涉及。

description

String

参数解释

插件输入的描述。

取值范围

不涉及。

required

String

参数解释

是否必须。

取值范围

不涉及。

extend_prop

ExtensionExtendProp object

参数解释

扩展属性。

取值范围

不涉及。

validation

ExtensionValidation object

参数解释

插件输入项校验信息。

取值范围

不涉及。

layout_content

String

参数解释

插件输入项样式信息。

取值范围

不涉及。

表6 ExtensionExtendProp

参数

参数类型

描述

api_options

String

参数解释

API选项。

取值范围

不涉及。

api_type

String

参数解释

API类型。

取值范围

不涉及。

show_placeholder

String

参数解释

显示占位符。

取值范围

不涉及。

options

String

参数解释

选项。

取值范围

不涉及。

disabled_conditions

String

参数解释

禁用条件。

取值范围

不涉及。

visible_conditions

String

参数解释

可见条件。

取值范围

不涉及。

表7 ExtensionValidation

参数

参数类型

描述

required_message

String

参数解释

若插件输入项为必填而实际未填写时,提示的信息。

取值范围

不涉及。

regex

String

参数解释

插件输入项值的校验正则表达式。

取值范围

不涉及。

regex_message

String

参数解释

若插件输入项的值不满足regex中的正则表达式时,提示的信息。

取值范围

不涉及。

max_length

Integer

参数解释

插件输入项值的最大长度。

取值范围

不涉及。

min_length

Integer

参数解释

插件输入项值的最小长度。

取值范围

不涉及。

表8 PluginExecutionVO

参数

参数类型

描述

logic_id

String

参数解释

插件执行的逻辑id。

取值范围

不涉及。

plugin_name

String

参数解释

插件名称。

取值范围

不涉及。

version

String

参数解释

插件版本号。

取值范围

不涉及。

basic_instance_id

String

参数解释

插件的唯一实例id。

取值范围

不涉及。

workspace_id

String

参数解释

租户ID,用户的domainId。

取值范围

不涉及。

execution_type

String

参数解释

执行类型。

取值范围

  • CONTAINER

  • ZIP

  • SHELL

  • COMPOSITE

start_command

String

参数解释

执行命令,当execution_type为CONTAINER时返回此参数。

取值范围

不涉及。

stop_command

String

参数解释

停止命令,当execution_type为CONTAINER时返回此参数。

取值范围

不涉及。

env

String

参数解释

镜像信息,当execution_type为CONTAINER时返回此参数。

取值范围

不涉及。

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/detail?plugin_name=apie_test&version=0.0.4

响应示例

状态码:200

OK

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test222",
  "op_user" : "devcloud_devcloud_h00485561_01",
  "op_time" : "1699358542000",
  "version" : "0.0.4",
  "unique_id" : "036d51108a0b48eeb876fb6341ee7615",
  "version_description" : "",
  "version_attribution" : "formal",
  "plugin_composition_type" : "multi",
  "plugin_attribution" : "custom",
  "input_info" : [ ],
  "plugin_execution" : { },
  "runtime_attribution" : "agent"
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码