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

ディスクのスナップショットを作成します。

操作説明

ローカルスナップショット機能は、スナップショット即時アクセス機能に置き換えられました。メトリックの説明は以下のとおりです。

2020 年 12 月 14 日より前にローカルスナップショットを使用していた場合、Category パラメーターを法線として使用できます。
2020 年 12 月 14 日より前にローカルスナップショットを使用していない場合、追加の構成は必須ではありません。ESSD シリーズディスク (ESSD、ESSD AutoPL、ESSD Entry、およびリージョン ESSD) に新規作成されるスナップショットは、デフォルトで即座にアクティブな状態になり、手動スナップショットと自動スナップショットの両方がサポートされます。API 操作における 3 つのスナップショット即時アクセス関連パラメーター InstantAccess、InstantAccessRetentionDays、および DisableInstantAccess は効果がなくなります。DescribeSnapshots および DescribeSnapshotGroups API 操作には、スナップショットのアクティブなステータスを示す Available という名前の新しいレスポンスパラメーターが含まれます。

開始する前に:

スナップショット機能を有効化してください。詳細については、「スナップショットの有効化」をご参照ください。
ディスクが 使用中 または 未アタッチ の状態である必要があります。状態ごとに以下の点にご注意ください。
- ディスクが 使用中 の状態の場合、インスタンスは 実行中 または停止の状態である必要があります。
- ディスクが 未アタッチ の状態の場合、そのディスクは以前に ECS インスタンスにアタッチされている必要があります。ECS インスタンスに一度もアタッチされていないディスクのスナップショットは作成できません。
- ディスクが動的拡張ボリュームまたは RAID 配列の作成に使用されている場合は、スナップショット整合性グループを使用し、アプリケーション整合性スナップショットを有効にしてデータをバックアップしてください。スナップショット整合性グループにより、業務システム内の複数のディスクに書き込まれるデータの書き込み順序の整合性とクラッシュ整合性が確保されます。詳細については、「スナップショット整合性グループの作成」および「アプリケーション整合性スナップショットの作成」をご参照ください。

スナップショットを作成する際は、以下の点にご注意ください。

ビジネスのピーク時間帯にスナップショットを作成しないでください。スナップショットの作成中は、ディスクの I/O パフォーマンスが最大 10% 低下し、読み取りおよび書き込みパフォーマンスが一時的に影響を受ける可能性があります。
スナップショットが作成されていない場合、そのスナップショットを使用してカスタムイメージ ( CreateImage ) を作成することはできません。
スナップショット作成中のディスク操作によって生成された増分データは、スナップショットにバックアップされません。
ディスクが ECS インスタンスにアタッチされている場合、スナップショット作成中に ECS インスタンスの停止や再起動など、インスタンスステータスを変更しないでください。変更すると、スナップショットの作成は失敗します。
スナップショットを作成中のディスクは、拡張をサポートしません。拡張操作を実行する前に、スナップショットの作成が完了するまでお待ちください。
期限切れ (Expired) 状態のディスクのスナップショットを作成できます。スナップショット作成中にディスクがリリース期限時間に達した場合、ディスクはリリースされ、作成中 (Creating) 状態のスナップショットも削除されます。
スナップショット作成後、システムは各リージョンのスナップショットのサイズに基づいて個別に料金を計算します。詳細については、「スナップショットの課金」をご参照ください。
以下のシナリオでは、指定したディスクのスナップショットを作成できません。
- ディスクに対して保持されている手動スナップショットの数が上限に達している場合。詳細については、「スナップショットの使用制限」をご参照ください。
- スナップショット作成には同時実行数の制限があります。制限を超えると作成に失敗します。詳細については、「スナップショットの使用制限」をご参照ください。
- ECS インスタンス情報をクエリした際、返されたデータに {"OperationLocks": {"LockReason" : "security"}} が含まれている場合、すべてのセキュリティ操作が禁止されます。

今すぐお試しください

この 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:CreateSnapshot

create

*Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

*Snapshot

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DiskId	string	必須	ディスクの ID。	d-bp1s5fnvk4gn2tws0****
SnapshotName	string	任意	スナップショットの名前。名前は 2～128 文字の長さである必要があります。先頭は英字にする必要があり、`http://` または `https://` で始めることはできません。名前には、文字カテゴリの Unicode 文字 (英語および中国語の文字を含む)、ASCII 数字 (0-9)、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。説明自動スナップショットの名前との競合を避けるため、名前の先頭を `auto` にすることはできません。	testSnapshotName
Description	string	任意	スナップショットの説明。説明は 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。デフォルト値: null。	testDescription
RetentionDays	integer	任意	スナップショットの保持期間の設定項目。単位: 日。有効な値: 1～65536。保持期間が終了すると、スナップショットは自動リリースの対象となります。デフォルト値: null。null はスナップショットが自動リリースの対象とならないことを示します。	30
Category	string	任意	スナップショットタイプ。有効な値: Standard: 標準スナップショット。 Flash: ローカルスナップショット。説明このパラメーターは非推奨となります。エンタープライズ SSD の標準スナップショットは、デフォルトで即時アクセスにアップグレードされました。追加の構成や料金は必須ではありません。これは、エンタープライズ SSD、ESSD AutoPL ディスク、ESSD Entry ディスク、およびリージョンエンタープライズ SSD に適用されます。標準 SSD の標準スナップショットもデフォルトでアクティブな状態です。	Standard
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken の値には ASCII 文字のみを含めることができ、長さは 64 文字以下である必要があります。詳細については、「べき等性の確保方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
ResourceGroupId	string	任意	スナップショットが属するリソースグループの ID。	rg-bp67acfmxazb4p****
InstantAccess	boolean	任意	スナップショット即時アクセス機能を有効にするかどうかを指定します。有効な値: true: 機能を有効にします。この機能はエンタープライズ SSD のみでサポートされています。 false: シャットダウン。標準スナップショットが作成されます。デフォルト値: false。説明このパラメーターは非推奨です。エンタープライズ SSD の標準スナップショットは、デフォルトで即時アクセスにアップグレードされました。追加の構成や料金は必須ではありません。これは、エンタープライズ SSD、ESSD AutoPL ディスク、ESSD Entry ディスク、およびリージョンエンタープライズ SSD に適用されます。標準 SSD の標準スナップショットもデフォルトでアクティブな状態です。	false
InstantAccessRetentionDays	integer	任意	スナップショット即時アクセス機能の保持期間の設定項目。保持期間が終了すると、スナップショットは自動リリースの対象となります。このパラメーターは `InstantAccess=true` の場合にのみ有効です。単位: 日。有効な値: 1～65535。デフォルト値: `RetentionDays` パラメーターの値と同じ。説明このパラメーターは非推奨です。エンタープライズ SSD の標準スナップショットは、デフォルトで即時アクセスにアップグレードされました。追加の構成や料金は必須ではありません。これは、エンタープライズ SSD、ESSD AutoPL ディスク、ESSD Entry ディスク、およびリージョンエンタープライズ SSD に適用されます。標準 SSD の標準スナップショットもデフォルトでアクティブな状態です。	1
Tag	array<object>	任意	タグ。
	object	任意	タグ。
key	string	任意	スナップショットのタグキー。説明互換性のために、Tag.N.Key パラメーターを使用してください。	null
Key	string	任意	スナップショットのタグキー。N の有効な値: 1～20。タグキーを空文字列にすることはできません。タグキーの長さは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。	TestKey
Value	string	任意	スナップショットのタグ値。N の有効な値: 1～20。タグ値は空文字列でも構いません。タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。	TestValue
value	string	任意	スナップショットのタグ値。説明互換性のために、Tag.N.Value パラメーターを使用してください。	null
StorageLocationArn	string	任意	説明このパラメーターは公開されていません。	null

レスポンスフィールド

フィールド	型	説明	例
	object
SnapshotId	string	スナップショットの ID。	s-bp17441ohwka0yuh****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "SnapshotId": "s-bp17441ohwka0yuh****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.KMSKeyId.NotFound	The specified KMSKeyId does not exist.
400	InvalidSnapshotName.Malformed	The specified SnapshotName is malformed.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	インスタンスステータスがこの操作をサポートしていないため、操作は許可されていません。
400	DiskCategory.OperationNotSupported	The type of the specified disk does not support creating a snapshot.	ディスクタイプの制限により、指定されたディスクはこの操作をサポートしていません。
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	InvalidRetentionDays.Malformed	The specified RetentionDays is not valid.	指定された保持日数が無効です。RetentionDays パラメーターの値が正しいことを確認してください。
400	CreateSnapshot.Failed	The process of creating snapshot is failed.	リクエストのプロセス中にエラーが発生しました。後でもう一度お試しください。リクエストでべき等性を使用している場合は、べき等性トークンを再生成してからもう一度お試しください。
500	InternalError	The request processing has failed due to some unknown error.
403	Throttling	Request was denied due to user flow control.	リクエストはスロットルされています。PageNumber ベースのページネーションメソッドではなく、NextToken ベースのページネーションメソッドを使用してください。
403	IncorrectDiskStatus.CreatingSnapshot	A previous snapshot creation is in process.
403	InstanceLockedForSecurity	The disk attached instance is locked due to security.
403	IncorrectDiskStatus.NeverAttached	The specified disk has never been attached to any instance.
403	QuotaExceed.Snapshot	The snapshot quota exceeds.
403	IncorrectDiskStatus.NeverUsed	The specified disk has never been used after creating.
403	CreateSnapshot.Failed	The process of creating snapshot is failed.
403	DiskInArrears	The specified operation is denied as your disk has expired.
403	DiskId.ValueNotSupported	The specified parameter diskid is not supported.	指定されたブロックストレージタイプはこの操作をサポートしていません。
403	IncorrectDiskStatus	The current disk status does not support this operation.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	InvalidAccountStatus.SnapshotServiceUnavailable	Snapshot service has not been opened yet.	スナップショットサービスが有効化されていません。この操作は実行できません。
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	IncorrectVolumeStatus	The current volume status does not support this operation.	共有ブロックストレージデバイスの現在の状態では、この操作はサポートされていません。
403	IdempotentParameterMismatch	The specified clientToken is used.	指定されたクライアントトークンは既に使用されています。
403	IncorrectDiskStatus.Invalid	The specified disk status is invalid. Restart the instance and try again.
403	IncorrectDiskType.NotSupport	The specified device type is not supported.	指定されたディスクのストレージタイプでは、この操作はサポートされていません。
403	IncorrectDiskStatus.Transferring	The specified device is transferring. You can retry after the process is finished.
403	InvalidParameter.KMSKeyId.CMKUnauthorized	ECS tags must be added to the CMK.	ECS には CMK を暗号化するまたは復号する権限がありません。
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.
403	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service does not have permission to access your KMS key. Please verify that the specified KMS key has authorized the ECS service.
403	IdempotentProcessing	The previous idempotent request(s) is still processing.	以前の冪等リクエストはまだプロセス中です。しばらくしてから再試行してください。
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	指定されたスナップショットタイプが無効です。Category パラメーターの値が正しいかどうかを確認してください。
403	InvalidAction.Unauthorized	The specified action is not valid.	指定された操作が無効です。
403	InvalidRegion.NotSupportSnapshotInstantAccessRegion	The snapshot InstantAccess is not supported for this region.
403	InvalidCategoryAndInstantAccess.Malformed	The snapshot Category and InstantAccess can't be used together.
403	DISK_HAS_CREATING_SNAPSHOT	The operation cannot be performed while a snapshot is being created for the disk.
403	HibernationConfigured.InstanceOperationForbidden	The operation is not permitted due to limit of the hibernation configured instance.	インスタンスが休止状態オプションを有効にするための要件を満たしていないため、操作は許可されていません。
403	QuotaExceed.SnapshotQuota	The quota is insufficient. Please contact your channel partner to increase the quota.
403	InvalidInstantAccessRetentionDays.Malformed	The specified InstantAccessRetentionDays is not valid.	指定された InstantAccessRetentionDays パラメーターの初期化が無効です。
403	CloudBoxNotSupportSnapshotWithInstantAccess	The specified disk in CloudBox does not support to create a snapshot with InstantAccess.	CloudBox 内のディスクは、インスタントアクセス機能を使用したスナップショットの作成をサポートしていません。
403	InvalidOperation.UnfinishedEncryptedSnapshotCopy	This disk has unfinished encrypted copy snapshots in the target region.	ディスクには暗号化されたスナップショットのコピータスクが進行中です。
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	InvalidClientToken.Malformed	The specified clientToken is improperly formatted. It must contain only ASCII characters and must not exceed 64 characters in length.	指定された ClientToken パラメーターが初期化要件を満たしていません。このパラメーターには ASCII 文字のみを含め、長さは 64 文字以内にする必要があります。
403	InvalidParameter.UnauthorizedStorageLocationArn	The operation has failed due to lack of permission for the specified "StorageLocationArn". Please use a resource with appropriate permission for the operation.	指定された StorageLocationArn に十分な権限がないため、操作に失敗しました。リソース管理者に連絡して必要な権限を取得してください。
403	InvalidStorageLocationArn.Malformed	The specified parameter StorageLocationArn is malformed.
403	InvalidStatus.ResourceGroup	You cannot perform an operation on a resource group that is being created or deleted.	リソースグループの作成中または削除中は操作が許可されていません。
403	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.	リソースタグの最大数に達しました。
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	指定されたディスクが存在しません。
404	InvalidDescription.Malformed	The specified description is malformed.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	指定されたインスタンス ID が無効です。
404	InvalidVolumeId.NotFound	The specified volume does not exist.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	指定されたリソースグループが見つかりませんでした。

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

変更履歴

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