アプリケーション - スナップショット
スナップショットの復元
スナップショットをもとにアプリケーションを復元します。
POST
/
v2
/
apps
/
{app_id}
/
snapshots
/
restore
スナップショットの復元
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"
}
このルートには60秒あたり1リクエストのレート制限があります。
snapshotId と versionId の値はスナップショット一覧の取得から取得します。これらは手動で組み立てる値ではありません。
snapshotId は UUID v4 である必要があり、versionId は S3 のバージョンキー形式に一致している必要があります。不正な形式の値は、復元が実行される前に拒否されます。復元自体はアプリケーションを再起動しません。実行中のプロセスに復元後のファイルを反映させる必要がある場合は、その後にアプリケーションの再起動を実行してください。
スナップショット(および復元)は有料プランでのみ利用できます。ワークスペースで共有されているアプリケーションでは、呼び出し元に Administrator ロールが必要です。
Parameters
string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
string
必須
このアプリケーション(app_id)に対して復元するスナップショットのID。
string
必須
スナップショットのバージョンキー。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。{
"status":"success"
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
MISSING_PARAMETERS | 400 | snapshotId または versionId が指定されていません。 |
INVALID_SNAPSHOT_ID | 400 | snapshotId が有効な UUID v4 ではありません。 |
INVALID_VERSION_ID | 400 | versionId が想定される S3 バージョンキー形式と一致しません。 |
SNAPSHOT_NOT_FOUND | 404 | 指定した ID とバージョンのスナップショットがこのアプリケーションに存在しません。 |
USER_NOT_FOUND | 404 | アプリケーションのオーナーを解決できませんでした。 |
SNAPSHOT_RESTORE_FAILED | 404 | クラスターが復元処理を実行できませんでした。 |
⌘I
スナップショットの復元
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"
}

