查询符合条件的镜像缓存列表。
调用该 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 | 分页查询时每页显示的记录数,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 个名称。 |
POST https://open.volcengineapi.com/?Action=ListImageCaches&Version=2022-05-12 HTTP/1.1 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "ImageCacheNames": ["image-cache-test"], "ImageCacheIds": ["imc-3uqroqkx0i3j********"], "Images": ["cr-cn-beijing.volces.com/vke****/nginx:latest"] } }
本接口返回参数如下表所示,公共返回参数请参见 返回结果。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items | Array of 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 | 镜像缓存创建时间。 |
ExpireDateTime | String | 2023-11-01T13:14:18Z | 镜像缓存到期时间。 说明 若创建镜像缓存时,未传入镜像缓存保留时间相关的 RetentionDays 参数(即镜像缓存永不过期)时,不会返回该参数。 |
LastMatchedTime | String | 2023-02-20T05:26:34Z | 最近一次匹配镜像缓存的时间。 |
Status | Object of Status | - | 镜像缓存状态信息。 |
Events | Array of Events | - | 镜像缓存对应的事件信息。 |
AutoPrewarmInfos | Array of AutoPrewarmInfos | - | 镜像缓存对应弹性块存储(EBS)快照的预热配置信息。 |
UpdateTime | String | 2023-02-20T05:26:34Z | 镜像缓存更新时间。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Phase | String | Ready | 镜像缓存状态。参数值说明:
说明
|
Conditions | Array of Conditions | - | 镜像缓存当前主状态下的状态条件,即进入该主状态的原因。 说明 合法的 Phase 和 Conditions.Type 组合说明,请参见 资源状态说明。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | Ok | 镜像缓存当前主状态下的状态条件,即进入该主状态的原因。参数值说明:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | Normal | 事件类型。参数值说明:
|
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****** | 事件名称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-b | 镜像缓存对应 EBS 快照的预热可用区。 |
PrewarmCreationTime | String | 2023-10-17T13:14:18Z | 镜像缓存对应 EBS 快照的预热开始时间。 |
PrewarmExpireTime | String | 2024-01-15T14:08:46Z | 镜像缓存对应 EBS 快照的预热到期时间。 |
PrewarmUpdateTime | String | 2023-10-10T10:33:30Z | 镜像缓存对应 EBS 快照的预热更新时间。 |
{ "ResponseMetadata": { "RequestId": "20231019152631F27********", "Action": "ListImageCaches", "Version": "2022-05-12", "Service": "vke", "Region": "cn-guangzhou" }, "Result": { "Items": [ { "ImageCacheId": "imc-3v7jly9r********", "ImageCacheName": "auto-imc-for-vci-3v7j******", "ImageCacheSize": 40, "Images": [ "vci-demo-gz-cn-guangzhou.cr.volces.com/vci_demo/big-image: 24G" ], "Status": { "Phase": "Ready", "Conditions": [ { "Type": "Ok" } ] }, "Events": [ { "Type": "Normal", "Name": "auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7******", "Reason": "DiskCreated", "Message": "The image cache disk has been created successfully", "FirstTimestamp": "2023-10-17T13:14:20Z" }, { "Type": "Normal", "Name": "auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7j******", "Reason": "Pulling", "Message": "Pulling images [vci-demo-gz-cn-guangzhou.cr.volces.com/vci_demo/big-image:24G]", "FirstTimestamp": "2023-10-17T13:14:20Z" }, { "Type": "Normal", "Name": "auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7j******", "Reason": "Pulled", "Message": "Successfully pulled image [vci-demo-gz-cn-guangzhou.cr.volces.com/vci_demo/big-image:24G]", "FirstTimestamp": "2023-10-17T14:03:56Z" }, { "Type": "Normal", "Name": "auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7j******", "Reason": "ImageCacheCreated", "Message": "The image cache has been created successfully,total capacity is 40 GiB", "FirstTimestamp": "2023-10-17T14:11:10Z" }, { "Type": "Normal", "Name": "auto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7j******", "Reason": "ImageCacheReady", "Message": "The image cache [vci-demo-gz-cn-guangzhou.cr.volces.com/vci_demo/big-image:24G] has been made successfully", "FirstTimestamp": "2023-10-17T14:11:10Z" } ], "AutoPrewarmInfos": [ { "ZoneId": "cn-guangzhou-a", "PrewarmCreationTime": "2023-10-17T13:14:18Z", "PrewarmExpireTime": "2024-01-15T14:08:46Z" } ], "CreationTime": "2023-10-17T13:14:18Z", "ExpireDateTime": "2023-11-01T13:14:18Z" } ], "PageNumber": 1, "PageSize": 100, "TotalCount": 1 } }
本接口无专有错误码,公共错误码请参见 公共错误码。