[comment]: # translation:outdated

[comment]: # ({4c82c7ad-4c82c7ad})
# 获取

[comment]: # ({/4c82c7ad-4c82c7ad})

[comment]: # ({99412dd4-ed55724c})
### 描述

`integer/array alert.get(object parameters)`

该方法允许根据给定的参数检索告警。

::: noteclassic
此方法对于任何用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看 [用户角色](/manual/web_interface/frontend_sections/administration/user_roles)。
:::

[comment]: # ({/99412dd4-ed55724c})

[comment]: # ({679c9091-218fa8cf})
### 参数

`(object)` 定义所需输出的参数。

该方法支持以下参数。

|参数|[类型](/manual/api/reference_commentary#数据类型)|描述|
|---------|---------------------------------------------------|-----------|
|alertids|string/array|仅返回给定 ID 的告警。|
|actionids|string/array|仅返回给定动作生成的告警。|
|eventids|string/array|仅返回给定事件生成的告警。|
|groupids|string/array|仅返回来自指定主机组的对象生成的告警。|
|hostids|string/array|仅返回来自指定主机的对象生成的告警。|
|mediatypeids|string/array|仅返回使用给定媒介类型的消息告警。|
|objectids|string/array|仅返回指定对象生成的告警。|
|userids|string/array|仅返回发送给指定用户的消息告警。|
|eventobject|integer|仅返回由与给定类型的对象相关的事件生成的告警。<br><br>参考 event ["object"](/manual/api/reference/event/object#事件) 获取受支持的对象类型列表。<br><br>默认： 0 - 触发器。|
|eventsource|integer|仅返回由给定类型的事件生成的告警。<br><br>参考 event ["source"](/manual/api/reference/event/object#事件) 获取受支持的事件类型列表。<br><br>默认： 0 - 触发器事件。|
|time\_from|timestamp|仅返回在给定时间之后生成的告警。|
|time\_till|timestamp|仅返回在给定时间之前生成的告警。|
|selectHosts|query|在 [hosts](/manual/api/reference/host/object) 属性中返回触发动作操作的主机。|
|selectMediatypes|query|在 [mediatypes](/manual/api/reference/mediatype/object) 属性中以数组形式返回消息告警的媒介类型。|
|selectUsers|query|在 [users](/manual/api/reference/user/object) 属性中以数组形式返回消息发送到的用户。|
|sortfield|string/array|根据给定的属性排序结果。<br><br>可用值： `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto` 和 `status`。|
|countOutput|boolean|这些参数对于所有 `get` 方法都是通用的，在 [参考说明](/manual/api/reference_commentary#通用get方法参数) 进行了描述。|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/679c9091-218fa8cf})

[comment]: # ({7223bab1-7223bab1})
### 返回值

`(integer/array)` 返回以下任一选项：

-   对象数组；
-   如果使用了 `countOutput` 参数，则检索对象的计数。

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({1d7d6df6-8d56d57c})
#### 通过动作 ID 检索告警

返回所有动作 ID 为"3"的告警。

请求：

```json
{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

响应：

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "alertid": "1",
            "actionid": "3",
            "eventid": "21243",
            "userid": "1",
            "clock": "1362128008",
            "mediatypeid": "1",
            "sendto": "support@company.com",
            "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
            "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
            "status": "0",
            "retries": "3",
            "error": "",
            "esc_step": "1",
            "alerttype": "0",
            "p_eventid": "0",
            "acknowledgeid": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/1d7d6df6-8d56d57c})

[comment]: # ({5371aed2-5371aed2})
### 参见

-   [主机](/manual/api/reference/host/object#主机)
-   [媒介类型](/manual/api/reference/mediatype/object#媒介类型)
-   [用户](/manual/api/reference/user/object#用户)

[comment]: # ({/5371aed2-5371aed2})

[comment]: # ({14a85885-14a85885})
### 来源

*ui/include/classes/api/services/CAlert.php* 中的 CAlert::get()。

[comment]: # ({/14a85885-14a85885})