Objet task

Les objets suivants sont directement liés à l’API task.

Task

L’objet task possède les propriétés suivantes :

Propriété Type Description
taskid ID ID de la tâche.

Comportement de la propriété :
- lecture seule
type integer Type de la tâche.

Valeurs possibles :
1 - Informations de diagnostic ;
2 - Actualiser la configuration du proxy ;
6 - Exécuter maintenant.

Les utilisateurs de type Admin et User ne peuvent créer que des tâches « Exécuter maintenant ».

Notez que task.get renvoie toujours « 7 » (Résumé de l’exécution de la tâche).

Comportement de la propriété :
- obligatoire
status integer Statut de la tâche.

Valeurs possibles :
1 - nouvelle tâche ;
2 - tâche en cours ;
3 - tâche terminée ;
4 - tâche expirée.

Comportement de la propriété :
- lecture seule
clock timestamp Heure de création de la tâche.

Comportement de la propriété :
- lecture seule
ttl integer Délai en secondes après lequel la tâche expire.

Comportement de la propriété :
- lecture seule
proxyid ID ID du proxy pour lequel les statistiques des informations de diagnostic sont collectées.

Comportement de la propriété :
- pris en charge si type est défini sur « Informations de diagnostic » ou « Actualiser la configuration du proxy »
request object Objet de requête de la tâche selon le type de tâche :
L’objet de la tâche « Exécuter maintenant » est décrit en détail ci-dessous ;
L’objet de la tâche « Actualiser la configuration du proxy » est décrit en détail ci-dessous ;
L’objet de la tâche « Informations de diagnostic » est décrit en détail ci-dessous.

Comportement de la propriété :
- obligatoire
result object Objet de résultat de la tâche d’informations de diagnostic.
Peut contenir NULL si le résultat n’est pas encore prêt.
L’objet de résultat est décrit en détail ci-dessous.

Comportement de la propriété :
- lecture seule

Objet de requête « Execute now »

L’objet de requête de tâche « Execute now » possède les propriétés suivantes.

Propriété Type Description
itemid ID ID de l’élément et des règles de découverte de bas niveau.

Les utilisateurs de type Admin et User peuvent « Execute now » des éléments sur les hôtes pour lesquels ils disposent d’une permission en lecture-écriture, ou d’une permission en lecture avec l’action invoke_execute_now activée pour leur rôle. Il en va de même pour les utilisateurs de type Admin concernant les règles de découverte de bas niveau (LLD).

Objet de requête « Refresh proxy configuration »

L’objet de requête de tâche « Refresh proxy configuration » possède les propriétés suivantes.

Propriété Type Description
proxyids array ID des proxys.

Objet de requête « Diagnostic information »

L’objet de requête de tâche d’informations de diagnostic possède les propriétés suivantes. L’objet de requête de statistiques pour tous les types de propriétés est décrit en détail ci-dessous.

Propriété Type Description
historycache object Requête de statistiques du cache d’historique. Disponible sur le serveur et le proxy.
valuecache object Requête de statistiques du cache des éléments. Disponible sur le serveur.
preprocessing object Requête de statistiques du gestionnaire de prétraitement. Disponible sur le serveur et le proxy.
alerting object Requête de statistiques du gestionnaire d’alertes. Disponible sur le serveur.
lld object Requête de statistiques du gestionnaire LLD. Disponible sur le serveur.
Objet de requête de statistiques

L’objet de requête de statistiques est utilisé pour définir quel type d’informations doit être collecté concernant les processus internes du serveur/proxy. Il possède les propriétés suivantes.

Propriété Type Description
stats query Propriétés de l’objet de statistiques à renvoyer.
La liste des champs disponibles pour chaque type de statistique d’informations de diagnostic est décrite en détail ci-dessous.

Par défaut : extend renverra tous les champs de statistiques disponibles.
top object Objet permettant de trier et de limiter les valeurs de statistiques renvoyées.
La liste des champs disponibles pour chaque type de statistique d’informations de diagnostic est décrite en détail ci-dessous.

Exemple : { “source.alerts”: 10 }
Liste des champs statistiques disponibles pour chaque type de requête d'informations de diagnostic

Les champs statistiques suivants peuvent être demandés pour chaque type de propriété de requête d'informations de diagnostic.

Type de diagnostic Champs disponibles Description
historycache items Nombre d'éléments en cache.
values Nombre de valeurs en cache.
memory Statistiques de mémoire partagée (espace libre, nombre de segments utilisés, nombre de segments libres, taille maximale du segment libre).
memory.data Statistiques de mémoire partagée du cache des données d'historique.
memory.index Statistiques de mémoire partagée du cache d'index d'historique.
valuecache items Nombre d'éléments en cache.
values Nombre de valeurs en cache.
memory Statistiques de mémoire partagée (espace libre, nombre de segments utilisés, nombre de segments libres, taille maximale du segment libre).
mode Mode du cache de valeurs.
preprocessing values Nombre de valeurs en file d'attente.
preproc.values Nombre de valeurs en file d'attente avec des étapes de prétraitement.
alerting alerts Nombre d'alertes en file d'attente.
lld rules Nombre de règles en file d'attente.
values Nombre de valeurs en file d'attente.
Liste des champs de tri disponibles pour chaque type de requête d’informations de diagnostic

Les champs statistiques suivants peuvent être utilisés pour trier et limiter les informations demandées.

Type de diagnostic Champs disponibles Type
historycache values integer
valuecache values integer
request.values integer
preprocessing values integer
alerting media.alerts integer
source.alerts integer
lld values integer
Objet de résultat statistique

L’objet de résultat statistique est récupéré dans le champ result de l’objet de tâche.

Propriété Type Description
status integer Statut du résultat de la tâche.

Valeurs possibles :
-1 - une erreur s’est produite lors de l’exécution de la tâche ;
0 - le résultat de la tâche est créé.

Comportement de la propriété :
- lecture seule
data string/object Résultats selon l’objet de requête statistique de la tâche d’informations de diagnostic particulière.
Contient une chaîne de message d’erreur si une erreur s’est produite lors de l’exécution de la tâche.