discoveryruleprototype.get
説明
integer/array discoveryruleprototype.get(object parameters)
このメソッドは、指定されたパラメータに従ってLLDルールのプロトタイプを取得します。
このメソッドは、あらゆるタイプのユーザーが利用できます。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくは、ユーザーロール をご覧ください。
パラメータ
(object) 必要な出力を定義するパラメータ。
このメソッドは以下のパラメータをサポートしています。
| パラメータ | 型 | 説明 |
|---|---|---|
| itemids | ID/array | 指定したIDを持つLLDルールのプロトタイプのみを返します。 |
| groupids | ID/array | 指定したグループのホストに属するLLDルールのプロトタイプのみを返します。 |
| hostids | ID/array | 指定したホストに属するLLDルールのプロトタイプのみを返します。 |
| inherited | boolean | true に設定した場合、テンプレートから継承されたLLDルールのプロトタイプのみを返します。 |
| interfaceids | ID/array | 指定したホストインターフェースを使用するLLDルールのプロトタイプのみを返します。 |
| monitored | boolean | true に設定した場合、監視対象ホストに属する有効なLLDルールのプロトタイプのみを返します。 |
| templated | boolean | true に設定した場合、テンプレートに属するLLDルールのプロトタイプのみを返します。 |
| templateids | ID/array | 指定したテンプレートに属するLLDルールのプロトタイプのみを返します。 |
| selectDiscoveryRule | query | LLDルールのプロトタイプの親LLDルールを含む discoveryRule プロパティを返します。 |
| selectDiscoveryRulePrototype | query | LLDルールのプロトタイプの親LLDルールプロトタイプを含む discoveryRulePrototype プロパティを返します。 |
| selectDiscoveryRulePrototypes | query | LLDルールのプロトタイプに属する子LLDルールのプロトタイプを含む discoveryRulePrototypes プロパティを返します。count をサポートします。 |
| selectFilter | query | LLDルールのプロトタイプで使用されるフィルタのデータを含む filter プロパティを返します。 |
| selectGraphs | query | LLDルールのプロトタイプに属するグラフのプロトタイプを含む graphs プロパティを返します。count をサポートします。 |
| selectHostPrototypes | query | LLDルールのプロトタイプに属するホストのプロトタイプを含む hostPrototypes プロパティを返します。count をサポートします。 |
| selectHosts | query | LLDルールのプロトタイプが属するホストの配列を含む hosts プロパティを返します。 |
| selectItems | query | LLDルールのプロトタイプに属するアイテムのプロトタイプを含む items プロパティを返します。count をサポートします。 |
| selectTriggers | query | LLDルールのプロトタイプに属するトリガーのプロトタイプを含む triggers プロパティを返します。count をサポートします。 |
| selectLLDMacroPaths | query | 各対応するマクロに割り当てられた値へのパスとLLDマクロの一覧を含む lld_macro_paths プロパティを返します。 |
| selectPreprocessing | query | LLDルールのプロトタイプの前処理オプションを含む preprocessing プロパティを返します。 |
| selectOverrides | query | プロトタイプオブジェクトに対して実行される上書きフィルタ、条件、および操作の一覧を含む lld_rule_overrides プロパティを返します。 |
| filter | object | 指定したフィルタに完全に一致する結果のみを返します。 キーがプロパティ名、値が一致対象の単一の値または値の配列であるオブジェクトを受け付けます。 text データ型 のプロパティはサポートしていません。追加のプロパティをサポートします: host - LLDルールのプロトタイプが属するホストの技術名。 |
| limitSelects | integer | サブセレクトで返されるレコード数を制限します。 以下のサブセレクトに適用されます: selectItems, selectGraphs, selectTriggers。 |
| sortfield | string/array | 指定したプロパティで結果を並べ替えます。 指定可能な値: itemid, name, key_, delay, type, status。 |
| countOutput | boolean | これらのパラメータはリファレンスコメントで説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
ホストから検出ルールのプロトタイプを取得
特定のホストIDのすべての検出ルールのプロトタイプを取得します。
{
"jsonrpc": "2.0",
"method": "discoveryruleprototype.get",
"params": {
"hostids": "10084"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "47253",
"type": "23",
"snmp_oid": "",
"hostid": "10084",
"name": "Discover tablespaces for {#DB}",
"key_": "db.tablespace.discovery[{#DB}]",
"delay": "0",
"history": "31d",
"trends": "365d",
"status": "0",
"value_type": "4",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "3",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"parameters": []
}
],
"id": 1
}関連項目
ソース
CDiscoveryRulePrototype::get() in ui/include/classes/api/services/CDiscoveryRulePrototype.php.