Skip to content

/AWS1/IF_SGM=>LISTMONITORINGALERTHISTORY()

About ListMonitoringAlertHistory

Gets a list of past alerts in a model monitoring schedule.

Method Signature

METHODS /AWS1/IF_SGM~LISTMONITORINGALERTHISTORY
  IMPORTING
    !IV_MONITORINGSCHEDULENAME TYPE /AWS1/SGMMONSCHEDULENAME OPTIONAL
    !IV_MONITORINGALERTNAME TYPE /AWS1/SGMMONITORINGALERTNAME OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMMONALERTHISTORYSORT00 OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMMONITORINGALERTSTATUS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlstmonalerthisto01
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_monitoringschedulename TYPE /AWS1/SGMMONSCHEDULENAME /AWS1/SGMMONSCHEDULENAME

The name of a monitoring schedule.

iv_monitoringalertname TYPE /AWS1/SGMMONITORINGALERTNAME /AWS1/SGMMONITORINGALERTNAME

The name of a monitoring alert.

iv_sortby TYPE /AWS1/SGMMONALERTHISTORYSORT00 /AWS1/SGMMONALERTHISTORYSORT00

The field used to sort results. The default is CreationTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the result of the previous ListMonitoringAlertHistory request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of results to display. The default is 100.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only alerts created on or before the specified time.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only alerts created on or after the specified time.

iv_statusequals TYPE /AWS1/SGMMONITORINGALERTSTATUS /AWS1/SGMMONITORINGALERTSTATUS

A filter that retrieves only alerts with a specific status.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlstmonalerthisto01 /AWS1/CL_SGMLSTMONALERTHISTO01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listmonitoringalerthistory(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_monitoringalertname = |string|
  iv_monitoringschedulename = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_monitoringalerthistory( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_monitoringschedulename = lo_row_1->get_monitoringschedulename( ).
      lv_monitoringalertname = lo_row_1->get_monitoringalertname( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_monitoringalertstatus = lo_row_1->get_alertstatus( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.