Addition of type and VM filter in the backup listing API by GeanJair · Pull Request #13644 · apache/cloudstack

GeanJair · 2026-07-17T14:57:42Z

Description

Currently, the listBackups API does not allow listing backups based on their type. Changes have been made to the API to allow backups to be listed informing a specific type. In addition, although the API already supports the filtering of backups by VM, support for this parameter had not been added to the GUI. Therefore, the GUI backup filter has been extended to support the search by both type and VM.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Screenshots (if appropriate):

Example of a listBackups API call

listBackups API call when filtering by a non-existent type

Filtering field in the GUI

How Has This Been Tested?

I checked the possibility of filtering backups by type.
I checked the possibility of filtering backups by VM.
I checked the response generated when attempting to pass a non-existent type or VM via CloudMonkey.
I checked the response generated when attempting to pass a non-existent type or VM via the browser URL.

… filter by VM

DaanHoogland

clgtm at first sight, but does backupType have a backing enum type that validation should happen against?

DaanHoogland · 2026-07-20T14:51:39Z

@blueorangutan package

blueorangutan · 2026-07-20T14:54:05Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

codecov · 2026-07-20T15:00:24Z

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 19.64%. Comparing base (75748a5) to head (16caf33).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...dstack/api/command/user/backup/ListBackupsCmd.java	0.00%	3 Missing ⚠️
...rg/apache/cloudstack/backup/BackupManagerImpl.java	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #13644      +/-   ##
============================================
- Coverage     19.65%   19.64%   -0.01%     
+ Complexity    19792    19789       -3     
============================================
  Files          6368     6368              
  Lines        575107   575113       +6     
  Branches      70370    70371       +1     
============================================
- Hits         113016   112995      -21     
- Misses       449808   449834      +26     
- Partials      12283    12284       +1

Flag	Coverage Δ
uitests	`3.41% <ø> (+<0.01%)`	⬆️
unittests	`20.92% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

blueorangutan · 2026-07-20T15:41:37Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 18624

DaanHoogland · 2026-07-20T17:46:18Z

@blueorangutan test

blueorangutan · 2026-07-20T17:48:10Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

…p/ListBackupsCmd.java Co-authored-by: Bernardo De Marco Gonçalves <bernardomg2004@gmail.com>

blueorangutan · 2026-07-21T15:37:42Z

[SF] Trillian test result (tid-16598)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 74801 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr13644-t16598-kvm-ol8.zip
Smoke tests completed. 144 look OK, 12 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
ContextSuite context=TestNASBackupAndRecovery>:setup	`Error`	0.00	test_backup_recovery_nas.py
ContextSuite context=TestConsoleEndpoint>:setup	`Error`	0.00	test_console_endpoint.py
ContextSuite context=TestInternalLb>:setup	`Error`	0.00	test_internal_lb.py
test_03_verify_libvirt_attach_disk	`Error`	2.30	test_deploy_virtio_scsi_vm.py
test_04_verify_guest_lspci	`Failure`	34.58	test_deploy_virtio_scsi_vm.py
test_05_change_vm_ostype_restart	`Failure`	13.39	test_deploy_virtio_scsi_vm.py
test_06_verify_guest_lspci_again	`Failure`	40.49	test_deploy_virtio_scsi_vm.py
ContextSuite context=TestDeployVMsInParallel>:setup	`Error`	0.00	test_deploy_vms_in_parallel.py
ContextSuite context=TestDeployVmWithUserData>:setup	`Error`	0.00	test_deploy_vm_with_userdata.py
ContextSuite context=TestDomainsServiceOfferings>:setup	`Error`	1522.98	test_domain_service_offerings.py
test_03_create_vpc_domain_vpc_offering	`Error`	15.81	test_domain_vpc_offerings.py
test_04_validate_vpc_offering_conserve_mode_disabled	`Error`	1518.70	test_domain_vpc_offerings.py
test_02_upgrade_kubernetes_cluster	`Failure`	14.04	test_kubernetes_clusters.py
test_03_deploy_and_scale_kubernetes_cluster	`Failure`	12.91	test_kubernetes_clusters.py
test_04_autoscale_kubernetes_cluster	`Failure`	9.68	test_kubernetes_clusters.py
test_05_basic_lifecycle_kubernetes_cluster	`Failure`	9.72	test_kubernetes_clusters.py
test_06_delete_kubernetes_cluster	`Failure`	12.83	test_kubernetes_clusters.py
test_08_upgrade_kubernetes_ha_cluster	`Failure`	12.88	test_kubernetes_clusters.py
test_10_vpc_tier_kubernetes_cluster	`Error`	9.00	test_kubernetes_clusters.py
test_11_test_unmanaged_cluster_lifecycle	`Error`	2.81	test_kubernetes_clusters.py
test_12_test_deploy_cluster_different_offerings_per_node_type	`Failure`	6.59	test_kubernetes_clusters.py
test_05_list_volumes_isrecursive	`Failure`	0.05	test_list_volumes.py
test_07_list_volumes_listall	`Failure`	0.04	test_list_volumes.py
ContextSuite context=TestMetrics>:setup	`Error`	0.00	test_metrics_api.py
test_delete_account	`Error`	1519.88	test_network.py
test_delete_network_while_vm_on_it	`Error`	1.34	test_network.py
test_deploy_vm_l2network	`Error`	1.31	test_network.py
test_l2network_restart	`Error`	1.42	test_network.py
ContextSuite context=TestPortForwarding>:setup	`Error`	2.81	test_network.py
ContextSuite context=TestPublicIP>:setup	`Error`	10.88	test_network.py
test_reboot_router	`Failure`	0.14	test_network.py
test_releaseIP	`Error`	5.39	test_network.py
test_releaseIP_using_IP	`Error`	5.63	test_network.py
ContextSuite context=TestRouterRules>:setup	`Error`	5.74	test_network.py

Damans227 · 2026-07-21T18:44:03Z

-        var filters = ['name', 'zoneid', 'domainid', 'account', 'backupofferingid', 'status']
-        return filters
-      },
+      searchFilters: ['name', 'zoneid', 'domainid', 'account', 'backupofferingid', 'status', 'type', 'virtualmachineid'],


Nit: extra trailing blank line left after this array, before tabs:.

Add filter by type to listBackups API and expand the UI to be able to…

f324f5c

… filter by VM

boring-cyborg Bot added component:api component:backup component:UI labels Jul 17, 2026

DaanHoogland reviewed Jul 20, 2026

View reviewed changes

bernardodemarco reviewed Jul 21, 2026

View reviewed changes

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

bernardodemarco added this to the 4.24.0 milestone Jul 21, 2026

Update api/src/main/java/org/apache/cloudstack/api/command/user/backu…

16caf33

…p/ListBackupsCmd.java Co-authored-by: Bernardo De Marco Gonçalves <bernardomg2004@gmail.com>

Damans227 reviewed Jul 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Addition of type and VM filter in the backup listing API #13644

Addition of type and VM filter in the backup listing API #13644
GeanJair wants to merge 2 commits into
apache:mainfrom
scclouds:add-type-and-vm-filter-to-backup-listing

GeanJair commented Jul 17, 2026

Uh oh!

DaanHoogland left a comment

Uh oh!

DaanHoogland commented Jul 20, 2026

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

codecov Bot commented Jul 20, 2026 •

edited

Loading

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

DaanHoogland commented Jul 20, 2026

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

Uh oh!

blueorangutan commented Jul 21, 2026

Uh oh!

Damans227 Jul 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

GeanJair commented Jul 17, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Jul 20, 2026

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

codecov Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

DaanHoogland commented Jul 20, 2026

Uh oh!

blueorangutan commented Jul 20, 2026

Uh oh!

Uh oh!

blueorangutan commented Jul 21, 2026

Uh oh!

Damans227 Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov Bot commented Jul 20, 2026 •

edited

Loading