文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 插件中心/ 查询插件详情 - ListPluginInfo
更新时间:2025-11-28 GMT+08:00
分享

查询插件详情 - ListPluginInfo

功能介绍

查询插件详情

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/plugins/code/{code}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

code

String

参数解释

插件编码

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

plugin_version

String

参数解释

插件版本

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

agent_version

String

参数解释

agent版本

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

plugin_arch

String

参数解释

插件架构

约束限制:

不涉及

取值范围:

  • x86_64:X86架构

  • arm:ARM架构

默认取值:

不涉及

plugin_os_type

String

参数解释

插件支持的操作系统类型

约束限制:

不涉及

取值范围:

  • Linux:Linux操作系统

  • Windows:Windows操作系统

默认取值:

不涉及 |

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data_list

Array of PluginDetailInfo objects

参数解释

插件详细信息列表

取值范围:

不涉及

total_num

Integer

参数解释

总数

取值范围:

不涉及

表4 PluginDetailInfo

参数

参数类型

描述

name

String

参数解释

插件名称

取值范围:

不涉及

id

String

参数解释

插件id

取值范围:

不涉及

version

String

参数解释

插件版本

取值范围:

不涉及

agent_version

String

参数解释

插件支持的最低Agent版本

取值范围:

不涉及

arch

String

参数解释

插件架构

取值范围:

  • x86_64:X86架构

  • arm:ARM架构

os_type

String

参数解释

插件支持的操作系统类型

取值范围:

  • Linux:Linux操作系统

  • Windows:Windows操作系统

version_description

String

参数解释

插件版本信息描述

取值范围:

不涉及

size

String

参数解释

插件安装包大小(MB)

取值范围:

不涉及

cpu_limit

Integer

参数解释

运行插件所需单核CPU(0-100%)

取值范围:

不涉及

memory_limit

Integer

参数解释

运行插件所需内存(MB)

取值范围:

不涉及

update_time

Long

参数解释

插件更新时间

取值范围:

不涉及

请求示例

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "name" : "NDR流量检测",
    "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
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档