edit-icon download-icon


Last Updated: Mar 04, 2018


This API supports both replica set instances and sharded cluster instances.

Input parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: DescribeBackups.
DBInstanceIdStringYesInstance ID
BackupIdIntegerNoBackup ID
NodeIdStringNoThe sharding instance type is valid. ID of the input instance on the shard node.
UnavailableStringNoLocation where the backup set is stored; optional values: OSS and Archive Storage. Default value: OSS
PageSizeIntegerNoNumber of records per page; optional values: 30, 50, and 100. Default value: 30.
PageNumberIntegerNoPage number. It must be greater than 0 and no greater than the Integer’s maximum value. Default value: 1

Response parameters

Public response parameters-For more information, see public response parameters.
ItemsList<Backup>Array composed of backups
PageNumberIntegerPage number
TotalCountIntegerTotal number of backups
PageSizeIntegerNumber of records per page

Backup data structure

BackupDBNames (TBD)StringList of DBs in the backup set. Multiple DBs are separated by commas (,), in the format of “Db1,Db2,Db3…”. Check whether the entire database is backed up.
BackupIdIntegerBackup ID
BackupStatusStringBackup status:
- Success: The backup is successful.
- Failed: The backup fails.
BackupStartTimeStringStart time of this backup, in the format of YYYY-MM-DD’T’hh:mm:ssZ.
BackupEndTimeStringEnd time of this backup in the format of YYYYMM-DD’T’hh:mm:ssZ.
BackupTypeStringBackup type:
- FullBackup: Full backup
- IncrementalBackup: Incremental backup
BackupModeStringBackup mode:
- Automated: Automatic backup
- Manual: Manual backup
BackupMethodStringBackup method:
- Snapshot: Snapshot-based backup
- Physical: Physical backup
BackupDownloadURLStringDownload URL. If the backup cannot be downloaded at the moment, this parameter is set to a null string.
BackupSizeLongBackup file size in bytes.
Thank you! We've received your feedback.