Restaurar snapshot - Square Cloud

POST

apps

{app_id}

snapshots

restore

Restaurar snapshot

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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"
}

Esta rota possui limite de taxa de 1 requisição a cada 60 segundos.

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Restaurar Snapshot volta o armazenamento de uma aplicação para um snapshot anterior, substituindo os arquivos atuais pelos que foram capturados no momento do snapshot. Use-o para se recuperar de um deploy ruim ou de uma exclusão acidental. Obtenha os valores de snapshotId e versionId em Listar Snapshots; eles não são algo que você constrói manualmente. snapshotId é o name do snapshot exatamente como Listar Snapshots retorna (o ID da aplicação, opcionalmente com os sufixos _<runtime> e _<origin>), e versionId precisa corresponder ao formato de chave de versão do S3; valores malformados são rejeitados antes de a restauração ser despachada. Restaurar não reinicia a aplicação por si só; execute Reiniciar Aplicação depois, caso o processo em execução precise assumir os arquivos restaurados. Snapshots (e, portanto, restaurações) estão disponíveis apenas em planos pagos. Em aplicações compartilhadas em workspace, quem chama precisa do papel de Administrador.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

string

obrigatório

O name do snapshot na listagem (o ID da aplicação, opcionalmente com os sufixos _<runtime> e _<origin>), enviado exatamente como retornado.

string

obrigatório

A chave de versão da snapshot.

Resposta

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

{
  "status":"success"
}

Erros comuns

Código	HTTP	Significado
`MISSING_PARAMETERS`	400	`snapshotId` ou `versionId` está ausente.
`INVALID_SNAPSHOT_ID`	400	`snapshotId` não é um nome de snapshot como retornado pela listagem (um ID, opcionalmente com até dois sufixos `_<tag>`).
`INVALID_VERSION_ID`	400	`versionId` não corresponde ao formato esperado de chave de versão do S3.
`SNAPSHOT_NOT_FOUND`	404	Não existe nenhum snapshot com esse ID e versão para esta aplicação.
`USER_NOT_FOUND`	404	Não foi possível resolver o proprietário da aplicação.
`SNAPSHOT_RESTORE_FAILED`	404	O cluster não conseguiu despachar a restauração.

Restaurar snapshot

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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"
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns