创建一个镜像缓存。
{Creating, [Progressing]}
状态,直到创建执行成功,进入{Ready, [Ok]}
状态。请调用 ListImageCaches 接口获取该镜像缓存当前的状态,查看镜像缓存是否创建成功。[Deleting,*]
),每个火山引擎账号(含子用户)最多支持存在 20 个镜像缓存,超过后无法创建新的镜像缓存。您可以删除无用的镜像缓存,或 提交工单 申请提升配额。调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateImageCache | 接口名称。当前 API 的名称为 CreateImageCache 。 |
Version | String | 是 | 2022-05-12 | 接口版本。当前 API 的版本为 2022-05-12 。 |
ImageCacheName | String | 是 | test-imc | 镜像缓存名称。
|
SubnetIds | Array of String | 是 | ["subnet-3rf6vwbgkg****"] | 镜像缓存实例所属的子网 ID。 说明 单次最多填写 5 个子网 ID。 |
SecurityGroupIds | Array of String | 是 | ["sg-2byy13cnsczy****"] | 镜像缓存网络所在安全组 ID。 说明 单次最多填写 5 个安全组 ID。 |
Images | Array of String | 是 | ["cr-cn-beijing.volces.com/vke****/nginx:latest"] | 制作镜像缓存所需要的容器镜像列表。 |
ImageCacheSize | Integer | 否 | 50 | 镜像缓存的大小。
|
ImageRegistryCredentials | Array of ImageRegistryCredentials | 否 | - | 镜像仓库(CR)的访问凭证信息。 |
AutoPrewarmConfig | Object of AutoPrewarmConfig | 否 | - | 镜像缓存对应的弹性块存储(EBS)快照预热策略配置。 |
RetentionDays | Integer | 否 | 15 | 镜像缓存保留时间,过期后镜像缓存会被清理。
注意 请求参数中不传入该参数时,表示镜像缓存永不过期。 |
RegistryHostnameResolvNameservers | Array of String | 否 | ["10.xx.xx.xx", "10.xx.xx.xx"] | 用于解析主机名的 DNS 服务器 IP 地址。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Server | String | 是 | cr-cn-beijing.volces.com | 不带 |
UserName | String | 是 | user_****@21000**** | 访问镜像仓库实例的用户名。 |
Password | String | 是 | dGhpcyBpcyBh******** | 镜像仓库实例用户名对应的密码。 注意 需要对密码进行 Base 64 编码后传入。Base 64 编码相关注意事项,请参见 FAQ。 您也可以获取临时访问密钥,访问镜像仓库实例。详细操作,请参见 GetAuthorizationToken。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ZoneIds | Array of String | 否 | ["cn-beijing-b"] | 需要预热的快照可用区。 说明 不传入参数值时,默认用创建镜像缓存时指定的子网所对应的可用区。 |
PrewarmRetentionDays | Integer | 否 | 90 | 镜像缓存对应 EBS 快照的预热保留时长。
|
POST /?Action= CreateImageCache&Version=2022-05-12 HTTP/1.1 Content-Type:application/json { "ImageCacheName": "test-imc", "SubnetIds": [ "subnet-3rf6vwbgkg****", "subnet-2d6kpn09********", "subnet-3rfcnoa********" ], "SecurityGroupIds": [ "sg-2byy13cnsczy****" ], "Images": [ "cr-cn-beijing.volces.com/vke****/nginx: latest", "cr-cn-beijing.volces.com/vke****/nginx:v1" ], "ImageRegistryCredentials": [{ "UserName": "user_****@21000****", "Server": "cr-cn-beijing.volces.com", "Password": "dGhpcyBpcyBh********" }], "ImageCacheSize": 50 }
本接口返回参数如下表所示,公共返回参数请参见 返回结果。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ImageCacheId | String | imc-3uqroqkx******** | 镜像缓存 ID。 |
{ "ResponseMetadata": { "RequestId": "2023022020005173B********", "Action": "CreateImageCache", "Version": "2022-05-12", "Service": "vke", "Region": "cn-beijing" }, "Result": { "ImageCacheId": "imc-3uqroqkx********" } }
本接口错误码如下表所示,公共错误码请参见 公共错误码。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | LimitExceeded.ImageCacheSize | You have reached the limit of the size of image cache that you can create. | 指定的镜像缓存盘容量超过所支持的最大值。请确认 ImageCacheSize 参数要求的取值范围。 |
400 | VpcMismatch.{{Parameter}} | The specified {{resourceType}} {{resourceId}} and {{resourceType}} {{resourceId}} are not in the same vpc. | 指定的子网、安全组等不同属于一个私有网络(VPC),请确保其处于同一个 VPC 内。 |
400 | OutOfStorage.ImageCacheSize | The size of the specified image cache is too small. | 指定的镜像缓存盘容量过小。请确认 ImageCacheSize 参数要求的取值范围。 |
400 | Conflict.Name | The specified name conflicts with existing {{resourceType}}. | 指定的地域内已经存在同名的镜像缓存。请更新镜像缓存名称后重试。 |