Creating an Extension Draft Version

Function

This API is used to create an extension draft version.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
unique_id	No	String	Definition: Extension ID. Obtain the ID by calling the API for querying the extension details. unique_id indicates extension ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
icon_url	No	String	Definition: URL of the extension icon. Constraints: N/A Value range: N/A Default value: N/A
runtime_attribution	Yes	String	Definition: Running attribute. Constraints: N/A Value range: agent: agent-based running. agentless: agentless running. Default value: N/A
plugin_name	Yes	String	Definition: Extension name. Constraints: Enter only letters, digits, hyphens (-), and underscores (_). Value range: 1 to 50 characters. Default value: N/A
display_name	Yes	String	Definition: Display name. Constraints: Enter only letters, spaces, digits, hyphens (-), underscores (_), and periods (.). Value range: 1 to 50 characters. Default value: N/A
business_type	Yes	String	Definition: Service type. Constraints: Enter only letters, digits, hyphens (-), and underscores (_). Range: Build. Gate. Deploy. Test. Normal. Default value: N/A
business_type_display_name	Yes	String	Definition: Service type of the extension. Constraints: N/A Value range: Build. Check. Deploy. Test. Normal. Default value: N/A
description	Yes	String	Definition: Extension description. Constraints: N/A Value range: N/A Default value: N/A
is_private	No	Integer	Definition: Whether the extension is private. Constraints: N/A Value range: 1: private. 0: public. Default value: 0.
region	No	String	Definition: Region. Constraints: N/A Value range: N/A Default value: N/A
maintainers	No	String	Definition: Extension maintainer. Constraints: N/A Value range: N/A Default value: N/A
plugin_composition_type	No	String	Definition: Combination type of an extension. Constraints: N/A Range: single: single-step extension. multi: multi-step extension. Default value: N/A
manifest_version	No	String	Definition: It is used to distinguish data of the new and old versions. Constraints: N/A Value range: N/A Default value: N/A
version	Yes	String	Definition: Extension version number. Constraints: The value must be in the format of x.xx.xx (for example, 1.0.2), where x is a number ranging from 0 to 99. xx indicates the number following the dot (.). Each xx can be a one-digit or two-digit number. Value range: N/A Default value: N/A
version_description	No	String	Definition: Description of the minor version of the extension. Constraints: N/A Value range: N/A Default value: N/A
execution_info	Yes	execution_info object	Definition: Execution information. Constraints: N/A Value range: N/A Default value: N/A
output_info	No	Array of output_info objects	Definition: Extension output content. Constraints: N/A Value range: N/A Default value: N/A
input_info	No	Array of input_info objects	Definition: Input Information. Constraints: N/A Value range: N/A Default value: N/A

**Table 4** execution_info
Parameter	Mandatory	Type	Description
inner_execution_info	Yes	inner_execution_info object	Definition: Extension execution information. Constraints: N/A Value range: N/A Default value: N/A

**Table 5** inner_execution_info
Parameter	Mandatory	Type	Description
execution_type	No	String	Definition: Extension type. Constraints: N/A Value range: CONTAINER, ZIP, SHELL, or COMPOSITE. Default value: N/A
steps	No	Array of steps objects	Definition: Step list. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 6** steps
Parameter	Mandatory	Type	Description
name	No	String	Definition: Task name. Constraints: N/A Value range: N/A Default value: N/A
task	No	String	Definition: Task type. Constraints: N/A Value range: N/A Default value: N/A
variables	No	Map<String,Object>	Definition: Parameter information. Constraints: N/A Value range: N/A Default value: N/A
identifier	No	String	Definition: Identifier of a step. Constraints: N/A Range: N/A Default value: N/A

**Table 7** output_info
Parameter	Mandatory	Type	Description
name	No	String	Definition: Unique identifier of the extension output configuration. Constraints: N/A Value range: N/A Default value: N/A
version	No	String	Definition: Extension output version number. Constraints: N/A Value range: N/A Default value: N/A
description	No	String	Definition: Description of extension output configuration. Constraints: N/A Value range: N/A Default value: N/A
source	No	String	Definition: Source of extension output configuration. Constraints: N/A Value range: N/A Default value: N/A
type	No	String	Definition: Output type of extension output configuration. Constraints: N/A Value range: N/A Default value: N/A

**Table 8** input_info
Parameter	Mandatory	Type	Description
name	No	String	Definition: Unique identifier of the extension input configuration. Constraints: N/A Value range: N/A Default value: N/A
default_value	No	String	Definition: Default value of the extension input configuration. If this parameter is not set, the default value is displayed. Constraints: N/A Value range: N/A Default value: N/A
type	No	String	Definition: Input type of the extension input configuration. Constraints: N/A Value range: N/A Default value: N/A
validation	No	String	Definition: Regular expression verification rule of the input content in the extension input configuration. Constraints: N/A Value range: N/A Default value: N/A
layout_content	No	String	Definition: Style information. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
-	String	Definition: Whether the calling is successful. Value range: true: The calling is successful. false: The calling fails.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

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

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test",
  "business_type" : "Normal",
  "description" : "",
  "maintainers" : "",
  "business_type_display_name" : "General",
  "icon_url" : "",
  "version" : "0.0.1",
  "version_description" : "",
  "input_info" : [ ],
  "execution_info" : {
    "inner_execution_info" : {
      "execution_type" : "COMPOSITE",
      "steps" : [ {
        "task" : "official_shell_plugin",
        "name" : "Executing the Shell",
        "variables" : {
          "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
        }
      } ]
    }
  },
  "runtime_attribution" : "agent"
}