[comment]: # ({4c82c7ad-4c82c7ad})
# alert.get

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

[comment]: # ({3c5ac067-ed55724c})
### 説明

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

このメソッドは、指定されたパラメーターに従ってアラートを取得できます。

::: noteclassic
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細は[ユーザーの役割](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/3c5ac067-ed55724c})

[comment]: # ({9bc7f5ce-218fa8cf})
### パラメーター

`(object)` 目的の出力を定義するパラメーター。

このメソッドは以下のパラメーターをサポートしています。

|パラメーター|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|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#event)を参照してください。<br><br>デフォルト: 0 - トリガー|
|eventsource|integer|指定されたタイプのイベントによって生成されたアラートのみを返します。<br><br>サポートされているイベントタイプのリストについては、event ["source"](/manual/api/reference/event/object#event) を参照してください。<br><br>デフォルト: 0 - トリガーイベント|
|time\_from|timestamp|指定された時間後に生成されたアラートのみを返します。|
|time\_till|timestamp|指定された時間より前に生成されたアラートのみを返します。|
|selectHosts|query|アクション操作をトリガーしたホストのデータを含む[ホスト](/manual/api/reference/host/object)プロパティを返します。|
|selectMediatypes|query|メッセージアラートに使用されたメディアタイプの配列を含む[メディアタイプ](/manual/api/reference/mediatype/object)プロパティを返します。|
|selectUsers|query|メッセージの宛先となったユーザーの配列を含む[ユーザー](/manual/api/reference/user/object)プロパティを返します。|
|sortfield|string/array|指定されたプロパティによって結果を並べ替えます。<br><br>利用可能な値: `alertid`, `clock`, `eventid`, `mediatypeid`, `sendto`, `status`.|
|countOutput|boolean|すべての`get`メソッドに共通するこれらのパラメーターは、[リファレンス解説](/manual/api/reference_commentary#common_get_method_parameters)で説明されています。|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/9bc7f5ce-218fa8cf})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメーターが使用されている場合、取得したオブジェクトの数

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

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

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

[comment]: # ({57a43812-8d56d57c})
#### アクションIDでアラートを取得する

アクション"3"によって生成されたすべてのアラートを取得します。

[リクエスト](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "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]: # ({/57a43812-8d56d57c})

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

-   [Host](/manual/api/reference/host/object#host)
-   [Media type](/manual/api/reference/mediatype/object#media_type)
-   [User](/manual/api/reference/user/object#user)

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

[comment]: # ({14a85885-14a85885})
### ソース

CAlert::get() in *ui/include/classes/api/services/CAlert.php*.

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