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 プロパティを返します。
selectInheritedTags query テンプレート、ホスト、リンクされたテンプレートに設定されているタグを含む inheritedTags プロパティを返します。
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",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "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",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "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": "",
            "formula": "",
            "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.",
            "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",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

依存アイテムの検索

特定のアイテムIDに対する依存アイテムを1つ検索します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.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": "",
            "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",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "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": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "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": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

関連項目

ソース

CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.