查询插件列表 - ListPlugins
功能介绍
查询插件列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/plugins
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
code |
否 |
String |
参数解释: 插件编码 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
name |
否 |
String |
参数解释: 插件名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_list |
Array of PluginInfo objects |
参数解释: 插件信息列表 取值范围: 不涉及 |
|
total_num |
Integer |
参数解释: 插件总数 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 插件编码 取值范围: 不涉及 |
|
name |
String |
参数解释: 插件名称 取值范围: 不涉及 |
|
description |
String |
参数解释: 插件的描述信息 取值范围: 不涉及 |
|
tags |
Array of strings |
参数解释: 插件标签信息 取值范围: 不涉及 |
|
installed_attachment_num |
Integer |
参数解释: 已安装插件的主机数量 取值范围: 不涉及 |
|
uninstall_attachment_num |
Integer |
参数解释: 未安装插件的主机数量,包括插件状态为未安装、安装中与安装失败的主机 取值范围: 不涉及 |
|
max_cpu_limit |
Integer |
参数解释: 此种类型的插件包中,运行插件所需单核CPU(0-100%)的最大值 取值范围: 不涉及 |
|
max_memory_limit |
Integer |
参数解释: 此种类型的插件包中,运行插件所需内存(MB)的最大值 取值范围: 不涉及 |
|
max_size |
String |
参数解释: 此种类型的插件包中,插件大小(MB)的最大值 取值范围: 不涉及 |
|
display_mode |
Integer |
参数解释: 插件展示模式 取值范围:
|
请求示例
无
响应示例
状态码:200
请求已成功
{
"data_list" : [ {
"code" : "ndr_plugin_xxx",
"name" : "NDR流量检测",
"description" : "NDR流量检测插件",
"tags" : [ "流量检测" ],
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。