cluster/filesystems/afmFilesets/health/state: GET

Gets details about AFM filesets health state that are reported on a cluster.

Availability

Available on all IBM Storage Scale editions.

Description

The GET cluster/filesystems/afmFilesets/health/state request gets information about the AFM fileset health state 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/afmFilesets/health/state

where

filesystem/filesystem_name: Specifies the file system about which you want to get information. Required.
afmFilesets/afm_fileset_name: Specifies the AFM filesets about which you want to get information. Required.
health/state: Specifies that you need to get the details of the fileset health state 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

{
  "states" : [ {
    "component" : "AFM",
    "entityName" : "afmCacheFS/singleWriter",
    "reasons" : [ ],
    "state" : "HEALTHY"
  } ],
  "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.

"state":

An array of elements that describe the fileset health state. Each element describes one node.

"component":"Component: The component to which the state belongs.
"message":"Message: The state message.
"entityName":" Name: The name of the entity for which the event occurred.
reasons" : "[]": The reasons of other that healthy state.
"state":"Fileset State: The state of the fileset.
"description":" Description: Description of the event.

Examples

The following example gets information about the AFM filesets reported on a cluster.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'cluster/filesystems/<filesystem_name>/afmFilesets/<afm_fileset_name>/health/state

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.

{
  "states" : [ {
    "component" : "AFM",
    "entityName" : "afmCacheFS/singleWriter",
    "reasons" : [ ],
    "state" : "HEALTHY"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }