Querying Plug-in Version Details

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

View PDF

Function

URI

GET /v1/{domain_id}/agent-plugin/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Indicates the tenant ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
plugin_name	No	String	Plug-in
version	No	String	Version

Request Parameters

**Table 3** 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).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
plugin_name	String	Plug-in
display_name	String	Display Name
op_user	String	Operator
op_time	String	Operated
version	String	Version
unique_id	String	Unique ID
version_description	String	Version Description
version_attribution	String	Version Attribute
plugin_composition_type	String	Combination Plug-in Type
plugin_attribution	String	Plug-in Attribute
input_info	Array of input_info objects	Entering information
plugin_execution	Object	Execution Information
runtime_attribution	String	Operating attributes

**Table 5** input_info
Parameter	Type	Description
unique_id	String	Unique ID
name	String	Name
default_value	String	Default Value
plugin_name	String	Plug-in
version	String	Version
type	String	Type
workspace_id	String	TenantID
validation	ExtensionValidation object	Verification
layout_content	String	Style Information

**Table 6** ExtensionValidation
Parameter	Type	Description
required_message	String	Message
regex	String	Regex
regex_message	String	Regular Message
max_length	Integer	Maximum length
min_length	Integer	Minimum Length

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/detail?plugin_name=apie_test&version=0.0.4

Example Responses

Status code: 200

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test222",
  "op_user" : "devcloud_devcloud_h00485561_01",
  "op_time" : "1699358542000",
  "version" : "0.0.4",
  "unique_id" : "036d51108a0b48eeb876fb6341ee7615",
  "version_description" : "",
  "version_attribution" : "formal",
  "plugin_composition_type" : "multi",
  "plugin_attribution" : "custom",
  "input_info" : [ ],
  "plugin_execution" : {
    "logic_id" : "",
    "plugin_name" : "apie_test",
    "version" : "0.0.4",
    "basic_instance_id" : "036d51108a0b48eeb876fb6341ee7615",
    "workspace_id" : "ce8df55870164338a72d7e828a966a2a",
    "execution_type" : "COMPOSITE",
    "steps" : [ {
      "name" : "Executing the Shell",
      "task" : "official_shell_plugin",
      "variables" : {
        "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
      }
    } ]
  },
  "runtime_attribution" : "agent"
}