task.get

描述

integer/array task.get(object parameters)

该方法允许根据给定参数检索任务。 该方法仅返回关于"诊断信息"任务的详细信息。

此方法仅适用于超级管理员用户类型。 调用该方法的权限可以在用户角色设置中撤销。有关更多信息,请参阅 User roles

参数

(object) 定义期望输出的参数。

该方法支持以下参数。

参数 数据类型 描述
taskids string/array 仅返回具有指定ID的任务。
output query 这些参数在通用get方法参数中有详细说明。
preservekeys boolean

返回值

(integer/array) 返回一个array的objects。

示例

按ID检索任务

获取ID为"1"的任务的所有数据。

请求:

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

响应:

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

另请参阅

来源

CTask::get() 位于 ui/include/classes/api/services/CTask.php 文件中。