maintenance

Cluster maintenance and recovery APIs.

post /maintenance/osd/{osdId}/deep-scrub

Instruct an OSD to deep-scrub all its PGs.

Arguments
  • osdIdrequiredinteger

    -

Definition
post /maintenance/osd/{osdId}/deep-scrub

get /maintenance/flags

Ceph cluster flag overview.

Arguments
  • No arguments...

Definition
get /maintenance/flags
Attributes
  • namestring

    -

  • descriptionstring

    -

  • recommendedStateboolean

    -

  • currentStateboolean

    -

Example response
[ { "name": "string", "description": "string", "recommendedState": true, "currentState": true } ]

put /maintenance/flags/{flag}/set

Set a Ceph cluster flag.

Arguments
  • flagrequiredstring

    -

Definition
put /maintenance/flags/{flag}/set

put /maintenance/flags/{flag}/unset

Unset a Ceph cluster flag.

Arguments
  • flagrequiredstring

    -

Definition
put /maintenance/flags/{flag}/unset

get /maintenance/recovery-speed

Get the recovery speed.

Arguments
  • No arguments...

Definition
get /maintenance/recovery-speed
Attributes
  • speedinteger

    Recovery speed setting from 1 (slowest) to 10 (fastest). Set to <= 0 to restore the default configured in ceph.conf.

Example response
{ "speed": 0 }

put /maintenance/recovery-speed

Set the recovery speed.

Arguments
  • bodyoptional

    -

Definition
put /maintenance/recovery-speed

post /maintenance/reboot-all-servers

Reboot all servers not running their configured image.

Arguments
  • No arguments...

Definition
post /maintenance/reboot-all-servers
Attributes
  • statusCodeinteger

    -

  • idinteger

    -

  • startedBystring

    -

  • startedAtinteger

    -

  • doneboolean

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • objectstring

    -

  • outputstring

    -

Example response
{ "statusCode": 0, "id": 0, "startedBy": "string", "startedAt": 0, "done": true, "name": "string", "state": "WAITING", "object": "string", "output": "string" }

post /maintenance/migrations/mimic

Perform a cluster upgrade to Ceph Mimic.

Arguments
  • No arguments...

Definition
post /maintenance/migrations/mimic
Attributes
  • statusCodeinteger

    -

  • idinteger

    -

  • startedBystring

    -

  • startedAtinteger

    -

  • doneboolean

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • objectstring

    -

  • outputstring

    -

Example response
{ "statusCode": 0, "id": 0, "startedBy": "string", "startedAt": 0, "done": true, "name": "string", "state": "WAITING", "object": "string", "output": "string" }

get /maintenance/migrations

Check which Ceph upgrades can be performed.

Arguments
  • No arguments...

Definition
get /maintenance/migrations
Attributes
  • mimicboolean

    -

Example response
{ "mimic": true }

get /maintenance/config-backups

Check if cloud configuration backups are enabled and working.

Arguments
  • No arguments...

Definition
get /maintenance/config-backups
Attributes
  • enabledboolean

    -

  • lastBackupTimestampinteger

    Timestamp of the last backup, null if never backed up.

  • lastBackupSizeinteger

    Size of the last backup in byte, null if never backed up.

  • lastBackupChecksumstring

    SHA256 checksum of the encrypted data of the last backup, null if never backed up.

  • clusterIdstring

    -

  • backupEncryptionKeystring

    -

  • cephFsidstring

    -

Example response
{ "enabled": true, "lastBackupTimestamp": 0, "lastBackupSize": 0, "lastBackupChecksum": "string", "clusterId": "string", "backupEncryptionKey": "string", "cephFsid": "string" }

patch /maintenance/config-backups

Configure cloud configuration backups.

Arguments
  • bodyoptional

    -

Definition
patch /maintenance/config-backups

post /maintenance/osd/{osdId}/scrub

Instruct an OSD to scrub all its PGs.

Arguments
  • osdIdrequiredinteger

    -

Definition
post /maintenance/osd/{osdId}/scrub

post /maintenance/config-backups/create

Perform a cloud backup now.

Arguments
  • No arguments...

Definition
post /maintenance/config-backups/create
Attributes
  • statusCodeinteger

    -

  • idinteger

    -

  • startedBystring

    -

  • startedAtinteger

    -

  • doneboolean

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • objectstring

    -

  • outputstring

    -

Example response
{ "statusCode": 0, "id": 0, "startedBy": "string", "startedAt": 0, "done": true, "name": "string", "state": "WAITING", "object": "string", "output": "string" }