Druva MSP icon

Druva MSP

Interact with the Druva MSP API
Join our community

Actions39

Overview

The "Get Consumption by Backup Set Report" operation within the "Report - Hybrid Workloads" resource retrieves detailed consumption data related to backup sets in a hybrid workload environment. This report helps users analyze backup storage and usage patterns across different customers and workload types over specified date ranges.

Typical use cases include:

  • Monitoring backup consumption trends for billing or cost optimization.
  • Auditing backup usage per customer or workload type.
  • Generating reports for compliance or operational insights.

For example, an MSP (Managed Service Provider) might use this node to generate monthly backup consumption reports filtered by specific customers and workload types to understand resource utilization and optimize service plans accordingly.

Properties

Name Meaning
Return All Whether to return all available results or limit the output to a specified number.
Limit Maximum number of results to return when not returning all. Value range: 1 to 100.
Date Selection Method Choose how to filter the report data by date:
• No Date Filter — include all dates.
• Specific Dates — specify exact start and end dates.
• Relative Date Range — select from predefined relative periods like current month, last 30 days, etc.
Start Date Start date (inclusive) for filtering report data when using Specific Dates method.
End Date End date (inclusive) for filtering report data when using Specific Dates method.
Date Range Predefined relative date range for filtering report data when using Relative Date Range method. Options include:
Current Month, Previous Month, Current Quarter, Previous Quarter, Current Year, Previous Year, Last 30/60/90 Days, Last 6/12 Months, Year To Date.
Filter by Customer(s) Whether to filter the report results by specific customers.
Customer IDs List of customer IDs to filter by when filtering by customers is enabled.
Filter by Workload Types Whether to filter the report results by workload types.
Workload Types List of workload types to filter by when filtering by workload types is enabled. For alert history reports, this filters by alert type instead.

Output

The node outputs JSON data representing the consumption report by backup set. The structure typically includes details such as:

  • Backup set identifiers.
  • Associated customer information.
  • Workload types.
  • Consumption metrics (e.g., storage used, backup counts).
  • Date/time stamps corresponding to the filtered period.

If multiple items are returned, they are provided as an array of JSON objects, each representing one backup set's consumption data.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Druva MSP API with appropriate API authentication credentials configured in n8n.
  • The node depends on the Druva MSP API endpoints that provide customer, workload, and report data.
  • Proper permissions must be granted to the API key or token to access reporting endpoints and customer/workload metadata.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Filtering by customers or workload types without valid IDs may result in empty responses.
    • Date filters outside the supported range or incorrect date formats can lead to errors or no data returned.
    • Requesting too many results without enabling "Return All" may truncate data unexpectedly.

  • Error Messages:

    • Errors related to API request failures often include messages about invalid parameters or unauthorized access.
    • If the resource or operation is not implemented, the node throws an error indicating the unsupported resource.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure customer IDs and workload types exist and are correctly selected.
    • Use valid date formats and supported date ranges.
    • Enable "Return All" if expecting large datasets or increase the "Limit" appropriately.

Links and References

  • Druva MSP API Documentation (general reference for API endpoints and data models)
  • n8n Documentation on Custom Nodes and API Integration
  • Best practices for date filtering and pagination in API requests

Discussion