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

Retrieve observed events

Contributors
PDFs

GET /support/ems/events

Introduced In: 9.6

Retrieves a collection of observed events.

  • event log show

Parameters

Name Type In Required Description

log_message

string

query

False

Filter by log_message

parameters.name

string

query

False

Filter by parameters.name

parameters.value

string

query

False

Filter by parameters.value

message.severity

string

query

False

Filter by message.severity

message.name

string

query

False

Filter by message.name

source

string

query

False

Filter by source

index

integer

query

False

Filter by index

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

time

string

query

False

Filter by time

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: 1

  • 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"
        }
      },
      "index": "1",
      "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",
      "time": "string"
    }
  ]
}

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

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

index

integer

Index of the event. Returned by default.

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

time

string

Timestamp of the event. Returned by default.

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.