Query the list of image caches that meet the specified criteria.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point for your business region.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=ListImageCaches&Version=2022-05-12

Request parameters

The following table contains the API request parameters. You also need to provide public parameters when calling this API. See Public parameters for details.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListImageCaches	The API name. The name of the current API is ListImageCaches.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of Filter	no	-	The criteria for querying image caches.
PageNumber	Integer	no	1	The starting page number when querying. The default number is 1.
PageSize	Integer	no	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListImageCaches	The API name. The name of the current API is ListImageCaches.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of Filter	no	-	The criteria for querying image caches.
PageNumber	Integer	no	1	The starting page number when querying. The default number is 1.
PageSize	Integer	no	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

Filter

Parameters	Type	Required	Sample value	Description
Images	Array of String	no	["cr-cn-beijing.volces.com/vke****/nginx:latest"]	The list of image addresses.
ImageCacheIds	Array of String	no	["imc-3uqroqkx0i3j********"]	The list of the image cache IDs. You can enter up to 100 IDs at a time.
ImageCacheNames	Array of String	no	["image-cache-test"]	The list of image cache names. You can enter up to 100 names at a time.

Sample requests

Response parameters

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameters	Type	Sample value	Description
Items	Array of Items	-	The details of the image cache.

Items

Parameters	Type	Sample value	Description
ImageCacheId	String	imc-3v7jly9r********	The ID of the image cache.
ImageCacheName	String	auto-imc-for-vci-3v7j******	The image cache name.
Images	Array of String	["cr-cn-beijing.volces.com/vke****/nginx:latest"]	The list of container images included in the image cache.
ImageCacheSize	Integer	40	The image cache capacity. Unit: GiB.
CreationTime	String	2023-10-17T13:14:18Z	The time when the image cache was created. UTC+0 time in standard RFC3339 format.
ExpireDateTime	String	2023-11-01T13:14:18Z	The time when the image cache expires. UTC+0 time in standard RFC3339 format. tip If you do not specify the RetentionDays parameter that controls the image cache retention duration (The image cache never expires) when creating an image cache, this parameter will not be returned.
LastMatchedTime	String	2023-02-20T05:26:34Z	The time when the image cache was last matched. UTC+0 time in standard RFC3339 format.
Status	Object of Status	-	The status information of the image cache.
Events	Array of Events	-	The event information of the image cache.
AutoPrewarmInfos	Array of AutoPrewarmInfos	-	The warm-up configurations of the EBS snapshots that correspond to the image cache.
UpdateTime	String	2023-02-20T05:26:34Z	The time when the image cache was updated. UTC+0 time in standard RFC3339 format.

Status

Parameters	Type	Sample value	Description
Phase	String	Ready	The status of the image cache. Valid values: Creating: The image cache is being created. Updating: The image cache is being updated. Ready: The image cache has been created. Failed: The image cache creation failed. Deleting: The image cache is being deleted. tip When the image cache is in the Ready state, you can use it. For valid combinations of Phase and Conditions.Type, see Resources status description.
Conditions	Array of Conditions	-	The conditions under which the add-on enters the primary status. tip For valid combinations of Phase and Conditions.Type, see Resources status description.

Conditions

Parameter	Type	Sample value	Description
Type	String	Ok	The conditions under which the image cache enters the primary status. Available status Ok: The image cache is in a normal status. Progressing: The image cache creation is in progress. CreationFailed: The image cache creation has failed. UpdateFailed: The image cache update has failed. Balance: The account is in arrears. Unknown: An unknown issue occurred.

Events

Parameters	Type	Sample value	Description
Type	String	Normal	The event type. Valid values: Normal: normal event Warning: alert event
Reason	String	DiskCreated	The event cause.
Message	String	The image cache disk has been created successfully	The event details.
FirstTimestamp	String	2023-10-17T13:14:20Z	The event start time.
Name	String	auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7******	The event name.

AutoPrewarmInfos

Parameters	Type	Sample value	Description
ZoneId	String	cn-beijing-b	The ID of the warm-up availability zone for the EBS snapshot that corresponds to the image cache.
PrewarmCreationTime	String	2023-10-17T13:14:18Z	The warm-up start time for the EBS snapshot that corresponds to the image cache. UTC+0 time in standard RFC3339 format.
PrewarmExpireTime	String	2024-01-15T14:08:46Z	The warm-up expiration time for the EBS snapshot that corresponds to the image cache. UTC+0 time in standard RFC3339 format.
PrewarmUpdateTime	String	2023-10-10T10:33:30Z	The warm-up update time for the EBS snapshot that corresponds to the image cache. UTC+0 time in standard RFC3339 format.

Sample responses

Error code

There are no proprietary error codes for this API. See Public error codes for details.

Volcengine Kubernetes Engine