Documentation
Table of Contents
service.get
説明
integer/array service.get(object parameters)
このメソッドで、指定されたパラメーターに従ってサービスを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) は、必要な出力を定義するパラメータです。
このメソッドは以下のパラメータをサポートしています。
| パラメータ | 型 | 説明 |
|---|---|---|
| serviceids | ID/array | 指定されたIDを持つサービスのみを返します。 |
| parentids | ID/array | 指定された親サービスにリンクされているサービスのみを返します。 |
| deep_parentids | flag | すべての直接および間接の子サービスを返します。parentids と組み合わせて使用します。 |
| childids | ID/array | 指定された子サービスにリンクされているサービスのみを返します。 |
| evaltype | integer | タグ検索のルール 可能な値: 0 - (default) And/Or; 2 - Or. |
| tags | object/array | 指定されたタグを持つサービスのみを返します。タグによる完全一致、および演算子の値に応じて、タグ値による大文字と小文字を区別するか区別しないかの検索を行います。 形式: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]空の配列はすべてのサービスを返します。 使用可能な演算子値: 0 - (デフォルト) 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない |
| problem_tags | object/array | 指定された問題タグを持つサービスのみを返します。タグによる完全一致、および演算子値に応じてタグ値による大文字と小文字を区別するまたは区別しない検索 形式: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]空の配列はすべてのサービスを返します。 使用可能な演算子値: 0 - (デフォルト) 含む 1 - 等しい 2 - 含まない 3 - 等しくない 4 - 存在する 5 - 存在しない |
| without_problem_tags | フラグ | 問題タグのないサービスのみを返します。 |
| slaids | ID/配列 | 特定の SLA にリンクされているサービスのみを返します。 |
| selectChildren | クエリ | 子サービスを含む children プロパティを返します。count をサポートします。 |
| selectParents | クエリ | 親サービスを含む parents プロパティを返します。count をサポートします。 |
| selectTags | クエリ | サービスタグを含む tags プロパティを返します。count をサポートします。 |
| selectProblemEvents | クエリ | 問題イベントオブジェクトの配列を含む problem_events プロパティを返します。問題イベントオブジェクトには、次のプロパティがあります。 eventid - (ID) イベント IDseverity - (string) 現在のイベントの重大度name - (string) 解決されたイベント名count をサポートします。 |
| selectProblemTags | クエリ | 問題タグを含む problem_tags プロパティを返します。count をサポートします。 |
| selectStatusRules | クエリ | ステータスルールを含む status_rules プロパティを返します。count をサポートします。 |
| selectStatusTimeline | オブジェクト/配列 | 指定された期間のサービス状態の変化を含む status_timeline プロパティを返します。形式は [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] です。period_from は対象期間の開始日（開始日を含む、整数タイムスタンプ）で、period_to は終了日（終了日を含まない、整数タイムスタンプ）です。指定された期間内の状態変化の start_value プロパティと alarms 配列を含むエントリの配列を返します。 |
| sortfield | 文字列/配列 | 指定されたプロパティで結果を並べ替えます。 使用可能な値: serviceid、name、status、sortorder、created_at |
| countOutput | ブール値 | これらのパラメータについては、リファレンス解説で説明されています。 |
| editable | ブール値 | |
| excludeSearch | ブール値 | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | ブール値 | |
| search | object | |
| searchByAny | ブール値 | |
| searchWildcardsEnabled | ブール値 | |
| sortorder | 文字列/配列 | |
| startSearch | ブール値 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
すべてのサービスの取得
すべてのサービスとその依存関係に関するすべてのデータを取得します。
{
"jsonrpc": "2.0",
"method": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": "extend"
},
"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.