Nodes/{name}/info/memory: GET

Displays the details on GPFS daemon process (mmfsd) memory usage for the specified node.

Availability

Available on all IBM Storage Scale editions.

Description

The GET scalemgmt/v2/nodes/{name}/info/memory request gets the details on GPFS daemon process (mmfsd) memory usage for the specified node. The distinct memory regions that are allocated and used by mmfsd are listed by this method. For more information about the fields in the returned data structure, see mmdiag command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/nodes/{name}/info/ memory
where
nodes
Specifies the resource for the GET request. Required.
memory
Specifies the information that is requested.

Request headers

Accept: application/json

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
name The name of the node. Required.

Request data

No request data.

Response data

"mmDiagMemory"{
  "memoryHeap": [
    {
      "inUse": "string",
      "payload": string ,
      "size": time,
      }
 ],        
  "memoryPool": [
            {
                "allocationFailures": "string",
                "hardLimit": "string"
                "id": "string"
                "inUse": "string"
                "regions": "string"
            }
        ]
    }
  "status": {
    "code": ReturnCode,
    "message": "ReturnMessage."
  }
}

The details of the parameters are provided in the following list:

mmDiagMemory
"memoryHeap"
An array of all the memory heap details.
"inUse":"size "
The size of memory in use.
"payload":"size"
The payload size.
"size":"size"
The memory size.
memoryPool
The memory area that is used for caching various kinds of internal GPFS metadata.
"allocationFailures":""
Specifies whether there are any prior allocation failures.
"hardLimit":"Limit"
The preset limit for memory usage.
"id":"Id "
The memory pool ID.
"inUse":"size"
The size of memory pool in use.
"regions":"Memory region "
The memory regions that are allocated for MMFSD use.

Examples

The following example lists the memory usage details.

Request data:
curl -k -u user:password -X GET --header 'accept:application/json' --header 'Authorization: Basic YWRtaW46YWRtaW4wMDE=' 'https://198.51.100.1:443/scalemgmt/v2/nodes/access-41/info/memory
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. 
{
    "mmDiagMemory": {
        "memoryHeap": [
            {
                "inUse": "84173048",
                "payload": "82777837",
                "size": "4399104"
            }
        ],
        "memoryPool": [
            {
                "allocationFailures": "0",
                "allocations": "398",
                "committedToRegions": "1048576",
                "frees": "398",
                "hardLimit": "5421044660",
                "id": "1",
                "inUse": "128",
                "regions": "1"
            }
        ]
    },
    "status": {
        "code": 200,
        "message": "The request finished successfully."
    }
}