/mgmt/status/default/ServicesMemoryStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/ServicesMemoryStatus2 resource to view information about memory usage by services on the appliance.

Resource URL

https://host:port/mgmt/status/default/ServicesMemoryStatus2
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 by services. Each object contains the following fields:
serviceClass
String.
The type of service being reported on.
serviceName
String.
The name of the service.
current
Integer.
Current memory in use in megabytes.
oneMinute
Integer.
The peak memory usage by the service over the previous minute.
fiveMinutes
Integer.
The peak memory usage by the service in the interval between 1 and 5 minutes ago.
tenMinutes
Integer.
The peak memory usage by the service in the interval between 5 and 10 minutes ago.
oneHour
Integer.
The peak memory usage by the service in the interval between 10 minutes and 1 hour ago.
twelveHours
Integer.
The peak memory usage by the service in the interval between 1 and 12 hours ago.
oneDay
Integer.
The peak memory usage by the service in the interval between 12 hours and 1 day ago.
lifetime
Integer.
The peak memory usage by the service over its lifetime.

Examples

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

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/ServicesMemoryStatus2
The following listing shows an example received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/ServicesMemoryStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/ServicesMemoryStatus2"
    }
  },
  "result": "No status retrieved."
}