Get backup status

Get status of active backup operations

Request:

Method:

GET

URI Path(s):

/api/v1/cluster/backups/status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

CurrentBackupOperationStatus+

Name	Description	Type	Notes
backup_id	Unique identifier of current backup	string
current_step	Current step of operation	string	Enum: BACKUP_CREATING_CLUSTER_BACKUP, BACKUP_CREATING_NODE_BACKUP
current_step_message	Additional human-readable status information about current step	string
end_time	Time when operation is expected to end	EpochMsTimestamp
operation_type	Type of operation that is in progress. Returns none if no operation is in progress, in which case none of the other fields will be set.	string	Required Enum: NONE, BACKUP
start_time	Time when operation was started	EpochMsTimestamp

Example Response:

{ "operation_type": "backup", "backup_id": "fec18cee-ccf7-4d7c-bcc2-8634b08195cd-1523411326", "start_time": 1523411326952, "end_time": 1523411628558, "current_step": "BACKUP_CREATING_CLUSTER_BACKUP" }

Required Permissions:

read

Feature:

utilities_backup

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable

Get backup status

Request:

Successful Response:

CurrentBackupOperationStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: