Sign in
Restore

Restore interface

Submit a request to restore the data from backup

post/restore

Headers

request_idstring

request_id

Request body

asyncboolean

execute asynchronously or not

backup_namestring

backup name to restore

bucket_namestring

if bucket_name and path is set. will override bucket/path in config.

collection_namesstring[]

collections to restore

collection_renamesobject

2, give a map to rename the collections, if not given, use the original name. collection_renames has higher priority than collection_suffix

collection_suffixstring

Support two ways to rename the collections while recover 1, set a suffix

db_collectionsstring

database and collections to restore. A json string. for example: {"db1":["collection1"],"db2":["collection2","collection3"]}

db_collections_after_renamestring

determine which database and collections to restore after rename

dropExistCollectionboolean

if true, drop existing target collection before create

dropExistIndexboolean

if true, drop existing index of target collection before create

ezkMappingobject

map of old ezk to new ezk, used to replace encryption keys during restore

idstring
maxShardNuminteger

target max shard number

metaOnlyboolean

if true only restore meta, not restore data

pathstring

if bucket_name and path is set. will override bucket/path in config.

rbacboolean

whether restore RBAC

requestIdstring

uuid of request, will generate one if not set

restoreIndexboolean

if true restore index info

skipCreateCollectionboolean

if true, will skip collection, use when collection exist, restore index or data

skipImportDiskQuotaCheckboolean

if true, skip the diskQuota in Import

truncateBinlogByTsboolean

if true, truncate binlog by timestamp, for cdc

useAutoIndexboolean

if true use autoindex when restore vector index

useV2Restoreboolean

Response

OK

code0 | 1 | 2 | 3 | 400 | 404
msgstring

error msg if fail

requestIdstring

uuid of the request to response

Changes

Changed in 3 of the 51 revisions of this API.111