task.get

Описание

integer/array task.get(object parameters)

Метод позволяет получать задачи в соответствии с заданными параметрами.

Этот метод доступен только для типа пользователя Super admin. Разрешения на вызов метода можно отозвать в настройках роли пользователя. См. Роли пользователей для получения дополнительной информации.

Параметры

(object) Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

Parameter Type Description
taskids ID/array Возвращать только задачи с указанными ID.
output query Эти параметры описаны в справочном комментарии.
preservekeys boolean

Возвращаемые значения

(целое число/массив) Возвращает массив объектов.

Примеры

Получение задачи по ID

Получите все данные о задаче с ID "1".

Запрос:

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

Ответ:

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

См. также

Источник

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