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) 状態の場合、ECS インスタンスステータスは 実行中 (Running) または停止 (Stopped) である必要があります。
- ディスクが 利用可能 (Available) 状態の場合、そのディスクは以前に ECS インスタンスにアタッチされたものである必要があります。ECS インスタンスに一度もアタッチされていないディスクでは、スナップショットの作成はサポートされていません。
スナップショット整合性グループは、ESSD シリーズのディスク (ESSD、ESSD AutoPL、ESSD Entry) のみをサポートします。
1 つのスナップショット整合性グループには最大 16 個のディスク (システムディスクおよびデータディスクを含む) を含めることができ、合計容量は 32 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://` で始めることはできません。	This is description.
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。詳細については、「冪等性の確保方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
StorageLocationArn	string	任意	説明このパラメーターは公開されていません。	null
ExcludeDiskId	array	任意	スナップショットを作成しないインスタンス内のディスクの ID。このパラメーターを指定すると、スナップショット整合性グループには指定されたディスクのスナップショットが含まれません。N の有効な値: 1～16。デフォルト値: null。null は、インスタンス内のすべてのディスクに対してスナップショットが作成されることを示します。説明このパラメーターは `DiskId.N` と同時に指定することはできません。	d-j6cf7l0ewidb78lq****
	string	任意	スナップショットを作成しないインスタンス内のディスクの ID。このパラメーターを指定すると、スナップショット整合性グループには指定されたディスクのスナップショットが含まれません。N の有効な値: 1～16。デフォルト値: null。null は、インスタンス内のすべてのディスクに対してスナップショットが作成されることを示します。説明このパラメーターは `DiskId.N` と同時に指定することはできません。	d-j6cf7l0ewidb78lq****
DiskId	array	任意	スナップショット整合性グループを作成するディスクの ID。同じゾーン内のインスタンスにまたがるディスクの ID を指定できます。N の有効な値: 1～16。スナップショット整合性グループには最大 16 個のディスクを含めることができ、合計容量は最大 32 TiB です。以下の点にご注意ください。このパラメーターは `ExcludeDiskId.N` と同時に指定することはできません。 `InstanceId` を指定した場合、このパラメーターには指定されたインスタンスにアタッチされたディスクのみを設定でき、複数のインスタンスにまたがるディスクの ID の指定はサポートされなくなります。
	string	任意	スナップショット整合性グループを作成するディスクの ID。同じゾーン内のインスタンスにまたがるディスクの ID を指定できます。N の有効な値: 1～16。スナップショット整合性グループには最大 16 個のディスクを含めることができ、合計容量は最大 32 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
SnapshotGroupId	string	スナップショット整合性グループの ID。	ssg-j6ciyh3k52qp7ovm****
RequestId	string	リクエスト ID	01ABBD93-1ABB-4D92-B496-1A3D20EC0697

例

成功レスポンス

JSONJSON

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

エラーコード

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.	指定されたタグキーが無効です。タグキーは空または 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	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 some unknown error.
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 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.
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	InvalidRegionId.NotFound	The specified RegionId does not exist.	リージョン情報が無効です。
404	InvalidKMSKeyId.NotFound	The KMS key used by the disk does not exist.	指定された KMS キー ID が存在しません。
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	指定されたリソースグループが見つかりませんでした。

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

変更履歴

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