Alle Snapshots des Kontos auflisten

GET

users

snapshots

curl --request GET \
  --url https://api.squarecloud.app/v2/users/snapshots \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/users/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/users/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/users/snapshots"

	req, _ := http.NewRequest("GET", 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/users/snapshots")

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

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

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

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

string

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope snapshots:read. Snapshots auflisten gibt die automatischen Backups zurück, die Square Cloud für deine Anwendungen oder Datenbanken vorhält, wobei jeder Eintrag ein signiertes Download-URL-Fragment mit Größe und Änderungsdatum kombiniert. Verwende dies, um eine Auswahl zur Wiederherstellung zu erstellen oder die Aufbewahrung in deinem eigenen Tooling zu prüfen, statt das Dashboard manuell zu kontrollieren. Ergebnisse werden pro Benutzer und Scope 30 Minuten zwischengespeichert; ein Cache-Miss zählt gegen ein engeres Limit von 3 Aufrufen pro 60 Sekunden, danach wird der Aufrufer für kurze Zeit gesperrt. Das Auflisten von Snapshots erfordert einen aktiven Plan, ein Konto ohne aktiven Plan erhält einen 402-Fehler. Snapshots werden nach Scope gruppiert, standardmäßig Anwendungen oder über den unten stehenden scope-Parameter Datenbanken. Für Anwendungsdetails siehe Anwendungsinformationen abrufen; für Datenbankdetails siehe Datenbankinformationen abrufen.

Parameter

string

Standard:"applications"

Gibt den Typ der abzurufenden Snapshots an.

applications (Standard): Gibt Snapshots von Anwendungen zurück
databases: Gibt Snapshots von Datenbanken zurück

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Der Name des Snapshots: die ID der Anwendung oder Datenbank, zu der er gehört, optional mit den Suffixen _<runtime> und _<origin>. Übergib ihn beim Wiederherstellen unverändert als snapshotId.

number

Größe des Snapshots in Bytes.

string

Datum der letzten Änderung des Snapshots.

string

AWS-Zugriffsschlüssel für den Snapshot.

string | null

Runtime, von der der Snapshot stammt: die Sprache der Anwendung (javascript, python, rust…) oder die Datenbank-Engine (mongo, mysql, postgres, redis). null bei Snapshots, die vor Einführung dieses Feldes erstellt wurden.

string | null

Wie der Snapshot erstellt wurde: manual (über API, Dashboard oder CLI angefordert) oder automatic (der täglich geplante Snapshot). null bei älteren Snapshots.

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

Das Format der URL zum Herunterladen des gewünschten Snapshots lautet: https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}

Häufige Fehler

Code	HTTP	Bedeutung
`INVALID_SCOPE`	400	Der Query-Parameter `scope` ist nicht `applications` oder `databases`.
`UPGRADE_REQUIRED`	402	Das Konto hat keinen aktiven Plan; das Auflisten von Snapshots erfordert einen.
`RATE_LIMITED`	429	Das Anfragelimit wurde erreicht. Warte und versuche es erneut.

Siehe auch

SDKs: api.account.snapshots() (JavaScript), client.account.snapshots() (Python), c.Account.Snapshots() (Go)

Alle Snapshots des Kontos auflisten

curl --request GET \
  --url https://api.squarecloud.app/v2/users/snapshots \
  --header 'Authorization: <authorization>'

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

fetch('https://api.squarecloud.app/v2/users/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/users/snapshots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/users/snapshots"

	req, _ := http.NewRequest("GET", 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/users/snapshots")

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

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

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

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Alle Snapshots des Kontos auflisten

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch