This is a translation of the original English documentation page. Help us make it better.

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 サブセレクトによって返されるレコードの数を制限します。

次のサブセレクトに適用されます: selectItemsselectGraphsselectTriggers
sortfield string/array 指定されたプロパティで結果を並べ替えます。

使用可能な値: itemidnamekey_delaytypestatus
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.