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

Retrieves the event catalog definitions

PDFs

learn more

  • [doc /support/ems/messages](#docs-support-support_ems_messages)

GET /support/ems/messages

Retrieves the event catalog definitions.

  • event catalog show

Learn more

Parameters

Name Type In Required Description

severity

string

query

False

Filter by severity

deprecated

boolean

query

False

Filter by deprecated

description

string

query

False

Filter by description

snmp_trap_type

string

query

False

Filter by snmp_trap_type

name

string

query

False

Filter by name

corrective_action

string

query

False

Filter by corrective_action

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.

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.

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"
        }
      },
      "corrective_action": "string",
      "deprecated": 1,
      "description": "string",
      "name": "callhome.spares.low",
      "severity": "error",
      "snmp_trap_type": "standard"
    }
  ]
}

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

records

Name Type Description

_links

_links

corrective_action

string

Corrective action

deprecated

boolean

Is deprecated?

description

string

Description

name

string

Name of the event.

severity

string

Severity

snmp_trap_type

string

SNMP trap type

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.
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response