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

Creating a Plug-in Draft Version

Function

Creating a Plug-in Draft Version

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the tenant ID.

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-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",
        "identifier" : "16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb",
        "variables" : {
          "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
        }
      } ]
    }
  },
  "runtime_attribution" : "agent"
}

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.