Querying the List of Optional Plug-ins

Function

URI

POST /v1/{domain_id}/relation/stage-plugins

**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
use_condition	No	String	Used to distinguish whether a plug-in can be used by a pipeline or a template.
comp_id	No	String	Microservice ID
comp_name	No	String	Indicates the microservice name.
cloud_id	No	String	Site ID
strategy_id	No	String	Policy ID.
category	No	String	Pipeline Type
publish_tab	No	String	Whether to release the pipeline
platform	No	String	Deployment Platform
comp_extend_type	No	String	Component Type
deploy_type	No	String	Deployment Type

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
full_stage_plugins_item_list	Array of full_stage_plugins_item_list objects	Viewing execution results

**Table 5** full_stage_plugins_item_list
Parameter	Type	Description
plugins_list	Array of plugins_list objects	Plug-in
display_name	String	Display Name
business_type	String	Service Type
unique_id	String	Unique ID
conditions	Array of strings	Condition
addables	Array of addables objects	Additional Attribute
editable	Boolean	Whether the pipeline is editable
removable	Boolean	Removable
cloneable	Boolean	Replicable or Not
disabled	Boolean	Disable

**Table 6** plugins_list
Parameter	Type	Description
unique_id	String	Unique ID
display_name	String	Display Name
plugin_name	String	Plug-in
disabled	Boolean	Disable
group_name	String	Group Name
group_type	String	Group type
plugin_attribution	String	Plug-in Attribute
plugin_composition_type	String	Composite Plug-in
runtime_attribution	String	Operating attributes
all_steps	Array of all_steps objects	Basic Plug-in List
description	String	Description
version_attribution	String	Version Attribute
icon_url	String	Icon URL
multi_step_editable	Integer	Whether the pipeline is editable
standard	Boolean	Standard

**Table 7** all_steps
Parameter	Type	Description
plugin_name	String	Plug-in
display_name	String	Display Name
version	String	Version

**Table 8** addables
Parameter	Type	Description
additionalProp1	Boolean	Extra attribute 1
additionalProp2	Boolean	Extra attribute 2
additionalProp3	Boolean	Extra attribute 3

Status code: 400

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

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/stage-plugins

Example Responses

Status code: 200

{
  "full_stage_plugins_item_list" : [ {
    "plugins_list" : [ {
      "unique_id" : "47d48e84-8a98-4ad1-8bc0-59c112a05c5b",
      "display_name" : "CloudBuild",
      "plugin_name" : "official_devcloud_cloudBuild",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "official",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "CloudBuild capabilities can be called on the pipeline for building.CloudBuild provides an easy-to-use, cloud-based build platform that supports multiple programming languages, helping you achieve continuous delivery, with shorter delivery period and higher delivery efficiency. With CloudBuild, you can create, configure, and run build tasks with a few clicks. CloudBuild also supports automation of code retrieval, building, and packaging, as well as real-time status monitoring.",
      "version_attribution" : "formal",
      "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=official_devcloud_cloudBuild-d81c87f9977d4923a546d067a0001914- builds .png-ce8df55870164338a72d7e828a966a2a.",
      "multi_step_editable" : 0,
      "standard" : true
    } ],
    "display_name" : "Build",
    "business_type" : "Build",
    "unique_id" : "f44ca008-ae9b-45ee-905d-711429382c71",
    "conditions" : null,
    "addables" : null,
    "editable" : false,
    "removable" : false,
    "cloneable" : false,
    "disabled" : false
  } ]
}