CreateCustomImage API によるスナップショットからのカスタムイメージ作成 - SAS

Simple Application Server のスナップショットに基づいてカスタムイメージを作成します。

操作説明

カスタムイメージは Simple Application Server のスナップショットから作成されます。カスタムイメージを使用すると、同じ構成を持つ複数の Simple Application Server を作成できます。また、カスタムイメージを Elastic Compute Service (ECS) に共有し、その共有イメージを使用して ECS インスタンスを作成したり、既存の ECS インスタンスの OS を置き換えたりすることもできます。カスタムイメージの詳細については、「カスタムイメージの概要」をご参照ください。

スナップショットに基づいてカスタムイメージを作成する前に、Simple Application Server のシステムディスクのスナップショットを作成する必要があります。詳細については、「CreateSnapshot」をご参照ください。

説明

カスタムイメージの作成時に Simple Application Server のデータディスク上のデータが必要な場合は、まずデータディスクのスナップショットを作成してください。

カスタムイメージを作成する前に、次の点にご注意ください：

カスタムイメージと対応する Simple Application Server は、同じリージョンに存在する必要があります。
作成できるカスタムイメージの最大数は、所有する Simple Application Server の数の 3 倍ですが、15 を超えることはできません。
カスタムイメージは、Simple Application Server のシステムディスクのスナップショットからのみ直接作成できます。カスタムイメージに Simple Application Server のデータディスクのデータを含めたい場合は、カスタムイメージの作成時にシステムディスクのスナップショットに加えてデータディスクのスナップショットを選択する必要があります。
Simple Application Server が期限切れや返金によりリリースされた場合、そのサーバーに基づいて作成されたカスタムイメージもリリースされます。
Simple Application Server のシステムをリセットしたり、イメージを変更したりすると、サーバー上のディスクデータが消去されます。必要に応じてデータをバックアップしてください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:CreateCustomImage

create

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 ListRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でトークンを生成できますが、異なるリクエスト間で一意であることを確認する必要があります。ClientToken の値は ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
InstanceId	string	必須	Simple Application Server の ID。	ace0706b2ac4454d984295a94213****
ImageName	string	必須	カスタムイメージの名前。名前は 2～128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字または数字で始まる必要があります。このパラメーターはデフォルトで空です。	customImage-test
SystemSnapshotId	string	任意	システムディスクのスナップショット ID。	s-acscasca****
Description	string	任意	カスタムイメージの説明。	test
DataSnapshotId	string	任意	データディスクのスナップショット ID。	s-acscasca****
Tag	array<object>	任意	カスタムイメージに追加するタグ。最大 20 個のタグを指定できます。
	object	任意	カスタムイメージのタグ。
Key	string	任意	カスタムイメージに追加するタグ N のキー。N の有効値：1～20。タグキーは空の文字列にできません。タグキーは最大 64 文字で、http:// または https:// を含めることはできません。タグキーは acs: または aliyun で始めることはできません。	TestKey
Value	string	任意	カスタムイメージに追加するタグ N の値。N の有効値：1～20。タグ値は空の文字列にすることができます。タグ値は最大 64 文字で、http:// または https:// を含めることはできません。	TestValue
ResourceGroupId	string	任意	リソースグループ ID。	rg-aek2bti7cf7****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ImageId	string	カスタムイメージ ID。	m-csaascsaccscs****

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ImageId": "m-csaascsaccscs****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParam.DataSnapshotIdNotFound	The specified parameter dataSnapshotId is not found.
400	InvalidParam.SystemSnapshotIdNotFound	The specified parameter systemSnapshotId is not found.
400	InvalidParam.IllegalImageName	The specified parameter imageName is illegal.
400	ImageNameAlreadyExist	The image name already exists.
400	CustomImageQuotaLimit	The maximum number of custom image in this region is exceeded.
400	InvalidParam.SystemSnapshotIdNotSupport	You cannot create custom images in the specified parameter system snapshotId.
500	InternalError	An error occurred while processing your request.
403	IncorrectInstanceStatus	The state of the current instance does not support this operation.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

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

変更履歴

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