文档首页/ 华为云UCS/ API参考/ API/ 插件管理/ 获取插件实例列表 - ListAddonInstances
更新时间：2025-11-17 GMT+08:00
查看PDF
分享

获取插件实例列表 - ListAddonInstances

功能介绍

获取插件实例列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/addons

表1 Query参数

参数

是否必选

参数类型

描述

cluster_id

是

String

集群id

addon_template_name

否

String

是否使用数据库存储的插件状态

is_database_status

否

String

插件包名字

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

kind

String

API类型

apiVersion

String

API版本

items

Array of AddonInstance objects

插件实例列表
表4 AddonInstance

参数

参数类型

描述

kind

String

API类型，必须是"Addon"

apiVersion

String

API版本，必须是"v3"

metadata

ObjectMeta object

资源元数据

spec

AddonInstanceSpec object

插件实例的期望状态

status

AddonInstanceStatus object

插件实例的实际状态
表5 ObjectMeta

参数

参数类型

描述

uid

String

资源ID

name

String

资源名称

generateName

String

当未提供name时，服务器使用的前缀来生成唯一名称

namespace

String

命名空间

labels

Map<String,String>

标签

annotations

Map<String,String>

注解

creationTimestamp

String

创建时间

updateTimestamp

String

更新时间

resourceVersion

String

资源内部版本

generation

String

资源期望状态的代数

managedFields

Array of ManagedFieldsEntry objects

记录哪些字段由哪些工作流管理

ownerReferences

Array of OwnerReference objects

用于定义对象间所有权关系，管理对象的依赖关系和垃圾回收机制，支持控制器对资源的管理
表6 ManagedFieldsEntry

参数

参数类型

描述

manager

String

管理者的名称

operation

String

记录导致此条目创建的操作类型，只能是 Apply 或 Update 两种操作类型

apiVersion

String

该管理者定义字段时所依据的资源 API 版本

time

String

此管理条目被创建或最后一次更新的时间戳

fieldsType

String

固定为 "FieldsV1"，标记字段结构格式

fieldsV1

Object

用于存储实际被管理的字段信息
表7 OwnerReference

参数

参数类型

描述

apiVersion

String

标识引用对象的API版本

kind

String

引用对象的类型

name

String

引用对象的名称

uid

String

引用对象的uid

controller

Boolean

如果为true，表示该引用指向管理该资源的控制器

blockOwnerDeletion

Boolean

当为true且拥有者有名为"foregroundDeletion"的finalizer 时，会阻止拥有者被删除，直到这个引用被移除
表8 AddonInstanceSpec

参数

参数类型

描述

clusterID

String

cluster ID信息

version

String

插件版本信息

addonTemplateName

String

插件模板名称

addonTemplateType

String

插件模板类型

addonTemplateLogo

String

插件模板Logo

addonTemplateLabels

Array of strings

插件模板标签

description

String

信息说明

values

Map<String,Object>

插件实例的配置参数

parameters

ReleaseParams object

发布参数

namespace

String

命名空间
表9 ReleaseParams

参数

参数类型

描述

dry_run

Boolean

是否仅模拟安装过程

replace

Boolean

是否允许重用已存在的名称

recreate

Boolean

是否强制重新创建资源

no_hooks

Boolean

是否禁止hook

reset_values

Boolean

更新时重设values

name_template

String

发布资源的名称模板

release_version

Integer

指定回滚版本号

include_hooks

Boolean

更新或删除时是否允许hook
表10 AddonInstanceStatus

参数

参数类型

描述

status

String

状态信息

Reason

String

变化原因信息

message

String

变化详细信息

targetVersions

Array of strings

目标版本信息

currentVersion

AddonVersion object

当前版本
表11 AddonVersion

参数

参数类型

描述

id

String

插件包版本id

version

String

插件版本信息

input

Map<String,Object>

输入

stable

Boolean

是否为稳定版本

translate

Map<String,Object>

供界面使用的翻译信息

supportVersions

Array of SupportVersion objects

支持的集群类型和和支持的集群版本信息

creationTimestamp

String

记录创建时间

updateTimestamp

String

记录更新时间
表12 SupportVersion

参数

参数类型

描述

category

String

支持的集群类型（CCE，thirdParty等）

clusterType

String

支持的集群类型（BareMetal，VirtualMachine，windows等）

clusterVersion

Array of strings

支持的集群版本，支持正则表达式，如".*"匹配所有集群版本

状态码：400

表13 响应Body参数

参数

参数类型

描述

-

String

状态码：500

表14 响应Body参数

参数

参数类型

描述

-

String

请求示例

无

响应示例

状态码：200

返回插件实例列表信息

{
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "929633dc-2dae-4db7-84e4-a33c91370d53",
      "name" : "log-agent",
      "creationTimestamp" : "2025-10-15T09:03:57Z",
      "updateTimestamp" : "2025-10-15T09:04:24Z"
    },
    "spec" : {
      "clusterID" : "871bfe78-0528-4267-8a94-d19139210f80",
      "version" : "1.7.14",
      "addonTemplateName" : "log-agent",
      "addonTemplateType" : "helm",
      "addonTemplateLogo" : "",
      "addonTemplateLabels" : [ "Maintenance" ],
      "description" : "log-agent is a logging collector and forward center.",
      "parameters" : {
        "no_hooks" : false,
        "reset_values" : false,
        "name_template" : "",
        "release_version" : 0
      },
      "namespace" : "monitoring"
    },
    "status" : {
      "status" : "running",
      "Reason" : "",
      "message" : "",
      "targetVersions" : null,
      "currentVersion" : {
        "id" : "",
        "version" : "1.7.14",
        "stable" : true,
        "supportVersions" : null,
        "creationTimestamp" : "2025-09-17T07:59:47Z",
        "updateTimestamp" : "2025-09-17T07:59:47Z"
      }
    }
  } ]
}

状态码

状态码

描述

200

返回插件实例列表信息

400

客户端请求错误，服务器无法执行请求

500

服务器内部错误

错误码

请参见错误码。

父主题： 插件管理

相关文档