文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 安装配置/ 查询插件列表 - ListDockerPlugins
更新时间:2025-10-31 GMT+08:00
分享

查询插件列表 - ListDockerPlugins

功能介绍

查询插件列表

授权信息

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

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

URI

GET /v5/{project_id}/setting/plugins

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

host_name

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

服务器ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

private_ip

String

参数解释:

服务器私有IP

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

public_ip

String

服务器公网IP

group_id

String

参数解释:

服务器组ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

asset_value

String

资产重要性,包含如下3种

  • important :重要资产

  • common :一般资产

  • test :测试资产

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

agent_status

String

参数解释

客户端状态

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

detect_result

String

参数解释

检测结果

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

host_status

String

参数解释

主机状态

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

os_type

String

参数解释

操作系统类型

约束限制

不涉及

取值范围

  • Linux:Linux操作系统。

  • Windows:Windows操作系统。

默认取值

不涉及

ip_addr

String

公网或私网IP

protect_status

String

防护状态

group_name

String

服务器组名称

policy_group_id

String

策略组ID

policy_group_name

String

策略组名称

label

String

资产标签

charging_mode

String

收费模式

refresh

Boolean

参数解释

是否强制从ECS同步主机

约束限制

不涉及

取值范围

  • true:是。

  • false:否。

默认取值

false

above_version

Boolean

是否返回比当前版本高的所有版本

name

String

参数解释

插件名称

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

opa-docker-authz

version

String

参数解释

主机开通的版本

约束限制

不涉及

取值范围

字符长度1-256位

默认取值

不涉及

plugin

String

参数解释

插件类型

约束限制

不涉及

取值范围

  • opa-docker-authz:docker插件。

默认取值

opa-docker-authz

outside_host

Boolean

参数解释

是否非华为云

约束限制

不涉及

取值范围

  • true:是。

  • false:否。

默认取值

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of PluginResponseInfo objects

data list

表5 PluginResponseInfo

参数

参数类型

描述

host_name

String

服务器名称

host_id

String

服务器ID

private_ip

String

私有IP地址

public_ip

String

公有IP地址

os_type

String

系统类型

plugin_name

String

插件名称

plugin_version

String

插件版本

plugin_status

String

插件状态

upgrade_status

String

插件升级状态

请求示例

查询插件列表

GET https://{endpoint}/v5/{project_id}/setting/plugins?name=opa-docker-authz

响应示例

状态码:200

docker插件安装脚本响应信息

{
  "total_num" : 1,
  "data_list" : [ {
    "host_name" : "Z00840245-TNISN",
    "host_id" : "08cfa327-b01b-39fa-989c-9842d4e5a4d3",
    "private_ip" : "10.112.30.223",
    "public_ip" : "192.168.0.135",
    "os_type" : "Linux",
    "plugin_name" : "xxx",
    "plugin_version" : "xxx",
    "plugin_status" : "xx",
    "upgrade_status" : "xx"
  } ]
}

状态码

状态码

描述

200

docker插件安装脚本响应信息

错误码

请参见错误码

相关文档