更新时间:2025-09-23 GMT+08:00

创建镜像缓存

功能介绍

创建镜像缓存。创建过程会在指定集群中启动临时Pod进行镜像缓存构建,创建镜像缓存后,可在负载创建时通过使用镜像缓存功能大幅减少下载容器镜像的耗时,实现容器的快速启动。单租户创建镜像缓存数量上限为50。

调用方法

请参见如何调用API

URI

POST /v5/imagecaches

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

GET方法不做校验。

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data(注:存在FormData参数时使用)

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

镜像缓存名称。

约束限制:

不涉及

取值范围:

以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围1-128位,且不能以中划线(-)结尾。镜像缓存名称不可重复。

默认取值:

不涉及

images

Array of strings

镜像缓存中的容器镜像列表。

image_cache_size

Integer

参数解释:

镜像缓存后端对应的存储盘大小,单位GiB。缓存对象为解压后的镜像文件,建议镜像缓存大小不低于该缓存中所有容器镜像大小总和的3倍。

约束限制:

不涉及

取值范围:

[20-400]

默认取值:

20

retention_days

Integer

参数解释:

镜像缓存有效的天数,不设置或值为0表示永久有效。镜像缓存到达有效期后自动过期并删除。

约束限制:

不涉及

取值范围:

[0-10000]

默认取值:

0

building_config

ImageCacheBuildingConfig object

构建镜像缓存的配置信息。

表3 ImageCacheBuildingConfig

参数

是否必选

参数类型

描述

cluster

String

参数解释:

构建镜像缓存所启动的临时Pod所在的Autopilot集群的UID。

约束限制:

要求使用的Autopilot集群版本为v1.28.8-r0或v1.31.4-r0以上版本。

取值范围:

不涉及

默认取值:

不涉及

image_pull_secrets

Array of strings

下载所需缓存镜像的访问凭证列表,不填写或无有效凭证时仅支持下载公共镜像。

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

image_cache

ImageCacheDetail object

镜像缓存信息。

表5 ImageCacheDetail

参数

参数类型

描述

name

String

镜像缓存名称。

id

String

镜像缓存ID。

created_at

String

镜像缓存创建时间戳。

images

Array of strings

镜像缓存中的容器镜像列表。

image_cache_size

Integer

镜像缓存后端对应的存储盘大小,单位GiB。

retention_days

Integer

参数解释:

镜像缓存有效的天数,不设置或值为0表示永久有效。镜像缓存到达有效期后自动过期并删除。

约束限制:

不涉及

取值范围:

[0-10000]

默认取值:

0

building_config

ImageCacheBuildingConfig object

构建镜像缓存的配置信息。

status

String

参数解释:

镜像缓存的状态。

约束限制:

不涉及

取值范围:

  • Available: 可用状态,表示当前镜像缓存正常可用。

  • Unavailable:不可用,表示镜像缓存状态异常或过期,不可使用。

  • Creating:创建中,表示镜像缓存正在创建中。

  • Deleting:删除中,表示镜像缓存正在删除中。

  • Failed:创建失败,表示镜像缓存创建失败。

默认取值:

不涉及

message

String

镜像缓存创建失败或异常的错误信息。

表6 ImageCacheBuildingConfig

参数

参数类型

描述

cluster

String

参数解释:

构建镜像缓存所启动的临时Pod所在的Autopilot集群的UID。

约束限制:

要求使用的Autopilot集群版本为v1.28.8-r0或v1.31.4-r0以上版本。

取值范围:

不涉及

默认取值:

不涉及

image_pull_secrets

Array of strings

下载所需缓存镜像的访问凭证列表,不填写或无有效凭证时仅支持下载公共镜像。

请求示例

创建名为test-imagecache1镜像缓存,缓存对象为两个容器镜像,有效期设置7天,镜像缓存后端对应的存储盘大小选择25Gi。

/v5/imagecaches

{
  "name" : "test-imagecache1",
  "images" : [ "swr.region.com/test/nginx:v1", "busybox:latest" ],
  "image_cache_size" : 25,
  "retention_days" : 7,
  "building_config" : {
    "cluster" : "8b3b4b2d-e39d-11ef-a9ac-0255ac100113",
    "image_pull_secrets" : [ "default:default-secret", "test:my-secret" ]
  }
}

响应示例

状态码:201

Created

{
  "image_cache" : {
    "name" : "test-imagecache1",
    "id" : "c271e39e-1a6e-4d3d-8fa8-2a36329c68d2",
    "created_at" : "2024-11-25 06:32:34.923248 +0000 UTC",
    "images" : [ "swr.region.com/test/nginx:v1", "busybox:latest" ],
    "image_cache_size" : 25,
    "retention_days" : 7,
    "building_config" : {
      "cluster" : "8b3b4b2d-e39d-11ef-a9ac-0255ac100113",
      "image_pull_secrets" : [ "default:default-secret", "test:my-secret" ]
    },
    "status" : "Creating"
  }
}

SDK代码示例

SDK代码示例如下。

创建名为test-imagecache1镜像缓存,缓存对象为两个容器镜像,有效期设置7天,镜像缓存后端对应的存储盘大小选择25Gi。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v5.region.CceRegion;
import com.huaweicloud.sdk.cce.v5.*;
import com.huaweicloud.sdk.cce.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateImageCacheSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateImageCacheRequest request = new CreateImageCacheRequest();
        CreateImageCacheRequestBody body = new CreateImageCacheRequestBody();
        List<String> listBuildingConfigImagePullSecrets = new ArrayList<>();
        listBuildingConfigImagePullSecrets.add("default:default-secret");
        listBuildingConfigImagePullSecrets.add("test:my-secret");
        ImageCacheBuildingConfig buildingConfigbody = new ImageCacheBuildingConfig();
        buildingConfigbody.withCluster("8b3b4b2d-e39d-11ef-a9ac-0255ac100113")
            .withImagePullSecrets(listBuildingConfigImagePullSecrets);
        List<String> listbodyImages = new ArrayList<>();
        listbodyImages.add("swr.region.com/test/nginx:v1");
        listbodyImages.add("busybox:latest");
        body.withBuildingConfig(buildingConfigbody);
        body.withRetentionDays(7);
        body.withImageCacheSize(25);
        body.withImages(listbodyImages);
        body.withName("test-imagecache1");
        request.withBody(body);
        try {
            CreateImageCacheResponse response = client.createImageCache(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建名为test-imagecache1镜像缓存,缓存对象为两个容器镜像,有效期设置7天,镜像缓存后端对应的存储盘大小选择25Gi。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v5.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateImageCacheRequest()
        listImagePullSecretsBuildingConfig = [
            "default:default-secret",
            "test:my-secret"
        ]
        buildingConfigbody = ImageCacheBuildingConfig(
            cluster="8b3b4b2d-e39d-11ef-a9ac-0255ac100113",
            image_pull_secrets=listImagePullSecretsBuildingConfig
        )
        listImagesbody = [
            "swr.region.com/test/nginx:v1",
            "busybox:latest"
        ]
        request.body = CreateImageCacheRequestBody(
            building_config=buildingConfigbody,
            retention_days=7,
            image_cache_size=25,
            images=listImagesbody,
            name="test-imagecache1"
        )
        response = client.create_image_cache(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建名为test-imagecache1镜像缓存,缓存对象为两个容器镜像,有效期设置7天,镜像缓存后端对应的存储盘大小选择25Gi。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateImageCacheRequest{}
	var listImagePullSecretsBuildingConfig = []string{
        "default:default-secret",
	    "test:my-secret",
    }
	buildingConfigbody := &model.ImageCacheBuildingConfig{
		Cluster: "8b3b4b2d-e39d-11ef-a9ac-0255ac100113",
		ImagePullSecrets: &listImagePullSecretsBuildingConfig,
	}
	var listImagesbody = []string{
        "swr.region.com/test/nginx:v1",
	    "busybox:latest",
    }
	retentionDaysCreateImageCacheRequestBody:= int32(7)
	imageCacheSizeCreateImageCacheRequestBody:= int32(25)
	request.Body = &model.CreateImageCacheRequestBody{
		BuildingConfig: buildingConfigbody,
		RetentionDays: &retentionDaysCreateImageCacheRequestBody,
		ImageCacheSize: &imageCacheSizeCreateImageCacheRequestBody,
		Images: listImagesbody,
		Name: "test-imagecache1",
	}
	response, err := client.CreateImageCache(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

错误码

请参见错误码