功能介紹
使用上傳至OBS桶中的超大外部 鏡像 文件制作私有鏡像，目前僅支持RAW或ZVHD2格式鏡像文件。且要求鏡像文件大小不能超過(guò)1TB。
由于快速導(dǎo)入功能要求提前轉(zhuǎn)換鏡像文件格式為RAW或ZVHD2格式，因此鏡像文件小于128GB時(shí)推薦您優(yōu)先使用常規(guī)的創(chuàng)建私有鏡像的方式。
作為異步接口，調(diào)用成功，只是說(shuō)明后臺(tái)收到了制作請(qǐng)求，鏡像是否制作成功需要通過(guò)異步任務(wù)查詢接口查詢?cè)撊蝿?wù)的執(zhí)行狀態(tài)，具體請(qǐng)參考異步任務(wù)查詢。
約束與限制
- RAW格式鏡像文件：確認(rèn)鏡像文件已經(jīng)轉(zhuǎn)換為RAW格式，按照要求完成了鏡像優(yōu)化，且已生成位表文件。
- ZVHD2格式鏡像文件：確認(rèn)鏡像文件已經(jīng)轉(zhuǎn)換為ZVHD2格式，并按照要求完成了鏡像優(yōu)化。
請(qǐng)您參考“快速導(dǎo)入鏡像文件”完成鏡像文件格式轉(zhuǎn)換、生成位表文件等操作。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v2/cloudimages/quickimport/action
請(qǐng)求消息
- 使用上傳至OBS桶中的外部鏡像文件創(chuàng)建系統(tǒng)盤鏡像時(shí)的請(qǐng)求參數(shù)
參數(shù)
是否必選
參數(shù)類型
描述
name
是
String
鏡像名稱。
name參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。
description
否
String
鏡像描述信息。
_description參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。
支持字母、數(shù)字、中文等，不支持回車、<、>，長(zhǎng)度不能超過(guò)1024個(gè)字符。默認(rèn)為空。
os_version
是
String
操作系統(tǒng)版本。
使用上傳至OBS桶中的外部鏡像文件制作鏡像時(shí)生效，具體取值見相關(guān)參數(shù)取值列表。
image_url
是
String
OBS桶中外部鏡像文件地址。
在使用OBS桶的外部鏡像文件制作鏡像時(shí)生效且為必選字段。格式為<OBS桶名>:<OBS鏡像文件名稱>。
說(shuō)明：此處的OBS桶和鏡像文件的存儲(chǔ)類別必須是標(biāo)準(zhǔn)存儲(chǔ)。
min_disk
是
Integer
最小系統(tǒng)盤大小，單位為GB。
- 在使用OBS桶的外部鏡像文件制作鏡像時(shí)生效且為必選字段。
- 取值為1～1024GB且需大于所選鏡像文件的大小。
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è)。
type
否
String
制作的鏡像類型。系統(tǒng)盤鏡像為ECS/BMS。默認(rèn)為ECS。
enterprise_project_id
否
String
表示當(dāng)前鏡像所屬的企業(yè)項(xiàng)目。
- 取值為0或無(wú)該值，表示屬于default企業(yè)項(xiàng)目。
- 取值為UUID，表示屬于該UUID對(duì)應(yīng)的企業(yè)項(xiàng)目。
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參考“企業(yè)中心總覽”。
architecture
否
String
鏡像的架構(gòu)類型。取值包括：
- x86
- arm
默認(rèn)使用“x86”。
說(shuō)明：當(dāng)架構(gòu)類型為arm時(shí)，鏡像引導(dǎo)方式將自動(dòng)轉(zhuǎn)為UEFI。
- 使用上傳至OBS桶中的外部鏡像文件創(chuàng)建數(shù)據(jù)盤鏡像時(shí)的請(qǐng)求參數(shù)
參數(shù)
是否必選
參數(shù)類型
描述
name
是
String
鏡像名稱。name參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。
description
否
String
鏡像描述信息。_description參數(shù)說(shuō)明請(qǐng)參考鏡像屬性。支持字母、數(shù)字、中文等，不支持回車、<、>，長(zhǎng)度不能超過(guò)1024個(gè)字符。默認(rèn)為空。
os_type
否
String
操作系統(tǒng)版本。
創(chuàng)建數(shù)據(jù)盤鏡像時(shí)取值為L(zhǎng)inux或Windows，默認(rèn)Linux。
image_url
是
String
OBS桶中外部鏡像文件地址。
在使用OBS桶的外部鏡像文件制作鏡像時(shí)生效且為必選字段。格式為<OBS桶名>:<OBS鏡像文件名稱>。
說(shuō)明：此處的OBS桶和鏡像文件的存儲(chǔ)類別必須是標(biāo)準(zhǔn)存儲(chǔ)。
min_disk
是
Integer
最小系統(tǒng)盤大小。
在使用OBS桶的外部鏡像文件制作鏡像時(shí)生效且為必選字段。取值為1～1024GB。
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è)。
type
是
String
制作的鏡像類型。數(shù)據(jù)盤鏡像為DataImage。
enterprise_project_id
否
String
表示當(dāng)前鏡像所屬的企業(yè)項(xiàng)目。
- 取值為0或無(wú)該值，表示屬于default企業(yè)項(xiàng)目。
- 取值為UUID，表示屬于該UUID對(duì)應(yīng)的企業(yè)項(xiàng)目。
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參考“企業(yè)中心總覽”。
請(qǐng)求示例
- 使用上傳至OBS桶的外部鏡像文件制作系統(tǒng)盤鏡像，其中，OBS桶中外部鏡像文件地址為“ims-image:centos70.zvhd2”，鏡像標(biāo)簽數(shù)據(jù)格式為tags。
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桶的外部鏡像文件制作系統(tǒng)盤鏡像，其中，OBS桶中外部鏡像文件地址為“ims-image:centos70.zvhd2”，鏡像標(biāo)簽數(shù)據(jù)格式為image_tags。
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桶的外部鏡像文件制作數(shù)據(jù)盤鏡像，其中，OBS桶中外部鏡像文件地址為“ims-image:centos70.zvhd2”，鏡像標(biāo)簽數(shù)據(jù)格式為tags。
POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作鏡像", "image_url": "ims-image:centos70.qcow2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
- 使用上傳至OBS桶的外部鏡像文件制作數(shù)據(jù)盤鏡像，其中，OBS桶中外部鏡像文件地址為“ims-image:centos70.zvhd2”，鏡像標(biāo)簽數(shù)據(jù)格式為image_tags。
POST https://{Endpoint}/v2/cloudimages/quickimport/action { "name": "ims_test_file", "description": "OBS文件制作鏡像", "image_url": "ims-image:centos70.qcow2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
響應(yīng)消息
- 響應(yīng)參數(shù)
參數(shù)
參數(shù)類型
描述
job_id
String
異步任務(wù)ID。
詳情請(qǐng)參見異步任務(wù)查詢。
- 響應(yīng)樣例
STATUS CODE 200
{ "job_id": "8a12fc664fb4daa3014fb4e581380005" }
返回值
- 正常
- 異常
返回值
說(shuō)明
400 Bad Request
請(qǐng)求錯(cuò)誤，具體返回錯(cuò)誤碼請(qǐng)參見錯(cuò)誤碼。
401 Unauthorized
鑒權(quán)失敗。
403 Forbidden
沒(méi)有操作權(quán)限。
404 Not Found
找不到資源。
500 Internal Server Error
服務(wù)內(nèi)部錯(cuò)誤。
503 Service Unavailable
服務(wù)不可用。
