Listing add-ons

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

View PDF

Function

Listing add-ons

URI

POST /v1/{domain_id}/agent-plugin/query-all

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Offset
limit	No	String	Size

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).

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
plugin_name	No	String	Plug-in
regex_name	No	String	Name
maintainer	No	String	Maintainer
business_type	No	Array of strings	Service Type
plugin_attribution	No	String	Attribute

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
offset	Integer	Offset
limit	Integer	Size
total	Integer	Total number.
data	Array of PluginBasicVO objects	Viewing execution results

**Table 6** PluginBasicVO
Parameter	Type	Description
plugin_name	String	Plug-in
display_name	String	Display Name
version	String	Version
version_description	String	Change History
description	String	Description
version_attribution	String	Version Attribute
unique_id	String	Unique ID
op_user	String	Operator
op_time	String	Operated
plugin_composition_type	String	Combination Type
plugin_attribution	String	Attribute
workspace_id	String	Indicates the tenant ID.
business_type	String	Service Type
business_type_display_name	String	Display Name of Service Type
maintainers	String	Maintainer
icon_url	String	Icon URL
refer_count	Integer	Reference Times
usage_count	Integer	Usage Times
runtime_attribution	String	Operating attributes
active	Integer	Whether to activate a job

Status code: 400

**Table 7** 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/query-all?offset=0&limit=3

{
  "plugin_name" : "",
  "maintainer" : "",
  "business_type" : [ "Build", "Gate", "Deploy", "Test", "Normal" ],
  "plugin_attribution" : "custom"
}

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 3,
  "total" : 32,
  "data" : [ {
    "plugin_name" : "basic_plugin",
    "display_name" : "basic_plugin",
    "version" : "",
    "version_description" : null,
    "description" : "",
    "version_attribution" : "init",
    "unique_id" : "83edd75a8be5406496d9fc63ce6c984e",
    "op_user" : "devcloud_devcloud_h00485561_01",
    "op_time" : "1699355741000",
    "plugin_composition_type" : "single",
    "plugin_attribution" : "custom",
    "workspace_id" : "ce8df55870164338a72d7e828a966a2a",
    "business_type" : "Normal",
    "business_type_display_name" : "General",
    "maintainers" : "",
    "icon_url" : "",
    "refer_count" : null,
    "usage_count" : null,
    "runtime_attribution" : "agent",
    "active" : 1
  }, {
    "plugin_name" : "apie_test",
    "display_name" : "apie_test",
    "version" : "0.0.2",
    "version_description" : "",
    "description" : "",
    "version_attribution" : "formal",
    "unique_id" : "8287cdb4908741f889ed307d265677d1",
    "op_user" : "devcloud_devcloud_h00485561_01",
    "op_time" : "1699354371000",
    "plugin_composition_type" : "multi",
    "plugin_attribution" : "custom",
    "workspace_id" : "ce8df55870164338a72d7e828a966a2a",
    "business_type" : "Normal",
    "business_type_display_name" : "General",
    "maintainers" : "",
    "icon_url" : "",
    "refer_count" : 0,
    "usage_count" : null,
    "runtime_attribution" : "agent",
    "active" : 0
  }, {
    "plugin_name" : "asdasadsas",
    "display_name" : "dasddasas",
    "version" : "",
    "version_description" : null,
    "description" : "",
    "version_attribution" : "init",
    "unique_id" : "4fccd9e61c424d1298cc9e5f71e7c9e7",
    "op_user" : "devcloud_devcloud_h00485561_01",
    "op_time" : "1699325617000",
    "plugin_composition_type" : "single",
    "plugin_attribution" : "custom",
    "workspace_id" : "ce8df55870164338a72d7e828a966a2a",
    "business_type" : "Gate",
    "business_type_display_name" : "CodeCheck",
    "maintainers" : "",
    "icon_url" : "",
    "refer_count" : null,
    "usage_count" : null,
    "runtime_attribution" : "agent",
    "active" : 1
  } ]
}