Sign in
ClusterBRService

ListClusterBRTasks lists the backup tasks of a specific cluster

Changed on
get/api/v2/clusters/{clusterId}/backup/tasks

Request

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

Path parameters

clusterIdstring required

The cluster ID

Query parameters

pageSizeinteger

Page size

pageTokenstring

Page token

skipinteger

Skip

orderBystring

order_by

isDescboolean

Is descending order

brTaskIdstring

The br task ID

clusterNamestring

The cluster name

type'full_backup' | 'log_backup' | 'restore_by_file' | 'restore_by_time' | 'all_backup' | 'all_restore'

Type of the br task

  • 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
status'running' | 'finished' | 'abnormal' | 'stopped'

Status of the br task

  • running: Running
  • finished: Finished
  • abnormal: Abnormal
  • stopped: Stopped

Response

A successful response.

nextPageTokenstring
totalSizeinteger

Changes