有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(ImportImage)用于导入镜像,导入后的镜像可用于创建实例。目前支持 RAW、VHD、QCOW2、VMDK 镜像格式。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportImage。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Architecture String 导入镜像的操作系统架构,x86_64i386
示例值:x86_64
OsType String 导入镜像的操作系统类型,通过DescribeImportImageOs获取
示例值:CentOS
OsVersion String 导入镜像的操作系统版本,通过DescribeImportImageOs获取
示例值:6
ImageUrl String 导入镜像存放的cos地址
示例值:http://111-1251233127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk
ImageName String 镜像名称
示例值:sample
ImageDescription String 镜像描述
示例值:sampleimage
DryRun Boolean 只检查参数,不执行任务
示例值:false
Force Boolean 是否强制导入,参考强制导入镜像
示例值:false
TagSpecification.N Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。
LicenseType String 导入镜像后,激活操作系统采用的许可证类型。
可选项:
TencentCloud: 腾讯云官方许可
BYOL: 自带许可(Bring Your Own License)
示例值:TencentCloud
BootMode String 启动模式
示例值:Legacy BIOS

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 导入镜像

用户导入镜像。

输入示例

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

{
    "ImageUrl": "http://111-1251233127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk",
    "ImageDescription": "sampleimage",
    "ImageName": "sample",
    "Architecture": "x86_64",
    "OsType": "CentOS",
    "OsVersion": "6"
}

输出示例

{
    "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ImageQuotaLimitExceeded 镜像配额超过了限制。
InvalidImageName.Duplicate 镜像名称与原有镜像重复。
InvalidImageOsType.Unsupported 不支持的操作系统类型。
InvalidImageOsVersion.Unsupported 不支持的操作系统版本。
InvalidParameter.InvalidParameterUrlError 错误的url地址。
InvalidParameterValue.InvalidAppIdFormat 无效的appid。
InvalidParameterValue.InvalidBootMode 不支持指定的启动模式。
InvalidParameterValue.InvalidLicenseType 许可证类型不可用。
InvalidParameterValue.TagKeyNotFound 指定的标签不存在。
InvalidParameterValue.TooLarge 参数值超过最大限制。
OperationDenied.InnerUserProhibitAction 禁止管控账号操作。
RegionAbilityLimit.UnsupportedToImportImage 该地域不支持导入镜像。