Documentation
Table of Contents
task.get
Descripción
integer/array task.get(object parameters)
El método permite recuperar tareas según los parámetros dados.
Este método solo está disponible para el tipo de usuario Super admin. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| taskids | ID/matriz | Devuelve sólo tareas con los ID proporcionados. |
| output | consulta | Estos parámetros, se describen en detalle en el comentario de referencia. |
| preservekeys | booleano |
Valores de retorno
(entero/matriz) Devuelve una matriz de objetos.
Ejemplos
Recuperar tarea por ID
Recupera todos los datos sobre la tarea con el ID "1".
{
"jsonrpc": "2.0",
"method": "task.get",
"params": {
"output": "extend",
"taskids": "1"
},
"id": 1
}Respuesta:
{
"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
}Véase también
- Tarea
- Objeto de solicitud 'Ejecutar ahora'
- Objeto de solicitud 'Actualizar configuración de proxy'
- Objeto de solicitud 'Información de diagnóstico'
Fuente
CTask::get() en ui/include/classes/api/services/CTask.php.