云主机

产品文档

云主机

importImage

描述

导入私有镜像。

详细操作说明请参考帮助文档:导入私有镜像

接口说明

  • 当前仅支持导入系统盘镜像。
  • 导入后的镜像将以 云硬盘系统盘镜像 格式作为私有镜像使用,同时会自动生成一个与导入镜像关联的快照。

请求方式

POST

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/images:import

名称 类型 是否必需 示例值 描述
regionId String cn-north-1 地域ID。

请求参数

名称 类型 是否必选 示例值 描述
architecture String x86_64 镜像架构。可选值:x86_64、i386
osType String linux 镜像的操作系统类型。可选值:windows、linux
platform String CentOS 镜像的操作系统平台名称。
可选值:Ubuntu、CentOS、Windows Server、Other Linux、Other Windows
diskFormat String qcow2 磁盘格式,可选值:qcow2、vhd、vmdk、raw
systemDiskSizeGB Integer 40 镜像系统盘的默认容量,单位GiB。取值范围:[40,500],要求值是10的整数倍。须保证此容量不小于镜像文件系统实际空间大小。
imageUrl String https://test.s3-internal.cn-north-1.jdcloud-oss.com/linux/system_img.raw 要导入镜像的对象存储内网下载地址。
osVersion String 8.2 镜像的操作系统版本。
imageName String image-test 导入镜像的自定义名称。参考 公共参数规范
description String 导入镜像的描述信息。参考 公共参数规范
forceImport Boolean false 是否强制导入。强制导入会忽略镜像的可用性检测。
可选值:
true:强制导入;
false(默认值):不强制导入。
clientToken String jd71-13hb-12dk-p123 用于保证请求的幂等性。由客户端生成,并确保不同请求中该参数唯一,长度不能超过64个字符。每次导出请传入不同的值,如果传值与某次的clientToken相同,则返还同一个请求结果。

返回参数

名称 类型 示例值 描述
result Result 响应结果。
requestId String c2hmmaan8w06w19qcdfuic4w03f7ft2d 请求ID。

Result

名称 类型 示例值 描述
imageId String 镜像id。
importTaskId Integer 导入任务id。

请求示例

POST

/v1/regions/cn-north-1/images:import
{
    "architecture":"x86_64",
    "osType":"linux",
    "platform":"CentOS",
    "diskFormat":"raw",
    "systemDiskSizeGB":50,
    "imageUrl":"https://test.s3-internal.cn-north-1.jdcloud-oss.com/linux/system_img.raw",
    "osVersion":"7.3",
    "imageName":"testImport",
    "description":"testImport",
    "forceImport":false
}

返回示例

{
    "imageId": "img-m5s0****29", 
    "importTaskId": 541
}

返回码

HTTP状态码 错误码 描述 错误解析
200 OK
400 CONFLICT OssRegion 'xx' not match current region 'xx' 对象存储外链地址不正确。
400 OUT_OF_RANGE SystemDiskSizeGB must be multiple of 10 系统盘大小步长错误,需要10的倍数。
500 INTERNAL Internal server error 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。
500 UNKNOWN Unknown server error 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。
更新时间:2021-09-01 20:20:29
文档反馈 docs feedback