Skip to content

/AWS1/CL_IOV=>LISTALARMS()

About ListAlarms

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

Method Signature

IMPORTING

Required arguments:

iv_alarmmodelname TYPE /AWS1/IOVALARMMODELNAME /AWS1/IOVALARMMODELNAME

The name of the alarm model.

Optional arguments:

iv_nexttoken TYPE /AWS1/IOVNEXTTOKEN /AWS1/IOVNEXTTOKEN

The token that you can use to return the next set of results.

iv_maxresults TYPE /AWS1/IOVMAXRESULTS /AWS1/IOVMAXRESULTS

The maximum number of results to be returned per request.

RETURNING

oo_output TYPE REF TO /aws1/cl_iovlistalarmsresponse /AWS1/CL_IOVLISTALARMSRESPONSE

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->/aws1/if_iov~listalarms(
  iv_alarmmodelname = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_alarmsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_alarmmodelname = lo_row_1->get_alarmmodelname( ).
      lv_alarmmodelversion = lo_row_1->get_alarmmodelversion( ).
      lv_keyvalue = lo_row_1->get_keyvalue( ).
      lv_alarmstatename = lo_row_1->get_statename( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastupdatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.