云桌面创建自定义镜像

1. 接口描述

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

创建自定义镜像。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateImage。
Version	是	String	公共参数，本接口取值：2020-11-04。
Region	否	String	公共参数，本接口不需要传递此参数。
InstanceId	是	String	云桌面实例ID。示例值：cdi-v2fpex3xyy3y6wd
ImageName	是	String	镜像名称。只支持中文、字母、数字或连接符号"-"，且最多60个字符。默认值：空。示例值：测试镜像
Description	否	String	镜像的描述信息。支持英文或中文字符，最多60个字符。默认值：空。示例值：description
DataDiskIds.N	否	Array of String	基于实例创建整机镜像时，指定包含在镜像里的数据盘ID。示例值：["disk-87afu9ag"]

3. 输出参数

参数名称	类型	描述
ImageId	String	镜像ID。示例值：img-mqxn7nyy
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建自定义镜像

输入示例

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

{
    "InstanceId": "cdi-v2fpex***y3y6wd",
    "ImageName": "test-*******data"
}

输出示例

{
    "Response": {
        "ImageId": "pvtimg-my***lve",
        "RequestId": "c9142a6c-320a-46f0-99b7-8b5dd122a92e"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	信令执行时发生错误,建议重试。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Disk	硬盘相关的参数错误。
InvalidParameterValue.InstanceId	实例ID参数错误。
LimitExceeded.ImageQuota	超出自定义镜像配额。
UnsupportedOperation.AssistantState	检查桌面助手的状态未通过。
UnsupportedOperation.DiskSize	由于硬盘的过大不支持该操作。
UnsupportedOperation.InstanceState	实例当前的状态下不支持该操作。
UnsupportedOperation.StoppedModeStopCharging	不支持关机不收费特性。

创建自定义镜像

本页目录：