All Products
Search
Document Center

Elastic Compute Service:DeleteSnapshot

Last Updated:Mar 13, 2024

Deletes a snapshot. If you call this operation to delete a snapshot that is being created, the snapshot creation task is canceled.

Operation description

Take note of the following items:

  • If the snapshot does not exist, the request is ignored.
  • If the snapshot has been used to create custom images, the snapshot cannot be deleted. You need to call the DeleteImage operation to delete the custom images before you can delete the snapshot.
  • If the snapshot has been used to create disks and Force is not specified or is set to false, the snapshot cannot be deleted directly. If you want to delete the snapshot, set Force to true to forcibly delete the snapshot. The disks created from the snapshot cannot be re-initialized after the snapshot is forcibly deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SnapshotIdstringYes

The snapshot ID.

s-bp1c0doj0taqyzzl****
ForcebooleanNo

Specifies whether to forcibly delete the snapshot that has been used to create disks. Valid values:

  • true: forcibly deletes the snapshot. After the snapshot is forcibly deleted, the disks created from this snapshot cannot be re-initialized.
  • false: does not forcibly delete the snapshot.

Default value: false.

false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter SnapshotId that is mandatory for processing this request is not supplied.The SnapshotId parameter is required.
403SnapshotCreatedImageThe snapshot has been used to create user defined image(s).The snapshot has been used to create custom images and cannot be deleted. The snapshot can be deleted only after the created custom images are deleted (DeleteImage).
403SnapshotCreatedDiskThe snapshot has been used to create disk(s).The specified snapshot has been used to create disks, and cannot be deleted when the Force parameter is left empty or set to false. If you do want to delete the snapshot, set the Force parameter to true to force delete the snapshot. The disks created from the snapshot cannot be re-initialized after the snapshot is force deleted.
403Operation.ConflictThe operation may conflicts with others, please retry later.This operation conflicts with another operation. Try again later.
403InvalidOperation.RelatedSnapshotNotFinishedThe related standard snapshot is not finished.-
403SnapshotCreatedDiskThe snapshot that you are trying to delete is in use by one or more disks.The snapshot that you are attempting to delete has been used to create one or more disks.
404InvalidSnapshotId.NotFoundThe specified snapshot is not found.-
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 500