graph.get

תיאור

integer/array graph.get(object parameters)

השיטה מאפשרת לשלוף גרפים לפי הפרמטרים הנתונים.

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

פרמטרים

(object) פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

פרמטר סוג תיאור
graphids string/array החזר רק גרפים עם המזהים הנתונים.
groupids string/array החזר רק גרפים השייכים למארחים בקבוצות המארחות הנתונות.
templateids string/array החזר רק גרף השייך לתבניות הנתונות.
hostids string/array החזר רק גרפים השייכים למארחים הנתונים.
itemids string/array החזר רק גרפים המכילים את הפריטים הנתונים.
templated boolean אם מוגדר כ-'true' החזר רק גרפים השייכים לתבניות.
herited boolean אם מוגדר כ-'true' החזר רק גרפים שעברו בירושה מתבנית.
expandName flag הרחבת פקודות מאקרו בשם הגרף.
selectGroups query החזר מאפיין groups עם קבוצות המארחים שאליהן שייך הגרף.
selectTemplates query החזר מאפיין templates עם התבניות שהגרף שייך להן.
selectHosts query החזר מאפיין hosts עם המארחים שאליהם שייך הגרף.
selectItems query החזר מאפיין items עם הפריטים המשמשים בגרף.
selectGraphDiscovery query החזר מאפיין graphDiscovery עם אובייקט גילוי הגרף. אובייקטי גילוי הגרף מקשרים את הגרף לאב טיפוס של גרף ממנו הוא נוצר.

יש לו את המאפיינים הבאים:
graphid - (string) ID של הגרף;
parent_graphid - מזהה (string) של אב הטיפוס של הגרף שממנו נוצר הגרף.
selectGraphItems query החזר מאפיין gitems עם הפריטים המשמשים בגרף.
selectDiscoveryRule query החזר מאפיין discoveryRule עם כלל הגילוי ברמה נמוכה שיצר את הגרף.
filter object החזר רק את התוצאות שתואמות בדיוק את המסנן הנתון.

מקבל מערך, כאשר המפתחות הם שמות מאפיינים, והערכים הם ערך בודד או מערך של ערכים שיש להתאים.

תומך במסננים נוספים:
מארח - שם טכני של המארח שאליו שייך הגרף;
hostid - מזהה המארח שאליו שייך הגרף.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: graphid, name ו-graphtype.
countOutput boolean הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה בוליאנית
excludeSearch בולאני
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled boolean
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

  • מערך של חפצים;
  • ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

דוגמאות

אחזור גרפים ממארחים

אחזר את כל הגרפים מהמארח "10107" ומיון אותם לפי שם.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "graph.get",
            "params": {
                "output": "להרחיב",
                "hostids": 10107,
                "sortfield": "שם"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "graphid": "612",
                    "name": "קפיצות מעבד",
                    "רוחב": "900",
                    "height": "200",
                    "yaxismin": "0",
                    "yaxismax": "100",
                    "templateid": "439",
                    "show_work_period": "1",
                    "show_trigers": "1",
                    "graphtype": "0",
                    "show_legend": "1",
                    "show_3d": "0",
                    "percent_left": "0",
                    "percent_right": "0",
                    "ymin_type": "0",
                    "ymax_type": "0",
                    "ymin_itemid": "0",
                    "ymax_itemid": "0",
                    "flags": "0"
                },
                {
                    "graphid": "613",
                    "name": "עומס מעבד",
                    "רוחב": "900",
                    "height": "200",
                    "yaxismin": "0",
                    "yaxismax": "100",
                    "templateid": "433",
                    "show_work_period": "1",
                    "show_trigers": "1",
                    "graphtype": "0",
                    "show_legend": "1",
                    "show_3d": "0",
                    "percent_left": "0",
                    "percent_right": "0",
                    "ymin_type": "1",
                    "ymax_type": "0",
                    "ymin_itemid": "0",
                    "ymax_itemid": "0",
                    "flags": "0"
                },
                {
                    "graphid": "614",
                    "name": "ניצול מעבד",
                    "רוחב": "900",
                    "height": "200",
                    "yaxismin": "0",
                    "yaxismax": "100",
                    "templateid": "387",
                    "show_work_period": "1",
                    "show_trigers": "0",
                    "graphtype": "1",
                    "show_legend": "1",
                    "show_3d": "0",
                    "percent_left": "0",
                    "percent_right": "0",
                    "ymin_type": "1",
                    "ymax_type": "1",
                    "ymin_itemid": "0",
                    "ymax_itemid": "0",
                    "flags": "0"
                },
                {
                    "graphid": "645",
                    "name": "שימוש בשטח דיסק /",
                    "width": "600",
                    "height": "340",
                    "yaxismin": "0",
                    "yaxismax": "0",
                    "templateid": "0",
                    "show_work_period": "0",
                    "show_trigers": "0",
                    "graphtype": "2",
                    "show_legend": "1",
                    "show_3d": "1",
                    "percent_left": "0",
                    "percent_right": "0",
                    "ymin_type": "0",
                    "ymax_type": "0",
                    "ymin_itemid": "0",
                    "ymax_itemid": "0",
                    "דגלים": "4"
                }
            ],
            "מזהה": 1
       }

ראה גם

מקור

CGraph::get()‎ בתוך ui/include/classes/api/services/CGraph.php.