Task-Objekt
Die folgenden Objekte stehen in direktem Zusammenhang mit der task-API.
Task
Das Task-Objekt hat die folgenden Eigenschaften:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| taskid | ID | ID der Task. Eigenschaftsverhalten: - schreibgeschützt |
| type | integer | Typ der Task. Mögliche Werte: 1 - Diagnoseinformationen; 2 - Proxy-Konfiguration aktualisieren; 6 - Jetzt ausführen. Benutzer der Typen Admin und User können nur Tasks vom Typ „Jetzt ausführen“ erstellen. Beachten Sie, dass task.get immer „7“ (Zusammenfassung der Task-Ausführung) zurückgibt.Eigenschaftsverhalten: - erforderlich |
| status | integer | Status der Task. Mögliche Werte: 1 - neue Task; 2 - Task in Bearbeitung; 3 - Task ist abgeschlossen; 4 - Task ist abgelaufen. Eigenschaftsverhalten: - schreibgeschützt |
| clock | timestamp | Zeitpunkt, zu dem die Task erstellt wurde. Eigenschaftsverhalten: - schreibgeschützt |
| ttl | integer | Die Zeit in Sekunden, nach der die Task abläuft. Eigenschaftsverhalten: - schreibgeschützt |
| proxyid | ID | ID des Proxy, über den Statistiken zu Diagnoseinformationen erfasst werden. Eigenschaftsverhalten: - unterstützt, wenn type auf „Diagnoseinformationen“ oder „Proxy-Konfiguration aktualisieren“ gesetzt ist |
| request | object | Task-Anfrageobjekt entsprechend dem Task-Typ: Das Objekt der Task „Jetzt ausführen“ wird weiter unten ausführlich beschrieben; das Objekt der Task „Proxy-Konfiguration aktualisieren“ wird weiter unten ausführlich beschrieben; das Objekt der Task „Diagnoseinformationen“ wird weiter unten ausführlich beschrieben. Eigenschaftsverhalten: - erforderlich |
| result | object | Ergebnisobjekt der Task für Diagnoseinformationen. Kann NULL enthalten, wenn das Ergebnis noch nicht bereit ist. Das Ergebnisobjekt wird weiter unten ausführlich beschrieben. Eigenschaftsverhalten: - schreibgeschützt |
Anfrageobjekt für „Jetzt ausführen“
Das Aufgaben-Anfrageobjekt „Jetzt ausführen“ hat die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| itemid | ID | ID von Datenpunkten und Low-Level-Discovery-Regeln. Benutzer des Typs Admin und User können Datenpunkte auf Hosts „Jetzt ausführen“, für die sie über Lese-/Schreib- Berechtigung verfügen oder über Lese-Berechtigung und die Aktion invoke_execute_now für ihre Rolle aktiviert ist. Dasselbe gilt für Benutzer des Typs Admin bei Low-Level-Discovery-(LLD-)Regeln. |
Anforderungsobjekt „Refresh proxy configuration“
Das Anforderungsobjekt der Aufgabe „Refresh proxy configuration“ hat die folgenden Eigenschaften.
| Eigenschaft | Type | Beschreibung |
|---|---|---|
| proxyids | array | Proxy-IDs. |
Anfrageobjekt „Diagnoseinformationen“
Das Anfrageobjekt für die Aufgabe „Diagnoseinformationen“ hat die folgenden Eigenschaften. Das Statistik-Anfrageobjekt für alle Eigenschaftstypen wird weiter unten ausführlich beschrieben.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| historycache | object | Statistik-Anfrage für den Verlaufscache. Verfügbar auf Server und Proxy. |
| valuecache | object | Statistik-Anfrage für den Datenpunkt-Cache. Verfügbar auf Server. |
| preprocessing | object | Statistik-Anfrage für den Präprozessierungsmanager. Verfügbar auf Server und Proxy. |
| alerting | object | Statistik-Anfrage für den Alarmmanager. Verfügbar auf Server. |
| lld | object | Statistik-Anfrage für den LLD-Manager. Verfügbar auf Server. |
Objekt für Statistikabfragen
Das Objekt für Statistikabfragen wird verwendet, um festzulegen, welche Art von Informationen über interne Prozesse von Server/Proxy erfasst werden soll. Es hat die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| stats | query | Eigenschaften des Statistikobjekts, die zurückgegeben werden sollen. Die Liste der verfügbaren Felder für jeden Typ von Statistiken zu Diagnoseinformationen wird weiter unten im Detail beschrieben. Standard: extend gibt alle verfügbaren Statistikfelder zurück. |
| top | object | Objekt zum Sortieren und Begrenzen der zurückgegebenen Statistikwerte. Die Liste der verfügbaren Felder für jeden Typ von Statistiken zu Diagnoseinformationen wird weiter unten im Detail beschrieben. Beispiel: { “source.alerts”: 10 } |
Liste der Statistikfelder, die für jeden Typ von Diagnoseinformationsanfrage verfügbar sind
Die folgenden Statistikfelder können für jede Eigenschaft eines Typs von Diagnoseinformationsanfrage angefordert werden.
| Diagnosetyp | Verfügbare Felder | Beschreibung |
|---|---|---|
| historycache | items | Anzahl der zwischengespeicherten Datenpunkte. |
| values | Anzahl der zwischengespeicherten Werte. | |
| memory | Statistiken zum Shared Memory (freier Speicherplatz, Anzahl verwendeter Blöcke, Anzahl freier Blöcke, maximale Größe eines freien Blocks). | |
| memory.data | Shared-Memory-Statistiken des Verlaufsdatencaches. | |
| memory.index | Shared-Memory-Statistiken des Verlaufsindexcaches. | |
| valuecache | items | Anzahl der zwischengespeicherten Datenpunkte. |
| values | Anzahl der zwischengespeicherten Werte. | |
| memory | Statistiken zum Shared Memory (freier Speicherplatz, Anzahl verwendeter Blöcke, Anzahl freier Blöcke, maximale Größe eines freien Blocks). | |
| mode | Modus des Wertecaches. | |
| preprocessing | values | Anzahl der Werte in der Warteschlange. |
| preproc.values | Anzahl der Werte in der Warteschlange mit Vorverarbeitungsschritten. | |
| alerting | alerts | Anzahl der Benachrichtigungen in der Warteschlange. |
| lld | rules | Anzahl der Regeln in der Warteschlange. |
| values | Anzahl der Werte in der Warteschlange. |
Liste der Sortierfelder, die für jeden Typ von Diagnoseinformationsanfrage verfügbar sind
Die folgenden Statistikfelder können verwendet werden, um angeforderte Informationen zu sortieren und zu begrenzen.
| Diagnosetyp | Verfügbare Felder | Typ |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
Statistik-Ergebnisobjekt
Das Statistik-Ergebnisobjekt wird im Feld result des task-Objekts abgerufen.
| Eigenschaft | Type | Beschreibung |
|---|---|---|
| status | integer | Status des task-Ergebnisses. Mögliche Werte: -1 - während der Ausführung des task ist ein Fehler aufgetreten; 0 - das task-Ergebnis wurde erstellt. Property behavior: - read-only |
| data | string/object | Ergebnisse entsprechend dem Statistik-Anfrageobjekt der jeweiligen Diagnoseinformationstask. Enthält eine Fehlerzeichenfolge, wenn während der Ausführung des task ein Fehler aufgetreten ist. |