文档首页/ 镜像服务 IMS/ API参考/ API/ 镜像/ 注册镜像
更新时间：2024-11-13 GMT+08:00
查看PDF
分享

注册镜像

功能介绍

该接口用于将镜像文件注册为云平台未初始化的私有镜像。

使用该接口注册镜像的具体步骤如下：

  1. 将镜像文件上传到OBS个人桶中。具体操作请参见“上传文件或文件夹”。
  2. 使用创建镜像元数据接口创建镜像元数据。调用成功后，保存该镜像的ID。创建镜像元数据请参考创建镜像元数据（OpenStack原生）。
  3. 根据2得到的镜像ID，使用注册镜像接口注册OBS桶中的镜像文件。
  4. 注册镜像接口作为异步接口，调用成功后，说明后台收到了注册请求。需要根据镜像ID查询该镜像状态验证镜像注册是否成功。当镜像状态变为“active”时，表示镜像注册成功。

    如何查询异步任务，请参见异步任务查询。

注册镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。

调试

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

URI

PUT /v1/cloudimages/{image_id}/upload

参数说明请参见表1。
表1 参数说明

参数

是否必选

参数类型

描述

image_id

是

String

镜像ID。

  • image_id为用户调用创建镜像元数据接口所创建出来镜像的id，使用其他方式创建的镜像id会导致注册失败。
  • 注册接口调用成功后，请根据镜像id查询镜像的状态。镜像状态变为active表示镜像注册成功，详情请参见查询镜像列表。

请求消息

  • 请求参数

    参数

    是否必选

    参数类型

    描述

    image_url

    是

    String

    源镜像的URL，格式：<bucket>:<file>

    image_url对应的镜像桶中的文件，镜像文件格式的取值范围为：ZVHD、QCOW2、VHD、RAW、VHDX、QED、VDI、QCOW、ZVHD2、VMDK、ISO。

    说明：

    此处的OBS桶和镜像文件的存储类别必须是标准存储。

请求示例

注册镜像，其中，源镜像URL为“bucketname:Centos6.5-disk1.vmdk”。

1
2
3
4
 
PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload
{
   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
}

响应消息

  • 响应参数

    参数

    参数类型

    描述

    job_id

    String

    异步任务ID。

    详情请参见异步任务查询。
  • 响应样例 
    HTTP/1.1 200
    1
2
3
    		 
    {
   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
}

返回值

  • 正常

    200

  • 异常

返回值

说明

400 Bad Request

请求错误，具体返回错误码请参见错误码。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。
父主题： 镜像

相关文档