CreateImage - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

カスタムイメージを作成します。作成したカスタムイメージを使用して、ECS インスタンスを作成 (RunInstances) したり、インスタンスのシステムディスクを置き換えたり (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 が指定されていない場合、デフォルト容量の空のデータディスクが作成されます。

説明

インスタンスがリリースされると、システムディスクは従量課金制のデータディスクとして保持されます。このディスクから作成されたスナップショットでは、カスタムイメージを作成できません。必要に応じて、インスタンスをリリースする前にカスタムイメージを作成してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:CreateImage

create

*Image。

acs:ecs:{#regionId}:{#accountId}:image/*

Instance。

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Snapshot。

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	任意	オペレーティングシステムのディストリビューション。データディスクのスナップショットをイメージのシステムディスクとして使用した後、このパラメーターを使用してシステムディスクのオペレーティングシステムのディストリビューションを指定します。有効な値: Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 デフォルト値: Others Linux。	CentOS
BootMode	string	任意	イメージの起動モード。有効な値: BIOS: BIOS 起動モード。 UEFI: UEFI 起動モード。 UEFI-Preferred: デュアル起動モード。重要サポートされていない起動モードが原因でインスタンスの起動が失敗しないようにするには、このパラメーターを指定する前に、ターゲットイメージでサポートされている起動モードを理解していることを確認してください。イメージの起動モードの詳細については、「イメージの起動モード」を参照してください。列挙値: BIOS : BIOS。 UEFI : UEFI。 UEFI-Preferred : UEFI-Preferred。	BIOS
Architecture	string	任意	システムアーキテクチャー。データディスクのスナップショットをイメージのシステムディスクとして使用した後、このパラメーターを使用してシステムディスクのシステムアーキテクチャーを指定します。有効な値: i386 x86_64 arm64 デフォルト値: x86_64。	x86_64
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken には ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-426655440000
ResourceGroupId	string	任意	カスタムイメージが属するリソースグループの ID。このパラメーターを特定の値に設定しない場合、作成されたイメージはデフォルトのリソースグループに属します。説明 Resource Access Management (RAM) ユーザーとしてこの操作を呼び出し、ResourceGroupId が空の場合、RAM ユーザーにデフォルトのリソースグループに対する権限がないと、エラーメッセージ Forbidden: 指定されたリソースを操作する権限がありませんが返されることに注意してください。RAM ユーザーに権限があるリソースグループ ID を設定するか、対応する Alibaba Cloud アカウントを使用して RAM ユーザーにデフォルトのリソースグループに対する権限を付与してから、この操作を再度呼び出してください。	rg-bp67acfmxazb4p****
DiskDeviceMapping	array<object>	任意	カスタムイメージの作成に使用されるディスクとスナップショット情報のコレクション。システムディスクとデータディスクのスナップショットからカスタムイメージを作成する場合は、このパラメーターを使用してスナップショットを指定します。
	object	任意	カスタムイメージの作成に使用されるディスクとスナップショット。
Device	string	任意	カスタムイメージ内のデバイス名。有効な値: システムディスクのデバイス名は /dev/xvda である必要があります。データディスクのデバイス名は /dev/xvdb から /dev/xvdz までのアルファベット順であり、重複はできません。	/dev/xvdb
DiskType	string	任意	新しいイメージ内のディスクのタイプ。このパラメーターを使用して、データディスクのスナップショットをイメージのシステムディスクとして設定できます。このパラメーターを指定しない場合、ディスクタイプはデフォルトでスナップショットに対応するディスクのタイプになります。有効な値: system: システムディスク。指定できるシステムディスクのスナップショットは 1 つだけです。 data: データディスク。最大 16 個のデータディスクのスナップショットを指定できます。	system
Size	integer	任意	ディスクのサイズ。単位: GiB。DiskDeviceMapping.N.Size の有効値とデフォルト値は、DiskDeviceMapping.N.SnapshotId によって異なります。 SnapshotId が指定されていない場合、Size の有効値とデフォルト値は次のとおりです。基本ディスク: 5～2000 GiB。デフォルト値: 5。その他のディスク: 20～32768 GiB。デフォルト値: 20。 SnapshotId が指定されている場合、Size の値はスナップショットのサイズ以上である必要があります。デフォルト値はスナップショットのサイズです。	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	任意	イメージ検出戦略。このパラメーターが指定されていない場合、検出はトリガーされません。標準検出モードのみがサポートされています。説明ほとんどの Linux および Windows バージョンがサポートされています。イメージ検出項目とオペレーティングシステムの制限の詳細については、「イメージ検出の概要」および「イメージ検出のオペレーティングシステムの制限」を参照してください。	標準
Features	object	任意	イメージの特徴に関連するプロパティ。
ImdsSupport	string	任意	イメージのメタデータアクセスモード。有効な値: v1: このイメージを使用して ECS インスタンスを作成する場合、メタデータアクセスモードを強化モードのみに設定することはできません。 v2: このイメージを使用して ECS インスタンスを作成する場合、メタデータアクセスモードを強化モードのみに設定できます。デフォルト値: スナップショットを使用してイメージを作成する場合、デフォルト値は v1 です。インスタンスを使用してイメージを作成する場合、デフォルト値はインスタンスの作成に使用されたイメージの ImdsSupport プロパティです。	v2
DryRun	boolean	任意
SecureBootOptions	object	任意	Secure Boot 関連のパラメーター。
SecureBootSupport	string	任意	イメージが Secure Boot をサポートするかどうかを指定します。有効な値: supported: Secure Boot がサポートされています。 unsupported: 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.SecureBootSupport パラメーターが無効です。
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 snapshot is a default free snapshot and does not support this operation.	指定されたスナップショットはデフォルトの無料スナップショットであるため、現在のエラーはサポートされていません。
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.	Record にリソースグループが見つかりません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。