アプリケーション - スナップショット
スナップショット一覧の取得
特定のアプリケーションのスナップショット一覧を取得します。
GET
/
v2
/
apps
/
{app_id}
/
snapshots
スナップショット一覧の取得
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/snapshots"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();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"
},
]
}
スナップショット一覧の取得は、アプリケーションに保存されているすべてのスナップショットを、サイズ、最終更新日時、ダウンロード用の署名付きキーとともに返します。復元用のピッカーを構築する際や、snapshot の作成後に返される
202 SNAPSHOT_PROCESSING レスポンスに対してスナップショットの生成が完了したかを確認する際に利用してください。作成エンドポイントに再度 POST するのではなく、このエンドポイントをポーリングしてください。
結果はオーナー/アプリケーションの組み合わせごとに 30 分間キャッシュされるため、バックグラウンドで生成が完了したばかりのスナップショットは、クラスターへの書き込み後もここに表示されるまで少し時間がかかることがあります。スナップショットの name と key を取得したら、それらをスナップショットの復元に渡すことで、アプリケーションをその時点まで復元できます。
スナップショットは有料プランでのみ利用でき、1 日あたりのスナップショットのクォータはアプリケーションの RAM 割り当てに応じて変動します。ワークスペースで共有されているアプリケーションでは、呼び出し元に Administrator ロールが必要です。
Parameters
string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
{
"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"
},
]
}
目的のスナップショットをダウンロードするためのURLの形式は次のとおりです: https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
APP_NOT_FOUND | 404 | 解決されたオーナーに該当する ID のアプリケーションが存在しません。 |
⌘I
スナップショット一覧の取得
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/snapshots"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();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"
},
]
}

