Oggetto task
I seguenti oggetti sono direttamente correlati all'API task.
Task
L'oggetto task ha le seguenti proprietà:
| Property | Type | Description |
|---|---|---|
| taskid | ID | ID del task. Property behavior: - sola lettura |
| type | integer | Tipo del task. Valori possibili: 1 - Informazioni diagnostiche; 2 - Aggiorna configurazione proxy; 6 - Esegui ora. Gli utenti di tipo Admin e User possono creare solo task di tipo "Esegui ora". Si noti che task.get restituisce sempre "7" (Riepilogo esecuzione task).Property behavior: - obbligatorio |
| status | integer | Stato del task. Valori possibili: 1 - nuovo task; 2 - task in corso; 3 - task completato; 4 - task scaduto. Property behavior: - sola lettura |
| clock | timestamp | Ora in cui il task è stato creato. Property behavior: - sola lettura |
| ttl | integer | Tempo in secondi dopo il quale il task scade. Property behavior: - sola lettura |
| proxyid | ID | ID del proxy per il quale vengono raccolte le statistiche delle informazioni diagnostiche. Property behavior: - supportato se type è impostato su "Informazioni diagnostiche" o "Aggiorna configurazione proxy" |
| request | object | Oggetto richiesta del task in base al tipo di task: L'oggetto del task "Esegui ora" è descritto in dettaglio di seguito; L'oggetto del task "Aggiorna configurazione proxy" è descritto in dettaglio di seguito; L'oggetto del task "Informazioni diagnostiche" è descritto in dettaglio di seguito. Property behavior: - obbligatorio |
| result | object | Oggetto risultato del task di informazioni diagnostiche. Può contenere NULL se il risultato non è ancora pronto. L'oggetto risultato è descritto in dettaglio di seguito. Property behavior: - sola lettura |
Oggetto della richiesta 'Execute now'
L'oggetto della richiesta del task 'Execute now' ha le seguenti proprietà.
| Proprietà | Tipo | Descrizione |
|---|---|---|
| itemid | ID | ID di item e regole di low-level discovery. Gli utenti di tipo Admin e User possono eseguire 'Execute now' sugli item dei host per i quali dispongono del permesso in lettura-scrittura, oppure del permesso in sola lettura con l'azione invoke_execute_now abilitata per il loro ruolo. Lo stesso vale per gli utenti di tipo Admin per le regole di low-level discovery (LLD). |
Oggetto richiesta 'Refresh proxy configuration'
L'oggetto richiesta del task 'Refresh proxy configuration' ha le seguenti proprietà.
| Proprietà | Type | Descrizione |
|---|---|---|
| proxyids | array | ID dei proxy. |
Oggetto richiesta 'Informazioni diagnostiche'
L'oggetto richiesta dell'attività di informazioni diagnostiche ha le seguenti proprietà. L'oggetto richiesta delle statistiche per tutti i tipi di proprietà è descritto in dettaglio di seguito.
| Proprietà | Tipo | Descrizione |
|---|---|---|
| historycache | object | Richiesta di statistiche della cache della cronologia. Disponibile su server e proxy. |
| valuecache | object | Richiesta di statistiche della cache degli item. Disponibile sul server. |
| preprocessing | object | Richiesta di statistiche del gestore di preprocessing. Disponibile su server e proxy. |
| alerting | object | Richiesta di statistiche del gestore degli avvisi. Disponibile sul server. |
| lld | object | Richiesta di statistiche del gestore LLD. Disponibile sul server. |
Oggetto di richiesta delle statistiche
L'oggetto di richiesta delle statistiche viene utilizzato per definire quale tipo di informazioni deve essere raccolto sui processi interni di server/proxy. Ha le seguenti proprietà.
| Property | Type | Description |
|---|---|---|
| stats | query | Proprietà dell'oggetto statistico da restituire. L'elenco dei campi disponibili per ciascun tipo di statistica delle informazioni diagnostiche è descritto in dettaglio di seguito. Predefinito: extend restituirà tutti i campi statistici disponibili. |
| top | object | Oggetto per ordinare e limitare i valori statistici restituiti. L'elenco dei campi disponibili per ciascun tipo di statistica delle informazioni diagnostiche è descritto in dettaglio di seguito. Esempio: { “source.alerts”: 10 } |
Elenco dei campi statistici disponibili per ciascun tipo di richiesta di informazioni diagnostiche
I seguenti campi statistici possono essere richiesti per ciascun tipo di proprietà della richiesta di informazioni diagnostiche.
| Tipo diagnostico | Campi disponibili | Descrizione |
|---|---|---|
| historycache | items | Numero di item nella cache. |
| values | Numero di valori nella cache. | |
| memory | Statistiche della memoria condivisa (spazio libero, numero di blocchi utilizzati, numero di blocchi liberi, dimensione massima del blocco libero). | |
| memory.data | Statistiche della memoria condivisa della cache dei dati storici. | |
| memory.index | Statistiche della memoria condivisa della cache dell'indice storico. | |
| valuecache | items | Numero di item nella cache. |
| values | Numero di valori nella cache. | |
| memory | Statistiche della memoria condivisa (spazio libero, numero di blocchi utilizzati, numero di blocchi liberi, dimensione massima del blocco libero). | |
| mode | Modalità della cache dei valori. | |
| preprocessing | values | Numero di valori in coda. |
| preproc.values | Numero di valori in coda con passaggi di preprocessing. | |
| alerting | alerts | Numero di avvisi in coda. |
| lld | rules | Numero di regole in coda. |
| values | Numero di valori in coda. |
Elenco dei campi di ordinamento disponibili per ciascun tipo di richiesta di informazioni diagnostiche
I seguenti campi statistici possono essere utilizzati per ordinare e limitare le informazioni richieste.
| Tipo diagnostico | Campi disponibili | Tipo |
|---|---|---|
| historycache | values | integer |
| valuecache | values | integer |
| request.values | integer | |
| preprocessing | values | integer |
| alerting | media.alerts | integer |
| source.alerts | integer | |
| lld | values | integer |
Oggetto risultato statistico
L'oggetto risultato statistico viene recuperato nel campo result dell'oggetto task.
| Proprietà | Tipo | Descrizione |
|---|---|---|
| status | integer | Stato del risultato del task. Valori possibili: -1 - si è verificato un errore durante l'esecuzione del task; 0 - il risultato del task è stato creato. Comportamento della proprietà: - sola lettura |
| data | string/object | Risultati in base all'oggetto richiesta statistica del particolare task di informazioni diagnostiche. Contiene una stringa con il messaggio di errore se si è verificato un errore durante l'esecuzione del task. |