/mgmt/status/default/SystemMemoryStatus GET

Use the HTTP GET method with the /mgmt/status/default/SystemMemoryStatus resource to request information about memory usage on the appliance.

Resource URL

https://host:port/mgmt/status/default/SystemMemoryStatus
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about memory usage and contains the following fields:
MemoryUsage
Integer.
The instantaneous memory usage as a percentage of the total memory.
TotalMemory
Integer.
The total memory of the system in megabytes. The total memory equals the amount of installed memory minus the amount of reserved memory.
UsedMemory
Integer.
The amount of memory that is currently in use. The used memory equals the amount of total memory minus the amount of free memory. The used memory does not include any hold memory.
FreeMemory
Integer.
The amount of memory that is currently not in use and is therefore available. The free memory value includes any hold memory that is not currently in use.

Examples

The following example requests information about memory usage on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/SystemMemoryStatus
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/SystemMemoryStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/SystemMemoryStatus"
    }
  },
  "SystemMemoryStatus": {
    "MemoryUsage": 3,
    "TotalMemory": 193638,
    "UsedMemory": 4955,
    "FreeMemory": 188683
  }
}