有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(DescribeImages) 用于查看镜像列表。

  • 可以通过指定镜像ID来查询指定镜像的详细信息,或通过设定过滤器来查询满足过滤条件的镜像的详细信息。
  • 指定偏移(Offset)和限制(Limit)来选择结果中的一部分,默认返回满足条件的前20个镜像信息。

默认接口请求频率限制:40次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeImages。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
ImageIds.N Array of String 镜像ID列表 。镜像ID如:img-gvbnzy6f。array型参数的格式可以参考API简介。镜像ID可以通过如下方式获取:
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过镜像控制台获取。
    示例值:["img-gvbnzy6f"]
  • Filters.N Array of Filter 过滤条件,每次请求的Filters的上限为10,Filters.Values的上限为5。参数不可以同时指定ImageIdsFilters。详细的过滤条件如下:

  • image-id

  • 按照【镜像ID】进行过滤。

    类型:String

    必选:否


  • image-type

  • 按照【镜像类型】进行过滤。

    类型:String

    必选:否

    可选项:

    PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)

    PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)

    SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)


  • image-name

  • 按照【镜像名称】进行过滤。

    类型:String

    必选:否


  • platform

  • 按照【镜像平台】进行过滤,如CentOS。

    类型:String

    必选:否


  • tag-key

  • 按照【标签键】进行过滤。

    类型:String

    必选:否


  • tag-value

  • 按照【标签值】进行过滤。

    类型:String

    必选:否


  • tag:tag-key

  • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

    类型:String

    必选:否

    Offset Integer 偏移量,默认为0。关于Offset详见API简介
    示例值:0
    Limit Integer 数量限制,默认为20,最大值为100。关于Limit详见API简介
    示例值:20
    InstanceType String 实例类型,如 S1.SMALL1
    示例值:"S1.SMALL1"

    3. 输出参数

    参数名称 类型 描述
    ImageSet Array of Image 一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。
    TotalCount Integer 符合要求的镜像数量。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 按镜像ID查询镜像

    已经知道镜像ID,查询镜像相关信息。

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeImages
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "img-9qabwvbn"
                ],
                "Name": "image-id"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "ImageSet": [
                {
                    "ImageId": "img-9qabwvbn",
                    "OsName": "CentOS 7.6 64位",
                    "ImageSize": 50,
                    "ImageType": "PUBLIC_IMAGE",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "ImageState": "NORMAL",
                    "ImageSource": "OFFICIAL",
                    "ImageName": "CentOS 7.6 64位",
                    "ImageDescription": "CentOS 7.6 64位",
                    "ImageCreator": null,
                    "SyncPercent": null,
                    "IsSupportCloudinit": true,
                    "Platform": "CentOS",
                    "Architecture": "x86_64",
                    "SnapshotSet": [],
                    "Tags": [
                        {
                            "Value": "xx",
                            "Key": "xx"
                        }
                    ]
                }
            ],
            "RequestId": "db145873-3128-4079-8cec-65e05a7c9f89"
        }
    }

    示例2 按镜像类型查询镜像

    查询账户下所有私有镜像。

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeImages
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "PRIVATE_IMAGE"
                ],
                "Name": "image-type"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 408,
            "ImageSet": [
                {
                    "OsName": "CentOS 7.4 64位",
                    "ImageSize": 20,
                    "ImageType": "PRIVATE_IMAGE",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "ImageDescription": "test-image",
                    "ImageSource": "CREATE_IMAGE",
                    "ImageId": "img-qlzp4oea",
                    "ImageName": "test-image",
                    "ImageCreator": "3205597606",
                    "ImageState": "NORMAL",
                    "SyncPercent": null,
                    "SnapshotSet": [
                        {
                            "SnapshotId": "snap-gqa37j2p",
                            "DiskUsage": "SYSTEM_DISK",
                            "DiskSize": 20
                        }
                    ],
                    "Tags": [
                        {
                            "Value": "xx",
                            "Key": "xx"
                        }
                    ],
                    "Architecture": "x86_64",
                    "Platform": "CentOS",
                    "IsSupportCloudinit": true
                }
            ],
            "RequestId": "5908394c-5b3f-42e0-a537-8410553890a5"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.IllegalTagKey 标签键存在不合法字符
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameter.InvalidParameterCoexistImageIdsFilters 不能同时指定ImageIds和Filters。
    InvalidParameterValue.InstanceTypeNotFound 指定机型不存在
    InvalidParameterValue.InvalidAppIdFormat 无效的appid。
    InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.TagKeyNotFound 指定的标签不存在。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    InvalidRegion.NotFound 未找到该区域。
    InvalidZone.MismatchRegion 指定的zone不存在。
    ResourcesSoldOut.SpecifiedInstanceType 指定的实例类型已售罄。
    UnauthorizedOperation.InvalidToken 请确认Token是否有效。
    UnauthorizedOperation.PermissionDenied 无权操作指定的资源,请正确配置CAM策略。
    UnsupportedOperation 操作不支持。