查看镜像列表

最近更新时间:2018-10-12 16:03:05

1. 接口描述

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

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

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获取。
  • 通过镜像控制台获取。
  • Filters.N Array of Filter 过滤条件,每次请求的Filters的上限为0,Filters.Values的上限为5。参数不可以同时指定ImageIdsFilters。详细的过滤条件如下:
  • image-id - String - 是否必填: 否 - (过滤条件)按照镜像ID进行过滤
  • image-type - String - 是否必填: 否 - (过滤条件)按照镜像类型进行过滤。取值范围:详见镜像类型
  • image-state - String - 是否必填: 否 - (过滤条件)按照镜像状态进行过滤。取值范围:详见镜像状态
  • Offset Integer 偏移量,默认为0。关于Offset详见API简介
    Limit Integer 数量限制,默认为20,最大值为100。关于Limit详见API简介
    InstanceType String 实例类型,如 S1.SMALL1

    3. 输出参数

    参数名称 类型 描述
    ImageSet Array of Image 一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。
    TotalCount Integer 符合要求的镜像数量。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 示例

    示例1 按镜像ID查询镜像

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeImages
    &Filters.0.Name=image-id
    &Filters.0.Values.0=img-pmqg1cw7
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "ImageSet": [
          {
            "Creator": "PUBLIC",
            "ImageCreateTime": "1970-01-01T00:00:00+00:00",
            "ImageDescription": "CentOS 6.6 32位",
            "ImageId": "img-pmqg1cw7",
            "ImageName": "CentOS 6.6 32位",
            "ImageOsName": "centos6.6x86_32",
            "ImageStatus": "NORMAL",
            "ImageType": "PUBLIC_IMAGE"
          }
        ],
        "RequestId": "5920380e-277a-420a-a221-0caac3eb7159",
        "TotalCount": 1
      }
    }

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

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeImages
    &Filters.0.Name=image-type
    &Filters.0.Values.0=PRIVATE_IMAGE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "ImageSet": [
          {
            "Creator": "PUBLIC",
            "ImageCreateTime": "1970-01-01T00:00:00+00:00",
            "ImageDescription": "CentOS 6.6 32位",
            "ImageId": "img-pmqg1cw7",
            "ImageName": "CentOS 6.6 32位",
            "ImageOsName": "centos6.6x86_32",
            "ImageStatus": "NORMAL",
            "ImageType": "PUBLIC_IMAGE"
          }
        ],
        "RequestId": "5920380e-277a-420a-a221-0caac3eb7159",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 无效的过滤器。
    InvalidParameter.InvalidParameterCoexistImageIdsFilters 不能同时指定ImageIds和Filters。
    InvalidParameterValue.InvalidParameterValueLimit 参数值错误。

    如果有其他疑问,你也可以通过提问形式与我们联系探讨