Come specificare le richieste ai servizi REST TEMS

Introduzione ai servizi REST TEMS.

I chiamanti interagiscono con i servizi REST del Tivoli Enterprise Monitoring Server (TEMS) utilizzando le chiamate REST HTTP. I possibili chiamanti sono basati sulla riga di comando (come curl ), applicazioni del browser web, applicazioni front-end o chiamanti programmatici creati con OpenAPI Generator. Il percorso di base per i servizi REST TEMS è il seguente:

https://host:port/api/version

Dove la porta è la porta HTTP o HTTPS nota per Tivoli® Management Services on z/OS®, come definita nel vostro sito.

La versione v1 dei servizi REST TEMS fornisce i seguenti tipi di endpoint:

Endpoint GET che consentono l'accesso in sola lettura ai dati OMEGAMON. È possibile accedere ai seguenti tipi di informazioni utilizzando gli endpoint disponibili:
- Dati di raccolta: dati in tempo reale e storia a breve termine dall'archivio dati persistente
  Nota: i servizi REST TEMS non supportano il richiamo dei dati da Tivoli Data Warehouse.
- Configurazioni di raccolta della cronologia, che definiscono quali dati storici vengono raccolti
- Dati del sistema gestito: applicazioni, gruppi, nodi, tabelle, record di agenti autodescrittivi e definizioni di comandi Take Action. I percorsi per gli endpoint di dati del sistema gestito includono /system nell'indirizzo.
- Definizioni e stati della situazione
POST endpoint che consentono di eseguire un'attività. È possibile eseguire le seguenti attività utilizzando gli endpoint disponibili:
- Avviare e interrompere una situazione
- Eseguire un'azione
PATCH endpoint che consente di modificare le situazioni e le definizioni delle azioni
PUT endpoint che consente di creare situazioni e definizioni di azioni
DELETE endpoint che consentono di eliminare situazioni, definizioni di azioni e configurazioni di raccolta della cronologia

Tutti i percorsi di richiesta e le risposte disponibili sono disponibili nel documento OpenAPI.

Terminologia dei servizi REST TEMS

La comprensione dei termini seguenti e del modo in cui sono correlati a OMEGAMON e al server di monitoraggio consentirà di accelerare l'avvio dei servizi REST TEMS.

applicazione: L'applicazione è il codice prodotto dell'agent.
affinità: L'affinità dell'agent è un identificativo interno di Tivoli Monitoring che associa aree di lavoro, query e altri elementi all'agent. Deve essere un valore univoco nell'installazione di Tivoli Monitoring.
gruppo: Una serie definita di risorse (nodi) utilizzata per controllare l'ambito della raccolta dati.
nodo: Un token univoco utilizzato per l'identificazione dell'agent, utilizzato nella raccolta dati per identificare un agent che esegue il monitoraggio di un sistema o di un sottosistema.
tabella: Una struttura dati composta da righe e colonne utilizzata dal server di monitoraggio e dagli agent di monitoraggio per memorizzare i dati di raccolta.

Utilizzo dei valori di tempo per le richieste

È possibile utilizzare i valori di tempo quando si effettuano richieste per i dati di raccolta o gli stati delle situazioni:

Dati di raccolta

Quando si richiedono i dati di raccolta utilizzando l'endpoint GET /data , sono disponibili due tipi di dati di raccolta: i dati in tempo reale e la cronologia a breve termine dall'archivio dati permanenti. Per richiedere i dati cronologici a breve termine, è necessario specificare i valori di tempo come parte della richiesta GET /data . Se non si specificano valori di tempo, la richiesta restituisce dati in tempo reale.

Per l'endpoint GET /data , i valori temporali vengono specificati utilizzando i parametri timeFrom e timeTill. Quando si richiedono i dati cronologici, è necessario fornire un'ora di inizio e un'ora di fine per la richiesta. Se si specifica il parametro timeFrom da solo, il valore predefinito del parametro timeTill è l'ora corrente. Se si specifica un valore per il parametro timeTill , è necessario specificare anche un valore per il parametro timeFrom .

Cronologia dello stato della situazione

Quando si richiede la cronologia dello stato della situazione utilizzando l'endpoint GET /situations/status/history, è necessario specificare un orario di inizio da cui recuperare la cronologia dello stato della situazione utilizzando il parametro timeFrom. È inoltre possibile specificare un'ora di fine utilizzando il parametro timeTill.

Il formato per i valori di ora è composto da 16 cifre come segue: YYYMMDDHHMMSS000

dove:

AAAA è il numero di anni dall'anno 1900.
MMDDHMMSS è rispettivamente mesi, giorni, ore, minuti e secondi.
Le ultime tre cifre sono zeri.

Ad esempio, 2023 July 17, 06:34:37 viene rappresentato come segue: 1230717063437000

È possibile utilizzare l'endpoint GET /timenow per recuperare l'ora locale TEMS. La risposta restituisce il valore temporale nel formato richiesto per l'utilizzo nei parametri timeFrom e timeTill .

Richiesta:

https://host:port/api/v1/timenow

Risposta:

{
  "timenow": "1230717063437000"
}