DescribeImageCaches - 批量查询镜像缓存信息 - 弹性容器实例

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
eci:DescribeImageCaches	get	ImageCache `acs:eci:{#regionId}:{#accountId}:imagecache/` *ImageCache `acs:eci:{#regionId}:{#accountId}:imagecache/{#imagecacheId}`	eci:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ImageCacheId	string	否	镜像缓存 ID。	imc-bp195erqe9o2pb09****
ImageCacheName	string	否	镜像缓存名称。	testcache
SnapshotId	string	否	镜像缓存对应的快照 ID。	s-2zec5oj8e1yhxijt****
Image	string	否	容器镜像。	nginx
ResourceGroupId	string	否	所属资源组 ID。	rg-2df3isufhi38****
Tag	array<object>	否	镜像缓存绑定的标签信息。
	object	否	镜像缓存绑定的标签信息，最多 20 个。
Key	string	否	镜像缓存标签键。	imc
Value	string	否	镜像缓存标签值。	test
MatchImage	array	否	指定容器镜像，用于查询最佳匹配的镜像缓存，最多 100 个。
	string	否	指定容器镜像，用于查询最佳匹配的镜像缓存，最多 100 个。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
Limit	integer	否	查询结果条数上限。	20
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAdDWBF2****
ImageFullMatch	boolean	否	是否完全匹配容器镜像。在配置了 MatchImage 取值的情况下，进一步过滤查询结果。	true
ImageMatchCountRequest	integer	否	完全匹配容器镜像的镜像缓存个数。在配置了 MatchImage 取值的情况下，进一步过滤查询结果。	3

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，唯一标识。	39FC2E43-3DD7-4CEF-9EF4-E4AD6E635301
ImageCaches	array<object>	镜像缓存信息列表。
ImageCache	object	镜像缓存信息列表。
Images	array	镜像缓存包含的镜像列表。
Image	string	镜像缓存包含的镜像列表。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
CreationTime	string	创建时间。	2021-02-09T02:24:07Z
Status	string	镜像缓存状态。可能值： Preparing：准备中 Creating：创建中 Ready：创建完成 Failed：创建失败 Updating：更新中 UpdateFailed：更新失败当状态为 Ready 时，即可使用该镜像缓存。	Ready
Progress	string	镜像缓存对应快照的创建进度。说明如果开启了极速镜像缓存功能，将先创建一份临时使用的本地快照再创建一份标准快照，该进度为标准快照的创建进度。	100%
ExpireDateTime	string	到期时间。	2019-11-10T09:00:48Z
LastMatchedTime	string	最新一次匹配到镜像缓存的时间。	2021-08-18T03:48:10Z
ContainerGroupId	string	容器组 ID。	eci-bp18oq3m15prd9jb****
Tags	array<object>	镜像缓存的标签列表信息。
Tag	object	镜像缓存的标签列表信息。
Key	string	标签键。	imc
Value	string	标签值。	test
Events	array<object>	镜像缓存拉取镜像事件信息。
Event	object	镜像缓存拉取镜像事件信息。
Type	string	事件类型。	Normal
LastTimestamp	string	事件结束时间。	2021-02-09T02:24:48Z
Message	string	事件消息。	Successfully check image cache resource.
Name	string	事件名称。	imagetest.1661f31f851a****
Count	integer	事件数。	1
FirstTimestamp	string	事件开始时间。	2021-02-09T02:24:48Z
Reason	string	事件原因。	Started
ImageCacheId	string	镜像缓存 ID。	imc-bp195erqe9o2pb09****
RegionId	string	所属地域。	cn-beijing
SnapshotId	string	镜像缓存对应的快照 ID。	s-2zec5oj8e1yhxijt****
FlashSnapshotId	string	本地快照 ID。开启极速镜像缓存功能后，将临时创建一份本地快照。	s-bp12w3v37sit96t6****
ResourceGroupId	string	所属资源组 ID。	rg-2df3isufhi38****
ImageCacheSize	integer	镜像缓存大小。单位：GiB。	20
ImageCacheName	string	镜像缓存名称。	imagetest
EliminationStrategy	string	镜像缓存的淘汰策略。默认为空，表示一直保留。支持配置为 LRU，表示可以被自动删除。当镜像缓存数量达到配额限制时，系统将自动删除最不常用的 EliminationStrategy 为 LRU 的镜像缓存。	LRU
NextToken	string	本次调用返回的查询凭证值。	AAAAAdDWBF2****
TotalCount	integer	查询结果总条数。	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	错误码	错误信息	描述
400	Account.Arrearage	Your account has an outstanding payment.	账号已经欠费。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	此次DryRun预检请求合格。
400	ServiceNotEnabled	%s	该次请求所依赖的服务没有开通，请开通后再试。
403	Forbidden.SubUser	The specified action is not available for you.	当前用户无法执行该操作。
403	Forbidden.UserBussinessStatus	This operation is not allowed, because you have overdue bills. Pay the overdue bill and try again.	用户处于欠费状态不允许创建，请充值后再尝试。
403	Forbidden.UserNotRealNameAuthentication	This operation is not allowed, because you have not passed the real-name verification.	操作被禁止，因为用户还未进行实名认证。
403	NoPermission	The RAM role does not belong to ECS.	-

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

变更历史

变更时间	变更内容概要	操作
2023-09-05	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-17	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-10-09	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-09-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2021-09-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2021-08-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情