hanode.get

תיאור

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

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

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

פרמטרים

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

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

פרמטר סוג תיאור
ha_nodeids string/array החזר רק צמתים עם מזהי הצמתים הנתונים.
filter object החזר רק את התוצאות המתאימות במדויק למסנן הנתון.

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

מאפשר סינון לפי מאפייני הצומת: שם, כתובת, סטטוס.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: name, lastaccess, status.
countOutput flag הפרמטרים הללו המשותפים לכל שיטות ה-'get' מתוארים בפירוט בפירוש ההתייחסות.
limit מספר שלם
פלט שאילתה
preservekeys בולאני
sortorder מחרוזת/מערך

החזר ערכים

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

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

דוגמאות

קבל רשימה של צמתים מסודרים לפי סטטוס

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hanode.get",
            "params": {
                "preservekeys": נכון,
                "sortfield": "סטטוס",
                "sortorder": "DESC"
            },
            "auth": "3a57200802b24cda67c4e4010b50c065",
            "מזהה": 1
       }

תְגוּבָה:

{
          "jsonrpc": "2.0",
          "תוצאה": {
            "ckuo7i1nw000h0sajj3l3hh8u": {
              "ha_nodeid": "ckuo7i1nw000h0sajj3l3hh8u",
              "name": "פעיל בצומת",
              "address": "192.168.1.13",
              "port": "10051",
              "lastaccess": "1635335704",
              "סטטוס": "3"
            },
            "ckuo7i1nw000e0sajwfttc1mp": {
              "ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
              "name": "node6",
              "address": "192.168.1.10",
              "port": "10053",
              "lastaccess": "1635332902",
              "סטטוס": "2"
            },
            "ckuo7i1nv000c0sajz85xcrtt": {
              "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
              "name": "node4",
              "address": "192.168.1.8",
              "port": "10052",
              "lastaccess": "1635334214",
              "status": "1"
            },
            "ckuo7i1nv000a0saj1fcdkeu4": {
              "ha_nodeid": "ckuo7i1nv000a0saj1fcdkeu4",
              "name": "node2",
              "address": "192.168.1.6",
              "port": "10051",
              "lastaccess": "1635335705",
              "סטטוס": "0"
            }
          },
          "מזהה": 1
       }

קבל רשימה של צמתים ספציפיים לפי המזהים שלהם

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hanode.get",
            "params": {
                "ha_nodeids": ["ckuo7i1nw000e0sajwfttc1mp", "ckuo7i1nv000c0sajz85xcrtt"]
            },
            "auth": "3a57200802b24cda67c4e4010b50c065",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
                    "name": "node4",
                    "address": "192.168.1.8",
                    "port": "10052",
                    "lastaccess": "1635334214",
                    "status": "1"
                },
                {
                    "ha_nodeid": "ckuo7i1nw000e0sajwfttc1mp",
                    "name": "node6",
                    "address": "192.168.1.10",
                    "port": "10053",
                    "lastaccess": "1635332902",
                    "סטטוס": "2"
                }
            ],
            "מזהה": 1
       }

קבל רשימה של צמתים עצורים

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hanode.get",
            "params": {
                "output": ["ha_nodeid", "כתובת", "יציאה"],
                "מסנן": {
                    "סטטוס": 1
                }
            },
            "auth": "3a57200802b24cda67c4e4010b50c065",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "ha_nodeid": "ckuo7i1nw000g0sajjsjre7e3",
                    "address": "192.168.1.12",
                    "port": "10051"
                },
                {
                    "ha_nodeid": "ckuo7i1nv000c0sajz85xcrtt",
                    "address": "192.168.1.8",
                    "port": "10052"
                },
                {
                    "ha_nodeid": "ckuo7i1nv000d0sajd95y1b6x",
                    "address": "192.168.1.9",
                    "port": "10053"
                }
            ],
            "מזהה": 1
       }

קבל ספירה של צמתי המתנה

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hanode.get",
            "params": {
                "countOutput": נכון,
                "מסנן": {
                    "סטטוס": 0
                }
            },
            "auth": "3a57200802b24cda67c4e4010b50c065",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "result": "3",
            "מזהה": 1
       }

בדוק את מצב הצמתים בכתובות IP ספציפיות

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hanode.get",
            "params": {
                "output": ["שם", "סטטוס"],
                "מסנן": {
                    "כתובת": ["192.168.1.7", "192.168.1.13"]
                }
            },
            "auth": "3a57200802b24cda67c4e4010b50c065",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "name": "node3",
                    "סטטוס": "0"
                },
                {
                    "name": "פעיל בצומת",
                    "סטטוס": "3"
                }
            ],
            "מזהה": 1
       }

מקור

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