功能介紹
使用 云服務(wù)器 、云服務(wù)器備份或者 云備份 制作整機(jī) 鏡像 。作為異步接口，調(diào)用成功，只是說明后臺收到了制作整機(jī)鏡像的請求，鏡像是否制作成功需要通過異步任務(wù)查詢接口查詢該任務(wù)的執(zhí)行狀態(tài)，具體請參考異步任務(wù)查詢。
約束與限制（使用云服務(wù)器制作整機(jī)鏡像）
- 創(chuàng)建整機(jī)鏡像時(shí)，請確保云服務(wù)器已完成相關(guān)配置，否則可能導(dǎo)致整機(jī)鏡像創(chuàng)建云服務(wù)器失敗。
詳情請參見“創(chuàng)建私有鏡像前云服務(wù)器、 裸金屬服務(wù)器 或鏡像文件需要完成哪些初始化配置？”。
- 使用Windows操作系統(tǒng)云服務(wù)器制作整機(jī)鏡像時(shí)，不允許云服務(wù)器存在跨區(qū)卷，否則制作的整機(jī)鏡像創(chuàng)建云服務(wù)器時(shí)可能會導(dǎo)致數(shù)據(jù)丟失。
- 使用Linux操作系統(tǒng)云服務(wù)器制作整機(jī)鏡像時(shí)，不允許云服務(wù)器存在由多個(gè)物理卷組成的卷組、或由多個(gè)物理卷組成的邏輯卷，否則制作的整機(jī)鏡像創(chuàng)建云服務(wù)器時(shí)可能會造成數(shù)據(jù)丟失。
- 帶有 專屬分布式存儲 磁盤的云服務(wù)器不支持創(chuàng)建整機(jī)鏡像。
- 整機(jī)鏡像不支持如下操作：不能發(fā)布為市場鏡像，不允許導(dǎo)出、區(qū)域內(nèi)復(fù)制。
- 使用Windows操作系統(tǒng)云服務(wù)器制作整機(jī)鏡像時(shí)，需修改云服務(wù)器SAN策略為OnlineAll類型。否則可能導(dǎo)致使用鏡像創(chuàng)建云服務(wù)器時(shí)，云服務(wù)器磁盤處于脫機(jī)狀態(tài)。
Windows操作系統(tǒng)SAN策略分為三種類型：OnlineAll、OfflineShared、OfflineInternal
表1 Windows操作系統(tǒng)SAN策略類型 類型
說明
OnlineAll
表示所有新發(fā)現(xiàn)磁盤都置于在線模式。
OfflineShared
表示所有共享總線上（比如FC、ISCSI）的新發(fā)現(xiàn)磁盤都置于離線模式，非共享總線上的磁盤都置于在線模式。
OfflineInternal
表示所有新發(fā)現(xiàn)磁盤都置于離線模式。
約束與限制（使用云服務(wù)器備份制作整機(jī)鏡像）
- 創(chuàng)建整機(jī)鏡像時(shí)，請確保創(chuàng)建該云服務(wù)器備份所屬的彈性云服務(wù)器已完成相關(guān)配置，否則可能導(dǎo)致整機(jī)鏡像創(chuàng)建云服務(wù)器失敗。
- 在云服務(wù)器關(guān)機(jī)狀態(tài)下，制作整機(jī)鏡像的過程中，用戶不能啟動云服務(wù)器。
- 使用云服務(wù)器備份創(chuàng)建整機(jī)鏡像時(shí)，不允許云服務(wù)器備份存在共享卷。
- 使用云服務(wù)器備份創(chuàng)建整機(jī)鏡像時(shí)，云服務(wù)器備份必須是可用狀態(tài)，且每個(gè)云服務(wù)器備份只能創(chuàng)建一個(gè)整機(jī)鏡像。
- 整機(jī)鏡像不支持如下操作：不能發(fā)布為市場鏡像，不允許導(dǎo)出、區(qū)域內(nèi)復(fù)制。
約束與限制（使用云備份制作整機(jī)鏡像）
- 創(chuàng)建整機(jī)鏡像前，請確保創(chuàng)建該云備份所屬的彈性云服務(wù)器已完成相關(guān)配置，否則可能導(dǎo)致整機(jī)鏡像創(chuàng)建云服務(wù)器失敗。
- 每個(gè)云備份只能創(chuàng)建一個(gè)整機(jī)鏡像。
- 在云服務(wù)器關(guān)機(jī)狀態(tài)下，制作整機(jī)鏡像的過程中，用戶不能啟動云服務(wù)器。
- 通過云備份創(chuàng)建的整機(jī)鏡像可以共享給其他租戶。但是，如果這個(gè)云備份是由其他租戶共享的，那么創(chuàng)建的整機(jī)鏡像不支持共享。
- 整機(jī)鏡像不支持如下操作：不能發(fā)布為市場鏡像，不允許導(dǎo)出、區(qū)域內(nèi)復(fù)制。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v1/cloudimages/wholeimages/action
請求消息
- 使用云服務(wù)器創(chuàng)建整機(jī)鏡像的請求參數(shù)
參數(shù)
是否必選
參數(shù)類型
描述
name
是
String
鏡像名稱。name參數(shù)說明請參考鏡像屬性。
description
否
String
鏡像描述信息。_description參數(shù)說明請參考鏡像屬性。
tags
否
Array of strings
鏡像標(biāo)簽列表。默認(rèn)為空。
tags和image_tags只能使用一個(gè)。
image_tags
否
Array of objects
新規(guī)范的鏡像標(biāo)簽列表。默認(rèn)為空。
tags和image_tags只能使用一個(gè)。
instance_id
是
String
云服務(wù)器ID。使用云服務(wù)器制作整機(jī)鏡像時(shí)使用此參數(shù)。
如何獲取云服務(wù)器ID：
- 登錄控制臺。
- 選擇“計(jì)算 > 彈性云服務(wù)器”。
- 在云服務(wù)器列表欄，單擊源云服務(wù)器名稱，在詳情頁查看ID。
enterprise_project_id
否
String
表示當(dāng)前鏡像所屬的企業(yè)項(xiàng)目。
- 取值為0或無該值，表示屬于default企業(yè)項(xiàng)目。
- 取值為UUID，表示屬于該UUID對應(yīng)的企業(yè)項(xiàng)目。
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請參考“企業(yè)中心總覽”。
max_ram
否
Integer
表示鏡像支持的最大內(nèi)存，單位為MB，默認(rèn)不設(shè)置。
min_ram
否
Integer
表示鏡像支持的最小內(nèi)存，單位為MB，默認(rèn)為0。
vault_id
否
String
表示云服務(wù)器待加入的或已加入的存儲庫的ID。
使用云服務(wù)器創(chuàng)建整機(jī)鏡像的過程為：先創(chuàng)建一個(gè)備份，再將備份創(chuàng)建為整機(jī)鏡像。如果這個(gè)備份為CBR，vault_id為必填項(xiàng)；如果備份為CSBS，vault_id參數(shù)可不填。
存儲庫ID可以從云備份服務(wù)控制臺獲取，或者參考“查詢存儲庫列表”查詢。
- 使用云服務(wù)器備份或云備份創(chuàng)建整機(jī)鏡像的請求參數(shù)
參數(shù)
是否必選
參數(shù)類型
描述
name
是
String
鏡像名稱。name參數(shù)說明請參考鏡像屬性。
description
否
String
鏡像描述信息。_description參數(shù)說明請參考鏡像屬性。
tags
否
Array of strings
鏡像標(biāo)簽列表。默認(rèn)為空。
tags和image_tags只能使用一個(gè)。
image_tags
否
Array of objects
新規(guī)范的鏡像標(biāo)簽列表。默認(rèn)為空。
tags和image_tags只能使用一個(gè)。
backup_id
是
String
云服務(wù)器備份ID或者云備份ID。
如何獲取云服務(wù)器備份ID：- 登錄管理控制臺。
- 選擇“存儲 > 云服務(wù)器備份”。
- 在備份列表欄，展開備份詳情，查看備份ID。
如何獲取云備份ID：- 登錄管理控制臺。
- 選擇“存儲 > 云備份”。
- 在云服務(wù)器備份頁面，單擊“備份副本”頁簽，在備份列表中查看備份ID。
enterprise_project_id
否
String
表示當(dāng)前鏡像所屬的企業(yè)項(xiàng)目。
- 取值為0或無該值，表示屬于default企業(yè)項(xiàng)目。
- 取值為UUID，表示屬于該UUID對應(yīng)的企業(yè)項(xiàng)目。
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請參考“企業(yè)中心總覽”。
max_ram
否
Integer
表示鏡像支持的最大內(nèi)存，單位為MB，默認(rèn)不設(shè)置。
min_ram
否
Integer
表示鏡像支持的最小內(nèi)存，單位為MB，默認(rèn)為0，表示不受限制。
whole_image_type
否
String
表示創(chuàng)建整機(jī)鏡像的方式。
- 若通過CBR服務(wù)的備份創(chuàng)建整機(jī)鏡像，該參數(shù)必填，設(shè)置為CBR，此時(shí)，backup_id為云備份ID。
- 若通過CSBS服務(wù)的備份創(chuàng)建整機(jī)鏡像，該參數(shù)可為空，取默認(rèn)值CSBS，此時(shí)，backup_id為云服務(wù)器備份ID。
請求示例
- 使用云服務(wù)器制作整機(jī)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為tags，虛擬機(jī)ID為“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "云服務(wù)器制作鏡像", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
- 使用云服務(wù)器制作整機(jī)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為image_tags，虛擬機(jī)ID為“877a2cda-ba63-4e1e-b95f-e67e48b6129a”。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "instance_whole_image", "description": "云服務(wù)器制作鏡像", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
- 使用云服務(wù)器備份或云備份制作整機(jī)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為tags，備份ID為"9b27efab-4a17-4c06-bfa2-3e0cf021d3c3"。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "云備份制作鏡像", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "whole_image_type": "CBR", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
- 使用云服務(wù)器備份或云備份制作整機(jī)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為image_tags，備份ID為"9b27efab-4a17-4c06-bfa2-3e0cf021d3c3"。
POST https://{Endpoint}/v1/cloudimages/wholeimages/action { "name": "backup_whole_image", "description": "云備份制作鏡像", "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3", "whole_image_type": "CBR", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
響應(yīng)消息
- 響應(yīng)參數(shù)
參數(shù)
參數(shù)類型
描述
job_id
String
異步任務(wù)ID。
詳情請參見異步任務(wù)查詢。
- 響應(yīng)樣例
STATUS CODE 200
{ "job_id": "4010a32b5f909853015f90aaa24b0015" }
返回值
- 正常
- 異常
返回值
說明
400 Bad Request
請求錯(cuò)誤，具體返回錯(cuò)誤碼請參見錯(cuò)誤碼。
401 Unauthorized
鑒權(quán)失敗。
403 Forbidden
沒有操作權(quán)限。
404 Not Found
找不到資源。
500 Internal Server Error
服務(wù)內(nèi)部錯(cuò)誤。
503 Service Unavailable
服務(wù)不可用。
