Table of Contents
discoveryruleprototype.get
説明
integer/array discoveryruleprototype.get(object parameters)
このメソッドは、指定されたパラメータに従ってLLDルールプロトタイプを取得することができます。
このメソッドは、すべての種類のユーザーが利用できます。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細はユーザーロールを参照してください。
パラメーター
(object) 望ましい出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| discoveryids | ID/array | 指定したLLDルールまたはLLDルールプロトタイプに属するLLDルールプロトタイプのみを返します。 |
| 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",
"output_format": "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
}参照
ソース
ui/include/classes/api/services/CDiscoveryRulePrototype.php の CDiscoveryRulePrototype::get()。