Lister les snapshots - Square Cloud

GET

apps

{app_id}

snapshots

Lister les snapshots

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_id}/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/apps/{app_id}/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/apps/{app_id}/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",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Lister les snapshots renvoie tous les snapshots stockés pour une application, chacun avec sa taille, sa date de dernière modification et une clé signée permettant de le télécharger. Utilisez cet endpoint pour construire un sélecteur de restauration, ou pour confirmer qu’un snapshot créé via Créer un snapshot a fini de se générer après une réponse 202 SNAPSHOT_PROCESSING : interrogez cet endpoint plutôt que de reposter vers la création. Le résultat est mis en cache pendant 30 minutes par paire propriétaire/application ; un snapshot qui vient de terminer sa génération en arrière-plan peut donc mettre un court instant à apparaître ici, même après que le cluster l’a écrit. Une fois que vous disposez du name et de la key d’un snapshot, transmettez-les à Restaurer un snapshot pour ramener l’application à cet état. Les snapshots ne sont disponibles que sur les plans payants, et le quota journalier de snapshots évolue avec l’allocation de RAM de l’application. Sur les applications partagées en espace de travail, l’appelant doit disposer du rôle Administrateur.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’ID de l’application depuis laquelle vous avez récupéré les snapshots.

number

Taille de la sauvegarde en octets.

string

Date de la dernière modification de la sauvegarde.

string

Clé d’accès AWS pour la sauvegarde.

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

Le format de l’URL pour télécharger le snapshot souhaité est : https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}

Erreurs courantes

Code	HTTP	Signification
`APP_NOT_FOUND`	404	Aucune application avec cet ID n’existe pour le propriétaire résolu.

Créer un snapshotEffectuez un snapshot de votre application. Soumis à une limite de débit de 1 requête toutes les 5 secondes.

Lister les snapshots

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

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

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_id}/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/apps/{app_id}/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/apps/{app_id}/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",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes