镜像文件快速导入

功能介绍

使用上传至OBS桶中的超大外部镜像文件制作私有镜像，目前仅支持RAW或ZVHD2格式镜像文件。且要求镜像文件大小不能超过1TB。

由于快速导入功能要求提前转换镜像文件格式为RAW或ZVHD2格式，因此镜像文件小于128GB时推荐您优先使用常规的创建私有镜像的方式。

作为异步接口，调用成功，只是说明后台收到了制作请求，镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态，具体请参考异步任务查询。

约束与限制

请您参考“快速导入镜像文件”完成镜像文件格式转换、生成位表文件等操作。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/cloudimages/quickimport/action

请求消息

• 使用上传至OBS桶中的外部镜像文件创建系统盘镜像时的请求参数

  参数	是否必选	参数类型	描述
  name	是	String	镜像名称。 name参数说明请参考镜像属性。
  description	否	String	镜像描述信息。 description参数说明请参考镜像属性。 支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。默认为空。
  os_version	是	String	操作系统版本。 使用上传至OBS桶中的外部镜像文件制作镜像时生效，具体取值见相关参数取值列表。
  image_url	是	String	OBS桶中外部镜像文件地址。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。格式为<OBS桶名>:<OBS镜像文件名称>。 说明： 此处的OBS桶和镜像文件的存储类别必须是标准存储。
  min_disk	是	Integer	最小系统盘大小，单位为GB。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。 取值需大于所选镜像文件的大小，linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。
  tags	否	Array of strings	镜像标签列表。默认为空。 tags和image_tags只能使用一个。
  image_tags	否	Array of objects	新规范的镜像标签列表。默认为空。 tags和image_tags只能使用一个。
  type	否	String	制作的镜像类型。系统盘镜像为ECS/BMS。默认为ECS。
  enterprise_project_id	否	String	表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目。 关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。
  architecture	否	String	镜像的架构类型。取值包括： x86 arm 默认使用“x86”。 说明： 当架构类型为arm时，镜像引导方式将自动转为UEFI。

• 使用上传至OBS桶中的外部镜像文件创建数据盘镜像时的请求参数

  参数	是否必选	参数类型	描述
  name	是	String	镜像名称。name参数说明请参考镜像属性。
  description	否	String	镜像描述信息。description参数说明请参考镜像属性。支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。默认为空。
  os_type	否	String	操作系统版本。 创建数据盘镜像时取值为Linux或Windows，默认Linux。
  image_url	是	String	OBS桶中外部镜像文件地址。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。格式为<OBS桶名>:<OBS镜像文件名称>。 说明： 此处的OBS桶和镜像文件的存储类别必须是标准存储。
  min_disk	是	Integer	最小系统盘大小。 在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。
  tags	否	Array of strings	镜像标签列表。默认为空。 tags和image_tags只能使用一个。
  image_tags	否	Array of objects	新规范的镜像标签列表。默认为空。 tags和image_tags只能使用一个。
  type	是	String	制作的镜像类型。数据盘镜像为DataImage。
  enterprise_project_id	否	String	表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目。 关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。

请求示例

• 使用上传至OBS桶的外部镜像文件制作系统盘镜像，其中，OBS桶中外部镜像文件地址为“ims-image:centos70.zvhd2”，镜像标签数据格式为tags。

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

  POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作镜像", "image_url": "ims-image:centos70.zvhd2", "os_version": "CentOS 7.0 64bit", "min_disk": 40, "type": "ECS", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }

• 使用上传至OBS桶的外部镜像文件制作系统盘镜像，其中，OBS桶中外部镜像文件地址为“ims-image:centos70.zvhd2”，镜像标签数据格式为image_tags。

  1 2 3 4 5 6 7 8 9 10

  POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作镜像", "image_url": "ims-image:centos70.zvhd2", "os_version": "CentOS 7.0 64bit", "min_disk": 40, "type": "ECS", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }

• 使用上传至OBS桶的外部镜像文件制作数据盘镜像，其中，OBS桶中外部镜像文件地址为“ims-image:centos70.zvhd2”，镜像标签数据格式为tags。

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作镜像", "image_url": "ims-image:centos70.zvhd2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }

• 使用上传至OBS桶的外部镜像文件制作数据盘镜像，其中，OBS桶中外部镜像文件地址为“ims-image:centos70.zvhd2”，镜像标签数据格式为image_tags。

  1 2 3 4 5 6 7 8 9 10

  POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作镜像", "image_url": "ims-image:centos70.zvhd2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }

响应消息

• 响应参数

  参数	参数类型	描述
  job_id	String	异步任务ID。 详情请参见异步任务查询。

• 响应样例

  STATUS CODE 200

  1 2 3

  { "job_id": "8a12fc664fb4daa3014fb4e581380005" }

返回值

• 正常

  200

• 异常

  返回值	说明
  400 Bad Request	请求错误，具体返回错误码请参见错误码。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。