全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
云服务器 ECS

ImportImage

更新时间:2017-10-17 14:02:33

描述

该接口用于导入线下镜像文件到 ECS 环境中,并生成自定义镜像。成功导入的镜像可以用于创建 ECS 实例或者更换系统盘

  • 必须提前上传镜像文件到 OSS
  • 导入镜像的地域必须跟镜像文件存放的 OSS 在同一个账号的同一个地域。
  • DiskDeviceMapping.n 中,n 的取值范围为 [1, 16]。n 为 1 时表示系统盘,n 为 [2, 16] 时表示数据盘。
  • 不能删除正在导入的镜像,但是可以取消导入镜像任务。
  • 需要通过 RAM 给阿里云 ECS 官方服务账号授权读取 OSS 的权限。
    1. 创建角色:AliyunECSImageImportDefaultRole。必须是这个名称,否则导入镜像会失败。角色的策略:
      1. {
      2. "Statement": [
      3. {
      4. "Action": "sts:AssumeRole",
      5. "Effect": "Allow",
      6. "Principal": {
      7. "Service": [
      8. "ecs.aliyuncs.com"
      9. ]
      10. }
      11. }
      12. ],
      13. "Version": "1"
      14. }
    2. 在该角色下,加入默认系统权限策略:AliyunECSImageImportRolePolicy。这个策略是 ECS 提供导入镜像的默认策略,您也可以创建自定义策略,权限需要包含:
      1. {
      2. "Version": "1",
      3. "Statement": [
      4. {
      5. "Action": [
      6. "oss:GetObject",
      7. "oss:GetBucketLocation"
      8. ],
      9. "Resource": "*",
      10. "Effect": "Allow"
      11. }
      12. ]
      13. }

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数。取值:ImportImage
RegionId String 源自定义镜像的 RegionId。RegionId 的列表详见 地域列表
ImageName String 镜像名称。
  • 长度为 [2, 128] 个大小写英文或中文字符,必须以大小字母或中文开头,可包含数字、点号(.)、下划线(_)或连字符(-)。
  • 镜像名称会显示在控制台。
  • 不能以 http:// 和 https:// 开头。
Description String 镜像的描述信息。
  • 长度为 [0, 256] 个大小写英文或中文字符。
  • 不能以 http:// 和 https:// 开头。
Architecture String 系统架构。取值范围:
  • i386
  • x86_64
默认值:x86_64
OSType String 操作系统平台类型。取值范围:
  • windows
  • linux
默认值:linux
Platform String 操作系统发行版。取值范围:
  • CentOS
  • Ubuntu
  • SUSE
  • OpenSUSE
  • Debian
  • CoreOS
  • Aliyun Linux
  • Windows Server 2003
  • Windows Server 2008
  • Windows Server 2012
  • Others Linux
  • Customized Linux
默认值:Others Linux
DiskDeviceMapping.n.Format String 镜像格式。取值范围:
  • RAW
  • VHD
导入镜像时,系统自动检测镜像格式,以检测格式为准。
DiskDeviceMapping.n.OSSBucket String 镜像文件所在的 OSS Bucket。
DiskDeviceMapping.n.OSSObject String 镜像文件所在的 OSS Object 的 key。
DiskDeviceMapping.n.DiskImageSize String 镜像大小。必须确保系统盘空间 ≥ 文件系统空间。取值范围:
  • n = 1 时,即系统盘:[5, 500] GB
  • n = [2, 16] 时,即数据盘:[5, 1000] GB
导入镜像时,系统自动检测镜像大小,以检测结果为准。

返回参数

名称 类型 描述
RegionId String 地域 ID
ImageId String 镜像 ID
ImportTaskId String 导入镜像任务 ID

错误码

错误代码 描述 HTTP 状态码 语义
MissingParameter An input parameter “RegionId” that is mandatory for processing the request is not supplied. 400 缺少 RegionId 值。RegionId 的列表详见 地域列表
MissingParameter An input parameter “DiskDeviceMapping.n.OSSBucket” that is mandatory for processing the request is not supplied. 400 缺少 OSSBucket 的值。
MissingParameter An input parameter “DiskDeviceMapping.n.OSSObject” that is mandatory for processing the request is not supplied. 400 缺少 OSSObject 值。
InvalidImageName.Malformed The specified destination Image name is wrongly formed. 400 指定的镜像名称不合法。
InvalidDescription.Malformed The specified destination image description is wrongly formed. 400 指定的目标镜像描述不合法。
RegionId.NotFound The specified region is not found. 400 指定的镜像的 RegionId 不存在。RegionId 的列表详见 地域列表
IncorrectImageStatus The specified image is not available. 400 指定的镜像状态不正确。
InvalidImageName.Duplicated The destination image is exist. 400 镜像名称已经重复。
QuotaExceed.Image The Image Quota exceeds. 403 已经超过自定义镜像配额限制,不能再导入镜像。
QuotaExceed.Snapshot The maximum number of snapshots is exceeded. 403 已经超过快照的配额限制,不能再导入镜像。
Forbbiden User not authorized to operate on the specified resource 400 没有权限导入镜像。
InvalidArchitecture.Malformed The specified Architecture is wrongly formed. 400 指定的平台架构不合法。
InvalidPlatform.Malformed The specified Platform is wrongly formed. 400 指定的操作系统发行版类型不合法。
InvalidOSType.Malformed The specified OSType is wrongly formed. 400 指定的操作系统类型不合法。
InvalidFormat.Malformed The specified Image format is wrongly formed. 400 指定的镜像文件格式不合法。
InvalidImageSize The specified “DiskDeviceMapping.n.DiskImageSize” should be not less than system device size. 400 指定的镜像的磁盘大小不合法。
ImageIsImporting The specified Image is importing. 403 指定的镜像正在复制中。
InvalidRegion.NotSupport The specified region does not support image import or export. 403 指定的 Region 暂时不支持导入镜像。

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=ImportImage
  2. &RegionId=cn-hangzhou
  3. &DiskDeviceMapping.1.OSSBucket=ecsimageos
  4. &DiskDeviceMapping.1.OSSObject=CentOS_5.4_32.raw
  5. &<公共请求参数>

返回示例

XML 格式

  1. <ImportImageResponse>
  2. <RequestId>C8B26B44-0189-443E-9816-D951F59623A9</RequestId>
  3. <ImageId>Img-231234567</ImageId>
  4. <ImportTaskId>123-345-2332-22323</ImportTaskId>
  5. </ImportImageResponse>

JSON 格式

  1. {
  2. "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
  3. "ImageId": "Img-231234567"
  4. "ImportTaskId":"123-345-2332-22323"
  5. }
本文导读目录