Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

1.10. http://localhost:7080/rest/reports : Provide the reports that are also run from the Reports section of the UI. All reports are only available in CSV format

Defining class: org.rhq.enterprise.server.rest.ReportsHandlerBean

Produces: text/csv

Methods

  • GET /reports

    Description

    List the available reports

    This method has no parameters

    Return type: String (multi)

  • GET /reports/alertDefinitions

    Description

    Export the AlertDefinitions as CSV

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: String (multi)

  • GET /reports/configurationHistory

    Description

    Export the Configuration History data as CSV

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: String (multi)

  • GET /reports/driftCompliance

    Description

    Export the drift compliance data

    Supports returning a gzip'ed Content-Encoding

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    resourceTypeId Query none String -all- -none-
    version Query none String -all- -none-

    Return type: String (multi)

  • GET /reports/inventorySummary

    Description

    Export the Inventory Summary data as CSV

    Supports returning a gzip'ed Content-Encoding

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    resourceTypeId Query none String -all- -none-
    version Query none String -all- -none-

    Return type: String (multi)

  • GET /reports/platformUtilization

    Description

    Export the Platform utilization data as CSV

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: String (multi)

  • GET /reports/recentAlerts

    Description

    Export the Recent Alert data as CSV

    Supports returning a gzip'ed Content-Encoding

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    alertPriority Query none String -all- high,medium,low
    startTime Query none Long -all- -none-
    endTime Query none Long -all- -none-

    Return type: String (multi)

  • GET /reports/recentDrift

    Description

    Export the Recent drift data as CSV

    Supports returning a gzip'ed Content-Encoding

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    categories Query Drift categories to report on false String FILE_ADDED, FILE_CHANGED, FILE_REMOVED
    snapshot Query none Integer -all- -none-
    path Query none String -all- -none-
    definition Query none String -all- -none-
    startTime Query none Long -all- -none-
    endTime Query none Long -all- -none-

    Return type: String (multi)

    Error codes:
    CodeReason
    404 If no category is provided or the category is wrong
  • GET /reports/recentOperations

    Description

    Export the Recent Operations Data as CSV

    Supports returning a gzip'ed Content-Encoding

    Parameters:
    NameP.TypeDescriptionRequiredTypeAllowed valuesDefault value
    status Query Status to look for. If parameter is not given, all values are used false String all inprogress,success,failure,canceled
    startTime Query The start time in ms since epoch of the time range to export. false Long all
    endTime Query The end time in ms since epoch of the time range to export. Defaults to 'now' if only the start time is given false Long all

    Return type: String (multi)

  • GET /reports/suspectMetrics

    Description

    Export the Suspect Metrics data as CSV

    Supports returning a gzip'ed Content-Encoding

    This method has no parameters

    Return type: String (multi)