查询插件列表 - ListPoolPlugins

功能介绍

查询插件实例列表接口用于获取系统中已部署的插件实例信息。该接口适用于以下场景：当用户需要查看系统中已部署的插件实例、监控插件运行状态、管理插件配置或进行故障排查时，可通过此接口获取插件实例的详细信息。使用该接口的前提条件是用户具有查询权限且系统中已部署至少一个插件实例。调用该接口后，系统将返回所有插件实例的列表，包括插件名称、类型、状态、版本及部署环境等信息。若用户无权限访问或系统中未部署任何插件实例，接口将返回相应的错误信息或空列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

URI

GET /v2/{project_id}/pools/{pool_name}/plugins

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
pool_name	是	String	参数解释：资源池名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
apiVersion	String	参数解释： API版本。取值范围：可选值如下： v2
kind	String	参数解释：资源类型。取值范围：可选值如下： PluginList：插件列表。
items	Array of Plugin objects	参数解释：资源池插件列表。

表3 Plugin
参数	参数类型	描述
apiVersion	String	参数解释： API版本。取值范围：可选值如下： v2
kind	String	参数解释：插件实例的类型。取值范围：可选值如下： Plugin：插件。
metadata	PluginMetadata object	参数解释：插件实例的metadata信息。
spec	PluginSpec object	参数解释：插件实例的具体信息。
status	PluginStatus object	参数解释：插件实例的状态信息。

表4 PluginMetadata
参数	参数类型	描述
name	String	参数解释：插件实例的名称。取值范围：不涉及。
creationTimestamp	String	参数解释：创建时间。取值范围：不涉及。

表5 PluginSpec
参数	参数类型	描述
template	Template object	参数解释：模板信息。约束限制：不涉及。

表6 Template
参数	参数类型	描述
name	String	参数解释：待安装插件模板名称，如log-agent。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
version	String	参数解释：待安装、升级插件的版本号。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
inputs	Map<String,Object>	参数解释：插件模板安装参数（各插件不同），升级插件时需要填写全量安装参数，未填写参数将使用插件模板中的默认值，当前插件安装参数可通过查询插件实例接口获取。约束限制：不涉及。

表7 PluginStatus
参数	参数类型	描述
phase	String	参数解释：插件实例的状态。取值范围：可选值如下： Pending：安装中，表示插件正在安装中。 Running：运行中，表示插件全部实例状态都在运行中，插件正常使用。 Updating：升级中，表示插件正在更新中。 Abnormal：不可用，表示插件状态异常，插件不可使用。可单击状态查看失败原因。 Deleting：删除中，表示插件正在删除中。
version	String	参数解释：插件实例的版本。取值范围：不涉及。
reason	String	参数解释：插件实例安装失败的详细信息。取值范围：不涉及。
values	String	参数解释：插件实例的安装参数（各插件不同）。取值范围：不涉及。
resources	Array of PluginResources objects	参数解释：插件实例占用的资源量。

表8 PluginResources
参数	参数类型	描述
involvedObject	ObjectReference object	参数解释：插件引用的资源对象。
replicas	Integer	参数解释：资源对象的副本数。取值范围：不涉及。
limits	Map<String,String>	参数解释：申请的资源限制。
requests	Map<String,String>	参数解释：申请的资源需求。

表9 ObjectReference
参数	参数类型	描述
kind	String	参数解释：资源对象的API类型，例如，DaemonSet、Deployment 等。取值范围：不涉及。
apiVersion	String	参数解释：资源对象的API版本。取值范围：不涉及。
namespace	String	参数解释：资源对象的命名空间。取值范围：不涉及。
name	String	参数解释：资源对象的名称。取值范围：不涉及。
uid	String	参数解释：资源对象的唯一标识符（UID）。取值范围：不涉及。
resourceVersion	String	参数解释：资源对象的当前版本。取值范围：不涉及。

请求示例

查询插件实例列表。

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/plugins

{
  "kind" : "PluginList",
  "apiVersion" : "v2",
  "items" : [ {
    "kind" : "Plugin",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "lite-cluster-ac7339d4-4858-11ec-9d-0200b0b-gpu-beta",
      "creationTimestamp" : "2025-01-22T03:01:53Z"
    },
    "spec" : {
      "template" : {
        "name" : "gpu-beta"
      }
    },
    "status" : {
      "phase" : "Running",
      "version" : "1.2.15",
      "reason" : "Upgrade complete"
    }
  }, {
    "kind" : "Plugin",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "lite-cluster-ac7339d4-4858-11ec-a79d-0255ac100b0b-os-node-agent",
      "creationTimestamp" : "2025-01-22T03:01:53Z"
    },
    "spec" : {
      "template" : {
        "name" : "os-node-agent",
        "version" : "6.8.0-20250219120620",
        "inputs" : {
          "configs" : {
            "metric_config" : {
              "backNodeUp" : true,
              "enable" : true,
              "exporter" : {
                "enable" : false,
                "port" : "10120"
              },
              "namespaces" : [ "monitoring" ],
              "prometheus" : {
                "accessCode" : "",
                "prometheusId" : ""
              },
              "uplink" : "both"
            }
          }
        }
      }
    },
    "status" : {
      "phase" : "Running",
      "version" : "6.8.0-20250219120620",
      "reason" : "Upgrade complete"
    }
  } ]
}

响应示例

状态码：200

OK。

{
  "kind" : "PluginList",
  "apiVersion" : "v2",
  "items" : [ {
    "kind" : "Plugin",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "lite-cluster-ac7339d4-4858-11ec-9d-0200b0b-gpu-beta",
      "creationtimestamp" : "2025-01-22T03:01:53Z"
    },
    "spec" : {
      "template" : {
        "name" : "gpu-beta"
      }
    },
    "status" : {
      "phase" : "Running",
      "version" : "1.2.15",
      "reason" : "Upgrade complete"
    }
  }, {
    "kind" : "Plugin",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "lite-cluster-ac7339d4-4858-11ec-a79d-0255ac100b0b-os-node-agent",
      "creationtimestamp" : "2025-01-22T03:01:53Z"
    },
    "spec" : {
      "template" : {
        "name" : "os-node-agent",
        "version" : "6.8.0-20250219120620",
        "inputs" : {
          "configs" : {
            "metric_config" : {
              "backNodeUp" : true,
              "enable" : true,
              "exporter" : {
                "enable" : false,
                "port" : "10120"
              },
              "namespaces" : [ "monitoring" ],
              "prometheus" : {
                "accessCode" : "",
                "prometheusId" : ""
              },
              "uplink" : "both"
            }
          }
        }
      }
    },
    "status" : {
      "phase" : "Running",
      "version" : "6.8.0-20250219120620",
      "reason" : "Upgrade complete"
    }
  } ]
}