功能介紹
使用上傳至OBS桶中的外部數(shù)據(jù)盤 鏡像 文件制作數(shù)據(jù)鏡像。作為異步接口，調(diào)用成功，只是說明后臺收到了制作請求，鏡像是否制作成功需要通過異步任務(wù)查詢接口查詢該任務(wù)的執(zhí)行狀態(tài)，具體請參考異步任務(wù)查詢。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v1/cloudimages/dataimages/action
請求消息
- 請求參數(shù)
參數(shù)
是否必選
參數(shù)類型
描述
name
是
String
鏡像名稱。name參數(shù)說明請參考鏡像屬性。
description
否
String
鏡像描述信息。_description參數(shù)說明請參考鏡像屬性。支持字母、數(shù)字、中文等，不支持回車、<、>，長度不能超過1024個(gè)字符。默認(rèn)為空。
os_type
否
String
操作系統(tǒng)類型。
只能是Windows、Linux二者之一，默認(rèn)Linux。
image_url
是
String
OBS桶中外部鏡像文件地址。
格式為<OBS桶名>:<OBS鏡像文件名稱>。
說明：此處的OBS桶和鏡像文件的存儲類別必須是標(biāo)準(zhǔn)存儲。
min_disk
是
Integer
最小數(shù)據(jù)盤大小。
取值范圍40-2048GB。
cmk_id
否
String
創(chuàng)建加密鏡像的自定義密鑰，具體取值請參考“查看密鑰”獲取。
tags
否
Array of strings
鏡像標(biāo)簽列表。默認(rèn)為空。
tag的參數(shù)說明請參考鏡像標(biāo)簽數(shù)據(jù)格式。
tags和image_tags只能使用一個(gè)。
image_tags
否
新規(guī)范的鏡像標(biāo)簽列表。默認(rèn)為空。
tags和image_tags只能使用一個(gè)。
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è)中心總覽”。
請求示例
- 使用外部鏡像文件制作數(shù)據(jù)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為tags，OBS桶中外部鏡像文件地址為“"image-test:fedora_data1.qcow2"，操作系統(tǒng)為Linux，數(shù)據(jù)盤大小為40G。
POST https://{Endpoint}/v1/cloudimages/dataimages/action { "name": "fedora-data1", "image_url": "image-test:fedora_data1.qcow2", "description": "fedora的數(shù)據(jù)盤1", "min_disk": 40, "tags": [ "aaa.111", "bbb.222" ], "os_type": "Linux" }
- 使用外部鏡像文件制作數(shù)據(jù)鏡像，其中，鏡像標(biāo)簽數(shù)據(jù)格式為image_tags，OBS桶中外部鏡像文件地址為“"image-test:fedora_data1.qcow2"，操作系統(tǒng)為Linux，數(shù)據(jù)盤大小為40G。
POST https://{Endpoint}/v1/cloudimages/dataimages/action { "name": "fedora-data2", "image_url": "image-test:fedora_data1.qcow2", "description": "fedora的數(shù)據(jù)盤2", "min_disk": 40, "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}], "os_type": "Linux" }
響應(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ù)不可用。
