task.get

Descripció

integer/array task.get(object parameters)

El mètode permet recuperar tasques en funció dels paràmetres donats.

Aquest mètode només és disponible per a usuaris del tipus Super admin. Els permisos per invocar el mètode es poden revocar a la configuració del rol d'usuari. Consulteu els Rols d'usuari per obtindre més informació.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents. Paràmetre Tipus Descripció
taskids ID/array Retorna només tasques amb els ID donats.
output query Aquests paràmetres es descriuen amb detall a comentaris de referència.
preservekeys boolean ^

Valors retornats

(integer/array) Retorna una matriu d'objectes.

Exemples

Recuperar la tasca per ID

Recupera totes les dades de la tasca amb l'ID "1".

Petició:

{
    "jsonrpc": "2.0",
    "method": "task.get",
    "params": {
        "output": "extend",
        "taskids": "1"
    },
    "id": 1
}

Resposta:

{
    "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
}

Veieu també

Font

CTask::get() in ui/include/classes/api/services/CTask.php.