Query Plug-in Output Configuration
Function
Query Plug-in Output Configuration
URI
POST /v1/{domain_id}/agent-plugin/plugin-output
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
domain_id |
Yes |
String |
Indicates the tenant ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
[items] |
No |
Array of PluginPartQueryDTO objects |
Query Request Body |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
[items] |
Array of PluginPartQueryVOListAgentPluginOutputVO objects |
OK |
Parameter |
Type |
Description |
|---|---|---|
plugin_name |
String |
Plug-in |
display_name |
String |
Display Name |
data |
Array of data objects |
Viewing execution results |
Parameter |
Type |
Description |
|---|---|---|
unique_id |
String |
Unique ID |
plugin_name |
String |
Plug-in name |
version |
String |
Version |
workspace_id |
String |
Indicates the tenant ID. |
output_key |
String |
Name |
output_value |
String |
Value |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_msg |
String |
Error Message |
error_code |
String |
Error code. |
Example Requests
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-output
[ {
"plugin_name" : "official_shell_plugin",
"display_name" : "",
"plugin_attribution" : "official",
"version_attribution" : "formal"
} ]
Example Responses
Status code: 200
OK
[ {
"plugin_name" : "official_shell_plugin",
"display_name" : "",
"data" : [ ]
} ]
Status Codes
Status Code |
Description |
|---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
