You need to enable JavaScript to run this app.
导航
ListImageCaches
最近更新时间:2024.09.29 18:50:57首次发布时间:2023.03.02 14:08:00

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=ListImageCaches&Version=2022-05-12

请求参数

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

参数类型是否必选示例值描述
ActionStringListImageCaches接口名称。当前 API 的名称为 ListImageCaches
VersionString2022-05-12接口版本。当前 API 的版本为 2022-05-12
FilterObject of Filter-待查询镜像缓存的筛选条件。
PageNumberInteger1分页查询时的起始页码,从 1 开始,默认为 1。

PageSize

Integer

10

分页查询时每页显示的记录数,取值:

  • 最小值:1
  • 最大值:100
  • 默认值:10

Filter

参数类型是否必选示例值描述
ImagesArray of String["cr-cn-beijing.volces.com/vke****/nginx:latest"]镜像地址列表。
ImageCacheIdsArray of String["imc-3uqroqkx0i3j********"]镜像缓存 ID 列表。 单次最多填写 100 个 ID。
ImageCacheNamesArray 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"]
    }
}

返回参数

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

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

Items

参数类型示例值描述
ImageCacheIdStringimc-3v7jly9r********镜像缓存 ID。
ImageCacheNameStringauto-imc-for-vci-3v7j******镜像缓存名称。
ImagesArray of String["cr-cn-beijing.volces.com/vke****/nginx:latest"]镜像缓存包含的容器镜像列表。
ImageCacheSizeInteger40镜像缓存大小,单位: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 时间。

StatusObject of Status-镜像缓存状态信息。
EventsArray of Events-镜像缓存对应的事件信息。
AutoPrewarmInfosArray 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:告警事件
ReasonStringDiskCreated事件原因。
MessageStringThe image cache disk has been created successfully事件详情信息。
FirstTimestampString2023-10-17T13:14:20Z事件开始时间。
NameStringauto-imc-for-vci-3v7jly7kx95g1ho3mixi.3v7******事件名称。

AutoPrewarmInfos

参数类型示例值描述
ZoneIdStringcn-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 时间。

返回示例

{
    "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
    }
}

错误码

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