調(diào)用CopyImage復(fù)制一個地域下的自定義鏡像到其他地域。復(fù)制鏡像可以實(shí)現(xiàn)跨地域部署ECS實(shí)例、跨地域復(fù)制ECS實(shí)例等目的。
接口說明
您可以在其他地域使用復(fù)制后的鏡像創(chuàng)建 ECS 實(shí)例(RunInstances),或者更換實(shí)例的系統(tǒng)盤(ReplaceSystemDisk)。
調(diào)用該接口時,您需要注意:
- 自定義鏡像的狀態(tài)必須為可用(
Available
)。 - 鏡像是您賬號下的自定義鏡像時,可以跨地域復(fù)制鏡像;鏡像是其他人共享給您的鏡像時,只能同地域復(fù)制鏡像。
- 復(fù)制鏡像期間,您無法直接操作刪除( DeleteImage )復(fù)制中的鏡像,但是您可以通過取消復(fù)制任務(wù)( CancelCopyImage )的方式來刪除復(fù)制中的鏡像。
- 同一個地域下同時只能有五個鏡像復(fù)制任務(wù)運(yùn)行,其余任務(wù)需要排隊等待上述任一任務(wù)完成后再依次排隊執(zhí)行。
- 您可以通過
ResourceGroupId
參數(shù)指定復(fù)制后的鏡像所屬的資源組。如果不設(shè)置ResourceGroupId
參數(shù)值,復(fù)制后的鏡像屬于默認(rèn)資源組。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎ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:CopyImage | update | *Image acs:ecs:{#regionId}:{#accountId}:image/* |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DestinationImageName | string | 否 | 復(fù)制后的鏡像的名稱。長度為 2~128 個字符。必須以大小寫字母或中文開頭,也不能以 | YourImageName |
DestinationDescription | string | 否 | 復(fù)制后的鏡像的描述信息。長度為 2~256 個英文或中文字符,不能以 | This is a description example. |
ImageId | string | 是 | 源自定義鏡像的 ID。 | m-bp1h46wfpjsjastc**** |
RegionId | string | 是 | 源自定義鏡像的地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
DestinationRegionId | string | 否 | 復(fù)制到目標(biāo)地域的 ID。 | cn-shanghai |
Encrypted | boolean | 否 | 是否加密復(fù)制后的鏡像。
默認(rèn)值:false。 | false |
KMSKeyId | string | 否 | 加密鏡像使用的密鑰 ID。 | e522b26d-abf6-4e0d-b5da-04b7******3c |
EncryptAlgorithm | string | 否 | 說明
該參數(shù)暫未開放使用。
| hide |
ResourceGroupId | string | 否 | 復(fù)制后的鏡像的資源組 ID。如果不設(shè)置該參數(shù)值,復(fù)制后的鏡像屬于默認(rèn)資源組。 說明
如果您當(dāng)前使用的是 RAM 用戶調(diào)用該接口,且 ResourceGroupId 取值為空,您需要注意,當(dāng) RAM 用戶沒有默認(rèn)資源組權(quán)限時,調(diào)用接口會返回報錯信息Forbidden: User not authorized to operate on the specified resource 。請您設(shè)置 RAM 用戶支持的資源組 ID 或者通過相應(yīng)阿里云賬號為該 RAM 用戶授予默認(rèn)資源組權(quán)限后,再次調(diào)用該接口。
| rg-bp67acfmxazb4p**** |
Tag | array<object> | 否 | 標(biāo)簽列表。 | |
object | 否 | 標(biāo)簽列表。 | ||
Key | string | 否 | 復(fù)制后的鏡像的標(biāo)簽鍵。N 的取值范圍為 1~20。一旦傳入該值,則不允許為空字符串。最多支持 128 個字符,不能以 | TestKey |
Value | string | 否 | 復(fù)制后的鏡像的標(biāo)簽值。N 的取值范圍為 1~20。一旦傳入該值,可以為空字符串。最多支持 128 個字符,不能以 | TestValue |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"ImageId": "m-bp1h46wfpjsjastd****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidDescription.Malformed | The specified destination description is wrongly formed. | 指定的資源描述格式不合法。長度為 2-256 個字符,不能以 http:// 和 https:// 開頭。 |
400 | SourceRegion.NotFound | The source region not found. | 指定的源鏡像的地域不存在。 |
400 | DestinationRegion.NotFound | The destination region not found. | 未找到目的地域 |
400 | IncorrectImageStatus | The image not available. | 指定的鏡像不可用。 |
400 | InvalidSnapshotId.NotFound | The specified SnapshotId does not exist. | 指定的快照不存在,請您檢查快照是否正確。 |
400 | InvalidImageName.Duplicated | The destination image is exist. | 指定的鏡像名已存在。 |
400 | InvalidParameter.EncryptedIllegal | The specified parameter Encrypted must be true when kmsKeyId is not empty. | 設(shè)置參數(shù) KMSKeyId 后,您必須開啟加密屬性。 |
400 | InvalidEncrypted.NotMatchEncryptAlgorithm | The specified parameter Encrypted must be true when EncryptAlgorithm is not empty. | - |
400 | InvalidEncryptAlgorithm | The specified parameter EncryptAlgorithm is not valid. | - |
400 | InvalidEncrypted.NotMatchKmsKeyId | The specified parameter Encrypted must be true when KmsKeyId is not empty. | - |
400 | OperationDenied.CommunityImage | Community image does not support copy. | 社區(qū)鏡像不支持復(fù)制。 |
400 | InvalidImageName.Malformed | The specified destination image name is wrongly formed. | 鏡像名稱不合法。限制條件請參見 DestinationImageName 參數(shù)說明。 |
400 | InvalidParameter.KmsNotEnabled | The specified operation need enable KMS. | 當(dāng)前操作需要開啟KMS。 |
400 | OperationDenied.ImageCopyConflict | The same image cannot be copied concurrently. Please wait until the last copy is completed before performing the next operation. | 同一鏡像不能并發(fā)拷貝,請等待上一次拷貝完成再進(jìn)行下一次操作。 |
401 | InvalidAliUid.IsNull | The aliUid must not be null. | - |
403 | Forbbiden | User not authorized to operate on the specified resource. | 用戶未被授權(quán)操作指定的資源。 |
403 | QuotaExceed.Image | The Image Quota exceeds. | 自定義鏡像額度已用完。 |
403 | QuotaExceed.Snapshot | The snapshot quota exceeds. | 快照額度超過限制,若要存儲新快照,在不影響業(yè)務(wù)的情況下,請您刪除已有的老快照。 |
403 | OperationDenied.ImageCopying | The Image are coping. | 正在復(fù)制鏡像,請您稍后再試。 |
403 | RegionNotSupportCopy | The region not support copy. | 指定的目標(biāo)鏡像地域或者源鏡像所在地域暫時不支持鏡像復(fù)制。 |
403 | InvalidSnapshot.TooOld | This operation is denied because the specified snapshot is created before 2013-07-15. | 該操作被拒絕。因?yàn)橹付ǖ目煺談?chuàng)建于 2013-07-15 之前。 |
403 | OperationDenied | The specified snapshot is not allowed to create image. | 指定快照不允許創(chuàng)建鏡像。 |
403 | IncorrectDestinationRegion | The destination region is not equal the target region. | 復(fù)制鏡像的源地域不能等于目標(biāo)地域。 |
403 | OperationDeined.EncryptedSnapshot | The image contains encrypted snapshots, which do not support copying. | 指定的鏡像含有加密快照,不支持復(fù)制這種鏡像。 |
403 | OperationDenied.SameRegionOnly | The image shared from others can not be copied to another region directly. | 其他人分享的鏡像不能復(fù)制到另一個地域。 |
403 | OperationDenied.NotPublished | The operation is denied because corresponding marketplace image is not published in destination region. | 指定的操作無法執(zhí)行,鏡像的原始鏡像來自云市場,并且未在目標(biāo)地域發(fā)布。 |
403 | OperationDenied.NotAuthorized | The operation is denied because corresponding marketplace image is not authorized to current user. | - |
403 | OperationDeined.EncryptedSnapshot | The image contains encrypted snapshots, which do not support copying to non-encrypted ones. | 鏡像包含加密快照,不支持復(fù)制到非加密快照。 |
403 | OperationDenied.EncryptSnapshotAcrossRegion | The image do not contain encrypted snapshots, which do not support copying to encrypted ones. | - |
403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設(shè)置了 KMSKeyId 后,CMK必須處于啟用狀態(tài)。您可以調(diào)用密鑰管理服務(wù)的 DescribeKey 接口查詢指定CMK的相關(guān)信息。 |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服務(wù)無權(quán)訪問您的 KMS。 |
403 | InvalidRegion.NotSupport | The specified region does not support byok. | 該地域不支持BYOK。 |
403 | UserNotInTheWhiteList | The user is not in byok white list. | 您不在byok白名單中,請加入白名單后重試。 |
403 | InvalidRegionId.NotSupportEncryptAlgorithm | The current region does not support creating encrypted disks with EncryptAlgorithm. | - |
403 | OperationDenied.KmsServiceUnauthorized | The account is not authorized to kms service, please authorize it. | 用戶未授權(quán)kms服務(wù),請先授權(quán)。 |
403 | OperationDenied.NonCompliantDestinationRegion | The copy operation to the destination region is not in compliance with regulations. | 目標(biāo)地域不符合安全合規(guī)要求。 |
403 | InvalidEncrypted.NotMatchDiskDefaultEncryption | The specified parameter Encrypted not match for your account default encryption settings. | 加密參數(shù)不匹配當(dāng)前賬號云盤默認(rèn)加密配置。 |
403 | InvalidParameter.DataEncryptedKeyCreateFailed | Create kms data encrypted key fail. If you need further assistance, you can contact the KMS Technical Support. | 使用KMS主密鑰創(chuàng)建數(shù)據(jù)密鑰失敗,請聯(lián)系KMS值班同學(xué)進(jìn)一步排查。 |
403 | SizeExceed.Image | The image exceeds the maximum size. You can use the CopySnapshot API to copy your snapshots of the image and then create a new image from them. | 鏡像的大小已超過可操作的最大值。您可以使用CopySnapshot接口復(fù)制這個鏡像的快照到目標(biāo)地域,然后用復(fù)制后快照創(chuàng)建一個新的鏡像。 |
404 | InvalidImageId.NotFound | The specified ImageId does not exist. | 指定的鏡像在該用戶賬號下不存在,請您檢查鏡像 ID 是否正確。 |
404 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的參數(shù) KMSKeyId 不存在。 |
404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源組并不在記錄中。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-12-11 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-12-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-09-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-06-27 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-18 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-08-23 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-07-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-03-03 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |