1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
提供导出自定义镜像到指定COS存储桶的能力
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ExportImages。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BucketName | 是 | String | COS存储桶名称 示例值：mybucketname |
| ImageIds.N | 否 | Array of String | 镜像ID列表 |
| ExportFormat | 否 | String | 镜像文件导出格式。取值范围：RAW，QCOW2，VHD，VMDK。默认为RAW 示例值：RAW |
| FileNamePrefixList.N | 否 | Array of String | 导出文件的名称前缀列表 示例值：["testfilename"] |
| OnlyExportRootDisk | 否 | Boolean | 是否只导出系统盘 示例值：True |
| DryRun | 否 | Boolean | 检测镜像是否支持导出 示例值：True |
| RoleName | 否 | String | 角色名称。默认为CVM_QcsRole，发起请求前请确认是否存在该角色，以及是否已正确配置COS写入权限。 示例值：CVM_QcsRole |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 导出镜像任务ID |
| CosPaths | Array of String | 导出镜像的COS文件名列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导出自定义镜像
导出自定义镜像
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportImages
<公共请求参数>
{
"ImageIds": [
"img-72n9mi0y"
],
"BucketName": "test-bucket-AppId"
}输出示例
{
"Response": {
"RequestId": "7995cb6f-0018-4286-a4d4-b6301b962d9e",
"TaskId": 105591590,
"CosPaths": [
"/img-pq5pau1w_system_snap-fiux4bof.raw"
]
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.CamRoleNameAuthenticateFailed | 角色名鉴权失败 |
| InvalidImageId.Malformed | 错误的镜像Id格式。 |
| InvalidImageId.NotFound | 未找到该镜像。 |
| InvalidParameter.ImageIdsSnapshotIdsMustOne | 参数ImageIds和SnapshotIds必须有且仅有一个。 |
| InvalidParameter.SnapshotNotFound | 指定的快照不存在。 |
| InvalidParameterValue.BucketNotFound | 请确认存储桶是否存在。 |
| InvalidParameterValue.InvalidAppIdFormat | 无效的appid。 |
| InvalidParameterValue.InvalidBucketPermissionForExport | 请检查存储桶的写入权限是否已放通。 |
| InvalidParameterValue.InvalidFileNamePrefixList | 参数 FileNamePrefixList 的长度与 ImageIds 或 SnapshotIds 不匹配。 |
| InvalidParameterValue.InvalidImageId | 镜像不允许执行该操作 |
| InvalidParameterValue.InvalidImageOsName | 当前地域不支持指定镜像所包含的操作系统。 |
| InvalidParameterValue.InvalidImageState | 镜像被其他操作占用，请检查，并稍后重试。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| InvalidParameterValue.TooLarge | 参数值超过最大限制。 |
| LimitExceeded.ExportImageTaskLimitExceeded | 正在运行中的镜像导出任务已达上限，请等待已有任务完成后，再次发起重试。 |
| UnsupportedOperation.EncryptedImagesNotSupported | 不支持加密镜像。 |
| UnsupportedOperation.ImageTooLargeExportUnsupported | 镜像大小超出限制，不支持导出。 |
| UnsupportedOperation.MarketImageExportUnsupported | 从市场镜像创建的自定义镜像不支持导出。 |
| UnsupportedOperation.PublicImageExportUnsupported | 公共镜像或市场镜像不支持导出。 |
| UnsupportedOperation.RedHatImageExportUnsupported | RedHat镜像不支持导出。 |
| UnsupportedOperation.SharedImageExportUnsupported | 共享镜像不支持导出。 |
| UnsupportedOperation.WindowsImageExportUnsupported | Windows镜像不支持导出。 |
