Retrieving Plugin Details

Function

This API is used to retrieve plugin details.

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/code/{code}

**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
code	Yes	String	Definition Plug-in ID. Constraints N/A Range The value can contain 1 to 64 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
plugin_version	No	String	Definition Plug-in version. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
agent_version	No	String	Definition Agent version. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
plugin_arch	No	String	Definition Plug-in architecture. Constraints N/A Range x86_64: x86 architecture arm: Arm architecture Default Value N/A
plugin_os_type	No	String	Definition OS type supported by the plug-in. Constraints N/A Range Linux Windows Default Value N/A \|

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 4** PluginDetailInfo
Parameter	Type	Description
name	String	Definition Plug-in name. Range N/A
id	String	Definition Plug-in ID. Range N/A
version	String	Definition Plug-in version. Range N/A
agent_version	String	Definition Earliest agent version supported by the plug-in. Range N/A
arch	String	Definition Plug-in architecture. Range x86_64: x86 architecture arm: Arm architecture
os_type	String	Definition OS type supported by the plug-in. Range Linux Windows
version_description	String	Definition Plug-in version description. Range N/A
size	String	Definition Plug-in installation package size (MB). Range N/A
cpu_limit	Integer	Definition Single-core CPU required for running the plug-in (0-100%). Range N/A
memory_limit	Integer	Definition Memory required for running the plug-in (MB). Range N/A
update_time	Long	Definition Plug-in update time. Range N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "name" : "NDR traffic check.",
    "id" : "cf1a93c1-4565-4187-9c99-xxxx",
    "version" : "1.0.0",
    "agent_version" : "1.0.0",
    "arch" : "x86_64",
    "os_type" : "Linux",
    "size" : 49.02,
    "cpu_limit" : 5,
    "memory_limit" : 50,
    "update_time" : 1758697255744
  } ],
  "total_num" : 1
}