Snapshot erstellen - Square Cloud

POST

databases

{database_id}

snapshots

Snapshot erstellen

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/databases/{database_id}/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status":"success",
  "response":{
    "url":"https://snapshots.squarecloud.app/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D"
  }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

Jeder Account kann bis zu (RAM / 256) * 2 Snapshots alle 24 Stunden erstellen.

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Erstellt eine Sicherung der Daten der Datenbank zu einem bestimmten Zeitpunkt und lädt sie in den Snapshot-Speicher von Square Cloud hoch, wobei eine signierte Download-URL zurückgegeben wird, die 30 Tage gültig ist. Verwenden Sie dies vor einer riskanten Migration, einer manuellen Snapshot-Wiederherstellung oder nach einem Zeitplan zur Notfallwiederherstellung. Einmal erstellt, erscheinen Snapshots auch in Snapshots auflisten.

Parameter

string

erforderlich

Die ID der Datenbank.

Verhalten der Soft Deadline

Diese Route folgt einem Soft-Deadline-Modell — sie antwortet nicht mehr immer synchron.

Wenn der Snapshot innerhalb von ~90 Sekunden fertiggestellt wird, antwortet die Route wie bisher mit 200 success und einer signierten Download-URL (30 Tage gültig).
Wenn die Erstellung des Snapshots länger als ~90 Sekunden dauert, antwortet die Route sofort mit 202 und dem Code SNAPSHOT_PROCESSING. Das ist kein Fehler. Der Snapshot wird im Hintergrund weiter erstellt und erscheint von selbst in der Snapshot-Auflistung, in der Regel innerhalb von ~2 Minuten. Bei großen Datenbanken ist das erwartetes Verhalten.

Verwende diesen POST-Endpoint nicht als Polling-Mechanismus. Um zu prüfen, ob ein SNAPSHOT_PROCESSING-Snapshot abgeschlossen wurde, verwende den List Snapshots-Endpoint (GET) — nicht ein weiteres POST. Ein erneutes POST nach Abschluss des Snapshots startet einen komplett neuen Snapshot von Grund auf.

Der Client sollte je nach Antwort wie folgt verzweigen:

Antwort	Bedeutung	Was zu tun ist
`status === "success"`	Snapshot ist bereit.	Verwende die `url`, um ihn herunterzuladen.
`status === "error"` und `code === "SNAPSHOT_PROCESSING"`	Snapshot wird noch erstellt.	Warte ~2 Minuten und bestätige dann über List Snapshots (`GET`). Führe kein erneutes `POST` aus.
`status === "error"` mit einem anderen `code`	Tatsächlicher Fehler.	Behandle den Fehler (siehe unten).

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

object

Der Inhalt der Antwort. Nur vorhanden, wenn status gleich success ist.

Anzeigen Objekt umschalten

string

Die URL zum Herunterladen des Snapshots deiner Anwendung.

string

Der Schlüssel zum Herunterladen des Snapshots deiner Anwendung.

202

Wird zurückgegeben, wenn der Snapshot die Soft Deadline von ~90 Sekunden überschreitet. Der Snapshot wird im Hintergrund weiter erstellt und erscheint von selbst in der Snapshot-Auflistung, in der Regel innerhalb von ~2 Minuten. Kein Fehler — warte und bestätige über den GET-Auflistungs-Endpoint.

Fehler

Eine Snapshot-Anfrage kann mit 429 Too Many Requests abgelehnt werden. Verwende das Feld code, um die beiden Fälle zu unterscheiden:

429

Kurzfristige Abkühlphase — du hast das Limit pro Benutzer (1 Anfrage / 5s) oder pro Datenbank (1 Anfrage / 180s) erreicht. Warte kurz und versuche es erneut.

429

Tageskontingent erreicht — der Account hat sein tägliches Snapshot-Kontingent des Plans aufgebraucht ((RAM / 256) × 2 pro 24h). Das Kontingent wird frei, während das gleitende 24-Stunden-Fenster fortschreitet; für ein höheres Tageskontingent aktualisiere den Plan.

{
  "status":"success",
  "response":{
    "url":"https://snapshots.squarecloud.app/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D"
  }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

Zurück

Snapshot wiederherstellenStellt eine Datenbank anhand eines Snapshots wieder her.

Weiter

Snapshot erstellen

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/databases/{database_id}/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status":"success",
  "response":{
    "url":"https://snapshots.squarecloud.app/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D"
  }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

​Parameter

​Verhalten der Soft Deadline

​Antwort

​Fehler

Parameter

Verhalten der Soft Deadline

Antwort

Fehler