Querying the Plugin List

Function

This API is used to query the plugin list.

Authorization Information

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.

URI

GET /v5/{project_id}/plugins

**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.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
code	No	String	Definition Plug-in ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
name	No	String	Definition Plug-in name. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
data_list	Array of PluginInfo objects	Definition Plug-in information list. Range N/A
total_num	Integer	Definition Total number of plug-ins. Range N/A

**Table 4** PluginInfo
Parameter	Type	Description
code	String	Definition Plug-in ID. Range N/A
name	String	Definition Plug-in name. Range N/A
description	String	Definition Plug-in description. Range N/A
tags	Array of strings	Definition Plug-in label information. Range N/A
installed_attachment_num	Integer	Definition Number of servers where the plug-in has been installed. Range N/A
uninstall_attachment_num	Integer	Definition Number of servers where the plug-in is not installed, including servers where the plug-in has not been installed, is being installed, or fails to be installed. Range N/A
max_cpu_limit	Integer	Definition Maximum single-core CPU (0-100%) required for running a plug-in in this type of plug-in package. Range N/A
max_memory_limit	Integer	Definition Maximum memory (MB) required for running a plug-in in this type of plug-in package. Range N/A
max_size	String	Definition Maximum plug-in size (MB) in this type of plug-in package. Range N/A
display_mode	Integer	Definition Plug-in display mode. Range 0: All plug-in operations are supported. 1: Plug-ins cannot be installed or uninstalled. 2: No functions of the plug-in are supported.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "code" : "ndr_plugin_xxx",
    "name" : "NDR traffic check.",
    "description" : "NDR traffic check plug-in.",
    "tags" : [ "Traffic Check" ],
    "installed_attachment_num" : 1,
    "uninstall_attachment_num" : 1,
    "max_cpu_limit" : 5,
    "max_memory_limit" : 50,
    "max_size" : "49.02",
    "display_mode" : 1
  } ],
  "total_num" : 1
}