このページで
item.get
説明
integer/array item.get(object parameters)
このメソッドは、指定されたパラメータに従ってアイテムを取得することができます。
このメソッドは、すべてのタイプのユーザーが利用できます。 このメソッドの呼び出し権限は、ユーザーロールの設定で取り消すことができます。 詳細はユーザーロールを参照してください。
パラメーター
(object) 取得する出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| itemids | ID/array | 指定したIDのアイテムのみを返します。 |
| groupids | ID/array | 指定したグループのホストに属するアイテムのみを返します。 |
| templateids | ID/array | 指定したテンプレートに属するアイテムのみを返します。 |
| hostids | ID/array | 指定したホストに属するアイテムのみを返します。 |
| proxyids | ID/array | 指定したプロキシによって監視されているアイテムのみを返します。 |
| interfaceids | ID/array | 指定したホストインターフェースを使用するアイテムのみを返します。 |
| graphids | ID/array | 指定したグラフで使用されているアイテムのみを返します。 |
| triggerids | ID/array | 指定したトリガーで使用されているアイテムのみを返します。 |
| webitems | flag | 結果にWebアイテムを含めます。 |
| inherited | boolean | trueに設定すると、テンプレートから継承されたアイテムのみを返します。 |
| inheritedTags | boolean | 指定したtagsがホスト/テンプレート/リンクされたテンプレートにもあるアイテムを返します。指定可能な値: true - テンプレート/ホスト/リンクされたテンプレートにも指定したタグが必要;false - (デフォルト) テンプレート/ホスト/リンクされたテンプレートのタグは無視されます。 |
| templated | boolean | trueに設定すると、テンプレートに属するアイテムのみを返します。 |
| monitored | boolean | trueに設定すると、監視対象ホストに属する有効なアイテムのみを返します。 |
| group | string | 指定した名前のグループに属するアイテムのみを返します。 |
| host | string | 指定した名前のホストに属するアイテムのみを返します。 |
| evaltype | integer | タグの評価方法。 指定可能な値: 0 - (デフォルト) And/Or; 2 - Or。 |
| tags | array | 指定したタグを持つアイテムのみを返します。 フォーマット: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]。空の配列はすべてのアイテムを返します。 指定可能なoperator値: 0 - (デフォルト) 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。 |
| with_triggers | boolean | trueに設定すると、トリガーで使用されているアイテムのみを返します。 |
| selectHosts | query | アイテムが属するホストの配列を持つhostsプロパティを返します。 |
| selectInterfaces | query | アイテムで使用されているホストインターフェースの配列を持つinterfacesプロパティを返します。 |
| selectTriggers | query | アイテムが使用されているトリガーを持つtriggersプロパティを返します。countをサポートします。 |
| selectGraphs | query | アイテムを含むグラフを持つgraphsプロパティを返します。countをサポートします。 |
| 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 | アイテムを作成したLLDルールを持つdiscoveryRuleプロパティを返します。 |
| selectInheritedTags | query | テンプレート/ホスト/リンクされたテンプレートにあるタグを持つinheritedTagsプロパティを返します。 |
| selectPreprocessing | query | アイテムの事前処理オプションを持つpreprocessingプロパティを返します。 |
| selectTags | query | アイテムタグをtagsプロパティで返します。 |
| selectValueMap | query | アイテムの値マップを持つvaluemapプロパティを返します。 |
| filter | object | 指定したフィルターに完全一致する結果のみを返します。 オブジェクトを受け入れ、キーはプロパティ名、値は一致させる単一値または値の配列です。 textデータ型のプロパティはサポートしません。追加プロパティをサポートします: host - アイテムが属するホストの技術名。 |
| limitSelects | integer | サブセレクトで返されるレコード数を制限します。 以下のサブセレクトに適用されます: selectGraphs - 結果はnameでソートされます;selectTriggers - 結果はdescriptionでソートされます。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: itemid, name, key_, delay, history, trends, 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 | |
| selectItemDiscovery | query | アイテムディスカバリオブジェクトを持つitemDiscoveryプロパティを返します。アイテムディスカバリオブジェクトは、アイテムを、そのアイテムが作成されたアイテムプロトタイプにリンクします。このクエリは非推奨です。代わりに selectDiscoveryDataを使用してください。 |
戻り値
(integer/array) 以下のいずれかを返します。
- オブジェクトの配列
countOutputパラメータが使用されている場合は、取得したオブジェクトの数
例
キーによるアイテムの検索
特定のホストIDのトリガーで使用されているアイテムのうち、アイテムキーに「system.cpu」を含むものを取得し、名前でソートします。
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "42269",
"type": "18",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU utilization",
"key_": "system.cpu.util",
"delay": "0",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"formula": "",
"logtimefmt": "",
"templateid": "42267",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "CPU utilization in %.",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "42264",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "CPU utilization",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42259",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (15m avg)",
"key_": "system.cpu.load[all,avg15]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42219",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (15m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42249",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (1m avg)",
"key_": "system.cpu.load[all,avg1]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42209",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (1m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42257",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Load average (5m avg)",
"key_": "system.cpu.load[all,avg5]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42217",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Load average (5m avg)",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "42260",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Number of CPUs",
"key_": "system.cpu.num",
"delay": "1m",
"history": "7d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "42220",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Number of CPUs",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}キーで依存アイテムを検索する
キーに「apache」という単語が含まれている、ID「10116」のホストからすべての依存アイテムを取得します。
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": 18
}
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Days",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "25545",
"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",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "Hours",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0"
}
],
"id": 1
}HTTPエージェントアイテムの検索
特定のホストIDに対して、ポストボディタイプがXMLのHTTPエージェントアイテムを検索します。
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": 19,
"post_type": 3
}
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "template item",
"key_": "ti",
"delay": "30s",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "",
"url": "localhost",
"query_fields": [
{
"name": "mode",
"value": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"state": "0",
"error": "",
"name_resolved": "template item",
"parameters": [],
"lastclock": "0",
"lastns": "0",
"lastvalue": "",
"prevvalue": ""
}
],
"id": 1
}前処理ルールを持つアイテムの取得
特定のホストIDのすべてのアイテムとその前処理ルールを取得します。
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "HTTP agent example JSON",
"key_": "json",
"preprocessing": [
{
"type": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}参照
ソース
CItem::get() in ui/include/classes/api/services/CItem.php.