Documentation
Table of Contents
task.get
Description
integer/array task.get(object parameters)
La méthode permet de récupérer des tâches en fonction des paramètres donnés. La méthode renvoie des détails uniquement sur les tâches d''informations de diagnostic'.
Cette méthode est seulement disponible pour les utilisateurs du type Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôle d'utilisateur. Voir Rôles utilisateur pour plus d'informations.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants. |Paramètre|Type|Description| |--|--|------| |taskids|string/array|Renvoie uniquement les tâches avec les ID donnés.| |output|query|Ces paramètres étant communs à toutes les méthodes get sont décrits en détail dans le commentaire de référence.| |preservekeys|boolean|^|
Valeurs retournées
(integer/array) Retourne un tableau d'objets.
Exemples
Récupérer d'une tâche par ID
Récupérez toutes les données sur la tâche avec l'ID "1".
Requête :
{
"jsonrpc": "2.0",
"method": "task.get",
"params": {
"output": "extend",
"taskids": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"taskid": "1",
"type": "7",
"status": "3",
"clock": "1601039076",
"ttl": "3600",
"proxy_hostid": null,
"request": {
"alerting": {
"stats": [
"alerts"
],
"top": {
"media.alerts": 10
}
},
"lld": {
"stats": "extend",
"top": {
"values": 5
}
}
},
"result": {
"data": {
"alerting": {
"alerts": 0,
"top": {
"media.alerts": []
},
"time": 0.000663
},
"lld": {
"rules": 0,
"values": 0,
"top": {
"values": []
},
"time": 0.000442
}
},
"status": "0"
}
}
],
"id": 1
}Voir également
Source
CTask::get() dans ui/include/classes/api/services/CTask.php.