discoveryruleprototype.get

説明

integer/array discoveryruleprototype.get(object parameters)

このメソッドを使用すると、指定したパラメータに従って LLD ルールのプロトタイプを取得できます。

このメソッドは、あらゆる種類のユーザーが利用できます。メソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。詳細は User roles を参照してください。

パラメータ

(object) 目的の出力を定義するパラメータ。

このメソッドは次のパラメータをサポートします。

Parameter Type Description
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 data type のプロパティはサポートしません。

追加のプロパティをサポートします:
host - LLDルールプロトタイプが属するホストの技術名。
limitSelects integer サブセレクトで返されるレコード数を制限します。

次のサブセレクトに適用されます: selectItems, selectGraphs, selectTriggers。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: itemid, name, key_, delay, type, status。
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 パラメータが使用されている場合は、取得したオブジェクトの件数

例

ホストからのディスカバリールールプロトタイプの取得

特定のホストIDのすべてのディスカバリールールプロトタイプを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "discoveryruleprototype.get",
    "params": {
        "hostids": "10084"
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "{#DB} の tablespace を検出",
            "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",
            "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()。