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

指定された ECS インスタンスのディスクに対するスナップショット整合性グループを作成します。スナップショット整合性グループには、1 つ以上のディスクのスナップショットが含まれます。

操作説明

InstanceId を設定して、インスタンス内の指定されたディスクに対するスナップショット整合性グループを作成できます。または、DiskId.N のみを使用して、同じゾーン内の複数の ECS インスタンスにアタッチされている複数のディスクに対するスナップショット整合性グループを作成することもできます。

説明

DiskId.N と ExcludeDiskId.N を同じ時間に指定することはできません。InstanceId を指定した場合、DiskId.N は指定されたインスタンスにアタッチされているディスクにのみセットできます。この場合、複数のインスタンスにまたがるディスク ID の指定はサポートされません。

スナップショット整合性グループを作成する場合は、次の点に注意してください。

スナップショットを作成するディスクは、使用中 (In_use) または 未アタッチ (Available) のステータスである必要があります。
- ディスクが 使用中 (In_use) のステータスである場合、インスタンスステータスは 実行中 (Running) または停止 (Stopped) である必要があります。
- ディスクが 未アタッチ (Available) のステータスである場合、そのディスクは過去に ECS インスタンスにアタッチされたことがある必要があります。ECS インスタンスにアタッチされたことのないディスクのスナップショットは作成できません。
スナップショット整合性グループは、ESSD シリーズディスク (ESSD、ESSD AutoPL、ESSD Entry) のみをサポートします。
1 つのスナップショット整合性グループには、最大 128 個のディスク (システムディスクとデータディスクを含む) を含めることができ、スナップショットのサイズの合計は最大 256 TiB です。
ユーザー作成のスナップショットは、削除するまで保持されます。不要になったスナップショットは定期的に削除し、スナップショットのサイズに対する継続的な課金を回避してください。
マルチアタッチ属性が有効なディスクは、スナップショット整合性グループをサポートしません。インスタンスにマルチアタッチ属性が有効なディスクがある場合は、ExcludeDiskId.N パラメーターをセットしてそれらのディスクを除外してください。

スナップショット整合性グループの特徴と課金の詳細については、「スナップショット整合性グループ」を参照してください。

今すぐお試しください

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

create

Instance。

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

Disk。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出し、最新のリージョンリストをクエリできます。	cn-hangzhou
InstanceId	string	任意	インスタンス ID	i-j6ca469urv8ei629****
InstantAccess	boolean	任意	スナップショットのインスタントアクセスを有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。デフォルト値: false。説明このパラメーターは非推奨です。エンタープライズ SSD の標準スナップショットは、デフォルトでインスタントアクセスにアップグレードされました。追加の構成や課金は必須ではありません。	false
InstantAccessRetentionDays	integer	任意	スナップショットのインスタントアクセスの特徴がアクティブな日数。単位: 日。有効な値: 1～65535。このパラメーターは、InstantAccess=true の場合にのみ効果があります。指定された期間が経過すると、スナップショットのインスタントアクセスの特徴は自動的に無効になります。デフォルト値: null。null は、スナップショットがリリースされるまでスナップショットのインスタントアクセスの特徴がアクティブであることを示します。説明このパラメーターは非推奨です。エンタープライズ SSD の標準スナップショットは、デフォルトでインスタントアクセスにアップグレードされました。追加の構成や課金は必須ではありません。	1
Name	string	任意	スナップショット整合性グループの名前。名前は 2～128 文字である必要があります。先頭は英字である必要があり、http:// または https:// で始めることはできません。名前には、数字、期間 (.)、アンダースコア (_)、ハイフン (-)、コロン (:) を使用できます。	testName
Description	string	任意	説明。説明は 2～256 文字である必要があり、http:// または https:// で始めることはできません。	これは説明です
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意になるようにしてください。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-426655440000
StorageLocationArn	string	任意	説明このパラメーターは公開されていません。	null
ExcludeDiskId	array	任意	スナップショットを作成しないインスタンス内のディスクの ID。ディスク ID を指定すると、スナップショット整合性グループには指定されたディスクのスナップショットが含まれません。N の有効な値: 1～128。デフォルト値: null。null は、インスタンス内のすべてのディスクのスナップショットが作成されることを示します。説明このパラメーターは DiskId.N と同時に指定することはできません。	d-j6cf7l0ewidb78lq****
	string	任意	スナップショットを作成しないインスタンス内のディスクの ID。ディスク ID を指定すると、スナップショット整合性グループには指定されたディスクのスナップショットが含まれません。N の有効な値: 1～128。デフォルト値: null。null は、インスタンス内のすべてのディスクのスナップショットが作成されることを示します。説明このパラメーターは DiskId.N と同時に指定することはできません。	d-j6cf7l0ewidb78lq****
DiskId	array	任意	スナップショット整合性グループを作成するディスクの ID。同じゾーン内のインスタンスにまたがるディスク ID を指定できます。N の有効な値: 1～128。スナップショット整合性グループには、最大 128 個のディスクを含めることができ、合計容量は最大 256 TiB です。次の点に注意してください。このパラメーターは ExcludeDiskId.N と同時に指定することはできません。 InstanceId を指定した場合、このパラメーターには指定されたインスタンスにアタッチされているディスクのみを設定できます。この場合、複数のインスタンスにまたがるディスク ID の指定はサポートされません。
	string	任意	スナップショット整合性グループを作成するディスクの ID。同じゾーン内のインスタンスにまたがるディスク ID を指定できます。N の有効な値: 1～128。スナップショット整合性グループには、最大 128 個のディスクを含めることができ、合計容量は最大 256 TiB です。次の点に注意してください。このパラメーターは ExcludeDiskId.N と同時に指定することはできません。 InstanceId を指定した場合、このパラメーターには指定されたインスタンスにアタッチされているディスクのみを設定できます。この場合、複数のインスタンスにまたがるディスク ID の指定はサポートされません。	d-bp1bcpqxahucdrcn****
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	スナップショット整合性グループのタグキー。N の有効な値: 1～20。タグキーは空の文字列にすることはできません。タグキーの長さは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。	TestKey
Value	string	任意	スナップショット整合性グループのタグ値。N の有効な値: 1～20。タグ値は空の文字列にすることができます。タグ値の長さは最大 128 文字で、acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。	TestValue
ResourceGroupId	string	任意	スナップショット整合性グループが属するリソースグループの ID。	rg-bp67acfmxazb4p****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	01ABBD93-1ABB-4D92-B496-1A3D20EC0697
SnapshotGroupId	string	スナップショット整合性グループの ID。	ssg-j6ciyh3k52qp7ovm****

例

成功レスポンス

JSONJSON

{
  "RequestId": "01ABBD93-1ABB-4D92-B496-1A3D20EC0697",
  "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidDiskIds.NotInSameZone	The specified disks are not in the same availability zone.
400	MissingParamter.InstanceId	The specified InstanceId should not be null.
400	InvalidParam.ExcludeDiskIdsAndDiskIds.Conflict	The use of parameter 'ExcludeDiskIds' and 'DiskIds' at the same time is not supported.
400	InvalidSnapshotName.Malformed	The specified SnapshotName is malformed.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	現在のインスタンスステータスでは、この操作はサポートされていません。
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.	指定された保持日数の値が無効です。RetentionDays パラメーター値が正しいかどうかを確認してください。
400	DiskCategory.OperationNotSupported	The specified disk is encrypted. This operation is not supported.
400	InvalidParameter.Name	The specified Name is invalid.	指定された Name パラメーターが無効です。
400	InvalidParameter.Description	The specified Description is invalid.
500	InternalError	The request processing has failed due to an internal error and you may retry later or contact support with the request ID.
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.	リクエストパラメーターが、同じ ClientToken を持つリクエストと一致しません。
403	IncorrectDiskStatus.Invalid	The specified device 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.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	InvalidOperation.Unauthorized	The specified operation is unauthorized.
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	IncorrectDiskStatus.TooManyCreatingSnapshots	The specified disk has too many unfinished snapshots.
403	InvalidRegion.NotSupport	The specified region does not support creating snapshot group.
403	UserNotInTheWhiteList	The user is not in the white list of creating snapshot group.
403	InvalidInstance.NoDisk	There is no disk mounted on the instance.	インスタンスにディスクがアタッチされていません。
403	NumberExceed.TooManyDisks	The number of all disks in the request exceeds.	リクエスト内のクラウドディスク数が制限を超えています。
403	CapacityExceed.TooManyDisks	The capacity of all disks in the request exceeds.
403	InvalidOperation.MultiAttachDisk	Multi attach disk does not support this operation.	マルチアタッチが有効なディスクはこの操作をサポートしていません。
403	InvalidParameter.KMSKeyId.CMKUnauthorized	The CMK has not authorized the ECS service to perform the KMS TagResource and UntagResource operations. Please verify the authorization and try again.
403	InvalidDisk.DiskCategoryInconsistent	If any specified disk is of a regional disk category; then all disks must also be of that regional disk category.
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	InvalidDisk.ShareVolume	The specified diskId is invalid. The shared volume does not support creating a snapshot group.	指定された diskId が無効です。共有ディスクはスナップショット整合性グループの作成をサポートしていません。
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	InvalidOperation.SnapshotStorageLocationUnsupported	Snapshots with storage location in CloudBox do not support the current operation.	CloudBox に保存されたスナップショットは、現在の操作をサポートしていません。
403	InvalidStorageLocationArn.Malformed	The specified parameter StorageLocationArn is malformed.
403	Forbidden.InDebt	The operation is not allowed because your account has an outstanding balance. Please settle the overdue payment and try again.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	指定されたディスクが存在しません。ディスク ID が正しいかどうかを確認してください。
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	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定された RegionId が存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。
404	InvalidKMSKeyId.NotFound	The specified KMSKeyId does not exist. Please verify that the key ID is correct and that the key resides in the current region.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	Record にリソースグループが見つかりません。

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

変更履歴

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