调用CreateImageCache接口创建镜像缓存-弹性容器实例-阿里云

调用CreateImageCache接口创建一个镜像缓存，以便后续创建ECI实例可以加速镜像拉取，减少实例启动耗时。

接口说明

注意事项

创建镜像缓存涉及资源计费。建议您提前了解相关计费信息。更多信息，请参见镜像缓存计费。
创建镜像缓存前，您需要评估待缓存镜像的总大小，如果镜像总大小超过设置的缓存大小，将会创建失败。
创建镜像缓存时，系统将自动创建一个 ECI 实例和一块 ESSD PL1 类型的云盘用于中转创建镜像缓存。创建过程中请勿删除 ECI 实例和云盘，否则镜像缓存将创建失败。
创建镜像缓存将生成对应的快照。请勿删除快照，否则镜像缓存将会失效。
如果使用 SDK，则对应版本为：Java 1.0.10 以上，Python 1.0.7 以上。

使用建议

对于使用自定义域名的 ACR 企业版镜像，需要指定 ACR 实例（设置 AcrRegistryInfo 相关参数）来配置免密。设置 AcrRegistryInfo 相关参数时，必须设置 AcrRegistryInfo.N.InstanceId。
如果该镜像缓存将用于批量创建多个（超过 1000 个）ECI 实例，建议您设置 StandardCopyCount 和 FlashCopyCount 实现快照多副本功能。快照多副本按增量数据收费，由于本次创建的多个快照副本数据均一致，因此使用快照多副本功能不会增加额外费用。

说明

调用 CreateImageCache 创建镜像缓存时，系统将自动为您创建一个服务关联角色 AliyunServiceRoleForECI，用于访问 ECS、VPC 等相关云服务。更多信息，请参见弹性容器实例服务关联角色。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

eci:CreateImageCache

create

*ImageCache

acs:eci:{#regionId}:{#accountId}:imagecache/*

eci:tag

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
RegionId	string	是	地域 ID。	cn-hangzhou
ZoneId	string	否	可用区。	cn-hangzhou-g
SecurityGroupId	string	否	安全组 ID。	sg-uf66jeqopgqa9hdn****
VSwitchId	string	否	交换机 ID。支持指定多个交换机 ID（单次最多 10 个），各交换机 ID 之间可以用半角逗号（,）进行分割，例如`vsw-*,vsw-*`。	vsw-uf6h3rbwbm90urjwa****
ImageCacheName	string	是	镜像缓存名称。	testcache
EipInstanceId	string	否	弹性公网 IP。如果需要拉取公网镜像，需要确保 ECI 实例能够访问公网，您可以配置 EIP 或者 NAT 网关实现公网访问。	eip-2zedsm5mfl3uhdj2d****
ResourceGroupId	string	否	资源组 ID。	rg-aekzh43v*****
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。	123e4567-xxx-xxx-xxxx-42665544xxxx
ImageCacheSize	integer	否	镜像缓存的大小。默认为 20 GiB。	20
RetentionDays	integer	否	镜像缓存保留时间，过期将会被清理，默认永不过期。说明创建失败的镜像缓存仅保留一天。	7
AutoMatchImageCache	boolean	否	是否开启镜像缓存复用。开启后，新创建的镜像缓存可以复用已有镜像缓存的镜像层，加快镜像缓存的制作速度。取值范围： true：开启 false：不开启默认为 false。	true
ImageRegistryCredential	array<object>	否	镜像仓库信息。
	object	否	镜像仓库信息。
Password	string	否	镜像仓库密码。	password
Server	string	否	不带 `http://` 或 `https://` 前缀的镜像仓库地址。	registry-vpc.cn-hangzhou.aliyuncs.com
UserName	string	否	镜像仓库用户名。	username
Image	array	是	用于制作镜像缓存的容器镜像。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
	string	否	用于制作镜像缓存的容器镜像。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl
Tag	array<object>	否	镜像缓存标签信息，最多 20 个。
	object	否	镜像缓存标签信息，最多 20 个。
Key	string	否	镜像缓存标签键。	imc
Value	string	否	镜像缓存标签值。	test
Flash	boolean	否	是否开启极速镜像缓存功能，开启后，可以加速镜像缓存创建。取值范围： true：开启 false：不开启默认为 false。	true
AcrRegistryInfo	array<object>	否	ACR 实例信息。更多信息，请参见免密拉取 ACR 镜像。
	object	否	ACR 实例信息。
Domain	array	否	ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名，多个以半角逗号分隔。	test****-registry.cn-beijing.cr.aliyuncs.com
	string	否	ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名，多个以半角逗号分隔。	test****-registry.cn-beijing.cr.aliyuncs.com
InstanceName	string	否	ACR 企业版实例的名称。	test****
InstanceId	string	否	ACR 企业版实例 ID。	cri-nwj395hgf6f3****
RegionId	string	否	ACR 企业版实例所属地域。	cn-beijing
ArnService	string	否	ECI 实例等资源归属账号下的 RAM 角色的 ARN。	acs:ram::1609982529******:role/role-assume
ArnUser	string	否	ACR 实例归属账号下的 RAM 角色的 ARN。	acs:ram::1298452580******:role/role-acr
Annotations	string	否	注解。该参数暂不对外使用。	hide
PlainHttpRegistry	string	否	自建镜像仓库地址。使用 HTTP 协议的自建镜像仓库中的镜像创建镜像缓存时，需配置该参数，使得 ECI 使用 HTTP 协议拉取镜像，避免因协议不同而导致镜像拉取失败。	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"
InsecureRegistry	string	否	自建镜像仓库地址。使用自签发证书的自建镜像仓库中的镜像创建镜像缓存时，需配置该参数来跳过证书认证，避免因证书认证失败而导致镜像拉取失败。	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"
StandardCopyCount	integer	否	标准快照副本数。默认情况下，一个镜像缓存对应一个快照。如果该镜像缓存将用于批量创建多个 ECI 实例，建议您配置该参数实现快照多副本。推荐每 1000 个 ECI 实例增加一个快照副本。说明未开启极速镜像缓存功能（Flash 取值为 false）时，创镜像缓存的过程中仅生成标准快照。	7
FlashCopyCount	integer	否	本地快照副本数。默认情况下，一个镜像缓存对应一个快照。如果该镜像缓存将用于批量创建多个 ECI 实例，建议您配置该参数实现快照多副本。推荐每 1000 个 ECI 实例增加一个快照副本。说明开启极速镜像缓存功能（Flash 取值为 true）时，创建镜像缓存的过程中将先创建本地快照，在本地快照创建完成后开始创建标准快照，待标准快照创建完成后会自动删除本地快照。	7
EliminationStrategy	string	否	镜像缓存的淘汰策略。默认为空，表示一直保留。支持配置为 LRU，表示可以被自动删除。当镜像缓存数量达到配额限制时，系统将自动删除最不常用的 EliminationStrategy 为 LRU 的镜像缓存。	LRU
OsType	string	否	容器镜像的操作系统。取值范围： Linux（默认值） Windows 说明 Windows 正在邀测中，如需使用，请提交工单申请。	Linux

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，唯一标识。	0E234675-3465-4CC3-9D0F-9A864BC391DD
ImageCacheId	string	镜像缓存 ID。	imc-2zebxkiifuyzzlhl****
ContainerGroupId	string	用于中转创建镜像缓存的 ECI 实例 ID。	eci-2zebxkiifuyzzlhl****

示例

正常返回示例

JSON格式

{
  "RequestId": "0E234675-3465-4CC3-9D0F-9A864BC391DD",
  "ImageCacheId": "imc-2zebxkiifuyzzlhl****",
  "ContainerGroupId": "eci-2zebxkiifuyzzlhl****"
}

错误码

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	InvalidParameter.CPU.Memory	The specified cpu and memory are not allowed
400	IncorrectStatus	%s	指定的实例状态不正确。
400	ServiceNotEnabled	%s	该次请求所依赖的服务没有开通，请开通后再试。
400	DiskVolume.NotSupport	The disk volume is not supported.	云盘卷暂不支持，如有需要请联系我们。
400	RamRole.NotSupport	The RAM role is not supported.	ram实例角色不支持。
400	ImageCache.IncorrectStatus	%s	镜像缓存当前的状态不对。
400	ImageCacheNotSupport	Image cache is not available for all users. If you want to enable this function, contact us.	镜像缓存功能还未全网开放，如果有需要请联系我们。
400	EipAddressPoolIpNotEnough	The ip address of specified PublicIpAddressPool is not enough.	指定的eip公网地址池地址资源不足。
400	OperationConflict	The request was denied. It conflicts with a previous request.
403	OperationDenied.VswZoneMisMatch	The specified VSwitchId is not in the specified Zone.
403	QuotaExceeded	%s quota exceeded.
403	Zone.NotOnSale	The specified zone is not available for purchase.	创建实例的可用区已经关闭售卖，请更换其他可用区。或者无法在该可用区使用指定 VPC 的虚拟交换机。
403	Forbidden.RiskControl	This operation has been identified as an abnormal operation and cannot be processed.	此操作已被确定为一个操作异常，无法处理。
403	Forbidden.SubUser	The specified action is not available for you.
403	Forbidden.OnlyForInvitedTest	Eci create action is only open to invited users during public beta.
403	OperationDenied.SecurityGroupMisMatch	The specified VSwitchId and SecurityGroupId are not in the same VPC.
403	InvalidVSwitchId.IpNotEnough	The specified VSwitch does not have enough IP addresses.
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	InvalidUser.PassRoleForbidden	The RAM user is not authorized to assume a RAM role.	子账号用户没有权限使用RAM实例角色。
403	OperationDenied.NoStock	Sales of this resource are temporarily suspended in the specified zone. We recommend that you use the multi-zone creation function to avoid the risk of insufficient resource. For more information, see https://help.aliyun.com/document_detail/157290.html
403	NoPermission	The RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again.
403	SecurityRisk.3DVerification	We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.	我们检测到您的默认信用卡或借记卡存在安全风险。请通过电子邮件中的链接进行验证。
403	CreateServiceLinkedRole.Denied	Please make sure the account has ram:CreateServiceLinkedRole permission.	请确保账号拥有ram:CreateServiceLinkedRole权限。

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

变更历史

更多信息，参考变更详情。