Documentation
Table of Contents
itemprototype.get
תיאור
integer/array itemprototype.get(object parameters)
השיטה מאפשרת לשלוף אבות טיפוס של פריט בהתאם לנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
פרמטרים
(object) פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| discoveryids | string/array | החזר רק אבות טיפוס של פריטים השייכים לכללי ה-LLD הנתונים. |
| graphids | string/array | החזר רק אבות-טיפוס של פריטים המשמשים באבות-טיפוס של גרפים. |
| hostids | string/array | החזר רק אבות טיפוס של פריטים השייכים למארחים הנתונים. |
| herited | boolean | אם הוגדר כ-'true' החזר רק אבות-טיפוס של פריטים שעברו בירושה מתבנית. |
| itemids | string/array | החזר רק אבות טיפוס של פריטים עם המזהים הנתונים. |
| monitored | boolean | אם מוגדר כ-'true', החזר רק אבות-טיפוס של פריטים מופעלים השייכים למארחים מנוטרים. |
| templated | boolean | אם מוגדר כ-'true' החזר רק אבות-טיפוס של פריטים השייכים לתבניות. |
| templateids | string/array | החזר רק אבות טיפוס של פריטים השייכים לתבניות הנתונות. |
| triggerids | string/array | החזר רק אבות-טיפוס של פריטים המשמשים באבות-טיפוס של טריגר. |
| selectDiscoveryRule | query | החזר מאפיין discoveryRule עם כלל הגילוי ברמה נמוכה שאליו שייך אב הטיפוס של הפריט. |
| selectGraphs | query | החזר מאפיין manual/api/reference/graphprototype/object#graph_prototype עם אבות טיפוס גרפים שבהם נעשה שימוש באב הטיפוס של הפריט.< br> תומך ב'ספירה'. |
| selectHosts | query | החזר מאפיין hosts עם מערך מארחים שאליהם שייך אב הטיפוס של הפריט. |
| selectTags | query | החזר את תגי אב הטיפוס של הפריט במאפיין tags. |
| selectTriggers | query | החזר מאפיין triggers עם אבות טיפוס של טריגר שבהם נעשה שימוש באב הטיפוס של הפריט. תומך ב'count'. |
| selectPreprocessing | query | החזר מאפיין preprocessing עם אפשרויות עיבוד מוקדם של פריט. יש לו את המאפיינים הבאים: type - (מחרוזת) סוג אפשרות העיבוד המקדים:1 - מכפיל מותאם אישית; 2 - חיתוך ימני; 3 - חיתוך שמאלי; 4 - חיתוך; 5 - התאמת ביטוי רגולרי;< br>6 - בוליאני עד עשרוני; 7 - אוקטל עד עשרוני; 8 - הקסדצימלי לעשרוני; 9 - שינוי פשוט; 10 - שינוי בשנייה; 11 - XML XPath ; 12 - JSONPath; 13 - בטווח; 14 - מתאים לביטוי רגולרי; 15 - לא תואם לביטוי רגולרי; 16 - בדוק אם יש שגיאה ב-JSON; 17 - בדוק אם יש שגיאה ב-XML; 18 - בדוק אם יש שגיאה באמצעות ביטוי רגולרי; 19 - מחק ללא שינוי; 20 - מחק ללא שינוי עם פעימות לב; 21 - JavaScript; 22 - תבנית Prometheus; 23 - Prometheus ל-JSON; 24 - CSV ל-JSON; 25 - החלפה; 26 - בדוק אם הערך אינו נתמך; 27- XML ל-JSON.<br > params - (מחרוזת) פרמטרים נוספים המשמשים את אפשרות העיבוד המקדים. פרמטרים מרובים מופרדים על ידי LF (\n)character.error_handler - (מחרוזת) סוג הפעולה המשמש במקרה של כשל בשלב העיבוד המקדים:0 - הודעת השגיאה מוגדרת על ידי שרת Zabbix;<br >1 - Discard value; 2 - הגדר ערך מותאם אישית; 3 - הגדר הודעת שגיאה מותאמת אישית. error_handler_params - (string) פרמטרי מטפל בשגיאות. |
| selectValueMap | query | החזר מאפיין valuemap עם מפת ערך אב טיפוס של פריט. |
| filter | object | החזר רק את התוצאות שתואמות בדיוק את המסנן הנתון. מקבל מערך, כאשר המפתחות הם שמות מאפיינים, והערכים הם ערך בודד או מערך של ערכים שיש להתאים. תומך במסננים נוספים: מארח - שם טכני של המארח שאליו שייך אב הטיפוס של הפריט. |
| limitSelects | integer | מגביל את מספר הרשומות המוחזרות על ידי תת-בחירה. חל על תת-הבחירות הבאות: selectGraphs - התוצאות ימוינו לפי שם;selectTriggers - תוצאות ימוינו לפי תיאור. |
| sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: itemid, name, key_, delay, type ו-status. |
| countOutput | boolean | הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות. |
| עריכה | בוליאנית | |
| excludeSearch | בולאני | |
| limit | מספר שלם | |
| פלט | שאילתה | |
| preservekeys | בולאני | |
| חיפוש | אובייקט | |
| searchByAny | boolean | |
| searchWildcardsEnabled | בוליאני | |
| sortorder | מחרוזת/מערך | |
| startSearch | boolean |
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
דוגמאות
אחזור אבות-טיפוס של פריטים מכלל LLD
אחזר את כל אבות הטיפוס של הפריטים עבור מזהה כלל LLD ספציפי.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"output": "להרחיב",
"discoveryids": "27426"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"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": "",
"יחידות": "bps",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "0",
"תיאור": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "",
"query_fields": [],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"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": "",
"פרמטרים": []
},
{
"itemid": "10010",
"type": "0",
"snmp_oid": "",
"hostid": "10001",
"name": "עומס מעבד (דקה ממוצעת לכל ליבה)",
"key_": "system.cpu.load[percpu,avg1]",
"delay": "1m",
"history": "1w",
"trends": "365d",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"יחידות": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "0",
"description": "עומס המעבד מחושב כעומס המעבד של המערכת חלקי מספר ליבות המעבד.",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "",
"query_fields": [],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"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",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"discover": "0",
"uuid": "",
"פרמטרים": []
}
],
"מזהה": 1
}מציאת פריט תלוי
מצא פריט תלוי אחד עבור פריט עם מזהה "25545".
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "להרחיב",
"מסנן": {
"type": "18",
"master_itemid": "25545"
},
"limit": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"itemid": "25547",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "שניות",
"key_": "apache.status.uptime.seconds",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"יחידות": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "0",
"תיאור": "",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3 שניות",
"url": "",
"query_fields": [],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"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": "",
"פרמטרים": []
}
],
"מזהה": 1
}מצא אב-טיפוס של פריט סוכן HTTP
מצא אב טיפוס של פריט סוכן HTTP עם שיטת הבקשה HEAD עבור מזהה מארח ספציפי.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "itemprototype.get",
"params": {
"hostids": "10254",
"מסנן": {
"type": "19",
"request_method": "3"
}
},
"מזהה": 17,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"itemid": "28257",
"type": "19",
"snmp_oid": "",
"hostid": "10254",
"name": "התגלה",
"key_": "פריט[{#INAME}]",
"delay": "{#IUPDATE}",
"history": "90d",
"trends": "30d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"יחידות": "",
"logtimefmt": "",
"templateid": "28255",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "2",
"תיאור": "",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "{#IURL}",
"query_fields": [],
"פוסטים": "",
"status_codes": "",
"follow_redirects": "0",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"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": "",
"פרמטרים": []
}
],
"מזהה": 17
}ראה גם
מקור
CItemPrototype::get() בתוך ui/include/classes/api/services/CItemPrototype.php.