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

查询插件输出配置

功能介绍

查询插件输出配置

调用方法

请参见如何调用API。

URI

POST /v1/{domain_id}/agent-plugin/plugin-output

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

否

Array of PluginPartQueryDTO objects

参数解释:

查询插件输出请求体。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 PluginPartQueryDTO

参数

是否必选

参数类型

描述

plugin_name

是

String

参数解释:

插件名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

display_name

是

String

参数解释:

展示名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

version

是

String

参数解释:

版本号。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

plugin_attribution

是

String

参数解释:

插件属性。

约束限制:

不涉及。

取值范围:

  • custom:自定义插件。

  • official:官方插件。

默认取值:

不涉及。

version_attribution

否

String

参数解释:

版本属性。

约束限制:

不涉及。

取值范围:

  • draft:草稿版本。

  • formal:正式版本。

默认取值:

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of PluginVersionPartQueryVOListAgentPluginOutputVO objects

参数解释:

插件输出配置列表。

约束限制:

不涉及。

表6 PluginVersionPartQueryVOListAgentPluginOutputVO

参数

参数类型

描述

plugin_name

String

参数解释:

扩展插件名称。

取值范围:

不涉及。

display_name

String

参数解释:

扩展插件展示名称。

取值范围:

不涉及。

version

String

参数解释:

扩展插件版本号。

取值范围:

不涉及。

data

Array of data objects

参数解释:

扩展插件输出详细信息。

取值范围:

不涉及。

表7 data

参数

参数类型

描述

basic_instance_id

String

参数解释:

唯一ID。

取值范围:

不涉及。

workspace_id

String

参数解释:

租户ID,用户的domainId。

取值范围:

不涉及。

plugin_name

String

参数解释:

扩展插件名称。

取值范围:

不涉及。

name

String

参数解释:

展示名称。

取值范围:

不涉及。

version

String

参数解释:

扩展插件版本号。

取值范围:

不涉及。

type

String

参数解释:

类型。

取值范围:

不涉及。

description

String

参数解释:

描述。

取值范围:

不涉及。

source

String

参数解释:

源。

取值范围:

不涉及。

prop

OutputPropVO object

参数解释:

扩展属性。

取值范围:

不涉及。

表8 OutputPropVO

参数

参数类型

描述

group

String

参数解释:

分组名。

取值范围:

不涉及。

default_value

String

参数解释:

默认值。

取值范围:

不涉及。

display_type

String

参数解释:

展示类型。

取值范围:

不涉及。

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-output

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "",
  "plugin_attribution" : "official",
  "version_attribution" : "formal"
} ]

响应示例

状态码:200

OK

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "",
  "data" : [ ]
} ]

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。