Creating a Plug-in Version

Updated on 2023-11-28 GMT+08:00

View PDF

Function

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	TenantID

Request Parameters

**Table 2** Request header 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).

**Table 3** Request body parameters
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

**Table 4** execution_info
Parameter	Mandatory	Type	Description
inner_execution_info	No	Object	Execution Information

**Table 5** input_info
Parameter	Mandatory	Type	Description
name	No	String	Name
default_value	No	String	Default Value
type	No	String	Input Type
validation	No	String	Verification
layout_content	No	String	Style Information

Response Parameters

Status code: 400

**Table 6** Response body parameters
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"
        }
      } ]
    }
  }
}