查询符合条件的镜像缓存列表。

请求说明

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

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

请求参数

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

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

Filter

参数	类型	是否必选	示例值	描述
Images	Array of String	否	["cr-cn-beijing.volces.com/vke****/nginx:latest"]	镜像地址列表。
ImageCacheIds	Array of String	否	["imc-3uqroqkx0i3j********"]	镜像缓存 ID 列表。单次最多填写 100 个 ID。
ImageCacheNames	Array of String	否	["image-cache-test"]	镜像缓存名称列表。单次最多填写 100 个名称。

请求示例

返回参数

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

参数	类型	示例值	描述
Items	Array of Items	-	镜像缓存的详细信息列表。

Items

参数	类型	示例值	描述
ImageCacheId	String	imc-3v7jly9r********	镜像缓存 ID。
ImageCacheName	String	auto-imc-for-vci-3v7j******	镜像缓存名称。
Images	Array of String	["cr-cn-beijing.volces.com/vke****/nginx:latest"]	镜像缓存包含的容器镜像列表。
ImageCacheSize	Integer	40	镜像缓存大小，单位：GiB。
CreationTime	String	2023-10-17T13:14:18Z	镜像缓存创建时间。标准 RFC3339 格式的 UTC+0 时间。
ExpireDateTime	String	2023-11-01T13:14:18Z	镜像缓存到期时间。标准 RFC3339 格式的 UTC+0 时间。说明若创建镜像缓存时，未传入镜像缓存保留时间相关的 RetentionDays 参数（即镜像缓存永不过期）时，不会返回该参数。
LastMatchedTime	String	2023-02-20T05:26:34Z	最近一次匹配镜像缓存的时间。标准 RFC3339 格式的 UTC+0 时间。
Status	Object of Status	-	镜像缓存状态信息。
Events	Array of Events	-	镜像缓存对应的事件信息。
AutoPrewarmInfos	Array of AutoPrewarmInfos	-	镜像缓存对应弹性块存储（EBS）快照的预热配置信息。
UpdateTime	String	2023-02-20T05:26:34Z	镜像缓存更新时间。标准 RFC3339 格式的 UTC+0 时间。

Status

参数	类型	示例值	描述
Phase	String	Ready	镜像缓存状态。参数值说明： Creating：创建中 Updating：更新中 Ready：创建完成 Failed：创建失败 Deleting：删除中说明当状态为 Ready 时，可以使用该镜像缓存。合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。
Conditions	Array of Conditions	-	镜像缓存当前主状态下的状态条件，即进入该主状态的原因。说明合法的 Phase 和 Conditions.Type 组合说明，请参见资源状态说明。

Conditions

参数	类型	示例值	描述
Type	String	Ok	镜像缓存当前主状态下的状态条件，即进入该主状态的原因。参数值说明： Ok：正常 Progressing：进行中 CreationFailed：创建失败 UpdateFailed：更新失败 Balance：欠费 Unknown：未知

Events

参数	类型	示例值	描述
Type	String	Normal	事件类型。参数值说明： Normal：普通事件 Warning：告警事件
Reason	String	DiskCreated	事件原因。
Message	String	The image cache disk has been created successfully	事件详情信息。
FirstTimestamp	String	2023-10-17T13:14:20Z	事件开始时间。
Name	String	auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7******	事件名称。

AutoPrewarmInfos

参数	类型	示例值	描述
ZoneId	String	cn-beijing-b	镜像缓存对应 EBS 快照的预热可用区。
PrewarmCreationTime	String	2023-10-17T13:14:18Z	镜像缓存对应 EBS 快照的预热开始时间。标准 RFC3339 格式的 UTC+0 时间。
PrewarmExpireTime	String	2024-01-15T14:08:46Z	镜像缓存对应 EBS 快照的预热到期时间。标准 RFC3339 格式的 UTC+0 时间。
PrewarmUpdateTime	String	2023-10-10T10:33:30Z	镜像缓存对应 EBS 快照的预热更新时间。标准 RFC3339 格式的 UTC+0 时间。

返回示例

错误码

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