RestoreSnapshot-阿里云帮助中心

Operation description

Restores to a target branch based on a snapshot LSN. You can specify the restored branch name and target branch. FinalizeRestore controls whether to complete the restoration immediately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Specifies the region in which to query or perform the operation.	cn-hangzhou
ProjectId	string	Yes	The Supabase project ID.	spb-xxxx
RestoredLsn	string	Yes	The snapshot LSN used for restoration.	0/3522648
TargetBranchId	string	No	The target branch ID. If not specified, the backend selects the target branch based on the restoration process.	br-main
RestoredBranchName	string	No	The name of the restored branch. If not specified, the backend generates a name automatically.	restore_preview
FinalizeRestore	boolean	No	Specifies whether to complete the restoration immediately. Default value: false.	false
ClientToken	string	No	The idempotence token. Ensures that repeated requests do not execute the same operation more than once.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
BranchId	string	The ID of the restored branch.	br-restore
ProjectId	string	The Supabase project ID.	spb-xxxx

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.