Skip to main content
REST API reference
A newer release of this product is available.

Retrieve observed events

PDFs

GET /support/ems/events

Introduced In: 9.6

Retrieves a collection of observed events.

  • event log show

Parameters

Name Type In Required Description

stateful

boolean

query

False

Filter by stateful

  • Introduced in: 9.11

uuid

string

query

False

Filter by uuid

  • Introduced in: 9.11

action.possible_actions.action

string

query

False

Filter by action.possible_actions.action

  • Introduced in: 9.11

action.possible_actions.parameters.format

string

query

False

Filter by action.possible_actions.parameters.format

  • Introduced in: 9.11

action.possible_actions.parameters.name

string

query

False

Filter by action.possible_actions.parameters.name

  • Introduced in: 9.11

action.possible_actions.parameters.type

string

query

False

Filter by action.possible_actions.parameters.type

  • Introduced in: 9.11

action.possible_actions.invoke.verb

string

query

False

Filter by action.possible_actions.invoke.verb

  • Introduced in: 9.11

message.name

string

query

False

Filter by message.name

message.severity

string

query

False

Filter by message.severity

time

string

query

False

Filter by time

source

string

query

False

Filter by source

creation_time

string

query

False

Filter by creation_time

  • Introduced in: 9.11

log_message

string

query

False

Filter by log_message

state

string

query

False

Filter by state

  • Introduced in: 9.11

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

parameters.name

string

query

False

Filter by parameters.name

parameters.value

string

query

False

Filter by parameters.value

index

integer

query

False

Filter by index

last_update_time

string

query

False

Filter by last_update_time

  • Introduced in: 9.11

filter.name

string

query

False

Filter the collection returned using an event filter

  • Introduced in: 9.8

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 3,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "action": {
        "possible_actions": [
          {
            "action": "scheduled",
            "invoke": {
              "_links": {
                "href": "/api/resourcelink"
              },
              "verb": "patch"
            },
            "parameters": [
              {
                "format": "date-time",
                "name": "schedule-at",
                "type": "string"
              }
            ]
          }
        ]
      },
      "creation_time": "string",
      "index": 1,
      "last_update_time": "string",
      "log_message": "string",
      "message": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "callhome.spares.low",
        "severity": "emergency"
      },
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "parameters": [
        {
          "name": "numOps",
          "value": "123"
        }
      ],
      "source": "string",
      "state": "auto_healing",
      "time": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

invoke

Opaque URL and HTTP verb used to perform the action.

Name Type Description

_links

href

verb

string

parameters

Name Type Description

format

string

Indicates the contents and format of the string.

name

string

Parameter name.

type

string

Parameter type.

possible_actions

Name Type Description

action

string

Name of the action.

invoke

invoke

Opaque URL and HTTP verb used to perform the action.

parameters

array[parameters]

Parameter list for the action.

action

Actions that can be performed on the alert. To perform an action, send a POST request to the "invoke" URL with appropriate set of parameter values from the "possible_actions" list.

Name Type Description

possible_actions

array[possible_actions]

A list of possible actions along with the parameter names and types that can be used with the opaque URL.

message

Name Type Description

_links

_links

name

string

Message name of the event. Returned by default.

severity

string

Severity of the event. Returned by default.

node

Name Type Description

_links

_links

name

string

uuid

string

parameters

Name Type Description

name

string

Name of parameter

value

string

Value of parameter

records

Name Type Description

_links

_links

action

action

Actions that can be performed on the alert. To perform an action, send a POST request to the "invoke" URL with appropriate set of parameter values from the "possible_actions" list.

creation_time

string

Timestamp of the event creation.

index

integer

Index of the event. Returned by default.

last_update_time

string

Timestamp of the last update to the alert.

log_message

string

A formatted text string populated with parameter details. Returned by default.

message

message

node

node

parameters

array[parameters]

A list of parameters provided with the EMS event.

source

string

Source

state

string

Indicates the event state. A stateful event tracks the state changes of a system condition and reflects the current system condition.

stateful

boolean

Indicates whether the event is stateful. A stateful event tracks the state changes of a system condition and reflects the current system condition while a stateless event simply reports a certain system condition that has occurred sometime in the past.

time

string

Timestamp of the event. Returned by default.

uuid

string

The UUID that uniquely identifies the alert.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.