首页 弹性容器实例 开发参考 API参考 API目录 镜像缓存 DescribeImageCaches - 批量查询镜像缓存信息

DescribeImageCaches - 批量查询镜像缓存信息

更新时间: 2023-09-25 15:18:14

调用DescribeImageCaches批量查询镜像缓存信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eci:DescribeImageCachesRead
  • ImageCache
    acs:eci:{#regionId}:{#accountId}:imagecache/*
  • ImageCache
    acs:eci:{#regionId}:{#accountId}:imagecache/{#imagecacheId}
  • eci:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
ImageCacheIdstring

镜像缓存ID。

imc-bp195erqe9o2pb09****
ImageCacheNamestring

镜像缓存名称。

testcache
SnapshotIdstring

镜像缓存对应的快照ID。

s-2zec5oj8e1yhxijt****
Imagestring

容器镜像。

nginx
ResourceGroupIdstring

所属资源组ID。

rg-2df3isufhi38****
Tagobject []

镜像缓存绑定的标签信息。

Keystring

镜像缓存标签键。

imc
Valuestring

镜像缓存标签值。

test
MatchImagearray

指定容器镜像,用于查询最佳匹配的镜像缓存,最多100个。

string

指定容器镜像,用于查询最佳匹配的镜像缓存,最多100个。

registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
Limitinteger

查询结果条数上限。

20
NextTokenstring

查询凭证(Token),取值为上一次API调用返回的NextToken参数值。

AAAAAdDWBF2****
ImageFullMatchboolean

是否完全匹配容器镜像。
在配置了MatchImage取值的情况下,进一步过滤查询结果。

true
ImageMatchCountRequestinteger

完全匹配容器镜像的镜像缓存个数。
在配置了MatchImage取值的情况下,进一步过滤查询结果。

3

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID,唯一标识。

39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301
ImageCachesobject []

镜像缓存信息列表。

Imagesarray

镜像缓存包含的镜像列表。

string

镜像缓存包含的镜像列表。

registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
CreationTimestring

创建时间。

2021-02-09T02:24:07Z
Statusstring

镜像缓存状态。可能值:

  • Preparing:准备中
  • Creating:创建中
  • Ready:创建完成
  • Failed:创建失败
  • Updating:更新中
  • UpdateFailed:更新失败

当状态为Ready时,即可使用该镜像缓存。

Ready
Progressstring

镜像缓存对应快照的创建进度。

说明 如果开启了极速镜像缓存功能,将先创建一份临时使用的本地快照再创建一份普通快照,该进度为普通快照的创建进度。
100%
ExpireDateTimestring

到期时间。

2019-11-10T09:00:48Z
LastMatchedTimestring

最新一次匹配到镜像缓存的时间。

2021-08-18T03:48:10Z
ContainerGroupIdstring

容器组ID。

eci-bp18oq3m15prd9jb****
Tagsobject []

镜像缓存的标签列表信息。

Keystring

标签键。

imc
Valuestring

标签值。

test
Eventsobject []

镜像缓存拉取镜像事件信息。

Typestring

事件类型。

Normal
LastTimestampstring

事件结束时间。

2021-02-09T02:24:48Z
Messagestring

事件消息。

Successfully check image cache resource.
Namestring

事件名称。

imagetest.1661f31f851a****
Countinteger

事件数。

1
FirstTimestampstring

事件开始时间。

2021-02-09T02:24:48Z
Reasonstring

事件原因。

Started
ImageCacheIdstring

镜像缓存ID。

imc-bp195erqe9o2pb09****
RegionIdstring

所属地域。

cn-beijing
SnapshotIdstring

镜像缓存对应的快照ID。

s-2zec5oj8e1yhxijt****
FlashSnapshotIdstring

本地快照ID。开启极速镜像缓存功能后,将临时创建一份本地快照。

s-bp12w3v37sit96t6****
ResourceGroupIdstring

所属资源组ID。

rg-2df3isufhi38****
ImageCacheSizeinteger

镜像缓存大小。单位:GiB。

20
ImageCacheNamestring

镜像缓存名称。

imagetest
EliminationStrategystring

镜像缓存的淘汰策略。默认为空,表示一直保留。

支持配置为LRU,表示可以被自动删除。当镜像缓存数量达到配额限制时,系统将自动删除最不常用的EliminationStrategy为LRU的镜像缓存。

LRU
NextTokenstring

本次调用返回的查询凭证值。

AAAAAdDWBF2****
TotalCountinteger

查询结果总条数。

15

示例

正常返回示例

JSON格式

{
  "RequestId": "39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301",
  "ImageCaches": [
    {
      "Images": [
        "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl"
      ],
      "CreationTime": "2021-02-09T02:24:07Z",
      "Status": "Ready",
      "Progress": "100%",
      "ExpireDateTime": "2019-11-10T09:00:48Z",
      "LastMatchedTime": "2021-08-18T03:48:10Z",
      "ContainerGroupId": "eci-bp18oq3m15prd9jb****",
      "Tags": [
        {
          "Key": "imc",
          "Value": "test"
        }
      ],
      "Events": [
        {
          "Type": "Normal",
          "LastTimestamp": "2021-02-09T02:24:48Z",
          "Message": "Successfully check image cache resource.",
          "Name": "imagetest.1661f31f851a****",
          "Count": 1,
          "FirstTimestamp": "2021-02-09T02:24:48Z",
          "Reason": "Started"
        }
      ],
      "ImageCacheId": "imc-bp195erqe9o2pb09****",
      "RegionId": "cn-beijing",
      "SnapshotId": "s-2zec5oj8e1yhxijt****",
      "FlashSnapshotId": "s-bp12w3v37sit96t6****",
      "ResourceGroupId": "rg-2df3isufhi38****",
      "ImageCacheSize": 20,
      "ImageCacheName": "imagetest",
      "EliminationStrategy": "LRU"
    }
  ],
  "NextToken": "AAAAAdDWBF2****",
  "TotalCount": 15
}

错误码

HTTP status code错误码错误信息描述
400Account.ArrearageYour account has an outstanding payment.账号已经欠费。
400DryRunOperationRequest validation has been passed with DryRun flag set.此次DryRun预检请求合格。
400ServiceNotEnabled%s该次请求所依赖的服务没有开通,请开通后再试。
403Forbidden.SubUserThe specified action is not available for you.当前用户无法执行该操作
403Forbidden.UserBussinessStatusThis operation is not allowed, because you have overdue bills. Pay the overdue bill and try again.用户处于欠费状态不允许创建,请充值后再尝试。
403Forbidden.UserNotRealNameAuthenticationThis operation is not allowed, because you have not passed the real-name verification.操作被禁止,因为用户还未进行实名认证。
403NoPermissionThe RAM role does not belong to ECS.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-05OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-04-17OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:ImageFullMatch
    新增入参:ImageMatchCountRequest
2022-10-09OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:Limit
    新增入参:NextToken
出参OpenAPI 返回结构发生变更
2021-09-22OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:MatchImage
2021-09-22OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2021-08-10OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
阿里云首页 弹性容器实例 相关技术圈