查询镜像缓存列表 - ListImageCaches
功能介绍
查询镜像缓存列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cce:imageCache:list
List
-
-
-
-
URI
GET /v5/imagecaches
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数解释: 按单个镜像缓存名称进行过滤,不支持模糊匹配。 约束限制: 不涉及 取值范围: 以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围1-128位,且不能以中划线(-)结尾。 默认取值: 无 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式)。 约束限制: GET方法不做校验。 取值范围: 默认取值: 不涉及 |
|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
image_caches |
Array of ImageCacheDetail objects |
镜像缓存列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 镜像缓存的状态。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
message |
String |
镜像缓存创建失败或异常的错误信息。 |
请求示例
无
响应示例
状态码:200
OK
{
"image_caches" : [ {
"name" : "test-imagecache",
"id" : "c271e39e-1a6e-4d3d-8fa8-2a36329c68d2",
"created_at" : "2024-11-25 06:32:34.923248 +0000 UTC",
"images" : [ "swr.xxxxx.com/xxxxx/nginx: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代码示例如下。
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 |
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 ListImageCachesSolution { 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(); ListImageCachesRequest request = new ListImageCachesRequest(); try { ListImageCachesResponse response = client.listImageCaches(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 |
# 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 = ListImageCachesRequest() response = client.list_image_caches(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 |
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.ListImageCachesRequest{} response, err := client.ListImageCaches(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。