You need to enable JavaScript to run this app.
导航
CreateImageCache
最近更新时间:2024.11.25 17:26:56首次发布时间:2023.03.14 21:35:34

创建一个镜像缓存。

使用说明

  • 此接口为异步接口,当此接口返回成功时,会返回镜像缓存的 ID 信息,此时镜像缓存将进入{Creating, [Progressing]}状态,直到创建执行成功,进入{Ready, [Ok]}状态。请调用 ListImageCaches 接口获取该镜像缓存当前的状态,查看镜像缓存是否创建成功。
  • 创建镜像缓存前,需要准备所需的容器镜像。支持使用火山引擎镜像仓库(CR)中的镜像,也支持使用第三方镜像仓库中的镜像。CR 中上传镜像的操作,请参见 推送和拉取镜像
  • 除了正在删除中的镜像缓存(状态为[Deleting,*]),每个火山引擎账号(含子用户)最多支持存在 20 个镜像缓存,超过后无法创建新的镜像缓存。您可以删除无用的镜像缓存,或 提交工单 申请提升配额。

请求说明

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

请求参数

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

参数类型是否必选示例值描述
ActionStringCreateImageCache接口名称。当前 API 的名称为 CreateImageCache
VersionString2022-05-12接口版本。当前 API 的版本为 2022-05-12

ImageCacheName

String

test-imc

镜像缓存名称。

  • 同一个地域内,镜像缓存名称必须唯一。
  • 支持大小写英文字母、数字、短划线(-),长度限制为 1~64 个字符。

SubnetIds

Array of String

["subnet-3rf6vwbgkg****"]

镜像缓存实例所属的子网 ID。
可以调用 私有网络 API 获取目标子网 ID。

说明

单次最多填写 5 个子网 ID。

SecurityGroupIds

Array of String

["sg-2byy13cnsczy****"]

镜像缓存网络所在安全组 ID。
可以调用私有网络的 DescribeSecurityGroups 接口,获取安全组 ID。

说明

单次最多填写 5 个安全组 ID。

ImagesArray of String["cr-cn-beijing.volces.com/vke****/nginx:latest"]制作镜像缓存所需要的容器镜像列表。

ImageCacheSize

Integer

50

镜像缓存的大小。

  • 单位:GiB。
  • 取值范围:40~500。
  • 默认值:40。
ImageRegistryCredentialsArray of ImageRegistryCredentials-镜像仓库(CR)的访问凭证信息。
AutoPrewarmConfigObject of AutoPrewarmConfig-镜像缓存对应的弹性块存储(EBS)快照预热策略配置。

RetentionDays

Integer

15

镜像缓存保留时间,过期后镜像缓存会被清理。

  • 单位:天
  • 取值范围:1~365(正整数)

注意

请求参数中不传入该参数时,表示镜像缓存永不过期。

RegistryHostnameResolvNameservers

Array of String

["10.xx.xx.xx", "10.xx.xx.xx"]

用于解析主机名的 DNS 服务器 IP 地址。

  • 支持传入 0~3 个 IP 地址。
  • 每个地址必须为合法的 IPv4 地址。

ImageRegistryCredentials

参数类型是否必选示例值描述

Server

String

cr-cn-beijing.volces.com

不带http://https://前缀的镜像仓库域名。
通过 镜像仓库控制台 或调用镜像仓库的 ListDomains 接口,获取镜像仓库域名。

UserName

String

user_****@21000****

访问镜像仓库实例的用户名。
通过 镜像仓库控制台 或调用镜像仓库的 GetUser 接口,获取访问镜像仓库实例的用户名。

Password

String

dGhpcyBpcyBh********

镜像仓库实例用户名对应的密码。

注意

需要对密码进行 Base 64 编码后传入。Base 64 编码相关注意事项,请参见 FAQ

您也可以获取临时访问密钥,访问镜像仓库实例。详细操作,请参见 GetAuthorizationToken

AutoPrewarmConfig

参数类型是否必选示例值描述

ZoneIds

Array of String

["cn-beijing-b"]

需要预热的快照可用区。

说明

不传入参数值时,默认用创建镜像缓存时指定的子网所对应的可用区。

PrewarmRetentionDays

Integer

90

镜像缓存对应 EBS 快照的预热保留时长。

  • 单位:天
  • 取值范围:1~180
  • 默认值:90

请求示例

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
}

返回参数

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

参数类型示例值描述
ImageCacheIdStringimc-3uqroqkx********镜像缓存 ID。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023022020005173B********",
        "Action": "CreateImageCache",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "ImageCacheId": "imc-3uqroqkx********"
    }

}

错误码

本接口错误码如下表所示,公共错误码请参见 公共错误码

HTTP 状态码错误码错误信息说明
400LimitExceeded.ImageCacheSizeYou have reached the limit of the size of image cache that you can create.指定的镜像缓存盘容量超过所支持的最大值。请确认 ImageCacheSize 参数要求的取值范围。
400VpcMismatch.{{Parameter}}The specified {{resourceType}} {{resourceId}} and {{resourceType}} {{resourceId}} are not in the same vpc.指定的子网、安全组等不同属于一个私有网络(VPC),请确保其处于同一个 VPC 内。
400OutOfStorage.ImageCacheSizeThe size of the specified image cache is too small.指定的镜像缓存盘容量过小。请确认 ImageCacheSize 参数要求的取值范围。
400Conflict.NameThe specified name conflicts with existing {{resourceType}}.指定的地域内已经存在同名的镜像缓存。请更新镜像缓存名称后重试。