為一塊雲端硬碟建立一份快照。
介面說明
原本地快照更替為快照極速可用能力。參數說明如下:
如果您在 2020 年 12 月 14 日之前使用過本地快照,您可以正常使用參數
Category。如果您在 2020 年 12 月 14 日之前未使用過本地快照,無需額外進行配置,ESSD 系列雲端硬碟(ESSD、ESSD AutoPL、ESSD Entry 和 ESSD 同城冗餘)建立的快照將預設為建立後極速可用,且同時支援手動快照和自動快照。API 介面中的“InstantAccess”、“InstantAccessRetentionDays”、“DisableInstantAccess”三個極速可用功能相關參數不再生效,“DescribeSnapshots”、“DescribeSnapshotGroups”這兩個 API 介面將新增出參 Available 來描述快照可用的狀態。
前提條件:
-
已開通快照。具體操作,請參見開通快照。
-
雲端硬碟必須處於使用中或待掛載狀態。不同狀態下的注意事項如下:
建立快照時,您需要注意:
-
建立快照應避開業務高峰期。建立快照時,雲端硬碟 I/O 效能降低 10%以內,讀寫效能出現短暫瞬間變慢。
-
如果建立快照還未完成,這份快照無法用於建立自訂鏡像( CreateImage )。
-
建立快照期間,操作雲端硬碟產生的增量資料不會備份到快照中。
-
如果雲端硬碟已掛載到 ECS 執行個體上,建立快照期間請勿變更執行個體狀態,如停止或重啟 ECS 執行個體,否則會導致快照建立失敗。
-
正在建立快照的雲端硬碟不支援擴容。請您等待快照建立完成後,再開始執行擴容操作。
-
支援對處於已到期(
Expired)狀態的雲端硬碟建立快照。若建立快照時雲端硬碟正好達到到期釋放時間,雲端硬碟被釋放的同時也會刪除建立中(Creating)的快照。 -
建立快照後,系統根據快照容量大小,按每個地區單獨結算費用。更多資訊,請參見快照計費
-
以下情境中,您無法為指定的雲端硬碟建立快照:
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:CreateSnapshot |
create |
*Disk
*Snapshot
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DiskId |
string |
是 |
雲端硬碟 ID。 |
d-bp1s5fnvk4gn2tws0**** |
| SnapshotName |
string |
否 |
快照的名稱。長度為 2~128 個字元,必須以大小寫字母或中文開頭,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文等),ASCII 數字(0-9)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。 說明
不能以 http://和 https:// 開頭。為防止和自動快照的名稱衝突,不能以 |
testSnapshotName |
| Description |
string |
否 |
快照的描述。長度為 2~256 個英文或中文字元,不能以 預設值:空。 |
testDescription |
| RetentionDays |
integer |
否 |
設定快照的保留時間,單位為天。取值範圍:1~65536。保留時間到期後快照會被自動釋放。 預設值:空,表示快照不會被自動釋放。 |
30 |
| Category |
string |
否 |
快照類型。取值範圍:
說明
該參數即將被棄用。ESSD 雲端硬碟標準快照已升級為預設極速可用,您無需額外配置,且不產生額外花銷。 |
Standard |
| ClientToken |
string |
否 |
保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。更多詳情,請參見如何保證等冪性。 |
123e4567-e89b-12d3-a456-426655440000 |
| ResourceGroupId |
string |
否 |
快照所在的企業資源組 ID。 |
rg-bp67acfmxazb4p**** |
| InstantAccess |
boolean |
否 |
是否開啟快照極速可用功能。取值範圍:
預設值:false。 說明
該參數已棄用。ESSD 雲端硬碟標準快照已升級為預設極速可用,您無需額外配置,且不產生額外花銷。 |
false |
| InstantAccessRetentionDays |
integer |
否 |
設定快照極速可用功能的保留時間,保留時間到期後快照將自動釋放。該參數在 預設與參數 說明
該參數已棄用。ESSD 雲端硬碟標準快照已升級為預設極速可用,您無需額外配置,且不產生額外花銷。 |
1 |
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
標籤列表。 |
||
| key |
string |
否 |
快照的標籤鍵。 說明
為提高相容性,建議您盡量使用 Tag.N.Key 參數。 |
null |
| Key |
string |
否 |
快照的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空白字串。最多支援 128 個字元,不能以 aliyun 和 acs:開頭,不能包含 http://或者 https://。 |
TestKey |
| Value |
string |
否 |
快照的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空白字串。最多支援 128 個字元,不能包含 http://或者 https://。 |
TestValue |
| value |
string |
否 |
快照的標籤值。 說明
為提高相容性,建議您盡量使用 Tag.N.Value 參數。 |
null |
| StorageLocationArn |
string |
否 |
說明
該參數暫未開放使用。 |
null |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| SnapshotId |
string |
快照 ID。 |
s-bp17441ohwka0yuh**** |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
樣本
正常返回樣本
JSON格式
{
"SnapshotId": "s-bp17441ohwka0yuh****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. | 指定的保留天數無效。請檢查 RetentionDays 參數值是否正確。 |
| 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. | 指定的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 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. | CMK 需要添加 ECS 標籤。 |
| 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 | 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. | 指定的參數InstantAccessRetentionDays格式無效 |
| 403 | CloudBoxNotSupportSnapshotWithInstantAccess | The specified disk in CloudBox does not support to create a snapshot with InstantAccess. | 雲盒中的磁碟不支援建立帶IA特性的快照。 |
| 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. | 指定的參數ClientToken格式不符合規範要求,該參數應該只包括ASCII字元,且長度不應該超過64個字元。 |
| 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 | InvalidStorageLocationArn.Malformed | The specified parameter StorageLocationArn is wrongly formed. | 指定的參數StorageLocationArn的格式錯誤。 |
| 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. | 指定的磁碟不存在。請您檢查磁碟 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 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源群組並不在記錄中。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。