查看镜像列表
最近更新时间: 2024-10-18 10:38:40
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口(DescribeImages) 用于查看镜像列表。
- 可以通过指定镜像ID来查询指定镜像的详细信息，或通过设定过滤器来查询满足过滤条件的镜像的详细信息。( 该接口不支持公有镜像id的查询 )
- 指定偏移(Offset)和限制(Limit)来选择结果中的一部分，默认返回满足条件的前20个镜像信息。
默认接口请求频率限制：10次/秒。
接口更新时间：2022-04-22 17:51:31。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeImages |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| ImageIds | 否 | 否 | Array of String | 镜像ID列表 。镜像ID如：img-gvbnzy6f。array型参数的格式可以参考API简介。镜像ID可以通过如下方式获取：<br><li>通过DescribeImages接口返回的ImageId获取。<br><li>通过DescribeImages获取。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件。其中Filters的上限为10，Filters.Values的上限为5。 注意：不可以同时指定ImageIds和Filters。可选值包括 image-id, image-type。 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。关于Offset详见API简介。 |
| Limit | 否 | 否 | Uint64 | 数量限制，默认为20，最大值为100。关于Limit详见API简介。 |
| InstanceType | 否 | 否 | String | 将该实例机型规格相关的镜像过滤掉，比如S1.SMALL1、S1.SMALL2等。 |
| HostIp | 否 | 否 | String | 宿主机Ip, 用于创建CDH子机时过滤镜像 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageSet | Image | 此参数对外不可见。 一个关于镜像详细信息的结构体，主要包括镜像的主要状态与属性。 |
| TotalCount | Int64 | 此参数对外不可见。 符合要求的镜像数量。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidFilter | |
| InvalidParameterValue.InvalidParameterValueLimit | |
| InvalidParameter.InvalidParameterCoexistImageIdsFilters |