華為云計(jì)算 云知識(shí) 注冊(cè)鏡像RegisterImage
注冊(cè)鏡像RegisterImage

 

功能介紹

該接口用于將 鏡像 文件注冊(cè)為云平臺(tái)未初始化的私有鏡像。

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

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

    如何查詢(xún)異步任務(wù),請(qǐng)參見(jiàn)異步任務(wù)查詢(xún)。

注冊(cè)鏡像前請(qǐng)確保用戶(hù)已擁有 對(duì)象存儲(chǔ)服務(wù) 的Tenant Administrator權(quán)限。

調(diào)試

您可以在A(yíng)PI Explorer中調(diào)試該接口。

URI

PUT /v1/cloudimages/{image_id}/upload

參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。
表1 參數(shù)說(shuō)明

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

image_id

String

鏡像ID。

  • image_id為用戶(hù)調(diào)用創(chuàng)建鏡像元數(shù)據(jù)接口所創(chuàng)建出來(lái)鏡像的id,使用其他方式創(chuàng)建的鏡像id會(huì)導(dǎo)致注冊(cè)失敗。
  • 注冊(cè)接口調(diào)用成功后,請(qǐng)根據(jù)鏡像id查詢(xún)鏡像的狀態(tài)。鏡像狀態(tài)變?yōu)閍ctive表示鏡像注冊(cè)成功,詳情請(qǐng)參見(jiàn)查詢(xún)鏡像詳情(OpenStack原生)。

請(qǐng)求消息

  • 請(qǐng)求參數(shù)

    參數(shù)

    是否必選

    參數(shù)類(lèi)型

    描述

    image_url

    String

    源鏡像的URL,格式::

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

    說(shuō)明:

    此處的OBS桶和鏡像文件的存儲(chǔ)類(lèi)別必須是標(biāo)準(zhǔn)存儲(chǔ)。

請(qǐng)求示例

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

PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload

{
   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
}

響應(yīng)消息

  • 響應(yīng)參數(shù)

    參數(shù)

    參數(shù)類(lèi)型

    描述

    job_id

    String

    異步任務(wù)ID。

    詳情請(qǐng)參見(jiàn)異步任務(wù)查詢(xún)。

  • 響應(yīng)樣例
    HTTP/1.1 200
    {
       "job_id":" b912fb4a4c464b568ecfca1071b21b10"
    }
    

返回值

  • 正常

    200

  • 異常

返回值

說(shuō)明

400 Bad Request

請(qǐng)求錯(cuò)誤,具體返回錯(cuò)誤碼請(qǐng)參見(jiàn)錯(cuò)誤碼。

401 Unauthorized

鑒權(quán)失敗。

403 Forbidden

沒(méi)有操作權(quán)限。

404 Not Found

找不到資源。