Starting a Plugin

This API is used to start a plugin.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

POST /v5/{project_id}/plugins/attachments/start

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
plugin_code	Yes	String	Definition Plug-in ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
operate_all	No	Boolean	Definition Whether an operation is performed on all objects. The priority of this parameter is higher than that of host_id_list. If this parameter is set to true, the operation will still be performed on all objects even if host_id_list is not empty. Constraints N/A Range true: Start or stop all the plug-ins that meet specified conditions. false: The plug-in is started or stopped only on the servers specified in host_id_list. Default Value false
host_id_list	No	Array of strings	Definition Server ID list. Constraints N/A Range N/A Default Value N/A

Status code: 200

Request succeeded.

None

Start the NDR plug-in on server 71a15ecc-049f-4cca-bd28-xxx.

{
  "plugin_code" : "ndr",
  "operate_all" : false,
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-xxx" ]
}

None

Status Code	Description
200	Request succeeded.

Parent Topic: Plug-in Center

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.