DE EN EN (Google)

Retrieve status information about the server

GET /api/v1/plugin/base/server/status?token=<token>

Retrieves status information about a the server, including information about external components such as EAS and Elasticsearch.

Query String
token Session token acquired with /api/v1/session

Output

The status information is saved in a JSON object. It contains the current server time and four groups of information.

{
  "info_groups": [
    {
      "name": "system",
      "info": [ ... ]
    },
  {
      "name": "index",
      "info": [ ... ]
    },
  {
      "name": "eas",
      "info": [ ... ]
    },
  {
      "name": "elasticsearch",
      "info": [ ... ]
    }
  ],
  "_server_time": "2018-05-25T02:28:00+02:00"
}

The information is saved in a map, with an array data that contains the values, and an optional object headers that contains the corresponding header names.

{
  "type": "2d-map",
  "name": "indexer_stats_by_status",
  "headers": {
    "values": [
      "total"
    ],
    "name": "status"
  },
  "data": [
    {
      "values": [
        12
      ],
      "type": "integer",
      "name": "count"
    },
    {
      "values": [
        5.3
      ],
      "type": "string",
      "name": "percent"
    }
  ]
}

This map describes the content of a table, that is rendered in table form in the frontend:

Status Count %
total 12 5.3

Info Group system

A collection of general server information:

Info Group index

Process

Values are grouped into number_of_processes, objects_per_batch, keep_files:

Indexer stats by status

indexer_stats_by_status

Values are grouped into count (total number) and percent. Each data row contains information about the currently running indexer jobs, grouped by status.

Indexer stats by type

indexer_stats_by_type

Values are grouped into schema, count and percent. Each data row contains information about the currently running indexer jobs, grouped by the schema and name.

Indexer stats by priority

indexer_stats_by_priority

Values are grouped into count (total number) and percent. Each data row contains information about the currently running indexer jobs, grouped by priority.

Info Group eas

General Information

Supervisor-Jobs

Counts the EAS supervisor jobs:

Partitions

Overview over the partitions on the server.

Each partition is grouped into

EAS-Jobs

Overview over the EAS jobs that are currently running. The jobs are grouped into status and count.

Info Group elasticsearch

Overview over the elasticsearch instance.

General Information

Node

For each node, the information is grouped into one map.

Permissions

The user needs the “system.server.error” right (see rights management).

HTTP status codes
200 Success
400 API error: something is malformed
400 Not Authenticated: session is not authenticated
400 No System Right: user lacks the required “system.server.error” right
400 Error Not Found: the error uuid was not found
500 Server error: internal server error

Retrieve detailed information about a server error

GET /api/v1/plugin/base/server/error/<uuid>?token=<token>

Retrieves detailed information about a server error, identified by its .

Query String
token Session token acquired with /api/v1/session

Path parameters
uuid UUID of the server error (see server errors)

Output

A JSON object containing:
code Error code (string), see server errors
description Error description (string)
timestamp Timestamp (string)
request Information about the request that provoked the error
↦ method Request method (string)
↦ url Request URL (string): the request URL will use the host provided in the headers, or “localhost” if none was provided
↦ body Request body (string)
↦ headers Request headers (string)
session Information about the session (null, if there was no session)
↦ token Session Token (string)
↦ created Timestamp of session creation (string)
↦ user Authenticated user (user in short format): this is only given if the session was successfully authenticated
log Additional information (string): this may be multiline, using the line separator \n

Permissions

The user needs the “system.server.error” right (see rights management).

HTTP status codes
200 Success
400 API error: something is malformed
400 Not Authenticated: session is not authenticated
400 No System Right: user lacks the required “system.server.error” right
400 Error Not Found: the error uuid was not found
500 Server error: internal server error

Generate an error

POST /api/v1/plugin/base/server/error/<type>?token=<token>

Returns an error of the requested type.

Query String
token Session token acquired with /api/v1/session

Path parameters
type Type of error to be generated (string): user, server or api

Permissions

The user needs the “system.root” right (see rights management).

HTTP status codes

Notice that this call never returns 200. The requested errors are:
400 API error: something is malformed, or the requested API error
400 Not Authenticated: session is not authenticated
400 No System Right: user lacks the required “system.root” right
400 User Not Found: the requested user error
500 Server error: internal server error, or the requested server error