Updated on 2025-09-23 GMT+08:00

Viewing Details About an Image Cache

Function

This API is used to view the details about an image cache.

Calling Method

For details, see Calling APIs.

URI

GET /v5/imagecaches/{image_cache_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

image_cache_id

Yes

String

Details:

Image cache ID

Constraints:

None

Options:

Image cache IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Message body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

image_cache

ImageCacheDetail object

Image cache information

Table 4 ImageCacheDetail

Parameter

Type

Description

name

String

Image cache name

id

String

Image cache ID

created_at

String

Image cache creation timestamp

images

Array of strings

List of container images in an image cache

image_cache_size

Integer

Size of the disk for an image cache, in GiB

retention_days

Integer

Details:

The validity period of an image cache. If this parameter is not specified or the value is 0, the image cache is permanently valid. After the validity period expires, the image cache will expire automatically and be deleted.

Constraints:

None

Options:

0 to 10000

Default value:

0

building_config

ImageCacheBuildingConfig object

Configuration for creating an image cache

status

String

Details:

Status of an image cache

Constraints:

None

Options:

  • Available: The image cache is available.

  • Unavailable: The image cache is abnormal or has expired and cannot be used.

  • Creating: The image cache is being created.

  • Deleting: The image cache is being deleted.

  • Failed: The image cache failed to be created.

Default value:

N/A

message

String

Error message indicating that an image cache fails to be created or is abnormal

Table 5 ImageCacheBuildingConfig

Parameter

Type

Description

cluster

String

Details:

UID of a CCE Autopilot cluster where a temporary pod is started for creating an image cache

Constraints:

The CCE Autopilot cluster version must be v1.28.8-r0 or v1.31.4-r0 or later.

Options:

N/A

Default value:

N/A

image_pull_secrets

Array of strings

List of access credentials for downloading the images to be cached. If no access credential is specified or no valid credential is available, only public images can be downloaded.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "image_cache" : {
    "name" : "test-imagecache",
    "id" : "c271e39e-1a6e-4d3d-8fa8-2a36329c68d2",
    "created_at" : "2024-11-25 06:32:34.923248 +0000 UTC",
    "images" : [ "centos:latest", "busybox:latest" ],
    "image_cache_size" : 25,
    "retention_days" : 7,
    "building_config" : {
      "cluster" : "c271e39f-1a6e-4d3d-8fa8-2a36329c68d2",
      "image_pull_secrets" : [ "default:secret1", "default:secret2", "kube-system:secret3" ]
    },
    "status" : "Available"
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class ShowImageCacheSolution {

    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();
        ShowImageCacheRequest request = new ShowImageCacheRequest();
        request.withImageCacheId("{image_cache_id}");
        try {
            ShowImageCacheResponse response = client.showImageCache(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());
        }
    }
}
 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
# 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 = ShowImageCacheRequest()
        request.image_cache_id = "{image_cache_id}"
        response = client.show_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)
 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
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.ShowImageCacheRequest{}
	request.ImageCacheId = "{image_cache_id}"
	response, err := client.ShowImageCache(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.