数据库 - 快照
恢复 snapshot
基于某个 snapshot 恢复数据库。
POST
/
v2
/
databases
/
{database_id}
/
snapshots
/
restore
恢复 snapshot
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 来标识该 snapshot。snapshot 的引擎必须与目标数据库的 type 匹配,例如无法将 Redis 的 snapshot 恢复到 MongoDB 数据库上。
此操作会用 snapshot 的内容覆盖数据库的当前数据;除了提前再创建一次 snapshot 之外,没有撤销手段。恢复进行期间,该数据库的启动、停止和删除数据库请求都会被拒绝。速率限制为每用户每 60 秒 1 次恢复请求,每数据库每 120 秒 1 次恢复请求。
参数
string
必填
数据库的 ID。
string
必填
要为该数据库(database_id)恢复的 snapshot 的 ID。
string
必填
snapshot 的版本密钥。
响应
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 | snapshot 的引擎与该数据库的 type 不匹配。 |
SNAPSHOT_NOT_FOUND | 404 | 未找到与给定 snapshotId 和 versionId 匹配的 snapshot。 |
DATABASE_NOT_FOUND | 404 | 数据库不存在,或不属于调用者。 |
SNAPSHOT_RESTORE_FAILED | 404 | 集群拒绝了此次恢复操作。 |
⌘I
恢复 snapshot
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"
}

