adding backup filter by status

Author: gean.silva

api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java

@@ -89,6 +89,12 @@ public class ListBackupsCmd extends BaseListProjectAndAccountResourcesCmd {
             description = "list backups by backup offering")
     private Long backupOfferingId;
 
+    @Parameter(name = ApiConstants.STATUS,
+            type = CommandType.STRING,
+            since = "4.23.0",
+            description = "list backups by status")
+    private String backupStatus;
+
     @Parameter(name = ApiConstants.LIST_VM_DETAILS,
             type = CommandType.BOOLEAN,
             since = "4.21.0",
@@ -119,6 +125,10 @@ public Long getZoneId() {
         return zoneId;
     }
 
+    public String getBackupStatus() {
+        return backupStatus;
+    }
+
     public Boolean getListVmDetails() {
         return listVmDetails;
     }

server/src/main/java/org/apache/cloudstack/backup/BackupManagerImpl.java

@@ -39,6 +39,7 @@
 import javax.naming.ConfigurationException;
 
 import com.cloud.utils.DomainHelper;
+import com.cloud.utils.EnumUtils;
 import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.InternalIdentity;
@@ -256,6 +257,8 @@ public class BackupManagerImpl extends ManagerBase implements BackupManager {
     private static Map<String, BackupProvider> backupProvidersMap = new HashMap<>();
     private List<BackupProvider> backupProviders;
 
+    private static final List<Backup.Status> INVALID_BACKUP_STATUS = List.of(Backup.Status.Expunged, Backup.Status.Removed);
+
     public AsyncJobDispatcher getAsyncJobDispatcher() {
         return asyncJobDispatcher;
     }
@@ -1089,13 +1092,28 @@ protected void deleteExcessBackups(List<BackupVO> backups, int amountOfBackupsTo
         }
     }
 
+    private Backup.Status validateBackupStatus(final String backupStatus) {
+        if (backupStatus == null) {
+            return null;
+        }
+
+        Backup.Status status = EnumUtils.getEnumIgnoreCase(Backup.Status.class, backupStatus);
+        if (status == null || INVALID_BACKUP_STATUS.contains(status)) {
+            throw new InvalidParameterValueException(String.format("Invalid backup status: %s. Valid values are: " +
+                    "Allocated, Queued, BackingUp, BackedUp, Error, Failed, Restoring.", backupStatus));
+        }
+
+        return status;
+    }
+
     @Override
     public Pair<List<Backup>, Integer> listBackups(final ListBackupsCmd cmd) {
         final Long id = cmd.getId();
         final Long vmId = cmd.getVmId();
         final String name = cmd.getName();
         final Long zoneId = cmd.getZoneId();
         final Long backupOfferingId = cmd.getBackupOfferingId();
+        final Backup.Status backupStatus = validateBackupStatus(cmd.getBackupStatus());
         final Account caller = CallContext.current().getCallingAccount();
         final String keyword = cmd.getKeyword();
         List<Long> permittedAccounts = new ArrayList<Long>();
@@ -1124,6 +1142,7 @@ public Pair<List<Backup>, Integer> listBackups(final ListBackupsCmd cmd) {
         sb.and("name", sb.entity().getName(), SearchCriteria.Op.EQ);
         sb.and("zoneId", sb.entity().getZoneId(), SearchCriteria.Op.EQ);
         sb.and("backupOfferingId", sb.entity().getBackupOfferingId(), SearchCriteria.Op.EQ);
+        sb.and("backupStatus", sb.entity().getStatus(), SearchCriteria.Op.EQ);
 
         if (keyword != null) {
             sb.and().op("keywordName", sb.entity().getName(), SearchCriteria.Op.LIKE);
@@ -1156,6 +1175,8 @@ public Pair<List<Backup>, Integer> listBackups(final ListBackupsCmd cmd) {
             sc.setParameters("backupOfferingId", backupOfferingId);
         }
 
+        sc.setParametersIfNotNull("backupStatus", backupStatus);
+
         if (keyword != null) {
             String keywordMatch = "%" + keyword + "%";
             sc.setParameters("keywordName", keywordMatch);