Documentation
maintenance.get
説明
integer/array maintenance.get(object parameters)
このメソッドで、指定されたパラメーターに従ってメンテナンスを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| groupids | string/array | 指定されたホストグループに割り当てられているメンテナンスのみを返します |
| hostids | string/array | 指定されたホストに割り当てられているメンテナンスのみを返します |
| maintenanceids | string/array | 指定されたIDのメンテナンスのみを返します |
| selectGroups | query | メンテナンスに割り当てられたホストグループを持つgroupsプロパティを返します。 |
| selectHosts | query | メンテナンスに割り当てられたホストを持つhostsプロパティを返します。 |
| selectTags | query | メンテナンスの障害タグを含むtagsプロパティを返します。 |
| selectTimeperiods | query | メンテナンスの期間を含むtimeperiodsプロパティを返します。 |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 利用可能な値は maintenanceid,name,maintenance_typeです。 |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。 |
| 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パラメータが使用されている場合、取得されたオブジェクトの数
例
メンテナンスの取得
構成されたすべてのメンテナンス、割り当てられたホストグループ、定義された期間、障害タグに関するデータを取得します。
Request:
{
"jsonrpc": "2.0",
"method": "maintenance.get",
"params": {
"output": "extend",
"selectGroups": "extend",
"selectTimeperiods": "extend",
"selectTags": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"maintenanceid": "3",
"name": "Sunday maintenance",
"maintenance_type": "0",
"description": "",
"active_since": "1358844540",
"active_till": "1390466940",
"tags_evaltype": "0",
"groups": [
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0"
}
],
"timeperiods": [
{
"timeperiod_type": "3",
"every": "1",
"month": "0",
"dayofweek": "1",
"day": "0",
"start_time": "64800",
"period": "3600",
"start_date": "2147483647"
}
],
"tags": [
{
"tag": "service",
"operator": "0",
"value": "mysqld",
},
{
"tag": "error",
"operator": "2",
"value": ""
}
]
}
],
"id": 1
}参照
ソース
CMaintenance::get() in ui/include/classes/api/services/CMaintenance.php.