task.get

Leírás

integer/array task.get(object parameters)

A módszer lehetővé teszi a feladatok lekérését a megadott paraméterek szerint. A módszer csak a „diagnosztikai információs” feladatokról ad vissza részleteket.

Ez a módszer csak a Super admin felhasználótípus számára érhető el. A metódus meghívására vonatkozó engedélyeket a felhasználói szerepkör beállításaiban lehet visszavonni. Lát Felhasználó roles további információért.

Paraméterek

(object) A kívánt kimenetet meghatározó paraméterek.

A módszer a következő paramétereket támogatja.

Paraméter Típus Leírás
taskids string/array Csak a megadott azonosítókkal rendelkező feladatokat adja vissza.
output query Ezek a paraméterek, amelyek minden get metódusnál közösek, a referenciakommentár részben találhatók.
preservekeys boolean

Visszatérési értékek

(egész szám/tömb) Objektumok tömbjét adja vissza.

Példák

Retrieve task by ID

Retrieve all the data about the task with the ID "1".

Request:

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

Response:

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

Lásd még

Forrás

CTask::get() az ui/include/classes/api/services/CTask.php-ban.