alert.get

תיאור

integer/array alert.get(אובייקט פרמטרים)

השיטה מאפשרת לשחזר התראות לפי הפרמטרים הנתונים.

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

פרמטרים

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

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

פרמטר סוג תיאור
alertids string/array החזר רק התראות עם המזהים הנתונים.
actionids string/array החזר רק התראות שנוצרו על ידי הפעולות הנתונות.
eventids string/array החזר רק התראות שנוצרו על ידי האירועים הנתונים.
groupids string/array החזר רק התראות שנוצרו על ידי אובייקטים מקבוצות המארחות הנתונות.
hostids string/array החזר רק התראות שנוצרו על ידי אובייקטים מהמארחים הנתונים.
mediatypeids string/array החזר רק התראות על הודעות שהשתמשו בסוגי המדיה הנתונים.
objectids string/array החזר רק התראות שנוצרו על ידי האובייקטים הנתונים
userids string/array החזר רק התראות הודעות שנשלחו למשתמשים הנתונים.
eventobject integer החזר רק התראות שנוצרו על ידי אירועים הקשורים לאובייקטים מהסוג הנתון.

ראה אירוע "object" לקבלת רשימה של סוגי אובייקטים נתמכים.

ברירת מחדל: 0 - טריגר.
eventsource integer החזר רק התראות שנוצרו על ידי אירועים מהסוג הנתון.

ראה אירוע "source" לקבלת רשימה של סוגי אירועים נתמכים .

ברירת מחדל: 0 - אירועי טריגר.
time_from timestamp החזר רק התראות שנוצרו לאחר הזמן הנתון.
time_till timestamp החזר רק התראות שנוצרו לפני הזמן הנתון.
selectHosts query החזר מאפיין hosts עם נתונים של מארחים שהפעילו את פעולת הפעולה.
selectMediatypes query החזר מאפיין mediatypes עם מערך של סוגי המדיה ששימשו להתראת ההודעה.
selectUsers query החזר מאפיין משתמשים עם מערך של המשתמשים שאליהם הופנתה ההודעה.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: alertid, clock, eventid, mediatypeid, sendto וstatus.
countOutput boolean הפרמטרים האלה משותפים לכל שיטות ה-'get' מתוארים בפירוש ההתייחסות.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled boolean
sortorder מחרוזת/מערך
startSearch boolean

ערכים מוחזרים

(integer/array) מחזירה כל אחד מאלה:

  • מערך של עצמים;
  • כמות העצמים שנמשכו, אם נעשה שימוש במשתנה countOutput.

דוגמאות

אחזר התראות לפי מזהה פעולה

אחזר את כל ההתראות שנוצרו על ידי פעולה "3".

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "alert.get",
            "params": {
                "output": "להרחיב",
                "actionids": "3"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "alertid": "1",
                    "actionid": "3",
                    "eventid": "21243",
                    "userid": "1",
                    "שעון": "1362128008",
                    "mediatypeid": "1",
                    "sendto": "[email protected]",
                    "subject": "בעיה: סוכן Zabbix בשרת לינוקס אינו נגיש במשך 5 דקות: ",
                    "message": "טריגר: סוכן Zabbix בשרת Linux אינו ניתן לגישה במשך 5 דקות: \nסטטוס טריגר: בעיה\nחומרת ההפעלה: לא מסווג",
                    "status": "0",
                    "מחדש": "3",
                    "error": "",
                    "esc_step": "1",
                    "alerttype": "0",
                    "p_eventid": "0",
                    "acknowledgeid": "0"
                }
            ],
            "מזהה": 1
       }

מידע נוסף

מקור

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