云服务器查询镜像族内可用镜像-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeImageFromFamily) 用于查看镜像族内可用镜像信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeImageFromFamily。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
ImageFamily	否	String	镜像族示例值：business-daily-update

3. 输出参数

参数名称	类型	描述
Image	Image	镜像信息，没有可用镜像是返回为空注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看镜像族列表

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageFromFamily
<公共请求参数>

{
    "ImageFamily": "business-daily-update"
}

输出示例

{
    "Response": {
        "Image": {
            "ImageId": "abc",
            "OsName": "abc",
            "ImageType": "abc",
            "CreatedTime": "2020-09-22T00:00:00+00:00",
            "ImageName": "abc",
            "ImageDescription": "abc",
            "ImageSize": 0,
            "Architecture": "abc",
            "ImageState": "abc",
            "Platform": "abc",
            "ImageCreator": "abc",
            "ImageSource": "abc",
            "SyncPercent": 0,
            "IsSupportCloudinit": true,
            "SnapshotSet": [
                {
                    "SnapshotId": "abc",
                    "DiskUsage": "abc",
                    "DiskSize": 0
                }
            ],
            "Tags": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "LicenseType": "abc",
            "ImageFamily": "business-daily-update",
            "ImageDeprecated": false
        },
        "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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询镜像族内可用镜像

本页目录：