Creating a Plug-in Version
Function
Creating a Plug-in Version
URI
POST /v1/{domain_id}/agent-plugin/create
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
TenantID |
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 |
---|---|---|---|
unique_id |
No |
String |
Unique ID |
icon_url |
No |
String |
Icon URL |
runtime_attribution |
No |
String |
Operating attributes |
plugin_name |
No |
String |
Plug-in |
display_name |
No |
String |
Display Name |
business_type |
No |
String |
Service Type |
business_type_display_name |
No |
String |
Display Name of Service Type |
description |
No |
String |
Description |
is_private |
No |
Integer |
Private |
region |
No |
String |
Site |
maintainers |
No |
String |
Maintainer |
version |
No |
String |
Version |
version_description |
No |
String |
Version Description |
execution_info |
No |
execution_info object |
Execution Information |
input_info |
No |
Array of input_info objects |
Entering information |
Response Parameters
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/create { "plugin_name" : "apie_test", "display_name" : "apie_test", "version" : "0.0.2", "version_description" : "", "description" : "", "unique_id" : "ab43c83c2ae04000afd039ad894e953b", "business_type" : "Normal", "business_type_display_name" : "General", "icon_url" : "", "runtime_attribution" : "agent", "input_info" : [ ], "execution_info" : { "inner_execution_info" : { "execution_type" : "COMPOSITE", "steps" : [ { "task" : "official_shell_plugin", "name" : "Executing the Shell", "identifier" : "16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] } } }
Example Responses
Status code: 200
Indicates whether the invoking is successful.
true
Status Codes
Status Code |
Description |
---|---|
200 |
Indicates whether the invoking is successful. |
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.