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

カスタムイメージを作成します。作成したカスタムイメージを使用して、ECS インスタンスの作成 (RunInstances) やインスタンスのシステムクラウドディスクの置き換え (ReplaceSystemDisk) ができます。

操作説明

始める前に

これは非同期操作です。カスタムイメージの作成リクエストが送信されると、イメージ ID が返されます。ただし、イメージの作成はすぐには完了しません。 DescribeImage を呼び出してイメージ情報をクエリしてください。応答のステータスが Available になると、イメージが作成され、使用可能になります。詳細については、「カスタムイメージの概要」をご参照ください。
ECS インスタンス情報をクエリした際、応答に {"OperationLocks": {"LockReason" : "security"}} が含まれている場合、カスタムイメージを作成できません。
イメージ作成時にイメージ検出パラメーター 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 マーケットプレイスイメージまたは Alibaba Cloud マーケットプレイスイメージから作成されたカスタムイメージである場合、このパラメーターは現在のインスタンスイメージの `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。このパラメーターが設定されていない場合、作成されたイメージはデフォルトのリソースグループに属します。説明この操作を RAM ユーザーとして呼び出し、`ResourceGroupId` が空のままの場合、RAM ユーザーにデフォルトのリソースグループに対する権限がないと、エラーメッセージ `Forbidden: User not authorized to operate on the specified resource` が返されます。RAM ユーザーが権限を持つリソースグループ ID を設定するか、この操作を再度呼び出す前に RAM ユーザーにデフォルトのリソースグループに対する権限を付与してください。	rg-bp67acfmxazb4p****
DiskDeviceMapping	array<object>	任意	カスタムイメージの作成に使用するディスクとスナップショットの情報。システムディスクとデータディスクのスナップショットからカスタムイメージを作成する場合、このパラメーターを使用してスナップショットを指定します。
	object	任意	カスタムイメージの作成に使用するディスクとスナップショット。
SnapshotId	string	任意	スナップショット ID。	s-bp17441ohwkdca0****
Size	integer	任意	ディスクのサイズ (GiB 単位)。DiskDeviceMapping.N.Size の有効な値とデフォルト値は DiskDeviceMapping.N.SnapshotId に依存します: SnapshotId が指定されていない場合、Size の有効な値とデフォルト値は次のとおりです: 基本ディスク: 5～2000 GiB。デフォルト値: 5。その他のディスクタイプ: 20～32768 GiB。デフォルト値: 20。 SnapshotId が指定されている場合、Size の値はスナップショットのサイズ以上である必要があります。デフォルト値: スナップショットのサイズ。	2000
Device	string	任意	カスタムイメージ内のデバイス名。有効な値: システムディスクのデバイス名は /dev/xvda である必要があります。データディスクのデバイス名は /dev/xvdb から /dev/xvdz まで順番に付けられ、重複できません。	/dev/xvdb
DiskType	string	任意	新しいイメージ内のディスクのタイプ。このパラメーターを使用して、データディスクスナップショットをイメージのシステムディスクとして指定できます。このパラメーターが指定されていない場合、ディスクタイプはスナップショットに対応するディスクのタイプがデフォルトになります。有効な値: system: システムディスク。システムディスクスナップショットは 1 つのみ指定できます。 data: データディスク。データディスクスナップショットは最大 16 個まで指定できます。	system
Tag	array<object>	任意	タグ。
	object	任意	タグ。
key	string	任意	イメージのタグキー。説明互換性を高めるため、代わりに Tag.N.Key を使用してください。	null
Key	string	任意	イメージのタグキー。N の有効な値: 1～20。タグキーは空の文字列にできません。最大 128 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	KeyTest
Value	string	任意	イメージのタグ値。N の有効な値: 1～20。タグ値は空の文字列にできます。最大 128 文字で、`acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	ValueTest
value	string	任意	イメージのタグ値。説明互換性を高めるため、代わりに Tag.N.Value を使用してください。	null
DetectionStrategy	string	任意	イメージ検出戦略。このパラメーターが指定されていない場合、検出はトリガーされません。標準検出モードのみがサポートされています。説明ほとんどの Linux および Windows バージョンがサポートされています。イメージ検出項目とオペレーティングシステムの制限の詳細については、「イメージ検出の概要」および「イメージ検出のオペレーティングシステムの制限」をご参照ください。	Standard
Features	object	任意	イメージの特徴プロパティ。
ImdsSupport	string	任意	イメージのメタデータアクセスモード。有効な値: v1: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを「セキュリティ強化モードのみ」に設定できません。 v2: このイメージから ECS インスタンスを作成する場合、メタデータアクセスモードを「セキュリティ強化モードのみ」に設定できます。デフォルト値: スナップショットからイメージを作成する場合、デフォルトは v1 です。インスタンスからイメージを作成する場合、デフォルトはインスタンスの作成時に使用されたイメージの ImdsSupport 値です。	v2
DryRun	boolean	任意

レスポンスフィールド

フィールド	型	説明	例
	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.	指定されたイメージ名の形式が無効です。長さは 2 ～ 128 文字で、先頭は大文字または小文字の英字、または漢字である必要があります。後続の文字には、数字、"."、"_"、"-" を使うことができます。
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.	指定された DiskDeviceMapping.n.Device パラメーターが無効です。
400	MissingParameter	The input parameter SnapshotId or InstanceId or DiskDeviceMapping that is mandatory for processing this request is not supplied.	指定されたパラメーターのうち、少なくとも 1 つを指定する必要があります。すべてを空にすることはできません。
400	InvalidSize.ValueNotSupported	The specified parameter DiskDeviceMapping.n.Size beyond the permitted range.	指定された Size が無効です。
400	InvalidDevice.InUse	The specified parameter DiskDeviceMapping.n.Device has been occupied.	指定された DiskDeviceMapping.n.Device パラメーターは既に使用されています。
400	OperationDenied	The specified parameter DiskDeviceMapping.n.SnapshotId does not contain system disk snapshot.	指定された EIP は利用できないか、権限がありません。
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.	指定されたタグキーが無効です。タグキーは空または null にできません。最大 128 文字で、「aliyun」または「acs:」で始めることはできず、「http://」または「https://」を含めることはできません。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定されたタグ値が無効です。タグ値は最大 128 文字で、「http://」または「https://」を含めることはできません。
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.	べき等性パラメーターが一致しません。
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 パラメーターが無効です。有効な値: BIOS、UEFI、UEFI-preferred。
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.	指定された EIP は利用できないか、権限がありません。
403	QuotaExceed.Image	The Image Quota exceeds.
403	InvalidParamter.Conflict	The specified same token is trying to make requests with different parameters.	SourceCidrIp パラメーターと DestCidrIp パラメーターを同じにすることはできません。
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.	ユーザーは Amazon リソースネーム (ARN) 関連のパラメーター操作を実行する権限を持つアカウントのリストに含まれていません。
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	ECS service have no right to access your KMS.	ECS サービスには KMS にアクセスする権限がありません。
403	QuotaExceed.Tags	%s	タグパラメーターのクォータを超えました。最大値は 20 です。
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.	Stopped 状態のインスタンスにクラウドディスクをアタッチした後、カスタムイメージを作成する前にインスタンスを再起動する必要があります。
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.	指定されたスナップショットはデフォルトの無料スナップショットであり、この操作はサポートされていません。
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.	指定されたリソースグループが存在しません。

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

変更履歴

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