查询符合条件的已安装组件详情列表。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=ListAddons&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListAddons	接口名称。当前 API 的名称为 ListAddons。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
Filter	Object of ListAddonsFilter	否	-	待查询组件的筛选条件。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

ListAddonsFilter

参数	类型	是否必选	示例值	描述
ClusterIds	Array of String	否	["cc5silumrsfeq****"]	集群 ID 列表。可以调用 ListClusters 接口，获取集群 ID。单次最多填写 100 个集群 ID。说明此参数为空数组时，基于账号下指定地域的所有集群进行筛选。
Names	Array of String	否	["ingress-nginx"]	组件名称列表。可以调用 ListSupportedAddons 接口，获取集群组件名称。单次最多填写 100 个组件名称。说明此参数为空数组时，基于指定集群下的所有组件进行筛选。
DeployModes	Array of String	否	["Unmanaged"]	支持的部署模式，取值： Unmanaged：查询非托管模式部署的组件。 Managed：查询托管模式部署的组件。为空：查询全部部署模式的组件。
DeployNodeTypes	Array of String	否	["VirtualNode"]	部署节点类型。仅DeployMode=Unmanaged时，才需要指定。取值： Node：查询以节点（云服务器）方式部署的组件。 VirtualNode：查询以虚拟节点（弹性容器实例）方式部署的组件。为空：查询全部部署节点类型的组件。
Statuses	Array of AddonStatusFilter	否	[{"Phase":"Running","Conditions.Type":"Ok"}]	组件状态。单次最多填写 15 个数组元素。传入多个状态时，状态间是逻辑「或」关系。
CreateClientToken	String	否	ed6b1190-dc17-11ec-9519-eb58a7******	创建成功时的 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。
UpdateClientToken	String	否	BC028527-33B9-4990-A633-54A859******	按更新幂等token过滤，精确查询最后一次更新成功时 ClientToken。 ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

AddonStatusFilter

参数	类型	是否必选	示例值	描述
Phase	String	否	Running	组件的状态，取值： Running Failed Creating Deleting Updating 注意 Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。
Conditions.Type	String	否	Ok	组件当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，取值： Unknown ClusterNotRunning CrashLoopBackOff ImagePullBackOff SchedulingFailed NameConflict ResourceCleanupFailed ClusterVersionUpgrading Ok Degraded Progressing 注意 Phase 和 Conditions.Type 两者至少有一个参数必填，否则为无效数组元素。合法的 Phase 和 Conditions.Type 组合请参见资源状态说明。

请求示例

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
Items	Array of Addon	-	组件列表。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页显示的组件数。
TotalCount	Integer	100	返回数据列表的总量。

Addon

参数	类型	示例值	描述
ClusterId	String	cc5sil****	组件所在集群 ID。
Name	String	ingress-nginx	组件名称。
Version	String	v0.44.0	组件版本。
DeployMode	String	Unmanaged	组件部署模式，参数值有： Unmanaged：非托管模式部署。 Managed：托管模式部署。
DeployNodeType	String	VirtualNode	部署节点的类型，参数值有： Node：以节点方式部署。 VirtualNode：以虚拟节点方式部署。仅DeployModes=Unmanaged时，才返回该参数。
Config	String		组件配置。详细的参数说明，请参见组件配置信息。
CreateTime	String	2021-10-27T10:33:30Z	安装组件的时间。标准 RFC3339 格式的 UTC+0 时间。
UpdateTime	String	2021-10-29T10:33:30Z	更新组件的时间。标准 RFC3339 格式的 UTC+0 时间。
Status	Object of AddonStatus		组件状态。
CreateClientToken	String	ed6b1190-dc17-11ec-9519-eb58a7******	建成功时的 ClientToken。
UpdateClientToken	String	BC028527-33B9-4990-A633-54A859******	最后一次更新成功时的 ClientToken。

AddonStatus

参数	类型	示例值	描述
Phase	String	Running	组件的状态，参数值有： Running Failed Creating Deleting Updating 说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。
Conditions	Array of AddonCondition	["Type":"Ok"]	组件当前主状态下的状态条件，即进入该主状态的原因。说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。

AddonCondition

参数	类型	示例值	描述
Type	String	Ok	组件当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有： Progressing ClusterVersionUpgrading Unknown Degraded NameConflict ClusterNotRunning CrashLoopBackOff SchedulingFailed ResourceCleanupFailed

返回示例

错误码

本接口无专有错误码，公共错误码请参见公共错误码。

容器服务