列出账户的全部 snapshot
列出你所有应用或数据库的自动 snapshot(GET /v2/users/snapshots),包括大小、日期和下载 URL。需要有效套餐。
GET
/
v2
/
users
/
snapshots
列出账户的全部 snapshot
curl --request GET \
--url https://api.squarecloud.app/v2/users/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/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/users/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/users/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/users/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/users/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/users/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_javascript_manual",
"size": 12900705,
"modified": "2024-06-27T06:23:42.326Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "manual"
},
{
"name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
"size": 12900705,
"modified": "2024-06-26T07:05:40.000Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "automatic"
}
]
}
需要具有
snapshots:read 权限范围的 API 密钥。
snapshot 列表返回 Square Cloud 为你的应用或数据库保留的自动备份,每一项都将已签名的下载 URL 片段与其大小和最后修改日期配对。可用于在你自己的工具中构建恢复选择器或审计保留情况,而不必手动查看控制面板。
结果按用户和范围缓存 30 分钟;缓存未命中会计入更严格的限制,即每 60 秒 3 次调用,超出后调用者会被短暂阻止。列出 snapshot 需要有效套餐,否则会收到 402。
snapshot 按范围分组,默认是 applications,也可以通过下方的 scope 参数指定为 databases。如需应用详情,请参阅获取应用信息;如需数据库详情,请参阅获取数据库信息。
参数
string
默认值:"applications"
指定要检索的 snapshot 类型。
applications(默认):返回应用的 snapshotdatabases:返回数据库的 snapshot
响应
string
指示调用是否成功。成功时为
success,否则为 error。object
响应的内容。
显示 展开对象
显示 展开对象
string
snapshot 的名称:其所属应用程序或数据库的 ID,可选带有
_<runtime> 和 _<origin> 后缀。恢复时将其原样作为 snapshotId 传入。number
snapshot 的大小,单位为字节。
string
snapshot 最后一次修改的日期。
string
snapshot 的 AWS 访问密钥。
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": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
"size": 12900705,
"modified": "2024-06-27T06:23:42.326Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "manual"
},
{
"name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
"size": 12900705,
"modified": "2024-06-26T07:05:40.000Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "automatic"
}
]
}
下载所需 snapshot 的 URL 格式为:https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
INVALID_SCOPE | 400 | scope 查询参数不是 applications 或 databases。 |
UPGRADE_REQUIRED | 402 | 账户没有有效套餐;列出 snapshot 需要有效套餐。 |
RATE_LIMITED | 429 | 已达到请求频率限制。请稍候重试。 |
相关内容
- SDK:
api.account.snapshots()(JavaScript)、client.account.snapshots()(Python)、c.Account.Snapshots()(Go)
⌘I
列出账户的全部 snapshot
curl --request GET \
--url https://api.squarecloud.app/v2/users/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/users/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/users/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/users/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/users/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/users/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/users/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_javascript_manual",
"size": 12900705,
"modified": "2024-06-27T06:23:42.326Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "manual"
},
{
"name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
"size": 12900705,
"modified": "2024-06-26T07:05:40.000Z",
"key": "AWSAccessKeyId=accesskey",
"runtime": "javascript",
"origin": "automatic"
}
]
}

