proxy.get

תיאור

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

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

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

פרמטרים

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

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

פרמטר סוג תיאור
proxyids string/array החזר רק פרוקסי עם המזהים הנתונים.
selectHosts query החזר מאפיין hosts כאשר המארחים מנוטרים על ידי ה-proxy.
selectInterface query החזר מאפיין ממשק עם ממשק ה-proxy בשימוש פרוקסי פסיבי.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

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

החזר ערכים

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

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

דוגמאות

אחזר את כל פרוקסי

אחזר את כל פרוקסי המוגדרים ואת הממשקים שלהם.

בַּקָשָׁה:

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

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "host": "פרוקסי פעיל",
             "status": "5",
             "lastaccess": "0",
             "תיאור": "",
             "tls_connect": "1",
             "tls_accept": "1",
             "tls_issuer": "",
             "tls_subject": "",
             "proxy_address": "",
             "auto_compress": "0",
             "proxyid": "30091",
             "ממשק": []
         },
         {
             "host": "פרוקסי פסיבי",
             "status": "6",
             "lastaccess": "0",
             "תיאור": "",
             "tls_connect": "1",
             "tls_accept": "1",
             "tls_issuer": "",
             "tls_subject": "",
             "proxy_address": "",
             "auto_compress": "0",
             "proxyid": "30092",
             "ממשק": {
                 "interfaceid": "30109",
                 "hostid": "30092",
                 "useip": "1",
                 "ip": "127.0.0.1",
                 "dns": "",
                 "port": "10051"
             ]
         }
     ],
     "מזהה": 1
}

מידע נוסף

מקור

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