列出数据库 snapshot
按时间从新到旧列出数据库的 snapshot(GET /v2/databases//snapshots):大小、日期、下载 URL 以及恢复所需的 ID。
GET
/
v2
/
databases
/
{database_id}
/
snapshots
列出数据库 snapshot
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_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/databases/{database_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/databases/{database_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/databases/{database_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/databases/{database_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_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":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}
需要具有
snapshots:read 权限范围的 API 密钥。
列出某个数据库存储的所有 snapshot,按最新优先排序,并提供每个 snapshot 的大小和最后修改日期。可用于在控制面板中构建恢复选择器,或在创建 snapshot调用返回 202 SNAPSHOT_PROCESSING 后轮询,确认文件是否已生成。
每一项都带有一个已签名的下载 url(有效期 30 天),以及一个在恢复时作为 versionId 传入的 version_id。响应按用户和数据库缓存 30 分钟,因此刚生成完成的 snapshot 可能需要一小段时间才会出现在这里。要恢复其中某个 snapshot,请参阅恢复 snapshot。
参数
string
必填
数据库的 ID。
响应
string
指示调用是否成功。成功时为
success,否则为 error。array
响应内容。
显示 展开对象
显示 展开对象
string
snapshot 的名称:数据库 ID 带
_<type> 后缀,较新的 snapshot 还带 _<origin>。恢复时将其原样作为 snapshotId 传入。number
备份的大小,单位为字节。
string
备份最后一次修改的日期。
string
下载 URL 的签名查询字符串。
string
snapshot 的版本。恢复时将其作为
versionId 传入。string
用于下载该 snapshot 的签名 URL,有效期 30 天。
string | null
snapshot 所来自的运行时:应用程序的语言(
javascript、python、rust 等)或数据库引擎(mongo、mysql、postgres、redis)。在此字段出现之前创建的 snapshot 为 null。string | null
snapshot 的创建方式:
manual(通过 API、控制台或 CLI 请求)或 automatic(每日定时 snapshot)。较旧的 snapshot 为 null。{
"status":"success",
"response":[
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}
通过 snapshot 的
url 下载 snapshot。该链接在 30 天内有效。常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
DATABASE_NOT_FOUND | 404 | 数据库不存在,或不属于调用者。 |
相关内容
- CLI:
squarecloud db snapshot list - SDK:
api.databases.snapshots.list()(JavaScript)、client.databases.snapshots.list()(Python)、c.Databases.Snapshots.List()(Go)
⌘I
列出数据库 snapshot
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_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/databases/{database_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/databases/{database_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/databases/{database_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/databases/{database_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_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":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}

