展示镜像列表

最近更新时间:2024-03-12 01:29:04

我的收藏

1. 接口描述

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

展示镜像列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeImage。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
Filters.N Array of Filter 过滤条件,每次请求的Filters的上限为10,详细的过滤条件如下:
image-id - String - 是否必填: 否 - (过滤条件)按照镜像ID进行过滤
image-type - String - 是否必填: 否 - (过滤条件)按照镜像类型进行过滤。取值范围:
PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)
PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)
instance-type -String - 是否必填: 否 - (过滤条件) 按机型过滤支持的镜像
image-name - String - 是否必填:否 - (过滤条件) 按镜像的名称模糊匹配,只能提供一个值
image-os - String - 是否必填:否 - (过滤条件) 按镜像系统的名称模糊匹配,只能提供一个值
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
示例值:0
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值:10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 镜像总数
示例值:20
ImageSet Array of Image 镜像数组
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 展示镜像列表

展示镜像列表

输入示例

https://ecm.tencentcloudapi.com/?Action=DescribeImage
&Offset=0
&Limit=10
&Filters.0.Name=image-type
&Filters.0.Values.0=PRIVATE_IMAGE
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "51e18e32-9bb8-4b1d-a7ac-92040fab2949",
        "ImageSet": [
            {
                "ImageId": "img-060ov1xz",
                "ImageName": "CentOS 6.9 32位",
                "ImageState": "NORMAL",
                "ImageType": "PRIVATE_IMAGE",
                "ImageOwner": 251006057,
                "ImageOsName": "CentOS 6.9 32位",
                "ImageDescription": "CentOS 6.9 32位",
                "Architecture": "i386",
                "OsType": "CentOS",
                "Platform": "",
                "OsVersion": "CentOS 6.9 32位",
                "ImageCreateTime": "2019-07-22 20:48:14",
                "ImageSize": 50,
                "ImageSource": "CREATE_IMAGE",
                "SrcImage": {
                    "ImageDescription": "CentOS 6.9 32位",
                    "InstanceId": "ein-gwht9ek2",
                    "Region": "ap-chongqing-ecm2",
                    "RegionID": 1084,
                    "ImageId": "img-cho4vg0s",
                    "ImageName": "test",
                    "RegionName": "重庆二区",
                    "InstanceName": "",
                    "ImageType": "PRIVATE_IMAGE",
                    "ImageOsName": "CentOS 6.9 32位"
                }
            },
            {
                "ImageId": "img-1tyt4apn",
                "ImageName": "CentOS 7.4 裸金属 64位",
                "ImageState": "NORMAL",
                "ImageType": "PRIVATE_IMAGE",
                "ImageOwner": 251006057,
                "ImageOsName": "CentOS 7.4 裸金属 64位",
                "ImageDescription": "CentOS 7.4 裸金属 64位",
                "Architecture": "x86_64",
                "OsType": "CentOS",
                "Platform": "",
                "OsVersion": "CentOS 7.4 裸金属 64位",
                "ImageCreateTime": "2019-07-22 20:48:14",
                "ImageSize": 50,
                "ImageSource": "EXTERNAL_IMPORT",
                "SrcImage": {
                    "ImageDescription": "",
                    "InstanceId": "",
                    "Region": "",
                    "RegionID": 0,
                    "ImageId": "",
                    "ImageName": "CentOS 7.4 64位",
                    "RegionName": "",
                    "InstanceName": "",
                    "ImageType": "",
                    "ImageOsName": "CentOS 7.4 64位"
                }
            }
        ],
        "TotalCount": 20
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ImageInUse 镜像正在使用中。
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.InvaildPageParam 分页参数不合法。
InvalidParameterValue.InvalidFilter 无效过滤器。
InvalidParameterValue.InvalidImageID 镜像ID不合法。
InvalidParameterValue.ParameterValueTooLarge 参数值超出限制。
MissingParameter.MissingImageParameter 镜像操作参数不全。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。