Skip to main content
POST
创建 snapshot
每个账户每 24 小时最多可执行 (RAM / 256) * 2 次 snapshot。
string
必填
你账户的 API 密钥。你可以在账户设置中找到它。
捕获数据库数据在某一时间点的备份,并上传到 Square Cloud 的 snapshot 存储,返回一个有效期 30 天的已签名下载 URL。可以在高风险迁移之前、手动恢复 snapshot之前,或按计划用于灾难恢复。创建后,snapshot 也会出现在snapshot 列表中。

参数

string
必填
数据库的 ID。

软截止时间行为

此路由遵循软截止时间模型 — 它不再总是同步响应。
  • 如果 snapshot 在 ~90 秒内完成,该路由将返回 200 success 以及一个已签名的下载 URL(有效期 30 天),与之前完全相同。
  • 如果 snapshot 生成时间超过 ~90 秒,该路由将立即返回 202 以及代码 SNAPSHOT_PROCESSING这不是失败。 snapshot 会在后台继续生成,并会自行出现在 snapshot 列表中,通常在 ~2 分钟内。对于大型数据库来说这是预期行为。
请勿将此 POST 端点用作轮询机制。要检查处于 SNAPSHOT_PROCESSING 状态的 snapshot 是否已完成,请使用 List SnapshotsGET)端点 — 而不是另一个 POST。在 snapshot 完成后重新发起 POST 会从头开始一个全新的 snapshot。
客户端应根据响应进行如下分支处理:

响应

string
指示调用是否成功。成功时为 success,否则为 error
object
响应的内容。仅当 statussuccess 时存在。
202
当 snapshot 超过 ~90 秒的软截止时间时返回。snapshot 仍在后台生成,并会自行出现在 snapshot 列表中,通常在 ~2 分钟内。这不是错误 — 请等待并通过 GET 列表端点确认。

错误

snapshot 请求可能会被拒绝并返回 429 Too Many Requests。使用 code 字段来区分这两种情况:
429
短期冷却 — 你触发了每用户(每 5 秒 1 次请求)或每数据库(每 180 秒 1 次请求)的限制。请退避并稍后重试。
429
已达到每日配额 — 该账户已用完其套餐的每日 snapshot 额度(每 24 小时 (RAM / 256) × 2 次)。随着滚动的 24 小时窗口推进,配额会释放;如需更高的每日额度,请升级套餐。