查询插件应用列表 - ListPluginStatus
功能介绍
查询插件应用列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/plugins/attachments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
plugin_code |
是 |
String |
参数解释: 插件编码 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
plugin_version |
否 |
String |
参数解释: 插件版本 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
plugin_status |
否 |
String |
参数解释: 插件状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
host_ids |
否 |
Array of strings |
参数解释: 服务器ID列表 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
host_status |
否 |
Array of strings |
参数解释: 服务器状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
agent_status |
否 |
String |
参数解释: agent状态 约束限制: 不涉及 取值范围: -not_installed:未安装 -online:在线 -offline:离线 -install_failed:安装失败 -installing:安装中 默认取值: 不涉及 |
|
os_type |
否 |
String |
参数解释: 主机操作系统 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
os_arch |
否 |
String |
参数解释: 系统架构 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_type |
否 |
String |
参数解释: 服务器类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 不涉及 |
|
data_list |
Array of PluginStatusInfo objects |
参数解释: 插件状态信息列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释: 服务器ID 取值范围: 字符长度1-128 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 字符长度1-256位 |
|
host_type |
String |
参数解释: 服务器类型 取值范围:
|
|
private_ip |
String |
参数解释: 服务器私网IP地址 取值范围: 字符长度0-128 |
|
public_ip |
String |
参数解释: 服务器公网IP地址 取值范围: 字符长度0-128 |
|
host_status |
String |
参数解释: 服务器状态 取值范围:
|
|
agent_status |
String |
参数解释: Agent状态 取值范围:
|
|
agent_version |
String |
参数解释: agent版本 取值范围: 字符长度0-32位 |
|
asset_value |
String |
参数解释: 服务器的资产重要性 取值范围:
|
|
os_type |
String |
参数解释: 操作系统类型 取值范围:
|
|
os_arch |
String |
参数解释: 系统架构 取值范围:
|
|
os_name |
String |
参数解释: 系统名称 取值范围: 不涉及 |
|
os_version |
String |
参数解释: 操作系统类型 取值范围:
|
|
plugin_status |
String |
参数解释: 插件状态 取值范围:
|
|
plugin_version |
String |
参数解释: 插件版本 取值范围: 不涉及 |
|
status_detail |
String |
参数解释: 插件操作失败原因,包括安装失败、启动失败、离线、停止失败、更新失败以及卸载失败 取值范围: 不涉及 |
|
install_progress |
String |
参数解释: 插件安装进度,百分比 取值范围: 0-99 |
|
remaining_time |
String |
参数解释: 插件剩余安装时间,单位分钟 取值范围: 不涉及 |
|
protect_status |
String |
参数解释: 主机防护状态 取值范围:
|
请求示例
无
响应示例
状态码:200
请求已成功
{
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。