For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Diagnostic Service (GET)

Retrieves diagnostic information for administration, runtime, configuration (live update), and push services.

Roles

Users in the following roles are authorized to perform this operation:

• mfpadmin
• mfpdeployer
• mfpmonitor
• mfpoperator

Method

GET

Path

/management-apis/2.0/diagnostic

Example

https://www.example.com/mfpadmin/management-apis/2.0/diagnostic

Produces

application/json, application/xml, text/xml

Response

Information about the diagnostic.

JSON Example

{
  "adminDB" : {
    "status" : "available",
  },
  "analyticsService" : [
    {
      "runtime" : "mfp",
      "status" : "available",
    },
    ...
  ],
  "configService" : {
    "status" : "available",
  },
  "productVersion" : "8.0",
  "pushDiagnostic" : {
    "status" : "available",
  },
  "runningProjectStatuses" : {
    "hasAppsOrAdapter" : true,
    "name" : "mfp",
    "running" : true,
    "synchronized" : "ok",
  },
  "runtimeDiagnostic" : [
    {
      "instances" : [
        {
          "Providers" : [
            {
              "DatabaseDiagnosticBean" : {
                "message" : "Database is OK",
                "ok" : "Ok",
              },
            },
            ...
          ],
          "overallStatus" : "Ok",
        },
        ...
      ],
      "name" : "mfp",
    },
    ...
  ],
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<diagnostic-info productVersion="8.0">
  <adminDB status="available"/>
  <analyticsServiceArray>
    <analyticsService
      runtime="mfp"
      status="available"/>
    ...
  </analyticsServiceArray>
  <configService status="available"/>
  <pushDiagnostic status="available"/>
  <runningProjectStatuses
    hasAppsOrAdapter="true"
    name="mfp"
    running="true"
    synchronized="ok"/>
  <runtimeDiagnosticArray>
    <runtimeDiagnostic name="mfp">
      <instances>
        <instance overallStatus="Ok">
          <Providers>
            <Provider>
              <DatabaseDiagnosticBean
                message="Database is OK"
                ok="Ok"/>
            </Provider>
            ...
          </Providers>
        </instance>
        ...
      </instances>
    </runtimeDiagnostic>
    ...
  </runtimeDiagnosticArray>
</diagnostic-info>

Response Properties

The response has the following properties:

adminDB

Status of the administration database.

analyticsService

Status of the Analytics service.

configService

Status of the configuration service/live update service.

productVersion

The exact product version.

pushDiagnostic

Status of the push service.

runningProjectStatuses

Status of all the running projects.

runtimeDiagnostic

Runtime diagnostics of each runtime.

The admin-db has the following properties:

status

Status of the administration database.

The analytics-service has the following properties:

runtime

The name of the runtime.

status

Status of the Analytics service.

The config-service has the following properties:

status

Status of the configuration service/live update service.

The push-service has the following properties:

status

Status of the push service.

The running-project has the following properties:

hasAppsOrAdapter

Whether the project includes any applications or adapters

name

The name of the project

running

Whether the project is running

synchronized

Synchronization status of the project

The runtime-diagnostic has the following properties:

instances

Status of each runtime instance

name

The name of the runtime

The runtime-status has the following properties:

Providers

Status of each runtime instance

overallStatus

The overall status of the runtime

The providers-status has the following properties:

DatabaseDiagnosticBean

Database Diagnostics Bean status

The db-status has the following properties:

message

Database status message

ok

Database status

Errors

403

The user is not authorized to call this service.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service