CreateSnapshotGroup - 建立快照一致性組 - Elastic Compute Service

為指定ECS執行個體中的雲端硬碟建立快照一致性組。快照一致性組包含一個或多個雲端硬碟對應的快照。

介面說明

您可以設定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）。
單個快照一致性組最多包括 16 塊雲端硬碟（包括系統硬碟和資料盤），且總容量不超過 32 TiB。
您自行建立的快照會一直保留，請定期刪除不再需要的快照，避免快照容量持續計費。
開啟多重掛載特性的雲端硬碟不支援建立快照一致性組。如果執行個體掛載了開啟多重掛載特性的雲端硬碟，您需要設定ExcludeDiskId.N參數排除該雲端硬碟。

關於快照一致性組的功能、計費等資訊，請參見快照一致性組。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 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，即一個快照一致性組內最多支援設定 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

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	指定的保留天數無效。請檢查 RetentionDays 參數值是否正確。
400	DiskCategory.OperationNotSupported	The special disk is encrypted, not support this operate.
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.	指定的Block Storage類型不支援此操作。
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.	共用Block Storage狀態不支援當前操作。
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.	ECS 服務無權訪問您的 KMS。
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 needs to be added ECS tag.	CMK 未授權
403	InvalidDisk.DiskCategoryInconsistent	If any specified disk is of a regional disk category, then all disks must also be of that regional disk category.	如果指定磁碟的磁碟類型中包含 regional 類型，則要求所有磁碟的磁碟類型都是 regional 類型
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 wrongly formed.	指定的參數StorageLocationArn的格式錯誤。
404	InvalidDiskId.NotFound	The specified DiskId does not exist.	指定的磁碟不存在。請您檢查磁碟 ID 是否正確。
404	InvalidDescription.Malformed	The specified description is wrongly formed.
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.	指定的地區 ID 不存在。
404	InvalidKMSKeyId.NotFound	The KMS key used by the disk does not exist.	磁碟使用的 KMS 密鑰不存在.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	資源群組並不在記錄中。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。