Sign in
Backup

Create backup interface

Create a backup with the given name and collections Storage preflight failures return HTTP 200 with code 503 (Storage_Not_Ready), without registering a task. The caller may retry the same request.

post/create

Headers

request_idstring

request_id

Request body

asyncboolean

async or not

backup_namestring

backup name, will generate one if not set

backup_root_pathstring

backup root path

collection_namesstring[]

collection names to backup, empty to backup all

db_collectionsstring

database and collections to backup. A json string. To support database. 2023.7.7

filterobject

filter for backup

forceboolean

force backup skip flush, Should make sure data has been stored into disk when using it Deprecated: set strategy=skip_flush instead

gc_pause_addressstring

gc pause API address

gc_pause_enableboolean

if true, stop GC to avoid the data compacted and GCed during backup, use it when the data to backup is very large.

gc_pause_secondsinteger

gc pause seconds, set it larger than the time cost of backup

meta_onlyboolean

only backup meta, including collection schema and index info Deprecated: set strategy=meta_only instead

rbacboolean

whether backup RBAC

requestIdstring

uuid of request, will generate one if not set

strategystring

strategy for backup, one of [meta_only, skip_flush, bulk_flush, serial_flush], if not set will auto select

with_index_extraboolean

Response

OK

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

error msg if fail

requestIdstring

uuid of the request to response

Changes

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