BackupJob#

Description of a PaaS service backup job.

Contents#

  • databases — A list of database names to back up. If the list is empty, backups are created for all databases of the service.

    • Type: List of strings

    • Constraints: Only for the dump method

  • day — The day of the week when the job runs. If omitted, the job runs daily.

    • Type: String

    • Valid values: 0 (Sunday) | 1 (Monday) | 2 (Tuesday) | 3 (Wednesday) | 4 (Thursday) | 5 (Friday) | 6 (Saturday)

  • instant — Indicates whether to run the backup immediately, outside the schedule.

    • Type: Boolean

  • jobId — The backup job ID.

    • Type: String

  • method — The backup method.

    • Type: String

    • Valid values: dump | wal-g

  • name — The backup job name.

    • Type: String

  • nextExecution — The next job run time, in Unix epoch format.

    • Type: Integer

  • node — The name of the cluster node on which the job runs. If omitted, the job runs on the first cluster node.

    • Type: String

  • rotate — The retention period of full backups, in days.

    • Type: Integer

    • Constraints: Only for the wal-g method

  • schemaOnly — Indicates whether to save database schemas only.

    • Type: Boolean

    • Constraints: Only for the dump method

  • storage — The name of the backup storage where backups are saved.

    • Type: String

  • time — The job start time in the ["HH", "MM"] format, Moscow time.

    • Type: List of strings