華為云計算 云知識 注冊鏡像RegisterImage
注冊鏡像RegisterImage

 

功能介紹

該接口用于將 鏡像 文件注冊為云平臺未初始化的私有鏡像。

使用該接口注冊鏡像的具體步驟如下:

  1. 將鏡像文件上傳到OBS個人桶中。具體操作請參見“上傳文件或文件夾”。
  2. 使用創(chuàng)建鏡像元數據接口創(chuàng)建鏡像元數據。調用成功后,保存該鏡像的ID。創(chuàng)建鏡像元數據請參考創(chuàng)建鏡像元數據(OpenStack原生)。
  3. 根據2得到的鏡像ID,使用注冊鏡像接口注冊OBS桶中的鏡像文件。
  4. 注冊鏡像接口作為異步接口,調用成功后,說明后臺收到了注冊請求。需要根據鏡像ID查詢該鏡像狀態(tài)驗證鏡像注冊是否成功。當鏡像狀態(tài)變?yōu)椤癮ctive”時,表示鏡像注冊成功。

    如何查詢異步任務,請參見異步任務查詢。

注冊鏡像前請確保用戶已擁有 對象存儲服務 的Tenant Administrator權限。

調試

您可以在API Explorer中調試該接口。

URI

PUT /v1/cloudimages/{image_id}/upload

參數說明請參見表1。
表1 參數說明

參數

是否必選

參數類型

描述

image_id

String

鏡像ID。

  • image_id為用戶調用創(chuàng)建鏡像元數據接口所創(chuàng)建出來鏡像的id,使用其他方式創(chuàng)建的鏡像id會導致注冊失敗。
  • 注冊接口調用成功后,請根據鏡像id查詢鏡像的狀態(tài)。鏡像狀態(tài)變?yōu)閍ctive表示鏡像注冊成功,詳情請參見查詢鏡像詳情(OpenStack原生)。

請求消息

  • 請求參數

    參數

    是否必選

    參數類型

    描述

    image_url

    String

    源鏡像的URL,格式::

    image_url對應的鏡像桶中的文件,鏡像文件格式的取值范圍為:ZVHD、QCOW2、VHD、RAW、VHDX、QED、VDI、QCOW、ZVHD2、VMDK、ISO。

    說明:

    此處的OBS桶和鏡像文件的存儲類別必須是標準存儲。

請求示例

注冊鏡像,其中,源鏡像URL為“bucketname:Centos6.5-disk1.vmdk”。

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
    {
       "job_id":" b912fb4a4c464b568ecfca1071b21b10"
    }
    

返回值

  • 正常

    200

  • 異常

返回值

說明

400 Bad Request

請求錯誤,具體返回錯誤碼請參見錯誤碼

401 Unauthorized

鑒權失敗。

403 Forbidden

沒有操作權限。

404 Not Found

找不到資源。