このページで
itemprototype.get
説明
integer/array itemprototype.get(object parameters)
このメソッドは、指定されたパラメータに従ってアイテムプロトタイプを取得することができます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドの呼び出し権限は、ユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object) 目的の出力を定義するパラメータ。
このメソッドは次のパラメータをサポートします。
| Parameter | Type | Description |
|---|---|---|
| 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 - (default) アイテムプロトタイプは発見済み, 1 - アイテムプロトタイプはもはや発見されていない; ts_delete - (timestamp) もはや発見されないアイテムプロトタイプが削除される時刻;ts_disable - (timestamp) もはや発見されないアイテムプロトタイプが無効化される時刻;disable_source - (int) アイテムプロトタイプが LLD ルールによって無効化されたか、手動で無効化されたかを示す指標:0 - (default) 自動的に無効化, 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 data type のプロパティはサポートしません。追加のプロパティをサポートします: host - アイテムプロトタイプが属するホストの技術名。 |
| limitSelects | integer | サブセレクトで返されるレコード数を制限します。 次のサブセレクトに適用されます: selectGraphs - 結果は name でソートされます;selectTriggers - 結果は description でソートされます。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: itemid, name, key_, delay, type, status, history, trends, discovered。 |
| countOutput | boolean | これらのパラメータは reference commentary で説明されています。 |
| 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": "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": "プロセッサ負荷（コアごとの1分平均）",
"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": "プロセッサ負荷は、システムCPU負荷をCPUコア数で割って計算されます。",
"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.