SDK de JavaScript: snapshots y copias de seguridad

Los snapshots son copias de seguridad del almacenamiento de una aplicación o de una base de datos. Las aplicaciones y las bases de datos comparten los mismos tres métodos:

api.apps.snapshots: list(appId), create(appId), restore(appId, name, versionId)
api.databases.snapshots: list(databaseId), create(databaseId), restore(databaseId, name, versionId)

La cantidad de snapshots que puedes crear por día depende de tu plan (consulta Límites). Los ejemplos usan el cliente api de Crear el cliente. appId es el id de una de tus aplicaciones: api.account.me() las lista.

Listar snapshots

for (const snapshot of await api.apps.snapshots.list(appId)) {
    console.log(snapshot.name, snapshot.version_id, snapshot.size, snapshot.modified);
}

Campo	Descripción
`name`	El id del snapshot que recibe `restore`
`version_id`	La versión que recibe `restore`
`size`	Tamaño en bytes
`modified`	Cuándo se tomó
`url`	URL de descarga firmada, válida durante 30 días
`key`	Query string firmada de la URL
`runtime`	Motor de base de datos o lenguaje de la aplicación (`null` en snapshots antiguos)
`origin`	`"automatic"`, `"manual"` o `null`

Crear un snapshot

create() espera al snapshot (al menos 120 s antes de agotar el tiempo). Es posible que un snapshot grande no termine a tiempo: en ese caso la API responde 202 y el SDK devuelve { pending: true }. El snapshot se sigue generando y aparece por sí solo en list(), normalmente en menos de 2 minutos.

const result = await api.apps.snapshots.create(appId);

if (result.pending) {
    // Poll list() later. Do not call create() again: that starts a new snapshot.
} else {
    console.log(result.url); // signed download URL, valid 30 days
}

Nunca vuelvas a llamar a create() para comprobar un snapshot pendiente: eso inicia uno nuevo y cuenta para la cuota diaria de snapshots del plan. Consulta list() periódicamente en su lugar.

Restaurar un snapshot

restore(id, name, versionId) recibe el name y el version_id de un snapshot del listado.

const [latest] = await api.apps.snapshots.list(appId);

await api.apps.snapshots.restore(appId, latest.name, latest.version_id);

Estado	Código	Cuándo
400	`MISSING_PARAMETERS`	Falta `name` o `versionId`
400	`INVALID_SNAPSHOT_ID`, `INVALID_VERSION_ID`	No es un `name`/`version_id` del listado
400	`SNAPSHOT_DATABASE_MISMATCH`	El motor del snapshot no coincide con el tipo de la base de datos (solo bases de datos)
404	`SNAPSHOT_NOT_FOUND`	No hay ningún snapshot con ese nombre y esa versión
404	`SNAPSHOT_RESTORE_FAILED`	No se pudo lanzar la restauración (el fallo habitual)
413	`PAYLOAD_TOO_LARGE`	El snapshot es demasiado grande para restaurarlo

Descargar un snapshot

api.downloadSnapshot(url, { signal }) transmite un archivo de snapshot desde su url firmada (de list() o create()). No llama a la API: la clave de API nunca se envía al host de almacenamiento. Devuelve un ReadableStream<Uint8Array>, sin nada almacenado en memoria, y no tiene timeout (pasa un signal).

import { createWriteStream } from "node:fs";
import { Writable } from "node:stream";

const [latest] = await api.apps.snapshots.list(appId);
const stream = await api.downloadSnapshot(latest.url);

await stream.pipeTo(Writable.toWeb(createWriteStream("backup.zip")));

Una URL caducada o no válida lanza un SquareCloudAPIError con el estado HTTP del host de almacenamiento y UNKNOWN_ERROR.

Snapshots de la cuenta

api.account.snapshots({ scope }) lista todos los snapshots de la cuenta, opcionalmente solo los de "applications" o "databases". Necesita un plan activo y comparte el límite de tasa de los endpoints de red (429 RATE_LIMITED).

const all = await api.account.snapshots();
const databases = await api.account.snapshots({ scope: "databases" });

Estado	Código	Cuándo
400	`INVALID_SCOPE`	`scope` no es `applications` ni `databases`
402	`UPGRADE_REQUIRED`	La cuenta no tiene un plan activo
429	`RATE_LIMITED`	Se alcanzó el límite de tasa

Límites

create() está limitado a una llamada cada 180 segundos y a una cuota diaria que depende del plan: superar la cuota da 429 DAILY_SNAPSHOTS_LIMIT_REACHED.
Mientras se ejecuta una restauración, eliminar la aplicación o iniciar la base de datos da 403 RESTORE_IN_PROGRESS.

Próximos pasos

Bases de datos

Crea y gestiona bases de datos.

Referencia de la API de snapshots

Los endpoints REST detrás de estos métodos.

Snapshots desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de JavaScript: snapshots y copias de seguridad

Listar snapshots

Crear un snapshot

Restaurar un snapshot

Descargar un snapshot

Snapshots de la cuenta

Límites

Próximos pasos

Bases de datos

Referencia de la API de snapshots

Snapshots desde la CLI

​Listar snapshots

​Crear un snapshot

​Restaurar un snapshot

​Descargar un snapshot

​Snapshots de la cuenta

​Límites

​Próximos pasos

Bases de datos

Referencia de la API de snapshots

Snapshots desde la CLI

Listar snapshots

Crear un snapshot

Restaurar un snapshot

Descargar un snapshot

Snapshots de la cuenta

Límites

Próximos pasos