カスタムイメージを作成します。作成したカスタムイメージを使用して、RunInstances を呼び出して ECS インスタンスを作成したり、ReplaceSystemDisk を呼び出してインスタンスのシステムクラウドディスクを置き換えたりできます。
操作説明
注意事項
-
この操作は非同期です。カスタムイメージの作成リクエストが送信されると、イメージ ID が返されます。イメージはすぐには作成されません。DescribeImage を呼び出してイメージ情報をクエリする必要があります。返されたステータスが Available の場合、イメージは作成され、使用可能になります。詳細については、「カスタムイメージの概要」を参照してください。
-
ECS インスタンス情報をクエリした際、返されたデータに {"OperationLocks": {"LockReason" : "セキュリティ"}} が含まれている場合、カスタムイメージを作成できません。
-
イメージの作成時に DetectionStrategy パラメーターを設定して、システムによるイメージの最適化を支援します。詳細については、「イメージチェックの概要」を参照してください。
以下のセクションでは、この操作を使用してカスタムイメージを作成する 3 つの方法について説明します。リクエストパラメーターの優先度は次のとおりです。InstanceId > DiskDeviceMapping > SnapshotId。リクエストにこれらのパラメーターのうち 2 つ以上が含まれている場合、最も優先度の高いパラメーターがイメージの作成に使用されます。
-
インスタンスからカスタムイメージを作成する: インスタンス ID (InstanceId) を指定します。
インスタンスは実行中 (Running) または停止 (Stopped) 状態である必要があります。
操作が呼び出された後、インスタンスの各クラウドディスクのスナップショットが作成されます。
重要 実行中のインスタンスには、ディスクに書き込まれていないキャッシュデータが存在する可能性があります。これにより、作成されたカスタムイメージのデータがインスタンスのデータと一致しなくなる可能性があります。したがって、イメージを作成する前にインスタンスを停止 (StopInstances) してください。 -
スナップショットからカスタムイメージを作成する (指定するスナップショットは 2013 年 7 月 15 日以前に作成されたものであってはなりません。)
システムクラウドディスクのスナップショットからカスタムイメージを作成する: インスタンスのシステムクラウドディスクのスナップショット ID (SnapshotId) のみを指定します。
- システムクラウドディスクのスナップショットとデータクラウドディスクのスナップショットからカスタムイメージを作成する: 複数のクラウドディスクのデータ関連付け (DiskDeviceMapping) を指定します。
指定できるシステムクラウドディスクのスナップショットは 1 つだけです。
指定できるデータクラウドディスクのスナップショットは最大 16 つです。DiskDeviceMapping.N.SnapshotId が指定されていない場合、デフォルト容量の空のデータクラウドディスクが作成されます。
インスタンスがリリースされると、システムクラウドディスクは従量課金制のデータクラウドディスクとして保持されます。このディスクから作成されたスナップショットを使用してカスタムイメージを作成することはできません。必要に応じて、インスタンスがリリースされる前にカスタムイメージを作成してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:CreateImage |
create |
*Image
Instance
Snapshot
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
イメージのリージョン ID。DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| SnapshotId |
string |
任意 |
カスタムイメージの作成に使用されるスナップショットの ID。 説明
インスタンスのシステムクラウドディスクのスナップショットのみからカスタムイメージを作成する場合は、このパラメーターまたは DiskDeviceMapping.N.SnapshotId パラメーターを使用できます。データクラウドディスクのスナップショットを追加する場合は、DiskDeviceMapping.N.SnapshotId パラメーターのみを使用してスナップショットを指定できます。 |
s-bp17441ohwkdca0**** |
| InstanceId |
string |
任意 |
インスタンスの ID。インスタンスからカスタムイメージを作成する場合、このパラメーターは必須です。 |
i-bp1g6zv0ce8oghu7**** |
| ImageName |
string |
任意 |
イメージ名。名前の長さは 2~128 文字である必要があります。先頭は英字または漢字とする必要があり、http:// または https:// で始めることはできません。数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。 |
TestCentOS |
| ImageFamily |
string |
任意 |
イメージ ファミリーの名前。名前の長さは 2~128 文字である必要があります。先頭は英字または漢字とする必要があります。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。 |
hangzhou-daily-update |
| ImageVersion |
string |
任意 |
イメージバージョン。 説明
インスタンス ID (InstanceId) を指定し、かつインスタンスのイメージが Alibaba Cloud Marketplace イメージまたは Alibaba Cloud Marketplace イメージから作成されたカスタムイメージである場合、このパラメーターは現在のインスタンスイメージの ImageVersion と同じであるか、空である必要があります。 |
2017011017 |
| Description |
string |
任意 |
イメージの説明。説明の長さは 2~256 文字である必要があり、http:// または https:// で始めることはできません。 |
ImageTestDescription |
| Platform |
string |
任意 |
オペレーティングシステム。データクラウドディスクのスナップショットをイメージのシステムクラウドディスクとして指定した後、Platform を使用してシステムクラウドディスクのオペレーティングシステムのディストリビューションを決定する必要があります。有効な値:
デフォルト値: Others Linux。 |
CentOS |
| BootMode |
string |
任意 |
イメージのブートモード。有効な値:
重要
サポートされていないブートモードが原因でインスタンスの起動が失敗しないようにするには、このパラメーターを設定する前に、送信先イメージでサポートされているブートモードを理解していることを確認してください。イメージのブートモードの詳細については、「イメージのブートモード」を参照してください。 列挙値:
|
BIOS |
| Architecture |
string |
任意 |
システムアーキテクチャー。データクラウドディスクのスナップショットをイメージのシステムクラウドディスクとして指定した後、Architecture を使用してシステムクラウドディスクのシステムアーキテクチャーを決定する必要があります。有効な値:
デフォルト値: x86_64。 |
x86_64 |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」を参照してください。 |
123e4567-e89b-12d3-a456-426655440000 |
| ResourceGroupId |
string |
任意 |
カスタムイメージが属するリソースグループの ID。このパラメーターを設定しない場合、作成されたイメージはデフォルトのリソースグループに属します。 説明
Resource Access Management (RAM) ユーザーを使用してこの操作を呼び出し、ResourceGroupId が空の場合、Resource Access Management (RAM) ユーザーにデフォルトのリソースグループに対する権限がないと、Forbidden: User not authorized to operate on the specified resource というエラーメッセージが返されることに注意してください。Resource Access Management (RAM) ユーザーに権限があるリソースグループの ID に設定項目を更新するか、対応する Alibaba Cloud アカウントを使用して Resource Access Management (RAM) ユーザーにデフォルトのリソースグループに対する権限を付与してから、この操作を再度呼び出してください。 |
rg-bp67acfmxazb4p**** |
| DiskDeviceMapping |
array<object> |
任意 |
カスタムイメージの作成に使用されるクラウドディスクおよびスナップショットに関する情報。システムクラウドディスクのスナップショットとデータクラウドディスクのスナップショットからカスタムイメージを作成する場合は、このパラメーターを使用してスナップショットを指定します。 |
|
|
object |
任意 |
カスタムイメージの作成に使用されるクラウドディスクおよびスナップショット。 |
||
| Device |
string |
任意 |
カスタムイメージ内のクラウドディスクのデバイス名。有効な値:
|
/dev/xvdb |
| DiskType |
string |
任意 |
新しいイメージ内のクラウドディスクタイプ。このパラメーターを使用して、データクラウドディスクのスナップショットをイメージのシステムクラウドディスクとして指定できます。このパラメーターを指定しない場合、デフォルト値はスナップショットに対応するクラウドディスクタイプになります。有効な値:
|
system |
| Size |
integer |
任意 |
クラウドディスクのサイズ。単位: GiB。DiskDeviceMapping.N.Size の有効値とデフォルト値は、DiskDeviceMapping.N.SnapshotId によって異なります。
|
2000 |
| SnapshotId |
string |
任意 |
スナップショットの ID。 |
s-bp17441ohwkdca0**** |
| Tag |
array<object> |
任意 |
タグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
イメージのタグキー。N の有効値: 1~20。このパラメーターを指定する場合、空の文字列にすることはできません。タグキーの長さは最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。 |
KeyTest |
| Value |
string |
任意 |
イメージのタグ値。N の有効値: 1~20。このパラメーターを指定する場合、空の文字列にすることができます。タグ値の長さは最大 128 文字です。acs: で始めることはできず、http:// または https:// を含めることはできません。 |
ValueTest |
| key |
string |
任意 |
イメージのタグキー。 説明
互換性を向上させるには、Tag.N.Key パラメーターを使用してください。 |
null |
| value |
string |
任意 |
イメージのタグ値。 説明
互換性を向上させるには、Tag.N.Value パラメーターを使用してください。 |
null |
| DetectionStrategy |
string |
任意 |
イメージチェック戦略。このパラメーターを設定しない場合、チェックはトリガーされません。標準 (Standard) チェックモードのみがサポートされています。 説明
ほとんどの Linux および Windows バージョンがサポートされています。イメージチェック項目とオペレーティングシステムの制限の詳細については、「イメージチェックの概要」および「イメージチェックのオペレーティングシステムの制限」を参照してください。 |
Standard |
| Features |
object |
任意 |
イメージの特徴属性。 |
|
| ImdsSupport |
string |
任意 |
イメージのメタデータアクセスモード。有効な値:
デフォルト値: スナップショットからイメージを作成する場合、デフォルト値は v1 です。インスタンスからイメージを作成する場合、デフォルト値はインスタンスの作成時に使用されたイメージの ImdsSupport 属性値です。 |
v2 |
| DryRun |
boolean |
任意 |
||
| SecureBootOptions |
object |
任意 |
Secure Boot パラメーター。 |
|
| SecureBootSupport |
string |
任意 |
イメージが Secure Boot をサポートするかどうかを指定します。有効な値:
説明
Secure Boot は UEFI または UEFI-Preferred ブートモードのみをサポートします。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| ImageId |
string |
イメージ ID |
m-bp146shijn7hujku**** |
| RequestId |
string |
リクエスト ID |
C8B26B44-0189-443E-9816-******* |
例
成功レスポンス
JSONJSON
{
"ImageId": "m-bp146shijn7hujku****",
"RequestId": "C8B26B44-0189-443E-9816-*******"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidImageName.Malformed | The specified Image name is wrongly formed. | イメージ名は有効ではありません。命名規則の詳細については、DestinationImageName パラメーターのメトリックの説明を参照してください。 |
| 400 | InvalidImageName.Duplicated | The specified image name is already in use. | イメージ名はすでに存在します。 |
| 400 | InvalidDescription.Malformed | The specified description is wrongly formed. | 指定されたリソースの説明の形式が無効です。説明は 2 ~ 256 文字で、http:// または https:// で始めることはできません。 |
| 400 | InvalidImageVersion.Malformed | The specified ImageVersion is wrongly formed. | イメージバージョン番号が有効ではないか、または指定されたスナップショットを使用する権限がありません。 |
| 400 | IncorrectInstanceStatus | The current status of the instance does not support this operation. | 現在のインスタンスステータスでは、この操作はサポートされていません。 |
| 400 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | |
| 400 | InvalidDevice.Malformed | The specified parameter DiskDeviceMapping.n.Device is not valid. | 指定されたディスクデバイス名は存在しません。 |
| 400 | MissingParameter | The input parameter SnapshotId or InstanceId or DiskDeviceMapping that is mandatory for processing this request is not supplied. | 必須パラメーターが指定されていません。 |
| 400 | InvalidSize.ValueNotSupported | The specified parameter DiskDeviceMapping.n.Size beyond the permitted range. | 指定された DiskDeviceMapping.n.Size パラメーターが有効な範囲外です。 |
| 400 | InvalidDevice.InUse | The specified parameter DiskDeviceMapping.n.Device has been occupied. | 指定されたデバイスには、すでにディスクがアタッチされています。 |
| 400 | OperationDenied | The specified parameter DiskDeviceMapping.n.SnapshotId does not contain system disk snapshot. | 指定されたスナップショットではデータボリュームの作成が許可されていません。 |
| 400 | InvalidDiskCategory.CreateImage | The specified diskCategory is not allowed to create image. | 指定されたディスクタイプではイメージの作成が許可されていません。 |
| 400 | InvalidArchitecture.Malformed | The specified Architecture is wrongly formed. | Architecture パラメーターの形式が無効です。 |
| 400 | InvalidPlatform.Malformed | The specified Platform is wrongly formed. | 指定されたイメージのオペレーティングシステムのディストリビューションが無効です。 |
| 400 | InvalidParameter.AllEmpty | %s | |
| 400 | InvalidParameter.DiskType | The specified disk type which has kms key can't convert to system disk. | |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | タグに重複するキーが存在します。すべてのキーが一意になるようにしてください。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定されたタグキーパラメーターが無効です。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定されたタグ値パラメーターが無効です。 |
| 400 | InvalidInstance.NotFoundSystemDisk | The specified instance does not have system disk. | |
| 400 | InvalidImageFamily.Malformed | The format of the specified image family is invalid. | 指定されたイメージファミリーの形式が無効です。 |
| 400 | ImageQuotaExceed.ImageFamily | The specified image family exceeds the maximum number of images for one image family. | |
| 400 | ImageFamilyQuotaExceed | The number of image families exceeds the limit in the region. | |
| 400 | InvalidDiskType.ValueNotSupported | The specified disk type is not supported. | 指定されたディスク属性はサポートされていません。 |
| 400 | IdempotenceParamNotMatch | Request uses a client token in a previous request but is not identical to that request. | リクエストパラメーターが、同じ ClientToken を持つリクエストと一致しません。 |
| 400 | InvalidBootMode.NotSupport | The specified parameter BootMode is not supported for current image architecture. | 現在のイメージアーキテクチャは、指定された起動モードをサポートしていません。 |
| 400 | InvalidParameter.FeaturesImdsSupport | The specified parameter Features.ImdsSupport is not supported. | 指定された Features.ImdsSupport パラメーターはサポートされていません。 |
| 400 | InvalidOperation.DiskCategoryUnsupported | The current category of the disk does not support this operation. | エラスティック一時ディスクでは、単独でのデタッチはサポートされていません。 |
| 400 | AccountForbidden.CreateOrder | Order cannot be created due to abnormal account. | 現在のアカウントは注文を作成できません。 |
| 400 | InvalidBootMode.Malformed | The specified parameter BootMode is invalid. Valid options are BIOS, UEFI, and UEFI-Preferred. | 指定された BootMode パラメーターは無効です。 |
| 400 | InvalidDetectionStrategy.Malformed | The specified value for parameter DetectionStrategy is not supported. Please refer to the documentation for accepted values. | 指定された DetectionStrategy パラメーター値はサポートされていません。許容される値については、リファレンスを参照してください。 |
| 400 | InvalidParameter.SecureBootSupport | The specified parameter SecureBootOptions.SecureBootSupport is not valid. | 指定された SecureBootOptions.SecureBootPort パラメーターは無効です。 |
| 500 | InternalError | The process of creating snapshot has failed due to some unknown error. | 内部エラーが発生しました。もう一度お試しください。 |
| 403 | IncorrectDiskStatus.NeverAttached | The specified disk has never been attached to instance. | |
| 403 | InvalidSnapshotId.NotReady | The current status of the DiskDeviceMapping.n.SnapshotId or SnapshotId does not support this operation. | 指定されたスナップショットは完了していません。 |
| 403 | InvalidSnapshot.TooOld | This operation is denied because the specified snapshot by DiskDeviceMapping.n.SnapshotId or SnapshotId is created before 2013-07-15. | 指定されたディスクのソーススナップショットは 2013 年 7 月 15 日以前に作成されたため、再初期化できません。 |
| 403 | OperationDenied | The specified snapshot is not allowed to create image. | 指定されたスナップショットではデータボリュームの作成が許可されていません。 |
| 403 | QuotaExceed.Image | The Image Quota exceeds. | |
| 403 | InvalidParamter.Conflict | The specified same token is trying to make requests with different parameters. | 権限を付与されるセキュリティグループと権限を付与するセキュリティグループは異なる必要があります。 |
| 403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | |
| 403 | InvalidAccountStatus.SnapshotServiceUnavailable | Snapshot service has not been opened yet. | スナップショットサービスが有効化されていません。操作を実行できません。 |
| 403 | UserNotInTheWhiteList | The user is not in the white list of create image by data disk snapshot. | ユーザーが共有ブロックストレージのホワイトリストに登録されていません。ホワイトリストへの登録を申請するには、チケットを起票してください。 |
| 403 | IncorrectDiskStatus.Invalid | Device status is invalid, please restart instance and try again. | 現在のディスクのステータスが無効です。インスタンスを再起動して、もう一度お試しください。 |
| 403 | OperationDenied.InvalidSnapshotCategory | %s | このスナップショットタイプでは、この操作はサポートされていません。 |
| 403 | QuotaExceed.Snapshot | The snapshot quota exceeds. | |
| 403 | IncorrectDiskStatus.Transferring | The specified device is transferring, you can retry after the process is finished. | 指定されたディスクは移行中です。移行の完了後にもう一度お試しください。 |
| 403 | IncorrectDiskStatus | The current disk status does not support this operation. | |
| 403 | InvalidSystemSnapshot.Missing | %s | |
| 403 | IncorrectDiskStatus.CreatingSnapshot | A previous snapshot creation is in process. | |
| 403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | ECS タグをカスタマーマスターキー (CMK) に追加する必要があります。 |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | The ECS service is not authorized to access your KMS key. Please grant the ECS service permission to use the key and try again. | |
| 403 | QuotaExceed.Tags | %s | タグの数が設定可能な最大値を超えています。%s は変数です。実際のエラーメッセージは、API 呼び出しに基づいて動的に返されます。 |
| 403 | InvalidSnapshotCategory.NotSupportImageCreation | The specified snapshot category does not support create image. | |
| 403 | TooManySnapshot.Unfinished | There are too many snapshots being created, please wait for them to be created done. | |
| 403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | インスタンスが休止状態オプションの有効化に関する要件を満たしていないため、この操作は許可されていません。 |
| 403 | SnapshotNotReady | The specified snapshot is not ready. | スナップショットがまだ作成されていないため、イメージの作成に使用できません。 |
| 403 | IncorrectInstanceStatus.NeedRestart | The instance needs to be restarted after adding a disk in a shutdown status. | 停止状態のインスタンスにディスクをアタッチした場合、カスタムイメージを作成する前にインスタンスを再起動する必要があります。 |
| 403 | QuotaExceed.ConcurrentSnapshotQuota | The number of snapshots being created for the disk %s has exceeded the concurrent quota (%s). Please wait for the previous snapshots to complete before trying again. | このディスクに対して作成中のスナップショットの数が同時実行クォータを超えています。以前のスナップショットの作成が完了するまで待機してから、もう一度お試しください。 |
| 403 | InvalidOperation.SnapshotStorageLocationUnsupported | Snapshots with storage location in CloudBox do not support the current operation. | CloudBox に保存されているスナップショットでは、この操作はサポートされていません。 |
| 403 | AccountEnterpriseStatusInvalid | Your enterprise registration is marked as revoked/deregistered in the National Enterprise Credit Information Publicity System. Account transaction features (purchase/renewal/recharge) are disabled. Please update real-name certification via Account Center. Restrictions will auto-remove after verification. | 国家企業信用情報公示システムにおける企業の登録ステータスが登録抹消 (または取消) になっています。アカウントでは、新規プロダクトの購入、更新、残高のチャージなどのトランザクション操作フォームを実行できません。アカウントセンターを通じて実名認証をできるだけ早く完了してください。変更完了後、Alibaba Cloud により購入制限の自動無効化および初期化が実行されます。 |
| 403 | InvalidOperation.DefaultFreeSnapshotNotSupport | The specified default free snapshot cannot be used for this operation. Please select another snapshot and try again. | |
| 403 | InvalidBootMode.SecureBootUnsupported | Secure Boot requires UEFI or UEFI-Preferred boot mode. Please check the BootMode and try again. | 指定された BootMode パラメーターは無効です。このブートモードはセキュアブートをサポートしていません。 |
| 404 | InvalidSnapshotId.NotFound | The specified SnapshotId does not exist. | |
| 404 | InvalidInstanceId.NotFound | The specified instance %s does not exist. | 指定されたインスタンスが存在しません。インスタンス ID が正しいかどうかを確認してください。 |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | レコードにリソースグループが見つかりません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。