クラウドディスクのスナップショットを作成します。
操作説明
スナップショットのインスタントアクセス機能は、レガシーローカルスナップショット機能に置き換わりました。パラメーターの説明は次のとおりです:
2020 年 12 月 14 日より前にローカルスナップショットを使用していた場合は、
Categoryパラメーターを引き続き使用できます。2020 年 12 月 14 日より前にローカルスナップショットを使用していなかった場合は、追加の設定は不要です。ESSD クラウドディスク (ESSD、ESSD AutoPL ディスク、ESSD Entry ディスク、ゾーン冗長 ESSD) で新規作成されるスナップショットは、デフォルトでインスタントアクセス機能が有効になります。これは手動スナップショットと自動スナップショットの両方に適用されます。インスタントアクセス関連のパラメーター
InstantAccess、InstantAccessRetentionDays、DisableInstantAccessは有効になりません。DescribeSnapshotsAPI およびDescribeSnapshotGroupsAPI は、スナップショットのステータスを示すAvailableパラメーターを返します。
前提条件:
-
スナップショット機能が有効になっていること。詳細については、「スナップショット機能を有効化」をご参照ください。
-
クラウドディスクが [使用中] または [利用可能] 状態である必要があります。次の点に注意してください:
クラウドディスクが [使用中] 状態の場合、ディスクがアタッチされているインスタンスは [実行中] または [停止済み] 状態である必要があります。
クラウドディスクが [利用可能] 状態の場合、過去に ECS インスタンスにアタッチされたことがある場合にのみ、そのクラウドディスクのスナップショットを作成できます。
クラウドディスクを使用して動的スケーラブルボリュームまたは RAID アレイを作成する場合は、スナップショット整合性グループを使用し、アプリケーション整合性スナップショットを有効にしてデータをバックアップすることを推奨します。スナップショット整合性グループを使用すると、複数のクラウドディスクにまたがって書き込まれるデータのクラッシュ整合性と書き込み順序整合性を確保できます。詳細については、「スナップショット整合性グループの作成」および「アプリケーション整合性スナップショットの作成」をご参照ください。
スナップショットを作成する際は、次の点に注意してください:
-
オフピーク時間にスナップショットを作成してください。スナップショットの作成中は、クラウドディスクの I/O パフォーマンスが 10% 未満低下したり、読み取りおよび書き込み操作が一時的に遅くなったりする場合があります。
-
作成中のスナップショットを使用してカスタムイメージ (CreateImage) を作成することはできません。
-
スナップショットは、作成中にクラウドディスク上で生成された増分データをバックアップしません。
-
クラウドディスクが ECS インスタンスにアタッチされている場合は、スナップショットの作成中にインスタンスの停止や再起動など、インスタンスの状態を変更しないでください。変更すると、スナップショットの作成に失敗します。
-
スナップショットの作成中にクラウドディスクのサイズ変更はできません。クラウドディスクのサイズ変更は、スナップショットの作成が完了した後にのみ実行できます。
-
[期限切れ] (
Expired) 状態のクラウドディスクに対してもスナップショットを作成できます。スナップショットの作成中に期限切れによってクラウドディスクが解放された場合、[作成中] (Creating) 状態のスナップショットも削除されます。 -
スナップショットの作成後は、スナップショットのサイズに基づいて料金が発生します。料金はリージョンごとに精算されます。詳細については、「スナップショット」をご参照ください。
-
次の場合、クラウドディスクのスナップショットを作成できません:
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:CreateSnapshot |
create |
*Disk
*Snapshot
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DiskId |
string |
必須 |
クラウドディスクの ID。 |
d-bp1s5fnvk4gn2tws0**** |
| SnapshotName |
string |
任意 |
スナップショット名は 2~128 文字です。先頭は英字または漢字とし、英字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。 説明
名前の先頭に |
testSnapshotName |
| Description |
string |
任意 |
スナップショットの説明は 2~256 文字で、先頭に このパラメーターは、デフォルトでは空です。 |
testDescription |
| RetentionDays |
integer |
任意 |
スナップショットの保持期間 (単位:日)。有効値:1~65,536。保持期間が終了すると、スナップショットは自動的に削除されます。 このパラメーターを指定しない場合、スナップショットは無期限に保持されます。 |
30 |
| Category |
string |
任意 |
スナップショットのタイプ。有効値:
説明
このパラメーターは非推奨です。ESSD クラウドディスクの標準スナップショットには、追加費用なしでデフォルトで インスタントアクセス 機能が含まれるようになりました。 |
Standard |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するためにクライアントが生成したトークン。トークンはリクエストごとに一意である必要があります。ClientToken の値は、最大 64 文字の ASCII 文字列である必要があります。詳細については、「べき等性を確保する方法」をご参照ください。 |
123e4567-e89b-12d3-a456-426655440000 |
| ResourceGroupId |
string |
任意 |
スナップショットが属するリソースグループの ID。 |
rg-bp67acfmxazb4p**** |
| InstantAccess |
boolean |
任意 |
インスタントアクセス機能を有効にするかどうかを指定します。有効値:
デフォルト値:false。 説明
このパラメーターは非推奨です。ESSD クラウドディスクの標準スナップショットには、追加費用なしでデフォルトで インスタントアクセス 機能が含まれるようになりました。 |
false |
| InstantAccessRetentionDays |
integer |
任意 |
インスタントアクセス機能の保持期間 (単位:日)。この保持期間が終了すると、スナップショットは自動的に削除されます。このパラメーターは、 デフォルト値は 説明
このパラメーターは非推奨です。ESSD クラウドディスクの標準スナップショットには、追加費用なしでデフォルトで インスタントアクセス 機能が含まれるようになりました。 |
1 |
| Tag |
array<object> |
任意 |
スナップショットに追加するタグ。最大 20 個のタグを追加できます。 |
|
|
object |
任意 |
キーと値のペアで構成されるタグ。 |
||
| key |
string |
任意 |
タグのキー。 説明
このパラメーターは非推奨です。互換性を高めるために、代わりに |
null |
| Key |
string |
任意 |
タグのキー。 説明
このパラメーターは非推奨です。互換性を高めるために、代わりに |
TestKey |
| Value |
string |
任意 |
タグの値。空の文字列にすることもできます。長さは 128 文字以下で、 |
TestValue |
| value |
string |
任意 |
タグの値。空の文字列にすることもできます。長さは 128 文字以下で、 |
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 wrongly formed. | 指定されたスナップショット名の形式が無効です。 |
| 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. | |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | |
| 400 | InvalidRetentionDays.Malformed | The specified RetentionDays is not valid. | |
| 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. | |
| 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 invalid, restart 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. | |
| 403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | |
| 403 | IdempotentProcessing | The previous idempotent request(s) is still processing. | |
| 403 | InvalidSnapshotCategory.Malformed | The specified Category is not valid. | |
| 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. | |
| 403 | CloudBoxNotSupportSnapshotWithInstantAccess | The specified disk in CloudBox does not support to create a snapshot with InstantAccess. | |
| 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. | |
| 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. | |
| 403 | InvalidStorageLocationArn.Malformed | The specified parameter StorageLocationArn is wrongly formed. | |
| 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 wrongly formed. | |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | |
| 404 | InvalidVolumeId.NotFound | The specified volume does not exist. | |
| 404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。