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. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

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

Metode atbalsta šādus parametrus.

Parameter Type Description
discoveryids ID/array Atgriezt tikai vienumu prototipus, kas pieder dotajiem LLD noteikumiem.
graphids ID/array Atgriezt tikai vienumu prototipus, kas tiek izmantoti dotajos grafiku prototipos.
hostids ID/array Atgriezt tikai vienumu prototipus, kas pieder dotajiem hosts.
inherited boolean Ja iestatīts uz true, atgriezt tikai no veidnes mantotos vienumu prototipus.
itemids ID/array Atgriezt tikai vienumu prototipus ar dotajiem ID.
monitored boolean Ja iestatīts uz true, atgriezt tikai iespējotos vienumu prototipus, kas pieder uzraudzītiem hosts.
templated boolean Ja iestatīts uz true, atgriezt tikai vienumu prototipus, kas pieder veidnēm.
templateids ID/array Atgriezt tikai vienumu prototipus, kas pieder dotajām veidnēm.
triggerids ID/array Atgriezt tikai vienumu prototipus, kas tiek izmantoti dotajos trigeru prototipos.
selectDiscoveryData query Atgriezt discoveryData īpašību ar vienumu prototipa atklāšanas objekta datiem. Vienumu prototipa atklāšanas objekts saista atklātu vienumu prototipu ar vienumu prototipu, no kura tas tika atklāts.

Tam ir šādas īpašības:
parent_itemid - (string) vienumu prototipa ID, no kura ir izveidots vienumu prototips;
key_ - (string) vienumu prototipa atslēga;
status - (int) vienumu prototipa atklāšanas statuss:
0 - (noklusējums) vienumu prototips ir atklāts,
1 - vienumu prototips vairs nav atklāts;
ts_delete - (timestamp) laiks, kad vienumu prototips, kas vairs nav atklāts, tiks dzēsts;
ts_disable - (timestamp) laiks, kad vienumu prototips, kas vairs nav atklāts, tiks atspējots;
disable_source - (int) indikators, vai vienumu prototips tika atspējots ar LLD noteikumu vai manuāli:
0 - (noklusējums) 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 vienumu prototips.
selectDiscoveryRulePrototype query Atgriezt discoveryRulePrototype īpašību ar vecāko LLD noteikuma prototipu, kuram pieder vienumu prototips.
selectGraphs query Atgriezt graphs īpašību ar grafiku prototipiem, kuros tiek izmantots vienumu prototips.

Atbalsta count.
selectHosts query Atgriezt hosts īpašību ar hosts masīvu, kuriem pieder vienumu prototips.
selectTags query Atgriezt vienumu prototipa tagus tags īpašībā.
selectTriggers query Atgriezt triggers īpašību ar trigeru prototipiem, kuros tiek izmantots vienumu prototips.

Atbalsta count.
selectPreprocessing query Atgriezt preprocessing īpašību ar vienumu prototipa pirmapstrādes opcijām.
selectValueMap query Atgriezt valuemap īpašību ar vienumu prototipa vērtību kartējumu.
filter object Atgriezt tikai tos rezultātus, kas precīzi atbilst dotajam filtram.

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir vai nu viena vērtība, vai vērtību masīvs, ar ko salīdzināt.

Neatbalsta text datu tipa īpašības.

Atbalsta papildu īpašības:
host - tehniskais nosaukums hostam, kuram pieder vienumu prototips.
limitSelects integer Ierobežo ierakstu skaitu, ko atgriež apakšatlases.

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 dotajā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ārā.
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 noteikuma

Izgūt visus vienumu prototipus konkrētam LLD noteikuma 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",
            "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": "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": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "Procesora noslodze tiek aprēķināta kā sistēmas CPU noslodze, dalīta ar CPU kodolu skaitu.",
            "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
}

Atkarīgā vienuma atrašana

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

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "item.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": "",
            "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
}

Atrast HTTP aģenta vienuma prototipu

Atrast 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": "",
            "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
}

Skatiet arī

Avots

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