RestoreSnapshot - 恢复快照

更新时间:
复制 MD 格式

从快照恢复 Supabase 项目。

接口说明

该接口用于基于快照 LSN 恢复到目标分支。可以指定恢复分支名称和目标分支,FinalizeRestore 用于控制是否直接完成恢复。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。用于限定查询或操作所在地域。

cn-hangzhou

ProjectId

string

Supabase 项目 ID。

spb-xxxx

RestoredLsn

string

用于恢复的快照 LSN。

0/3522648

TargetBranchId

string

目标分支 ID。不传时由后端按恢复流程选择目标分支。

br-main

RestoredBranchName

string

恢复后的分支名称。不传时由后端生成。

restore_preview

FinalizeRestore

boolean

是否直接完成恢复。不传时默认值为 false。

false

ClientToken

string

幂等 Token。用于保证重复请求不会重复执行同一操作。

123e4567-e89b-12d3-a456-426655440000

返回参数

名称

类型

描述

示例值

object

返回数据对象。

RequestId

string

请求 ID。

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

BranchId

string

恢复后的分支 ID。

br-restore

ProjectId

string

Supabase 项目 ID。

spb-xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "BranchId": "br-restore",
  "ProjectId": "spb-xxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情