# 查询镜像缓存详情 - ShowImageCache #### 功能介绍 查询镜像缓存详情 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0099.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0327.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cce:imageCache:get | Read | - | - | - | - | #### URI GET /v5/imagecaches/{image_cache_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | image_cache_id | 是 | String | **参数解释：** 镜像缓存ID。 **约束限制：** 不涉及 **取值范围：** 镜像缓存ID。 **默认取值：** 不涉及 | #### 请求参数 表2请求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](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image_cache | [ImageCacheDetail] object | 镜像缓存信息。 | 表4ImageCacheDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 镜像缓存创建失败或异常的错误信息。 | 表5ImageCacheBuildingConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster | String | **参数解释：** 构建镜像缓存所启动的临时Pod所在的Autopilot集群的UID。 **约束限制：** 要求使用的Autopilot集群版本为v1.28.8-r0或v1.31.4-r0以上版本。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | image_pull_secrets | Array of strings | 下载所需缓存镜像的访问凭证列表，不填写或无有效凭证时仅支持下载公共镜像。 | #### 请求示例 无 #### 响应示例 **状态码：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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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("")). 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=ShowImageCache)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。