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

Elastic Compute Service (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。説明このパラメーターは現在使用されていません。デフォルトでは、ESSD の新しい標準スナップショットは、追加の設定なしで無料でインスタントアクセススナップショットにアップグレードされます。詳細については、「インスタントアクセス機能の使用」をご参照ください。	false
InstantAccessRetentionDays	integer	任意	インスタントアクセス機能が利用可能な日数。単位：日。有効な値：1～65535。このパラメーターは、`InstantAccess` が true に設定されている場合にのみ有効です。指定した期間が終了すると、インスタントアクセス機能は自動的に無効になります。このパラメーターはデフォルトで空のままです。これは、インスタントアクセススナップショットがリリースされると、インスタントアクセス機能が自動的に無効になることを示します。説明このパラメーターは現在使用されていません。デフォルトでは、ESSD の新しい標準スナップショットは、追加の設定なしで無料でインスタントアクセススナップショットにアップグレードされます。詳細については、「インスタントアクセス機能の使用」をご参照ください。	1
Name	string	任意	スナップショット整合性グループの名前。長さは 2～128 文字である必要があります。名前に使用できる文字は、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、コロン (:) です。先頭は英字である必要があり、`http://` または `https://` で始めることはできません。	testName
Description	string	任意	スナップショット整合性グループの説明。長さは 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。	This is description.
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
StorageLocationArn	string	任意	説明このパラメーターは一般公開されていません。	null
ExcludeDiskId	array	任意	スナップショットを作成したくないクラウドディスクの ID。クラウドディスクの ID を指定すると、作成されるスナップショット整合性グループには、指定されたクラウドディスクのスナップショットは含まれません。N の有効値：1～16。このパラメーターはデフォルトで空です。これは、インスタンスのすべてのディスクに対してスナップショットが作成されることを示します。説明このパラメーターは `DiskId.N` と同時に設定することはできません。	d-j6cf7l0ewidb78lq****
	string	任意	スナップショットを作成したくないクラウドディスクの ID。クラウドディスクの ID を指定すると、作成されるスナップショット整合性グループには、指定されたクラウドディスクのスナップショットは含まれません。N の有効値：1～16。このパラメーターはデフォルトで空です。これは、インスタンスのすべてのディスクに対してスナップショットが作成されることを示します。説明このパラメーターは `DiskId.N` と同時に設定することはできません。	d-j6cf7l0ewidb78lq****
DiskId	array	任意	スナップショット整合性グループを作成するクラウドディスクの ID。同じゾーン内の複数のインスタンスにアタッチされているクラウドディスクの ID を指定できます。N の有効値：1～16。スナップショット整合性グループには、合計ディスクサイズが 32 TiB を超えない最大 16 個のクラウドディスクのスナップショットを含めることができます。次の点にご注意ください： DiskId.N と `ExcludeDiskId.N` パラメーターを同じリクエストで同時に指定することはできません。 `InstanceId` を指定した場合、指定されたインスタンスにのみアタッチされているクラウドディスクの ID を指定できます。複数のインスタンスにアタッチされているクラウドディスクの ID は指定できません。
	string	任意	スナップショット整合性グループを作成するクラウドディスクの ID。同じゾーン内の複数のインスタンスにアタッチされているクラウドディスクの ID を指定できます。N の有効値：1～16。スナップショット整合性グループには、合計ディスクサイズが 32 TiB を超えない最大 16 個のクラウドディスクのスナップショットを含めることができます。次の点にご注意ください： DiskId.N と `ExcludeDiskId.N` パラメーターを同じリクエストで同時に指定することはできません。 `InstanceId` を指定した場合、指定されたインスタンスにのみアタッチされているクラウドディスクの ID を指定できます。複数のインスタンスにアタッチされているクラウドディスクの ID は指定できません。	d-bp1bcpqxahucdrcn****
Tag	array<object>	任意	タグのリスト。
	object	任意
Key	string	任意	スナップショット整合性グループのタグ N のキー。N の有効値：1～20。タグキーは空の文字列にすることはできません。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	スナップショット整合性グループのタグ N の値。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 wrongly formed.	指定されたスナップショット名の形式が無効です。
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.
400	DiskCategory.OperationNotSupported	The special disk is encrypted, not support this operate.
400	InvalidParameter.Name	The specified Name is invalid.
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 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.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	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 needs to be added ECS tag.
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.
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	InvalidOperation.SnapshotStorageLocationUnsupported	Snapshots with storage location in CloudBox do not support the current operation.
403	InvalidStorageLocationArn.Malformed	The specified parameter StorageLocationArn is wrongly formed.
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	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidKMSKeyId.NotFound	The KMS key used by the disk does not exist.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.

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

変更履歴

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