All Products
Document Center


Last Updated: Mar 27, 2020


You can call this operation to query full backup tasks.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeFullBackupList.
BackupPlanId String Yes The ID of the backup schedule.
PageSize Integer No The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
PageNum Integer No The number of the page to return. It must be greater than or equal to 0 and smaller than or equal to the maximum value of the Integer type. Default value: 0.

Response parameters

Parameter Type Description
Items List The details of the full backup task. For more information, see the description of the FullBackupFile parameter.
TotalPages Integer The total number of pages returned.
PageSize Integer The number of entries returned per page.
PageNum Integer The number of the page returned.
TotalElements Long The total number of full backup tasks returned.


Parameter Type Description
BackupSetId String The ID of the backup set.
SourceEndpointIpPort String The connection endpoint of the database.
StartTime Long The start time of the backup. Example: 1554560477000.
EndTime Long The end time of the backup. Example: 1554560477000.
BackupStatus String The status of the backup task. Valid values:
  • schedule: The backup task was being initialized.
  • running: The backup task was running.
  • finish: The backup task was finished.
  • stop: The backup task failed.
  • pause: The backup task was stopped.
BackupSetExpiredTime Long The expiration time of the backup set. Example: 1554560477000.
BackupSize Long The size of the backup set.
StorageMethod String The storage class of the backup data. Valid values:
  • Standard: standard storage.
  • IA: infrequent access storage.
  • Archive: archived storage.
  • UNKNOWN: unknown storage, which generally indicates that the backup task is not yet finished.
BackupObjects String The objects that were backed up.
CreateTime Long The start time of the task. Example: 1554560477000.
FinishTime Long The end time of the task. Example: 1554560477000.
ErrMessage String The error message.

Error codes

Error code Error message Description
BackupFileNotDescribe Full Backup not Describe. The error message returned because the full backup tasks cannot be queried.