Read

GET v1/events

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
pageSize	NsUnsignedInt
id	NsObjectID
type	NsEventType
scope	NsScope
target	NsEventTargetName
target_type	NsEventTargetType
timestamp	NsTime
category	NsEventCategory
severity	NsSeverityLevel
summary	NsString
activity	NsAuditActivity
alarm_id	NsObjectID

GET v1/events/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
iSortBy	NsString
fields	NsCommaSeparatedList
pageSize	NsUnsignedInt
id	NsObjectID
type	NsEventType
scope	NsScope
target	NsEventTargetName
target_type	NsEventTargetType
timestamp	NsTime
category	NsEventCategory
severity	NsSeverityLevel
summary	NsString
activity	NsAuditActivity
alarm_id	NsObjectID

GET v1/events/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

List a set of event records or a single event record.

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	Deprecated
id	NsObjectID	string	Identifier for the event record. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
type	NsEventType	number	Type of the event record. Non-negative integer in range [0,2147483647].
scope	NsScope	string	The array name for array level event. Possible values: array serial number, or '-'. Example: 'AC-109084'.
target	NsEventTargetName	string	Name of object upon which the event occurred. String of up to 400 alphanumeric characters, - and . and : and " " are allowed after first character. Example: 'volumes in performance policy default'.
target_type	NsEventTargetType	string enum	Target type of the event record. Possible values: 'anon', 'array', 'controller', 'disk', 'nic', 'temperature', 'service', 'volume', 'protection_set', 'nvram', 'fan', 'power_supply', 'partner', 'raid', 'test', 'iscsi', 'pool', 'group', 'shelf', 'ntb', 'fc', 'initiator_group'.
timestamp	NsTime	number	Time when this event happened. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
category	NsEventCategory	string enum	Category of the event record. Possible values: 'unknown', 'hardware', 'service', 'replication', 'volume', 'update', 'configuration', 'test', 'security'.
severity	NsSeverityLevel	string enum	Severity level of the event. Possible values: 'info', 'notice', 'warning', 'critical'.
summary	NsString	string	Summary of the event. Plain string.
activity	NsAuditActivity	string	Description of the event. String of 1-1476 printable characters. Example: 'Created snapshot % of volume %'.
alarm_id	NsObjectID	string	The alarm ID if the event is related to an alarm. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.

JSON Response