Sommaire
task.get
Description
integer/array task.get(object parameters)
La méthode permet de récupérer des tâches selon les paramètres fournis.
Cette méthode est disponible uniquement pour le type d’utilisateur Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles 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 | ID/array | Retourner uniquement les tâches avec les ID donnés. |
| output | query | Ces paramètres sont décrits dans le commentaire de référence. |
| preservekeys | boolean |
Valeurs retournées
(integer/array) Retourne un tableau d'objets.
Exemples
Récupérer une tâche par ID
Récupérez toutes les données concernant la tâche avec l'ID « 1 ».
{
"jsonrpc": "2.0",
"method": "task.get",
"params": {
"output": "extend",
"taskids": "1"
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"taskid": "1",
"type": "7",
"status": "3",
"clock": "1601039076",
"ttl": "3600",
"proxyid": 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 aussi
- Tâche
- Objet de requête « Exécuter maintenant »
- Objet de requête « Actualiser la configuration du proxy »
- Objet de requête « Informations de diagnostic »
Source
CTask::get() dans ui/include/classes/api/services/CTask.php.