導(dǎo)出一份自定義鏡像到與自定義鏡像同一地域的OSS Bucket里。
接口說明
導(dǎo)出鏡像前:
-
您需要先了解前提條件以及注意事項。更多信息,請參見導(dǎo)出鏡像。
-
設(shè)置參數(shù)
ImageFormat
鏡像導(dǎo)出格式功能僅在部分地域可用,支持的地域有日本(東京)、印度尼西亞(雅加達)、德國(法蘭克福)、阿聯(lián)酋(迪拜)、美國(弗吉尼亞)、英國(倫敦)、新加坡、馬來西亞(吉隆坡)和美國(硅谷)。不支持設(shè)置鏡像格式的地域,默認(rèn)導(dǎo)出 RAW 格式的鏡像。 -
您必須通過 RAM 授權(quán)云服務(wù)器 ECS 寫入 OSS 的權(quán)限。具體操作說明如下:
- 創(chuàng)建角色:
AliyunECSImageExportDefaultRole
(其他任何角色名稱無效),為該角色設(shè)置以下角色策略:{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "Service": [ "ecs.aliyuncs.com" ] } } ], "Version": "1" }
- 在角色
AliyunECSImageExportDefaultRole
下加入默認(rèn)的系統(tǒng)權(quán)限策略:AliyunECSImageExportRolePolicy
,該策略是云服務(wù)器 ECS 提供導(dǎo)出鏡像的默認(rèn)策略。更多詳情,請參見云資源訪問授權(quán)。您也可以創(chuàng)建自定義策略,權(quán)限需要包含:{ "Version": "1", "Statement": [ { "Action": [ "oss:GetObject", "oss:PutObject", "oss:DeleteObject", "oss:GetBucketLocation", "oss:GetBucketInfo", "oss:AbortMultipartUpload", "oss:ListMultipartUploads", "oss:ListParts" ], "Resource": "*", "Effect": "Allow" } ] }
- 創(chuàng)建角色:
導(dǎo)出鏡像后:
自定義鏡像將保存在指定的 OSS bucket 中,您可以下載自定義鏡像。具體操作,請參見下載自定義鏡像文件。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ecs:ExportImage | update | *Image acs:ecs:{#regionId}:{#accountId}:image/{#imageId} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 自定義鏡像的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ImageId | string | 是 | 自定義鏡像 ID。 | m-bp67acfmxazb4p**** |
OSSBucket | string | 是 | 保存導(dǎo)出鏡像的 OSS bucket。 | testexportImage |
OSSPrefix | string | 否 | 您的 OSS Object 的前綴。可以由數(shù)字或者字母組成,字符長度為 1~30。 | EcsExport |
ImageFormat | string | 否 | 鏡像文件的導(dǎo)出格式。取值范圍:
默認(rèn)值:raw。 | raw |
RoleName | string | 否 | 導(dǎo)出鏡像時使用的 RAM 角色名稱。 | AliyunECSImageExportDefaultRole |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "C8B26B44-0189-443E-9816-D951F596****",
"TaskId": "tsk-bp67acfmxazb4p****",
"RegionId": "cn-hangzhou"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | MissingParameter | An input parameter "RegionId" that is mandatory for processing the request is not supplied. | - |
400 | MissingParameter | An input parameter "ImageId" that is mandatory for processing the request is not supplied. | - |
400 | MissingParameter | An input parameter "OSSBucket" that is mandatory for processing the request is not supplied. | - |
400 | InvalidImageName.Malformed | The specified Image name is wrongly formed. | 鏡像名稱格式錯誤。長度為2~128個字符。必須以大小字母或中文開頭,不能以aliyun和acs:開頭,不能包含http://或者https://。可以包含數(shù)字、半角句號(.)、半角冒號(:)、下劃線(_)或者短劃線(-)。 |
400 | InvalidOSSPrefix.Malformed | The specified OSSPrefix format is wrongly formed. | 參數(shù) OssPrefix 格式錯誤。 |
400 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
400 | InvalidRegion.NotSupport | The specified region does not support image import or export. | 指定的地域暫時不支持此操作。 |
400 | IncorrectImageStatus | The specified Image is not available. | 指定的源鏡像狀態(tài)不正確。 |
400 | InvalidImageFormat.Malformed | The specified Image Format is wrongly formed. | 指定的鏡像格式錯誤。 |
400 | InvalidOSSBucket.NotFound | The specified OSS bucket does not exist in this region. | 指定的 bucket 不存在。 |
400 | OperationDenied | The specified image contains the snapshot of the data disk,does not support this operation. | 包含了數(shù)據(jù)盤快照的鏡像,不支持此操作。 |
400 | InvalidImage.DiskAmountOrSize | %s | 無效的鏡像,導(dǎo)出的鏡像限制數(shù)據(jù)盤數(shù)不能超過 4 塊,單塊數(shù)據(jù)盤容量最大不能超過 500 GiB。 |
400 | ImageNotSupported | The specified Image contains encrypted snapshots, do not support export. | 指定的鏡像包含了加密快照,不支持導(dǎo)出。 |
400 | InvalidOSSObject.NeedRestore | The specified OSS object is a archive object, need restore first. | - |
400 | InvalidOSSBucket.NotMatched | The specified OSS bucket is incorrect, %s. | 指定的 OSS Bucket 有誤,具體信息請參見錯誤信息的實際返回結(jié)果。 |
400 | InvalidImage.DiskAmountOrSize | The diskSize of the image exceeds the maximum size. | - |
400 | InvalidImageFormat.RegionNotSupported | The specified image format is not supported in current region. | - |
403 | ImageNotSupported | The specified image from the image market, do not support export image. | 指定的鏡像來自云市場鏡像,此鏡像不能導(dǎo)出。 |
403 | ImageIsExporting | The specified Image is exporting. | 指定的鏡像正在導(dǎo)出。 |
403 | ExportImageFailed | Exporting image is failed, Please contact the administrator. | 導(dǎo)出鏡像失敗,請聯(lián)系系統(tǒng)管理員。 |
403 | UserNotInTheWhiteList | The user is not in the white list of exporting image. | 該用戶不在導(dǎo)出鏡像白名單中。 |
403 | NoSetRoletoECSServiceAcount | ECS service account Have no right to access your OSS.please attach a role of access your oss to ECS service account. | ECS 官網(wǎng)服務(wù)賬號沒有權(quán)限訪問您指定的 OSS 的 bucket 和 Object。 |
403 | InvalidOSS.NotAuthorized | The specified OSS bucket or object is not allowed to access. | - |
403 | ConcurrentQuotaExceed.ExportImage | %s | 當(dāng)前處理中的任務(wù),已達到并發(fā)最大額度,請耐心等待一段時間再創(chuàng)建任務(wù)。 |
403 | WeeklyQuotaExceed.ExportImage | %s | 本周提交任務(wù)已經(jīng)超出配額,請耐心等候再次分配可用額度。 |
403 | InvalidImageLicense.NotSupported | %s | 指定的鏡像不支持導(dǎo)出。具體信息請參見錯誤信息%s占位符的實際返回值。 |
403 | InvalidImageCategory.NotSupported | The specified image category is not supported. | - |
403 | InvalidOSSBucket.EncryptUnsupported | Accessing objects from encrypted OSS bucket is not supported. | 不支持從加密的OSS bucket讀取對象。 |
404 | InvalidImageId.NotFound | The specified ImageId does not exist. | 指定的鏡像在該用戶賬號下不存在,請您檢查鏡像 ID 是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-05-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |