Table of Contents
itemprototype.get
説明
integer/array itemprototype.get(object parameters)
このメソッドは、指定されたパラメータに従ってアイテムプロトタイプを取得することができます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドの呼び出し権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object) 望ましい出力を定義するパラメータ。
このメソッドは以下のパラメータをサポートします。
| パラメータ | 型 | 説明 |
|---|---|---|
| discoveryids | ID/array | 指定したLLDルールに属するアイテムプロトタイプのみを返します。 |
| graphids | ID/array | 指定したグラフプロトタイプで使用されているアイテムプロトタイプのみを返します。 |
| hostids | ID/array | 指定したホストに属するアイテムプロトタイプのみを返します。 |
| inherited | boolean | trueに設定すると、テンプレートから継承されたアイテムプロトタイプのみを返します。 |
| itemids | ID/array | 指定したIDのアイテムプロトタイプのみを返します。 |
| monitored | boolean | trueに設定すると、監視対象ホストに属する有効なアイテムプロトタイプのみを返します。 |
| templated | boolean | trueに設定すると、テンプレートに属するアイテムプロトタイプのみを返します。 |
| templateids | ID/array | 指定したテンプレートに属するアイテムプロトタイプのみを返します。 |
| triggerids | ID/array | 指定したトリガープロトタイプで使用されているアイテムプロトタイプのみを返します。 |
| selectDiscoveryData | query | アイテムプロトタイプのディスカバリオブジェクトデータを持つdiscoveryDataプロパティを返します。アイテムプロトタイプのディスカバリオブジェクトは、検出されたアイテムプロトタイプと、それが検出されたアイテムプロトタイプをリンクします。以下のプロパティを持ちます: parent_itemid - (string) アイテムプロトタイプが作成された元のアイテムプロトタイプのID;key_ - (string) アイテムプロトタイプのキー;status - (int) アイテムプロトタイプのディスカバリステータス:0 - (デフォルト) アイテムプロトタイプが検出されている, 1 - アイテムプロトタイプが検出されなくなった; ts_delete - (timestamp) もはや検出されなくなったアイテムプロトタイプが削除される時刻;ts_disable - (timestamp) もはや検出されなくなったアイテムプロトタイプが無効化される時刻;disable_source - (int) アイテムプロトタイプがLLDルールによって無効化されたか手動で無効化されたかの指標:0 - (デフォルト) 自動的に無効化, 1 - LLDルールによって無効化。 |
| selectDiscoveryRule | query | アイテムプロトタイプが属する低レベルディスカバリルールを持つdiscoveryRuleプロパティを返します。 |
| selectDiscoveryRulePrototype | query | アイテムプロトタイプが属する親LLDルールプロトタイプを持つdiscoveryRulePrototypeプロパティを返します。 |
| selectGraphs | query | アイテムプロトタイプが使用されているグラフプロトタイプを持つgraphsプロパティを返します。countをサポートします。 |
| selectHosts | query | アイテムプロトタイプが属するホストの配列を持つhostsプロパティを返します。 |
| selectTags | query | アイテムプロトタイプのタグをtagsプロパティで返します。 |
| selectTriggers | query | アイテムプロトタイプが使用されているトリガープロトタイプを持つtriggersプロパティを返します。countをサポートします。 |
| selectPreprocessing | query | アイテムプロトタイプの前処理オプションを持つpreprocessingプロパティを返します。 |
| selectValueMap | query | アイテムプロトタイプの値のマップを持つvaluemapプロパティを返します。 |
| filter | object | 指定したフィルタに完全一致する結果のみを返します。 オブジェクトを受け入れ、キーはプロパティ名、値は一致させる値または値の配列です。 textデータ型のプロパティはサポートしません。追加プロパティをサポートします: host - アイテムプロトタイプが属するホストの技術名。 |
| limitSelects | integer | サブセレクトによって返されるレコード数を制限します。 以下のサブセレクトに適用されます: selectGraphs - 結果はnameでソートされます;selectTriggers - 結果はdescriptionでソートされます。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 可能な値: itemid, name, key_, delay, type, status, history, trends, discovered. |
| 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パラメータが使用されている場合、取得されたオブジェクトの数
例
LLDルールからアイテムプロトタイプを取得する
特定のLLDルールIDのすべてのアイテムプロトタイプを取得します。
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23077",
"type": "0",
"snmp_oid": "",
"hostid": "10079",
"name": "Incoming network traffic on en0",
"key_": "net.if.in[en0]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "bps",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "2",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"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": "",
"parameters": []
},
{
"itemid": "10010",
"type": "0",
"snmp_oid": "",
"hostid": "10001",
"name": "Processor load (1 min average per core)",
"key_": "system.cpu.load[percpu,avg1]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "2",
"interfaceid": "0",
"description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
"evaltype": "0",
"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": "",
"parameters": []
}
],
"id": 1
}従属アイテムの検索
特定のアイテムIDに対して1つの従属アイテムを検索します。
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"filter": {
"type": 18,
"master_itemid": "25545"
},
"limit": "1"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25547",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Seconds",
"key_": "apache.status.uptime.seconds",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"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": "",
"parameters": []
}
],
"id": 1
}HTTPエージェントアイテムプロトタイプの検索
特定のホストIDに対して、リクエストメソッドHEADのHTTPエージェントアイテムプロトタイプを検索します。
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"filter": {
"type": 19,
"request_method": 3
}
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28257",
"type": "19",
"snmp_oid": "",
"hostid": "10254",
"name": "discovered",
"key_": "item[{#INAME}]",
"delay": "{#IUPDATE}",
"history": "90d",
"trends": "30d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "2",
"interfaceid": "2",
"description": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "",
"url": "{#IURL}",
"query_fields": [],
"posts": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"discover": "0",
"uuid": "",
"parameters": []
}
],
"id": 1
}参照
ソース
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.