snapshot の作成 - Square Cloud

POST

apps

{app_id}

snapshots

snapshot の作成

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

const options = {method: 'POST', 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 => "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/apps/{app_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/apps/{app_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/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%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"
}

各アカウントは 24 時間ごとに最大 (RAM / 256) * 2 回の snapshot を実行できます。

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

snapshot の作成は、アプリケーションのストレージ全体をある時点でキャプチャした .zip のコピーを生成し、署名付きダウンロード URL を返します。リスクのある変更を行う前の復元ポイントとして、またはプラットフォーム外にフルバックアップを持ち出す手段として利用できます。後でアプリケーションをその状態に戻すには、生成された snapshot をスナップショットの復元に渡してください。新しい snapshot を作成せずに過去の snapshot を確認・ダウンロードするには、スナップショット一覧の取得を使用してください。 snapshot は有料プランでのみ利用でき、1 日あたりのクォータはアプリケーションの RAM に応じて変動します((RAM / 256) × 2 回 / 24 時間)。ワークスペースで共有されているアプリケーションでは、呼び出し元に Administrator ロールが必要です。

パラメータ

string

必須

アプリケーションの ID。アプリケーションのダッシュボードの URL で確認できます。

ソフトデッドラインの挙動

このルートは ソフトデッドライン モデルに従います。つまり、常に同期的に応答するわけではなくなりました。

snapshot が 約 90 秒以内 に完了した場合、ルートは以前と同様に 200 success と署名付きダウンロード URL（30 日間有効）を返します。
snapshot の生成に 約 90 秒以上 かかる場合、ルートは 即座に 202 とコード SNAPSHOT_PROCESSING を返します。これは失敗ではありません。 snapshot はバックグラウンドで生成を続け、通常は約 2 分以内に自動的に snapshot 一覧に表示されます。これは大規模なアプリケーションでは想定される挙動です。

この POST endpoint をポーリング手段として使用しないでください。SNAPSHOT_PROCESSING の snapshot が完了したかどうかを確認するには、別の POST ではなく snapshot 一覧の取得（GET）endpoint を使用してください。snapshot 完了後に再度 POST すると、まったく新しい snapshot が最初から開始されます。

クライアントは、レスポンスに応じて以下のように分岐する必要があります。

レスポンス	意味	対応
`status === "success"`	snapshot の準備が完了。	`url` を使ってダウンロードします。
`status === "error"` かつ `code === "SNAPSHOT_PROCESSING"`	snapshot はまだ生成中。	約 2 分待ってから、snapshot 一覧の取得（`GET`）で確認します。再度 `POST` はしないでください。
`status === "error"` でその他の `code`	実際の失敗。	エラーを処理します（下記参照）。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

レスポンスの内容。status が success の場合にのみ存在します。

表示オブジェクトを開閉

string

アプリケーションの snapshot をダウンロードするための URL。

string

アプリケーションの snapshot をダウンロードするためのキー。

202

snapshot が約 90 秒のソフトデッドラインを超えた場合に返されます。snapshot はバックグラウンドでまだ生成中で、通常は約 2 分以内に自動的に snapshot 一覧に表示されます。エラーではありません。待ってから GET の一覧 endpoint で確認してください。

エラー

snapshot リクエストは 429 Too Many Requests で拒否されることがあります。code フィールドを使って 2 つのケースを区別してください。

429

短期的なクールダウン。ユーザーごと（5 秒あたり 1 リクエスト）またはアプリケーションごと（180 秒あたり 1 リクエスト）の制限に達しました。少し待ってから再試行してください。

429

1 日あたりのクォータに達しました。アカウントがプランの 1 日あたりの snapshot 許容量（24 時間あたり (RAM / 256) × 2）を使い切りました。クォータはローリング 24 時間ウィンドウが進むにつれて解放されます。1 日あたりの許容量を増やすには、プランをアップグレードしてください。

{
    "status": "success",
    "response": {
        "url": "https://snapshots.squarecloud.app/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%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"
}

スナップショットの復元スナップショットをもとにアプリケーションを復元します。

snapshot の作成

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

const options = {method: 'POST', 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 => "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/apps/{app_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/apps/{app_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/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%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"
}

​パラメータ

​ソフトデッドラインの挙動

​レスポンス

​エラー

パラメータ

ソフトデッドラインの挙動

レスポンス

エラー