查询插件输入配置
功能介绍
查询插件输入配置
调用方法
请参见如何调用API。
URI
POST /v1/{domain_id}/agent-plugin/plugin-input
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 租户ID,用户的domainId。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 否 | Array of PluginPartQueryDTO objects | 参数解释: 查询插件输入请求体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| plugin_name | 是 | String | 参数解释: 插件名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| display_name | 是 | String | 参数解释: 展示名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| version | 是 | String | 参数解释: 版本号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| plugin_attribution | 是 | String | 参数解释: 插件属性。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| version_attribution | 否 | String | 参数解释: 版本属性。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of PluginPartQueryVOListAgentPluginInputVO objects | 参数解释: 插件输入配置列表。 约束限制: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| plugin_name | String | 参数解释: 扩展插件名称。 取值范围: 1到50位字符。 |
| display_name | String | 参数解释: 扩展插件展示名称。 取值范围: 不涉及。 |
| data | Array of data objects | 参数解释: 插件输入项详细信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| unique_id | String | 参数解释: 插件输入项唯一ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 插件输入项名称。 取值范围: 不涉及。 |
| default_value | String | 参数解释: 插件输入项默认值。 取值范围: 不涉及。 |
| plugin_name | String | 参数解释: 插件名称。 取值范围: 不涉及。 |
| version | String | 参数解释: 插件版本。 取值范围: 不涉及。 |
| type | String | 参数解释: 插件输入项类型。 取值范围: 不涉及。 |
| workspace_id | String | 参数解释: 租户ID,用户的domainId。 取值范围: 32位字符,由数字和字母组成。 |
| validation | ExtensionValidation object | 参数解释: 插件输入项校验信息。 取值范围: 不涉及。 |
| layout_content | String | 参数解释: 插件输入项样式信息。 取值范围: 不涉及。 |
| extend_prop | ExtensionExtendProp object | 参数解释: 插件输入扩展信息。 取值范围: 不涉及。 |
| front_data_prop | String | 参数解释: 前端渲染使用的数据信息。 取值范围: 不涉及。 |
| label | String | 参数解释: 标签。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述。 取值范围: 不涉及。 |
| required | String | 参数解释: 是否必须。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| required_message | String | 参数解释: 若插件输入项为必填而实际未填写时,提示的信息。 取值范围: 不涉及。 |
| regex | String | 参数解释: 插件输入项值的校验正则表达式。 取值范围: 不涉及。 |
| regex_message | String | 参数解释: 若插件输入项的值不满足regex中的正则表达式时,提示的信息。 取值范围: 不涉及。 |
| max_length | Integer | 参数解释: 插件输入项值的最大长度。 取值范围: 不涉及。 |
| min_length | Integer | 参数解释: 插件输入项值的最小长度。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| api_options | String | 参数解释: API选项。 取值范围: 不涉及。 |
| api_type | String | 参数解释: API类型。 取值范围: 不涉及。 |
| show_placeholder | String | 参数解释: 显示占位符。 取值范围: 不涉及。 |
| options | String | 参数解释: 选项。 取值范围: 不涉及。 |
| disabled_conditions | String | 参数解释: 禁用条件。 取值范围: 不涉及。 |
| visible_conditions | String | 参数解释: 可见条件。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-input
[ {
"plugin_name" : "official_shell_plugin",
"display_name" : "执行Shell",
"version" : "0.0.2",
"plugin_attribution" : "official",
"version_attribution" : "formal"
} ] 响应示例
状态码:200
OK
[ {
"plugin_name" : "official_shell_plugin",
"display_name" : "执行Shell",
"data" : [ {
"unique_id" : "aac7e571b0d4462ba7962ce1735c4ec3",
"name" : "OFFICIAL_SHELL_SCRIPT_INPUT",
"default_value" : "",
"plugin_name" : "official_shell_plugin",
"version" : "0.0.2",
"type" : "shell",
"workspace_id" : "*",
"layout_content" : null,
"front_data_prop" : null,
"label" : "Shell命令",
"description" : "用户在此处输入Shell命令",
"required" : "true",
"extend_prop" : {
"api_options" : null,
"api_type" : null,
"options" : null,
"disabled_conditions" : null,
"visible_conditions" : null
},
"validation" : {
"required_message" : null,
"regex" : null,
"regex_message" : null,
"max_length" : null,
"min_length" : null
}
} ]
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。