DeleteSnapshots

1. API Description

This API is used to delete the specified snapshots.

Note

  • The snapshot must be in the NORMAL state. You can use DescribeSnapshots to query the state of the snapshot. See the description of the SnapshotState field in the output parameters. Batch operations are supported.

  • If some of the snapshots cannot be deleted, the API will return a list of snapshot IDs that failed to be deleted. The rest of the snapshots are executed normally.

  • Batch operations are supported. The maximum number of snapshots in each request is 100.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

snapshotIds

Yes

Array of String

List of snapshot IDs.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID,

which is returned for each request. RequestId is required for locating a problem.

snapshotIds

Array of String

The IDs of the snapshots that failed to be deleted.

4. Code Example

Delete snapshots.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DeleteSnapshots
<Common Request Params>

Request:
{
    "snapshotIds": ["snapshotId1","snapshotId2"]
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "snapshotIds": ["snapshotId1","snapshotId2"]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code
Error Code
Description

404

INVALID_DISK_SNAPSHOT_NOT_FOUND

The snapshot does not exist.

400

OPERATION_DENIED_DISK_SNAPSHOT_STATUS

The snapshot status is not supported.

Last updated