Read

GET v1/alarms

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
pageSize	NsUnsignedInt
id	NsObjectID
type	NsAlarmType
array	NsScope
curr_onset_event_id	NsObjectID
object_id	NsObjectID
object_name	NsEventTargetName
object_type	NsObjectType
onset_time	NsTime
ack_time	NsTime
status	NsAlarmStatus
user_id	NsObjectID
user_name	NsUserName
user_full_name	NsFullName
category	NsEventCategory
severity	NsAlarmSeverityLevel
remind_every	NsAlarmRemindEvery
remind_every_unit	NsPeriodUnit
activity	NsAuditActivity
next_notification_time	NsSignedLong

GET v1/alarms/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
fields	NsCommaSeparatedList
pageSize	NsUnsignedInt
id	NsObjectID
type	NsAlarmType
array	NsScope
curr_onset_event_id	NsObjectID
object_id	NsObjectID
object_name	NsEventTargetName
object_type	NsObjectType
onset_time	NsTime
ack_time	NsTime
status	NsAlarmStatus
user_id	NsObjectID
user_name	NsUserName
user_full_name	NsFullName
category	NsEventCategory
severity	NsAlarmSeverityLevel
remind_every	NsAlarmRemindEvery
remind_every_unit	NsPeriodUnit
activity	NsAuditActivity
next_notification_time	NsSignedLong

GET v1/alarms/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

List a set of alarms or a single alarm.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier for the alarm. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
type	NsAlarmType	number	Identifier for type of alarm. Non-negative integer in range [0,2147483647].
array	NsScope	string	The array name where the alarm is generated. Possible values: array serial number, or '-'. Example: 'AC-109084'.
curr_onset_event_id	NsObjectID	string	Identifier for the current onset event. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
object_id	NsObjectID	string	Identifier of object operated upon. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
object_name	NsEventTargetName	string	Name of object operated upon. String of up to 400 alphanumeric characters, - and . and : and " " are allowed after first character. Example: 'volumes in performance policy default'.
object_type	NsObjectType	string enum	Type of the object being operated upon. Possible values: 'active_directory', 'group', 'chapuser', 'initiatorgrp', 'perfpolicy', 'snapshot', 'snapcoll', 'vol', 'volcoll', 'partner', 'array', 'pool', 'initiator', 'protsched', 'volacl', 'throttle', 'sshkey', 'user', 'protpol', 'prottmpl', 'branch', 'route', 'role', 'privilege', 'netconfig', 'events', 'session', 'subnet', 'array_netconfig', 'nic', 'initiatorgrp_subnet', 'fc_initiator_alias', 'fc_port', 'fc_interface_collection', 'fc', 'event_dipatcher', 'fc_target_port_group', 'encrypt_key', 'encrypt_config', 'snapshot_lun', 'syslog', 'async_job', 'application_server', 'audit_log', 'ip address', 'disk', 'shelf', 'protocol_endpoint', 'folder', 'pe_acl', 'vvol', 'vvol_acl', 'alarm'.
onset_time	NsTime	number	Time when this alarm was triggered. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
ack_time	NsTime	number	Time when this alarm was acknowledged. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
status	NsAlarmStatus	string enum	Status of the operation -- open or acknowledged. Possible values: 'open', 'acknowledged'.
user_id	NsObjectID	string	Identifier of the user who acknowledged the alarm. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
user_name	NsUserName	string	Username of the user who acknowledged the alarm. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (\), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'.
user_full_name	NsFullName	string	Full name of the user who acknowledged the alarm. Alphanumeric string of up to 64 chars, starts with letter, can include space, apostrophe('), hyphen(-). Example: 'User-13 Peterson'.
category	NsEventCategory	string enum	Category of the alarm. Possible values: 'unknown', 'hardware', 'service', 'replication', 'volume', 'update', 'configuration', 'test', 'security'.
severity	NsAlarmSeverityLevel	string enum	Severity level of the event. Possible values: 'warning', 'critical'.
remind_every	NsAlarmRemindEvery	number	Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day. Frequency of alarm notification.
remind_every_unit	NsPeriodUnit	string enum	Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day. Possible values: 'minutes', 'hours', 'days', 'weeks'.
activity	NsAuditActivity	string	Description of activity performed and recorded in alarm. String of 1-1476 printable characters. Example: 'Created snapshot % of volume %'.
next_notification_time	NsSignedLong	number	Time when next reminder for the alarm will be sent. Signed 64-bit integer. Example: -1234.

JSON Response

            

{
   "startRow" : 0,
   "totalRows" : 484,
   "endRow" : 484,
   "data" : [
      {
         "id" : "3c00000000000004d3000000000000000000000001"
      },
      {
         "id" : "3c00000000000004d3000000000000000000000002"
      },
      {
         "id" : "3c00000000000004d3000000000000000000000003"
      },
      {
         "id" : "3c00000000000004d30000000000000000000001e4"
      }
   ]
}