Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Non-requirements
    • List archived alerts/events via UI/API
  • Configuration
    • There are is one global configuration parametersparameter:
      • alert.purge.delay - alerts older than specified number of days will be purged. Value set to 0 to never purge alerts automatically

...

ApiName

Request parameters

Response parameters

Available to regular user

deleteAlert

  • id(can pass one or more IDs seperated by comma)
  • type
  • time
  • true/false

No

archiveAlert

  • id(can pass one or more IDs seperated by comma)
  • type
  • time
  • true/false

No

In the above mentioned APIs, id and type are optional parameters. If admin , type and time *are optional parameters but while calling the APIs atleast one of them is required. Admin can pass one or multiple ids of alert to delete/archive them as per the requirement or if admin wants to delete/archive all the alerts of a particular type category then he needs to pass only *type parameter along with type value. If admin wants to delete/archive alerts older then some time then admin passes both ids and type then CloudStack will match the ids and type needs to pass time parameter. If admin passes any combination of parameters (two or all three) then CloudStack will fetch the alerts from database depends on the parameters and delete/archive only those alerts which satisfy this criteria.

...

Changes to Existing Files: 

  • Add new methods in AlertManagerImplManagementServerImpl.java to  to delete and archive alerts.
  • Add new components in AlertManagerManagementService.

Delete or Archive Events

...

ApiName

Request parameters

Response parameters

Available to regular user

deleteEvent

  •  id(can pass one or more IDs seperated by comma)
  • type
  • time
  •  true/false

No

archiveEvent

  •  id(can pass one or more IDs seperated by comma)
  • type
  • time
  • true/false

No

The APIs deleteEvent and archiveEvent will perform in the similar manner as of deleteAlert and archiveAlert.

...