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

查询基础插件详情

功能介绍

查询基础插件详情

调用方法

请参见如何调用API。

URI

GET /v3/{domain_id}/extension/detail

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

plugin_name

是

String

参数解释:

插件名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

version

是

String

参数解释:

插件版本。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

type

String

参数解释:

插件类型。

取值范围:

不涉及。

name

String

参数解释:

插件名称。

取值范围:

不涉及。

friendly_name

String

参数解释:

插件展示名。

取值范围:

不涉及。

category

String

参数解释:

业务类型。

取值范围:

不涉及。

description

String

参数解释:

插件描述。

取值范围:

不涉及。

version

String

参数解释:

插件版本。

取值范围:

不涉及。

version_description

String

参数解释:

插件版本说明。

取值范围:

不涉及。

inputs

Array of inputs objects

参数解释:

输入信息。

取值范围:

不涉及。

data_source_bindings

Array of data_source_bindings objects

参数解释:

数据源绑定信息。

取值范围:

不涉及。

outputs

Array of outputs objects

参数解释:

输出信息。

取值范围:

不涉及。

execution

execution object

参数解释:

插件类型。

取值范围:

不涉及。

表5 inputs

参数

参数类型

描述

name

String

参数解释:

名称。

取值范围:

不涉及。

type

String

参数解释:

类型。

取值范围:

不涉及。

label

String

参数解释:

标签。

取值范围:

不涉及。

description

String

参数解释:

说明。

取值范围:

不涉及。

default_value

String

参数解释:

默认值。

取值范围:

不涉及。

required

Boolean

参数解释:

是否必填。

取值范围:

  • true:必填。

  • false:非必填。

extend_prop

ExtensionExtendProp object

参数解释:

扩展属性。

取值范围:

不涉及。

validation

ExtensionValidation object

参数解释:

验证详情。

取值范围:

不涉及。

表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 data_source_bindings

参数

参数类型

描述

target

String

参数解释:

目标地址。

取值范围:

不涉及。

endpointId

String

参数解释:

扩展点id。

取值范围:

不涉及。

data_source_name

String

参数解释:

数据源绑定名称。

取值范围:

不涉及。

表9 outputs

参数

参数类型

描述

name

String

参数解释:

名称。

取值范围:

不涉及。

type

String

参数解释:

类型。

取值范围:

不涉及。

description

String

参数解释:

描述。

取值范围:

不涉及。

prop

Map<String,String>

参数解释:

扩展信息定义。

取值范围:

不涉及。

表10 execution

参数

参数类型

描述

target

String

参数解释:

执行文件位置。

取值范围:

不涉及。

type

String

参数解释:

插件类型。

取值范围:

不涉及。

sha256

String

参数解释:

sha256。

取值范围:

不涉及。

状态码:400

表11 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/detail?plugin_name=basic-CTS&version=2.3.5

响应示例

状态码:200

OK

{
  "type" : "Task",
  "name" : "basic-CTS",
  "category" : "Test",
  "description" : "",
  "version" : "2.3.5",
  "inputs" : [ {
    "name" : "SHELL_PLUGIN",
    "type" : "input",
    "label" : "单行输入框",
    "description" : "Sample String",
    "required" : true,
    "validation" : {
      "required_message" : null,
      "regex" : null,
      "regex_message" : null,
      "max_length" : null,
      "min_length" : null
    },
    "default_value" : "",
    "extend_prop" : {
      "api_options" : null,
      "api_type" : null,
      "options" : null,
      "disabled_conditions" : null,
      "visible_conditions" : null
    }
  } ],
  "outputs" : [ {
    "name" : "problem",
    "type" : "output",
    "description" : "记录问题个数"
  } ],
  "execution" : {
    "type" : "scripts/test.sh",
    "target" : "Shell",
    "sha256" : "4fa52dab3fb72847e4da5f00295a96fce8892f301d384efe9b776aa1731ba8f0"
  },
  "friendly_name" : "基础插件-CTS2",
  "version_description" : "执行Shell命令"
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。