Restaurer un snapshot - Square Cloud

POST

databases

{database_id}

snapshots

restore

Restaurer un snapshot

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snapshotId": "<string>",
  "versionId": "<string>"
}
'

import requests

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

payload = {
    "snapshotId": "<string>",
    "versionId": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({snapshotId: '<string>', versionId: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore', 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/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'snapshotId' => '<string>',
    'versionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}"

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

{
  "status":"success"
}

Cette route est soumise à une limite de 1 requête toutes les 60 secondes.

string

requis

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

Restaure une base de données sur place à partir d’un snapshot précédemment créé, identifié par les snapshotId et versionId renvoyés par Créer un snapshot ou Lister les snapshots. Le moteur du snapshot doit correspondre au type de la base de données cible : vous ne pouvez pas restaurer un snapshot Redis sur une base de données MongoDB, par exemple. Cette opération écrase les données actuelles de la base de données avec le contenu du snapshot ; il n’y a pas d’annulation possible, si ce n’est de créer un nouveau snapshot au préalable. Pendant que la restauration est en cours, Démarrer, Arrêter et Supprimer une base de données sont rejetés pour cette base de données. Limité à 1 restauration toutes les 60 secondes par utilisateur, et 1 restauration toutes les 120 secondes par base de données.

Paramètres

string

requis

L’ID de la base de données.

string

requis

L’ID du snapshot à restaurer pour cette base de données (database_id).

string

requis

La clé de version du snapshot.

Réponse

string

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

{
  "status":"success"
}

Erreurs courantes

Code	HTTP	Signification
`MISSING_PARAMETERS`	400	`snapshotId` ou `versionId` n’a pas été fourni.
`INVALID_SNAPSHOT_ID`	400	`snapshotId` n’est pas un UUID v4 valide.
`INVALID_VERSION_ID`	400	`versionId` ne correspond pas au format attendu.
`SNAPSHOT_DATABASE_MISMATCH`	400	Le moteur du snapshot ne correspond pas au `type` de cette base de données.
`SNAPSHOT_NOT_FOUND`	404	Aucun snapshot n’existe pour le `snapshotId` et le `versionId` donnés.
`DATABASE_NOT_FOUND`	404	La base de données n’existe pas ou n’appartient pas à l’appelant.
`SNAPSHOT_RESTORE_FAILED`	404	Le cluster a rejeté l’opération de restauration.

Créer un workspaceCréer un nouveau workspace dans votre compte Square Cloud.

Restaurer un snapshot

curl --request POST \
  --url https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "snapshotId": "<string>",
  "versionId": "<string>"
}
'

import requests

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

payload = {
    "snapshotId": "<string>",
    "versionId": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({snapshotId: '<string>', versionId: '<string>'})
};

fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore', 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/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'snapshotId' => '<string>',
    'versionId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/databases/{database_id}/snapshots/restore")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"snapshotId\": \"<string>\",\n  \"versionId\": \"<string>\"\n}"

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

{
  "status":"success"
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes