データベース - スナップショット
スナップショットの復元
データベースをそのスナップショットに基づいて復元します。
POST
/
v2
/
databases
/
{database_id}
/
snapshots
/
restore
スナップショットの復元
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"
}
このルートには60秒あたり1リクエストのレート制限があります。
snapshotId と versionId で特定される、以前に取得したスナップショットからデータベースをその場で復元します。スナップショットのエンジンは対象データベースの type と一致している必要があります。たとえば Redis のスナップショットを MongoDB のデータベースに復元することはできません。
この操作はデータベースの現在のデータをスナップショットの内容で上書きします。事前に別のスナップショットを取得しておく以外に元に戻す方法はありません。復元が実行されている間、そのデータベースに対する起動、停止、データベースの削除は拒否されます。レート制限はユーザーごとに 60 秒あたり 1 回、データベースごとに 120 秒あたり 1 回の復元です。
Parameters
string
必須
データベースのID。
string
必須
このデータベース(database_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 が想定される形式と一致しません。 |
SNAPSHOT_DATABASE_MISMATCH | 400 | スナップショットのエンジンがこのデータベースの type と一致しません。 |
SNAPSHOT_NOT_FOUND | 404 | 指定した snapshotId と versionId に一致するスナップショットが存在しません。 |
DATABASE_NOT_FOUND | 404 | データベースが存在しないか、呼び出し元が所有していません。 |
SNAPSHOT_RESTORE_FAILED | 404 | クラスターが復元操作を拒否しました。 |
⌘I
スナップショットの復元
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"
}

