1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(DescribeImages) 用于查看镜像列表。
- 可以通过指定镜像ID来查询指定镜像的详细信息,或通过设定过滤器来查询满足过滤条件的镜像的详细信息。
- 指定偏移(Offset)和限制(Limit)来选择结果中的一部分,默认返回满足条件的前20个镜像信息。
默认接口请求频率限制:40次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 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可以通过如下方式获取:ImageId 获取。 |
Filters.N | 否 | Array of Filter | 过滤条件,每次请求的Filters 的上限为0,Filters.Values 的上限为5。参数不可以同时指定ImageIds 和Filters 。详细的过滤条件如下:PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像) PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像) SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像) 。 |
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查询镜像
已经知道镜像ID,查询镜像相关信息。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeImages
&Filters.0.Name=image-id
&Filters.0.Values.0=img-9qabwvbn
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"ImageSet": [
{
"ImageId": "img-9qabwvbn",
"OsName": "CentOS 7.6 64位",
"ImageSize": 10,
"ImageType": "PUBLIC_IMAGE",
"CreatedTime": null,
"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": []
}
],
"RequestId": "db145873-3128-4079-8cec-65e05a7c9f89"
}
}
示例2 按镜像类型查询镜像
查询账户下所有私有镜像。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeImages
&Filters.0.Name=image-type
&Filters.0.Values.0=PRIVATE_IMAGE
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 408,
"ImageSet": [
{
"OsName": "CentOS 7.4 64位",
"ImageSize": 20,
"ImageType": "PRIVATE_IMAGE",
"CreatedTime": "2021-03-10T03:28:10Z",
"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
}
],
"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。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidFilter | 无效的过滤器。 |
InvalidFilterValue.LimitExceeded | Filter 。 |
InvalidImageId.Malformed | 错误的镜像Id格式。 |
InvalidInstanceType.Malformed | 指定InstanceType参数格式不合法。 |
InvalidParameter.InvalidParameterCoexistImageIdsFilters | 不能同时指定ImageIds和Filters。 |
InvalidParameterValue.InstanceTypeNotFound | 指定机型不存在 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
UnauthorizedOperation.PermissionDenied | 无权操作指定的资源,请正确配置CAM策略。 |