dservice.get

תיאור

integer/array dservice.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
dserviceids string/array החזר רק שירותים שהתגלו עם המזהים הנתונים.
dhotids string/array החזר רק שירותים שהתגלו השייכים למארחים שנתגלו.
dcheckids string/array החזר רק שירותים שהתגלו שזוהו על ידי בדיקות הגילוי שניתנו.
druleids string/array החזר רק שירותים שהתגלו שזוהו על ידי כללי הגילוי הנתונים.
selectDRules query החזר מאפיין drules עם מערך של כללי הגילוי שזיהו את השירות.
selectDHosts query החזר מאפיין dhosts עם מערך המארחים שהתגלו שאליהם שייך השירות.
selectHosts query החזר מאפיין hosts עם המארחים עם אותה כתובת IP ופרוקסי כמו השירות.

תומך ב'count'.
limitSelects integer מגביל את מספר הרשומות המוחזרות על ידי subselects.

חל על subselects הבאות:
selectHosts - התוצאה תמוין לפי hostid.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזר שירותים שהתגלו במארח

אחזר את כל השירותים שהתגלו שזוהו במארח שהתגלה "11".

בַּקָשָׁה:

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

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "dserviceid": "12",
                    "dhostid": "11",
                    "ערך": "",
                    "port": "80",
                    "status": "1",
                    "lastup": "0",
                    "lastdown": "1348650607",
                    "dcheckid": "5",
                    "ip": "192.168.1.134",
                    "dns": "john.local"
                },
                {
                    "dserviceid": "13",
                    "dhostid": "11",
                    "ערך": "",
                    "port": "21",
                    "status": "1",
                    "lastup": "0",
                    "lastdown": "1348650610",
                    "dcheckid": "6",
                    "ip": "192.168.1.134",
                    "dns": "john.local"
                }
            ],
            "מזהה": 1
       }

See also

מקור

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