Sign in
ClusterBRService

CreateBackupTask backups a cluster

Changed on
post/api/v2/clusters/{clusterId}/backup

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

clusterIdstring required

Cluster ID

Request body

namestring
destinationstring required
accessKeyIdstring
secretAccessKeystring
rateLimitinteger
concurrencyinteger
logFilestring
retentioninteger

Response

A successful response.

taskIdstring
type'full_backup' | 'log_backup' | 'restore_by_file' | 'restore_by_time' | 'all_backup' | 'all_restore'
  • full_backup: Full backup
  • log_backup: Log backup
  • restore_by_file: Restore by file
  • restore_by_time: Restore by time
  • all_backup: All backup
  • all_restore: All restore
triggerType'automatic' | 'manual'
  • automatic: automatic
  • manual: manual
namestring
status'running' | 'finished' | 'abnormal' | 'stopped'
  • running: Running
  • finished: Finished
  • abnormal: Abnormal
  • stopped: Stopped
restoredTsstring
startTimestring
endTimestring
clusterIdstring
clusterNamestring
destinationstring
sizestring
sizeBytestring int64
errorMessagestring
policyIdstring
policyNamestring
logstring
accessKeyIdstring
secretAccessKeystring
rateLimitinteger
concurrencyinteger
logFilestring
expireTimestring

Changes