Documentation
Table of Contents
service.get
説明
integer/array service.get(object parameters)
このメソッドで、指定されたパラメーターに従ってサービスを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| serviceids | string/array | 指定されたIDのサービスのみを返します |
| parentids | string/array | 指定された親サービスにリンクされているサービスのみを返します |
| deep_parentids | flag | すべての直接的および間接的な子サービスを返します。parentidsと一緒に使用されます |
| childids | string/array | 指定された子サービスにリンクされているサービスのみを返します |
| evaltype | integer | タグ検索のルール 利用可能な値： 0 - (デフォルト) And/Or 2 - Or |
| tags | object/array of objects | 指定されたタグを持つサービスのみを返します。 タグによる完全一致、演算子の値に応じたタグの大文字と小文字を区別する検索、大文字と小文字を区別しない検索。 フォーマット： [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]空配列の場合はすべてのサービスを返します 使用可能な演算子値： 0 - (デフォルト)含む<br >1 - 等しい 2 - 含まない 3 - 等しくない 4 - 存在する 5 - 存在しない |
| problem_tags | object/array of objects | 指定された障害タグを持つサービスのみを返します。 タグによる完全一致、演算子の値に応じた大文字と小文字を区別する検索、大文字と小文字を区別しない検索。 フォーマット： [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].空配列の場合はすべてのサービスを返します 使用可能な演算子値： 0 - (デフォルト) 含む 1 - 等しい 2 - 含まない 3 - 等しくない 4 - 存在する 5 - 存在しない |
| without_problem_tags | flag | 障害タグのないサービスのみを返します |
| slaids | string/array | 特定のSLAにリンクされているサービスのみを返します。 |
| selectChildren | query | 子サービスでchildrenプロパティを返します。countをサポートします。 |
| selectParents | query | 親サービスでparentsプロパティを返します。countをサポートします。 |
| selectTags | query | tagsプロパティをサービスタグとともに返します。countをサポートします。 |
| selectProblemEvents | query | 障害のあるイベントオブジェクトの配列を含むproblem_eventsプロパティを返します。障害のあるイベントオブジェクトには次のプロパティがあります。 eventid - (string)イベントIDseverity - (string)現在のイベントの深刻度name - (string)解決されたイベント名countをサポートします |
| selectProblemTags | query | 障害のあるタグを含むproblem_tagsプロパティを返します。countをサポートします。 |
| selectStatusRules | query | ステータスルールを含むstatus_rulesプロパティを返します。countをサポートします。 |
| selectStatusTimeline | object/array of objects | 指定された期間のサービス状態の変更を含むstatus_timelineプロパティを返します。フォーマット [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_fromは指定期間の開始日（その日を含む整数のタイムスタンプ）であり、period_toは指定期間の終了日（その日を含まない整数のタイムスタンプ）です。指定された期間内の状態変化について start_valueプロパティとalarms配列を含むエントリの配列を返します。 |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます 指定可能な値は serviceid,name, status,sortorder,created_atです |
| 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": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"serviceid": "1",
"name": "My Service - 0001",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0001.",
"uuid": "dfa4daeaea754e3a95c04d6029182681",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
},
{
"serviceid": "2",
"name": "My Service - 0002",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "My Service Description 0002.",
"uuid": "20ea0d85212841219130abeaca28c065",
"created_at": "946684800",
"readonly": false,
"parents": [],
"children": []
}
],
"id": 1
}ソース
CService::get() in ui/include/classes/api/services/CService.php.