maintenance.get

説明

integer/array maintenance.get(object parameters)

このメソッドを使用すると、指定したパラメータに従ってメンテナンスを取得できます。

このメソッドは、あらゆる種類のユーザーが利用できます。 このメソッドの呼び出し権限は、ユーザーのロール設定で取り消すことができます。 詳細は User roles を参照してください。

パラメータ

(object) 必要な出力を定義するパラメータ。

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

パラメータ 型 説明
groupids ID/array 指定したホストグループに割り当てられているメンテナンスのみを返します。
hostids ID/array 指定したホストに割り当てられているメンテナンスのみを返します。
triggerids ID/array 指定したトリガーに割り当てられているメンテナンスのみを返します。
maintenanceids ID/array 指定したIDを持つメンテナンスのみを返します。
selectHostGroups query メンテナンスに割り当てられているホストグループを含むhostgroupsプロパティを返します。
selectHosts query メンテナンスに割り当てられているホストを含むhostsプロパティを返します。
selectTriggers query メンテナンスに割り当てられているトリガーを含むtriggersプロパティを返します。
selectEventNames query メンテナンスに割り当てられているイベント名を含むevent_namesプロパティを返します。
selectTags query メンテナンスの障害タグを含むtagsプロパティを返します。
selectTimeperiods query メンテナンスの期間を含むtimeperiodsプロパティを返します。
sortfield string/array 指定したプロパティで結果を並べ替えます。

指定可能な値: maintenanceid、name、maintenance_type、active_since、active_till。
countOutput boolean これらのパラメータについては、リファレンス解説で説明しています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 以下のいずれかを返します。

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

例

メンテナンスの取得

設定されているすべてのメンテナンス、割り当てられたメンテナンス範囲（ホストグループ、ホスト、トリガー、イベント名、タグ）に関するデータ、および定義された期間を取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

レスポンス:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Regular DB maintenance",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Databases",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad-hoc: Printer: ink OUT",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Zabbix servers",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Printer: ink OUT"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}

関連項目

ソース

CMaintenance::get() in ui/include/classes/api/services/CMaintenance.php。