Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: V2 Core backup/restore API Examples

...

  1. shardBackupId - (Required) The shard backup ID assigned by the Backup Collection API for the current backup.
  2. prevShardBackupId - The previous shard backup ID against which the incremental backup is to be made. The previous shard backup is used as the base to find changed data.


Code Block
titleV1 Backup Core API
admin/cores?action=BACKUPCORE&
  core=core-node1&
  location=/path/to/my/shared/drive/myBackupName&
  prevShardBackupId=md_shard1_id_0
  shardBackupId=md_shard1_id_1

Restore Core API

This is also an internal API to be called by the Restore Collection API. It supports two new parameters:


Code Block
titleV2 Backup Core API
POST /v2/cores/someCoreName

{
  "backup-core": {
    "location": "/path/to/my/shared/drive/with/backupName",
    "shardBackupId": "md_shard1_id_1",
    "prevShardBackupId": "md_shard1_id_0"
  }
}

Restore Core API

This is also an internal API to be called by the Restore Collection API. It supports two new parameters:

  1. incremental – An optional boolean that signals whether the data being restored is in the "incremental" format incremental – An optional boolean that signals whether the data being restored is in the "incremental" format or not. Defaults to false.
  2. shardBackupId - The shard backup ID to be restored. This is a required parameter if incremental=true is specified.


Code Block
titleV1 Restore Core API
admin/cores?action=RESTORECORE&
  core=core-node1&
  incremental=true&
  location=/path/to/my/shared/drive/myBackupName&
  shardBackupId=md_shard1_id_1


Code Block
titleV2 Restore Core API
POST /v2/cores/someRestoreCoreName

{
  "restore-core": {
    "incremental": true,
    "location": "
Code Block
admin/cores?action=RESTORECORE&
  core=core-node1&
  incremental=true&
  location=/path/to/my/shared/drive/myBackupName&with/backupName",
  shardBackupId=  "shardBackupId": "md_shard1_id_1"
  }
}

Compatibility, Deprecation, and Migration Plan

...