cluster/filesystems/health/events: GET

Gets details about file system health events that are reported in a cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET cluster/filesystems/health/events request gets information about the system health events that are reported in the specified cluster. For more information about the fields in the data structures that are returned, see the topics mmhealth command and mmces command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/cluster/filesystems/health/events

where

filesystem/filesystem_name: Specifies the file systems about which you want to get information. Required.
health/events: Specifies that you need to get the details of the system health events reported on the cluster. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
filter	Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'	Optional.
name	Name of the node.	Required.

Request data

No request data.

Response data

{
  "events" : [ {
    "activeSince" : "2025-01-20 16:38:50.077863 CET",
    "arguments" : "afmCacheFS",
    "component" : "FILESYSTEM",
    "entityName" : "afmCacheFS",
    "entityType" : "FILESYSTEM",
    "eventtype" : "INFO_ADD_ENTITY",
    "fullidentifier" : "317908494530258156/1/filesystem//afmCacheFS",
    "identifier" : "afmCacheFS",
    "ishidden" : "no",
    "message" : "File system afmCacheFS was found.",
    "node" : "scale-11.vmlocal",
    "severity" : "INFO"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}

For more information about the fields in the following data structures, see the links at the end of this topic.

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"paging": The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.

"events":

An array of elements that describe the system health event. Each element describes one node.

activeSince" : "2025-01-20 16:38:50.077863 CET: Since when the event active.
arguments" : "afmCacheFS": File system on a cluster.
"component":"Component": The component to which the event belongs.
"entityName":" Name": The name of the entity for which the event occurred.
"entityType":"Entity Type": The type of the entity for which the event occurred.
"eventtype":"Entity Type": The type of the entity for which the event occurred.
"fullidentifier" : "317908494530258156/1/filesystem//afmCacheFS"
"identifier" : "afmCacheFS": Identifier of a file system.
"message" : "File system afmCacheFS was found.": A message when a file system found.
"node" : "scale-11.vmlocal": A node.
"severity" : "INFO": Information about event severity.
"description":" Description: Description of the event.
"state":"Event State: The state of the event.

Examples

The following example gets information about the events reported in the cluster.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://localhost:443/scalemgmt/v2/cluster/filesystems/afmCacheFS/health/events

Response data:

Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.

{
  "events" : [ {
    "activeSince" : "2025-01-20 16:38:50.077863 CET",
    "arguments" : "afmCacheFS",
    "component" : "FILESYSTEM",
    "entityName" : "afmCacheFS",
    "entityType" : "FILESYSTEM",
    "eventtype" : "INFO_ADD_ENTITY",
    "fullidentifier" : "317908494530258156/1/filesystem//afmCacheFS",
    "identifier" : "afmCacheFS",
    "ishidden" : "no",
    "message" : "File system afmCacheFS was found.",
    "node" : "scale-11.vmlocal",
    "severity" : "INFO"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}