Fetching Applied Plugin List

Function

This API is used to fetch the applied 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/attachments

**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
plugin_code	Yes	String	Definition Plug-in ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
plugin_version	No	String	Definition Plug-in version. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
plugin_status	No	String	Definition Plug-in status. Constraints N/A Range not_installed installing install_fail starting running start_fail offline stopping stopped updating update_failed uninstalling uninstall_failed Default Value N/A
host_name	No	String	Definition Server name. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
host_ids	No	Array of strings	Definition Server ID list. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
host_status	No	Array of strings	Definition Server status. Constraints N/A Range ACTIVE: running BUILDING: creating ERROR: faulty SHUTOFF: shut down Default Value N/A
agent_status	No	String	Definition Agent status. Constraints N/A Range not_installed online offline install_failed installing Default Value N/A
os_type	No	String	Definition Server OS. Constraints N/A Range linux: Linux OS Windows: Windows OS Default Value N/A
os_arch	No	String	Definition System architecture. Constraints N/A Range x86_64: x86 architecture arm: Arm architecture Default Value N/A
host_type	No	String	Definition Server type. Constraints N/A Range host: non-container host container: container host Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 4** PluginStatusInfo
Parameter	Type	Description
host_id	String	Definition Server ID. Range The value can contain 1 to 128 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
host_type	String	Definition Server type. Range host: non-container host container: container host
private_ip	String	Definition Server private IP address. Range The value can contain 0 to 128 characters.
public_ip	String	Definition Server EIP. Range The value can contain 0 to 128 characters.
host_status	String	Definition Server status. Range ACTIVE: running BUILDING: creating ERROR: faulty SHUTOFF: shut down
agent_status	String	Definition Agent status. Range not_installed online offline install_failed installing
agent_version	String	Definition Agent version. Range The value can contain 0 to 32 characters.
asset_value	String	Definition Server asset importance. Range important common test
os_type	String	Definition OS type. Range linux: Linux OS windows: Windows OS
os_arch	String	Definition System architecture. Range x86_64: x86 architecture arm: Arm architecture
os_name	String	Definition System name. Range N/A
os_version	String	Definition OS type. Range linux: Linux OS windows: Windows OS
plugin_status	String	Definition Plug-in status. Range not_installed installing install_fail starting running start_fail offline stopping stopped updating update_failed uninstalling uninstall_failed
plugin_version	String	Definition Plug-in version. Range N/A
status_detail	String	Definition Cause of the plug-in operation failure, for example, a plug-in fails to be installed, started, stopped, updated, uninstalled, or a plug-in is offline. Range N/A
install_progress	String	Definition Plug-in installation progress, in percentage. Range 0-99
remaining_time	String	Definition Remaining time for installing the plug-in, in minutes. Range N/A
protect_status	String	Definition Server protection status. Range closed: disabled opened: protected

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "host_id" : "5f69af31-bfdc-40b3-8c64-xxx",
    "host_name" : "test",
    "host_type" : "host",
    "private_ip" : "1.1.1.1",
    "public_ip" : "",
    "host_status" : "ACTIVE",
    "agent_status" : "online",
    "agent_version" : "1.0.0",
    "asset_value" : "common",
    "os_type" : "Linux",
    "os_arch" : "x86_64",
    "os_name" : "CentOS",
    "os_version" : "7",
    "plugin_status" : "not_installed",
    "protect_status" : "opened"
  } ],
  "total_num" : 1
}