ZIzilliztech
Restore

Restore interface

Changed on

Submit a request to restore the data from backup

post/restore

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Headers

request_idstring

request_id

Request body

asyncboolean

Execute asynchronously: return after the job is registered.

backup_namestring

Backup name to restore.

bucket_namestring

Bucket name; with path, overrides the config for this call.

collection_namesstring[]

Collections to restore.

collection_renamesobject

Rename the restored collections by map; wins over collection_suffix.

collection_suffixstring

Rename the restored collections by appending a suffix.

db_collectionsstring

Database and collections to restore, for example {"db1":["collection1"],"db2":["collection2","collection3"]}. Accepts both shapes it always has: a JSON string holding a JSON object, or the object itself.

db_collections_after_renamestring

Which database and collections to restore after rename. Accepts both shapes db_collections accepts.

dropExistCollectionboolean

Drop existing target collection before create.

dropExistIndexboolean

Drop existing index of target collection before create.

ezkMappingobject

Map of old ezk to new ezk, replacing encryption keys during restore.

idstring

Restore task id, defaults to a generated one when unset.

maxShardNuminteger

Target max shard number.

metaOnlyboolean

Only restore meta, not data.

pathstring

Path; with bucket_name, overrides the config for this call.

rbacboolean

Whether restore RBAC.

requestIdstring

Uuid of request, defaults to a generated one when unset.

restoreIndexboolean

Restore index info.

secondariesstring[]

REST endpoints of the secondary clusters that replicate this target, e.g. http://10.0.0.2:19530; when set, every import job is committed two-phase so its mirror commits on every secondary.

skipCreateCollectionboolean

Skip collection create; use when the collection exists and only index or data is restored.

skipImportDiskQuotaCheckboolean

Skip the disk quota check in import.

Deprecated: the check follows the config.

strategystring

Strategy for restore, one of [auto, per_seg, merged_seg, restore_snap, import_snap]; auto, like leaving the field unset, lets the restore pick the plan against the backup's format.

truncateBinlogByTsboolean

Truncate binlog by timestamp, for cdc.

useAutoIndexboolean

Use autoindex when restoring vector index.

useV2Restoreboolean

Deprecated: set strategy=merged_seg instead.

Response

OK

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

Error msg if fail.

requestIdstring

Uuid of the request answered; absent on the failures a request answers before its id is known.

Changes