vienumaprototips.get

Apraksts

integer/array itemprototype.get(object parameters)

Šī metode ļauj izgūt vienumu prototipus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā User roles.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
discoveryids ID/array Atgriezt tikai vienumu prototipus, kas pieder norādītajiem LLD noteikumiem.
graphids ID/array Atgriezt tikai vienumu prototipus, kas tiek izmantoti norādītajos grafiku prototipos.
hostids ID/array Atgriezt tikai vienumu prototipus, kas pieder norādītajiem hostiem.
inherited boolean Ja iestatīts uz true, atgriezt tikai no veidnes mantotos vienumu prototipus.
itemids ID/array Atgriezt tikai vienumu prototipus ar norādītajiem ID.
monitored boolean Ja iestatīts uz true, atgriezt tikai iespējotos vienumu prototipus, kas pieder uzraudzītiem hostiem.
templated boolean Ja iestatīts uz true, atgriezt tikai vienumu prototipus, kas pieder veidnēm.
templateids ID/array Atgriezt tikai vienumu prototipus, kas pieder norādītajām veidnēm.
triggerids ID/array Atgriezt tikai vienumu prototipus, kas tiek izmantoti norādītajos trigeru prototipos.
selectDiscoveryData query Atgriezt discoveryData īpašību ar vienuma prototipa atklāšanas objekta datiem. Vienuma prototipa atklāšanas objekts sasaista atklāto vienuma prototipu ar vienuma prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
parent_itemid - (string) tā vienuma prototipa ID, no kura tika izveidots vienuma prototips;
key_ - (string) vienuma prototipa atslēga;
status - (int) vienuma prototipa atklāšanas statuss:
0 - (default) vienuma prototips ir atklāts,
1 - vienuma prototips vairs nav atklāts;
ts_delete - (timestamp) laiks, kad vienuma prototips, kas vairs netiek atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad vienuma prototips, kas vairs netiek atklāts, tiks atspējots;
disable_source - (int) indikators, kas norāda, vai vienuma prototipu atspējoja LLD noteikums vai manuāli:
0 - (default) atspējots automātiski,
1 - atspējots ar LLD noteikumu.
selectDiscoveryRule query Atgriezt discoveryRule īpašību ar zema līmeņa atklāšanas noteikumu, kuram pieder vienuma prototips.
selectDiscoveryRulePrototype query Atgriezt discoveryRulePrototype īpašību ar vecāka LLD noteikuma prototipu, kuram pieder vienuma prototips.
selectGraphs query Atgriezt graphs īpašību ar grafiku prototipiem, kuros tiek izmantots vienuma prototips.

Atbalsta count.
selectHosts query Atgriezt hosts īpašību ar hostu masīvu, kuriem pieder vienuma prototips.
selectInheritedTags query Atgriezt inheritedTags īpašību ar tagiem, kas atrodas veidnē, hostā vai saistītajās veidnēs.
selectTags query Atgriezt vienuma prototipa tagus tags īpašībā.
selectTriggers query Atgriezt triggers īpašību ar trigeru prototipiem, kuros tiek izmantots vienuma prototips.

Atbalsta count.
selectPreprocessing query Atgriezt preprocessing īpašību ar vienuma prototipa priekšapstrādes opcijām.
selectValueMap query Atgriezt valuemap īpašību ar vienuma prototipa vērtību karti.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst norādītajam filtram.

Pieņem objektu, kurā atslēgas ir īpašību nosaukumi, bet vērtības ir viena vērtība vai vērtību masīvs, ar ko veikt atbilstības pārbaudi.

Neatbalsta text datu tipa īpašības.

Atbalsta papildu īpašības:
host - tā hosta tehniskais nosaukums, kuram pieder vienuma prototips.
limitSelects integer Ierobežo apakšatlases atgriezto ierakstu skaitu.

Attiecas uz šādām apakšatlasēm:
selectGraphs - rezultāti tiks kārtoti pēc name;
selectTriggers - rezultāti tiks kārtoti pēc description.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: itemid, name, key_, delay, type, status, history, trends, discovered.
countOutput boolean Šie parametri ir aprakstīti atsauces komentāros.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Vienumu prototipu izgūšana no LLD kārtulas

Izgūst visus vienumu prototipus norādītajam LLD kārtulas ID.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}

Atbilde:

{
    "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
}

Atkarīgā vienuma atrašana

Atrodiet vienu atkarīgo vienumu konkrētam vienuma ID.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "filter": {
            "type": 18,
            "master_itemid": "25545"
        },
        "limit": "1"
    },
    "id": 1
}

Atbilde:

{
    "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
}

Atrast HTTP aģenta vienuma prototipu

Atrodiet HTTP aģenta vienuma prototipu ar pieprasījuma metodi HEAD konkrētam hosta ID.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "hostids": "10254",
        "filter": {
            "type": 19,
            "request_method": 3
        }
    },
    "id": 1
}

Atbilde:

{
    "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
}

Skatiet arī

Avots

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