task.get

Descrição

integer/array task.get(object parameters)

O método permite recuperar tarefas de acordo com os parâmetros fornecidos.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
taskids	ID/array	Retorna apenas tarefas com os IDs fornecidos.
output	query	Esses parâmetros são descritos no comentário de referência.
preservekeys	boolean	Esses parâmetros são descritos no comentário de referência.

Valores de retorno

(integer/array) Retorna um array de objetos.

Exemplos

Recuperar tarefa por ID

Recupera todos os dados sobre a tarefa com o ID "1".

Requisição:

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

Veja também

Fonte

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

Documentation