AE REST API – Integritätsprüfung

DieAE -REST-API bietet zwei verschiedene Statusprüfungen:

  • eine schnelle /ping-Anfrage, die von HTTP/HTTPS-Proxys verwendet werden soll, um sicherzustellen, dass der REST-Knoten verfügbar ist

  • eine Zustandsprüfung der Systeminformation mit Details zum System

Diese Seite beinhaltet Folgendes:

Ping-Statusprüfung

Überprüfen, ob die AE-REST-API verfügbar ist, um nachfolgend eine Anfrage zu senden.

Anfrage: GET http://{host}:{port}/ae/api/v1/ping

Hinweise:

  • Keine Mandanteninformationen in URI erforderlich

  • Keine AE-Anmeldeinformationen/Standardauthentifizierung erforderlich

Beispiel: http://my-jcp-host:8088/ae/api/v1/ping

HTTP 200-Antwort: Keine Payload.

Systemstatusprüfung

Systeminformationen von AE erhalten, oder prüfen , ob der JCP/die REST-API verfügbar sind.

Anfragen: GET http://{host}:{port}/ae/api/v1/{client}/system/health

Beispiel: http://my-jcp-host:8088/ae/api/v1/8001/system/health

HTTP 200-Antwort: 

{  
   "status": "UP",
   "pwp": {
      "status": "UP",
      "instancesRunning": 1
    },  
    "wp": {    
       "status": "UP",
       "instancesRunning": 4  
    },  
    "jwp": {
       "status": "UP",
       "instancesRunning": 1  
    },  
    "jcp": {
       "status": "UP",
       "instancesRunning": 1  
    },  
    "rest": {
       "status": "UP",
       "instancesRunning": 1  
    },  
    "cp": {
       "status": "UP",
       "instancesRunning": 2  
    }
}

Das System fordert nicht, dass alle Prozesse ausgeführt werden, sondern nur eine Mindestzahl. Wenn sie ausgeführt werden, gibt das System die Antwort HTTP 200 ok zurück und der Status auf oberster Ebene ist UP. Die Antwort enthält eine Liste aller Prozesse und der Anzahl der ausgeführten Instanzen.

Wenn mindestens einer der minimal erforderlichen Prozesse nicht ausgeführt wird, gibt das System die Antwort HTTP 503-Dienst nicht verfügbar zurück und der Status auf oberster Ebene ist DOWN. In diesem Fall enthält die Antwort auch eine Liste aller Prozesse und der Anzahl der ausgeführten Instanzen, sogar diejenigen mit null (0) Instanzen.

Die mindestens erforderlichen Prozesse sind:

  • PWP = 1 (genau)
  • WP = 0, N
  • JWP = 1, N
  • JCP = 1, N
  • CP = 0, N
  • REST = 1, N

Hinweis: Abhängig von den Versionen Ihrer Agenten benötigen Sie möglicherweise nur Java-Kommunikationsprozesse (JCP) oder Kommunikationsprozesse (CP). Agenten, die unter Version 21.0 ausgeführt werden, stellen eine Verbindung zu JCP herstellen; Agenten, die auf älteren Versionen ausgeführt werden, stellen weiterhin eine Verbindung zu einem CP her.

Sie können auch das Suffix ?details=true zur Anfrage-URL hinzufügen, um weitere Informationen über Ihr System zu erhalten.

Anfragen: GET http://{host}:{port}/ae/api/v1/{client}/system/health?details=true

Beispiel: http://my-jcp-host:8088/ae/api/v1/8001/system/health?details=true

HTTP 200-Antwort: 

{
  "status": "UP",
   "count_active_executions": 0,
   "pwp":
   {
      "status": "UP",
      "instancesRunning": 1,
      "available": [
      {
         "name": "AUTOMIC#WP002",
         "count_of_connections": 9,
         "last_life_sign": "2020-02-12 13:57:54"
      }
      ],
      "unavailable": []
   },
   "wp":
   {
      "status": "UP",
      "instancesRunning": 4,
      "available": [
         {
            "name": "AUTOMIC#WP003",
            "count_of_connections": 5,
            "last_life_sign": "2020-02-12 13:57:48"
         },
         {
            "name": "AUTOMIC#WP004",
            "count_of_connections": 5,
            "last_life_sign": "2020-02-12 13:57:49"
         },
         {
            "name": "AUTOMIC#WP005",
            "count_of_connections": 5,
            "last_life_sign": "2020-02-12 13:57:51"
        },
        {
           "name": "AUTOMIC#WP006",
           "count_of_connections": 5,
           "last_life_sign": "2020-02-12 13:57:53"
        }
      ],
      "unavailable": []
   },
  "jwp":
  {
     "status": "UP",
     "instancesRunning": 1,
     "available": [
        {
           "name": "AUTOMIC#WP001",
           "count_of_connections": 0,
           "last_life_sign": "2020-02-12 13:57:46"
        }
     ],
     "unavailable": []
   },   ...}

In diesem Fall sind folgende Informationen ebenfalls enthalten:

  • count_active_executions

    Anzahl der noch aktiven bzw. noch nicht beendeten Ausführungen.

    Eine hohe oder zunehmende Anzahl von Ausführungen kann darauf hinweisen, dass das System sie nicht entsprechend verarbeiten kann.

  • available/unavailable

    Liste der verfügbaren/nicht verfügbaren Prozesse.

    Anhand dieser Informationen können Sie erkennen, ob alle installierten Prozesse wie geplant im System verfügbar sind.

  • count_of_connections

    Anzahl der internen und externen Verbindungen.

    • CP/JCP: Beinhaltet Verbindungen zu Benutzern und Agenten
    • REST: Beinhaltet Verbindungen zu REST-Mandanten 

    Zu viele oder zu wenige Verbindungen können auf Probleme und/oder Engpässe im System hinweisen.

  • last_life_sign

    Zeitstempel des letzten Lebenszykluszeichens des Prozesses.

    Wenn der Zeitstempel nicht regelmäßig durch den Prozess aktualisiert wird, funktioniert er nicht richtig, da er nicht in der Lage war, den Zeitstempel zu aktualisieren.

Siehe auch: