eks.snapshots.create

Take an etcd snapshot now

POST /eks/api/clusters/{cluster}/snapshotsIAM eks:CreateClusterSnapshotChanges state

One in flight and at most one per 10 minutes (409 otherwise). `evicts` names the on-demand snapshot this one pushes out of the 10 kept. The snapshot is `pending` until the leading control-plane machine has taken, checked and uploaded it, usually within a minute.

Request syntax

POST /eks/api/clusters/{cluster}/snapshots

Path parameters

  • clusterRequired

    string

    Constraints: /^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$/

Response

202 with the snapshot (kind `on-demand`, status `pending`): id, kind, status, requestedBy, requestedAt, takenAt, revision, totalKeys, sizeBytes, sha256, verifiedAt, error, expiresAt, plus evicts (the on-demand snapshot it pushes out, or null). 409 unless the cluster is active or updating, for a control plane built before backups, while a snapshot is being taken, or within 10 minutes of the last on-demand one. 404 when no cluster has that id or name, 403 without the permission on it.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow eks:CreateClusterSnapshot on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud eks snapshots create cluster

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_eks_snapshots_create.