為一塊云盤創建一份快照。
接口說明
原本地快照更替為快照極速可用能力。參數說明如下:
- 如果您在 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
)的快照。 -
創建快照后,系統根據快照容量大小,按每個地域單獨結算費用。更多信息,請參見快照計費
-
以下場景中,您無法為指定的云盤創建快照:
-
云盤保留的手動快照數達到了 256 份。
-
上份快照還未完成創建。
-
查詢 ECS 實例信息時,如果返回數據中包含
{"OperationLocks": {"LockReason" : "security"}}
,則禁止一切操作。
-
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:CreateSnapshot | create | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId} *Snapshot acs:ecs:{#regionId}:{#accountId}:snapshot/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DiskId | string | 是 | 云盤 ID。 | d-bp1s5fnvk4gn2tws0**** |
SnapshotName | string | 否 | 快照的名稱。長度為 2~128 個字符,必須以大小寫字母或中文開頭,支持 Unicode 中 letter 分類下的字符(其中包括英文、中文等),ASCII 數字(0-9)。可以包含半角冒號(:)、下劃線(_)、半角句號(.)或者短劃線(-)。 說明
不能以 http://和 https:// 開頭。為防止和自動快照的名稱沖突,不能以 auto 開頭。
| testSnapshotName |
Description | string | 否 | 快照的描述。長度為 2~256 個英文或中文字符,不能以 默認值:空。 | testDescription |
RetentionDays | integer | 否 | 設置快照的保留時間,單位為天。取值范圍:1~65536。保留時間到期后快照會被自動釋放。 默認值:空,表示快照不會被自動釋放。 | 30 |
Category | string | 否 | 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 |
返回參數
示例
正常返回示例
JSON
格式
{
"SnapshotId": "s-bp17441ohwka0yuh****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的參數 KMSKeyId 不存在。 |
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. | 創建快照失敗。 |
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 | 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 | IncorrectVolumeStatus | The current volume status does not support this operation. | 共享塊存儲狀態不支持當前操作。 |
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. | 加密云盤設置了 KMSKeyId 后,CMK必須處于啟用狀態。您可以調用密鑰管理服務的 DescribeKey 接口查詢指定CMK的相關信息。 |
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 | QuotaExceed.Tags | %s | 標簽數超過可以配置的最大數量。%s為變量,將根據調用API的實際情況動態返回錯誤信息。 |
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 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance to order postpaid product. | 使用按量付費產品,您的賬戶余額不得少于100元,請充值后再操作。 |
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. | 該磁盤正在創建的快照數量已超過并發配額,請等待之前的快照完成后再重試。 |
404 | InvalidDiskId.NotFound | The specified DiskId does not exist. | 指定的磁盤不存在。請您檢查磁盤 ID 是否正確。 |
404 | InvalidDescription.Malformed | The specified description is wrongly formed. | 指定的資源描述格式不合法。長度為 2-256 個字符,不能以 http:// 和 https:// 開頭。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
404 | InvalidVolumeId.NotFound | The specified volume does not exist. | 指定的共享塊存儲不存在,請您檢查共享塊存儲是否正確。 |
404 | InvalidResourceGroup.NotFound | The ResourceGroup provided does not exist in our records. | 資源組并不在記錄中。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-10-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-01 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |