Couchbase · Schema

BackupTask

Backup or restore task record

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
task_name	string	Name of the task
status	string	Task execution status
start	string	Task start time
end	string	Task end time
type	string	Type of task
node_runs	array	Per-node execution details

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BackupTask",
  "title": "BackupTask",
  "type": "object",
  "description": "Backup or restore task record",
  "properties": {
    "task_name": {
      "type": "string",
      "description": "Name of the task"
    },
    "status": {
      "type": "string",
      "description": "Task execution status",
      "enum": [
        "done",
        "running",
        "failed",
        "cancelled"
      ]
    },
    "start": {
      "type": "string",
      "format": "date-time",
      "description": "Task start time"
    },
    "end": {
      "type": "string",
      "format": "date-time",
      "description": "Task end time"
    },
    "type": {
      "type": "string",
      "description": "Type of task",
      "enum": [
        "BACKUP",
        "MERGE",
        "RESTORE"
      ]
    },
    "node_runs": {
      "type": "array",
      "description": "Per-node execution details",
      "items": {
        "type": "object"
      }
    }
  }
}