容器服务查询镜像缓存信息-弹性容器实例相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查询镜像缓存信息接口

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeImageCaches。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
ImageCacheIds.N	否	Array of String	镜像缓存Id数组示例值：""
ImageCacheNames.N	否	Array of String	镜像缓存名称数组示例值：""
Limit	否	Integer	限定此次返回资源的数量。如果不设定，默认返回20，最大不能超过50 示例值：""
Offset	否	Integer	偏移量,默认0 示例值：""
Filters.N	否	Array of Filter	过滤条件，可选条件： (1)实例名称 KeyName: image-cache-name 类型：String 示例值：""

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	镜像缓存总数示例值：[]
ImageCaches	Array of ImageCache	镜像缓存信息列表示例值：[]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询镜像缓存信息

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageCaches
<公共请求参数>

{
    "ImageCacheIds": [
        "imc-xxx"
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "RequestId": "6704dc99-e331-4055-8af9-123456789",
        "TotalCount": 1,
        "ImageCaches": [
            {
                "ImageCacheId": "imc-xxx",
                "ImageCacheName": "imc-nginx",
                "ImageCacheSize": 20,
                "Status": "Ready",
                "Images": [
                    "nginx"
                ],
                "CreationTime": "2021-12-06 22:52:24",
                "ExpireDateTime": "",
                "Events": [
                    {
                        "ImageCacheId": "imc-xxx",
                        "Reason": "SnapCreated",
                        "Type": "Normal",
                        "FirstTimestamp": "2021-12-06 15:10:43",
                        "LastTimestamp": "2021-12-06 15:10:43",
                        "Message": "Snap snap-xxx created"
                    },
                    {
                        "ImageCacheId": "imc-xxx",
                        "Reason": "DiskCreated",
                        "Type": "Normal",
                        "FirstTimestamp": "2021-12-06 15:03:24",
                        "LastTimestamp": "2021-12-06 15:03:24",
                        "Message": "Disk disk-xxx created"
                    },
                    {
                        "ImageCacheId": "imc-xxx",
                        "Reason": "EksciCreated",
                        "Type": "Normal",
                        "FirstTimestamp": "2021-12-06 15:03:24",
                        "LastTimestamp": "2021-12-06 15:03:24",
                        "Message": "Eksci eksci-xxx created"
                    }
                ],
                "LastMatchedTime": "2021-12-07 21:30:15",
                "SnapshotId": "snap-xxx"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。

查询镜像缓存信息

本页目录：