NAV סרגל ניווט
לוגו
פָּגָז

ממשק ה- API של Zevenet Community Edition v3.1

ZAPI (Zevenet Application Programming Interface) הוא הכלי עבור מנהל המערכת כדי לפקח Zevenet עומס איזון התנהגות.

יש צורך פעיל zapi המשתמש מממשק האינטרנט לפני השימוש בו, מערכת / משתמשים.

לאחר שהמשתמש zapi נוצר, ניתן לשלוח בקשה לכתובת URL, https: // (zevenet_server): 444 / zapi / v3.1 / zapi.cgi / (URI_path), שם zevenet_server הוא ה- IP שבו שירות HTTP מקשיב.

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

הפעלים המשמשים בממשק API זה יהיו לקבל, POST, PUT or למחוק. בקשת PUT או POST תמיד זקוקה כמעט לפרמטר אם כי אין בכך צורך בפרמטר נדרש.

תעודות

Zevenet תומך cetificates בפורמט PEM להשתמש בהם עם חוות HTTP שלך עם המאזין HTTPS. אם אתה רוצה ללמוד עוד על איך ליצור אישורים pem אנא בקר במאמר הבא: יצירת תעודות ב PEM פורמט

רשום את כל האישורים

רשום את כל האישורים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates

GET /certificates

רשימת כל אישורי CSR ו- PEM בחנות אישורים, אישורים אלה ניתן להשתמש עם חוות HTTPS.

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים אישור, שכל אחד מהם מכילים את תכונות המפתח להלן.

דוגמה לתגובה:

{
   "description" : "List all certificates",
   "params" : [
      {
         "CN" : "Zen Load Balancer",
         "creation" : "Jan 12 14:49:03 2011 GMT",
         "expiration" : "Jan  9 14:49:03 2021 GMT",
         "file" : "zencert.pem",
         "issuer" : "Zen Load Balancer",
         "type" : "Certificate"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימה של אובייקטים אישור.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
תפוגה מחרוזת תאריך תפוגה.
פילה מחרוזת שם הקובץ של התעודה, מזהה ייחודי.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
סוג מחרוזת CSR או אישור.

הורד אישור

הורד אישור

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem

GET /certificates/<file>

הורד אישור המותקן בחנות אישורים, השתמש בשם הקובץ בבקשה לזהות אותו.

התגובה תכלול את הכותרות המצוינות למטה עם מידע על הקובץ. גוף התגובה יהיה תוכן הקובץ.

כותרות תגובה:

HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359

מחיקת אישור

מחיקת אישור

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem

DELETE /certificates/<file>

מחיקת אישור לפי שם קובץ בחנות אישורים.

דוגמה לתגובה:

{
   "description" : "Delete certificate",
   "message" : "The Certificate example.pem has been deleted.",
   "success" : "true"
}

צור אישור אחריות חברתית

צור אישור אחריות חברתית

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates

POST /certificates

צור בקשת חתימה של אישור (קובץ CSR).

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם מחרוזת שם תעודת הזהות. נכון
fqdn מחרוזת שם התחום המלא של השרת שלך. נכון
חלוק מחרוזת חלוקת הארגון שלך בטיפול בתעודה. נכון
ארגון מחרוזת השם החוקי של הארגון שלך. נכון
יישוב מחרוזת העיר שבה נמצא הארגון שלך. נכון
היו מחרוזת המדינה / האזור שבהם נמצא הארגון שלך. נכון
מדינה מחרוזת קוד ISO בן שתי האותיות עבור הארץ שבה הארגון שלך נמצא במיקום. נכון
דואר מחרוזת כתובת דוא"ל המשמשת ליצירת קשר עם הארגון שלך. נכון

דוגמה לתגובה:

{
   "description" : "Create CSR",
   "message" : "Certificate NewCSR created",
   "success" : "true"
}

העלה אישור

העלה אישור

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem

POST /certificates/<file>

העלה אישור PEM עבור חוות HTTP עם המאזין HTTPS.

דורש את הפרמטר --tcp-nodelay, ו --data-binary כדי להעלות את הקובץ במצב בינארי.

בקש פרמטרים של URI

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

דוגמה לתגובה:

{
   "description" : "Upload PEM certificate",
   "message" : "Certificate uploaded",
   "success" : "true"
}

רשימת צופן

רשימת צופן

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/ciphers

GET /ciphers

רשום את הצופן הזמין שחוות HTTPS יכולה להשתמש בו.

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים אישור, שכל אחד מהם מכילים את תכונות המפתח להלן.

דוגמה לתגובה:

{
   "description" : "Get the ciphers available",
   "params" : [
      {
         "ciphers" : "all",
         "description" : "All"
      },
      {
         "ciphers" : "highsecurity",
         "description" : "High security"
      },
      {
         "ciphers" : "customsecurity",
         "description" : "Custom security"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימה של אובייקטים אישור.

אובייקט אישור

שדה סוּג תיאור
Ciphers מחרוזת הוא משמש כמזהה ייחודי.
תיאור מחרוזת שם ידידותי.

חוות

Zevenet היא מסוגלת לנהל את התנועה בשלוש דרכים שונות, בכל דרך מנוהלת על ידי מודול אחר, איזון עומס שירות מקומי או מודול LSLB ו Datalink Service Load Balancer או מודול DSLB.

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

רשום את כל החוות

רשום את כל החוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms

GET /farms

רשום את כל החוות הזמינות

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים לחידוש משק, שכל אחד מהם מכיל את תכונות המפתח להלן.

אובייקט החווה

שדה סוּג תיאור
שם החווה מחרוזת שם תיאור החווה. הוא משמש כמזהה ייחודי.
פרופיל מחרוזת סוג הפרופיל, ערכי הפרופיל הזמינים הם: http, https or l4xnat עבור מודול LSLB ו DataLink עבור מודול DSLB
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת Virtual IP שבו החווה מקבלת תנועה
גווניה מחרוזת יציאה וירטואלית שבה החווה מקבלת תנועה, הערכים הזמינים של הנמל הם: מספר יציאה עבור http [s] ו- l4xnat, קבוצת יציאות המופרדת על ידי "," או טווח יציאה המופרד על ידי ":" עבור פרופילי l4xnat, ב- l4xnat שניהם המפריד ניתן להשתמש בערכים ("," ו- ":") באותו שדה.

דוגמה לתגובה:

{
   "description" : "List farms",
   "params" : [
      {
         "farmname" : "httpFarm",
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.101.146",
         "vport" : "81"
      }
   ]
}

מחק משק חקלאי

מחק משק חקלאי

דוגמה לבקשה:

curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP

DELETE /farms/<farmname>

מחק חווה באמצעות שם החווה שלו identfier.

דוגמה לתגובה:

{
  "description" : "Delete farm FarmHTTP",
  "message" : "The Farm FarmHTTP has been deleted.",
  "success" : "true"
}

הגדר פעולה בחווה

הגדר פעולה בחווה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmTCP/actions

PUT /farms/<farmname>/actions

החל פעולה על חווה, עיין בטבלה פרמטרים בקשה לפעולות.

פרמטרים של בקשה

שדה סוּג תיאור
פעולה מחרוזת הגדר את הפעולה הרצויה. הפעולות הן: להפסיק, החווה תיעצר. התחלה, החווה תתחיל ו הפעלה מחדש, החווה תיעצר ותתחיל באופן אוטומטי.

דוגמה לתגובה:

{
  "description" : "Set a new action in FarmHTTP",
  "params" : [
     {
        "action" : "stop"
     }
  ]
}

פרמטרים של תגובה

אם אין בעיות בתצורה, zapi יחזיר את הפעולה המבוקשת.

חוות HTTP

פרופיל HTTP הוא שכבה מתקדמת 7 איזון עומס (או יישום Application Controller) עם מאפיינים מיוחדים proxy. פרופיל זה מציע כמה תכונות כמו HTTPS שכבת 7 איזון עומסים. פרופיל זה מיועד לשירותי אינטרנט (שרתי יישומי אינטרנט כלולים) וכל פרוטוקולי היישום המבוססים על פרוטוקולי HTTP ו- HTTPS כמו WebDav, RDP over HTTP, ICA over HTTP וכו '. כדי להגדיר פרופיל משק זה, כתובת IP וירטואלית יציאת TCP וירטואלית תידרש.

אחזר את החווה לפי שם

אחזר את החווה לפי שם

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/httpFarm

GET /farms/<farmname>

הצג את כל תצורת החווה.

דוגמה לתגובה:

{
   "description" : "List farm httpFarm",
   "params" : {
      "certlist" : [
         {
            "file" : "zencert.pem",
            "id" : 1
         }
      ],
      "cipherc" : "ALL",
      "ciphers" : "all",
      "contimeout" : 20,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "error414" : "Request URI is too long.",
      "error500" : "An internal server error occurred. Please try again later.",
      "error501" : "This method may not be used.",
      "error503" : "The service is not available. Please try again later.",
      "httpverb" : "MSRPCext",
      "listener" : "https",
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
      {
         "backends" : [
            {
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null
            }
         ],
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "tcp_check",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
params חפץ פרמטרים של תצורה חקלאית.
שירותים אובייקט [] מערך עם כל השירותים שנוצרו בחווה זו ואת התצורה שלה.

אובייקט פרמטרים עבור חוות HTTP:

שדה סוּג תיאור
certlist אובייקט [] רק בפרופיל https. אישור מופעל בחווה, בפורמט pem, מותר להוסיף רק תעודת אחד pem לאותה החווה. המאזין עם ערך https נדרש. כל תעודת פם בחנות אישורים ניתן להשתמש כאן.
cipherc מחרוזת רק במאזין https. זוהי רשימה מותאמת אישית של צופן שיתקבל על ידי חיבור SSL, שהוא מחרוזת באותו פורמט כמו בצופן OpenSSL. זה atribute משמש רק כאשר Ciphers שדה יש ​​ערך sutomsecurity.
Ciphers מחרוזת רק מאזין עם ערך https. משמש כדי לבנות רשימה של צופן המקובל על ידי חיבורי SSL כדי להקשיח את חיבור SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; או - מכס, רק ciphers טעון ב cipherc שדה יתקבל.
ת מספר כמה זמן החווה הולך לחכות חיבור TCP כדי backend בתוך שניות.
disable_sslv2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון את הקישורים באמצעות פרוטוקול אבטחה SSL עם גרסה 2 אסור; או שקר אם פרוטוקול SSLv2 מותר.
disable_sslv3 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון את הקישורים באמצעות פרוטוקול אבטחה SSL עם גרסה 3 אסור; או שקר אם פרוטוקול SSLv3 מותר.
disable_tlsv1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1 אסורים; או שקר אם פרוטוקול TLSv1 מותר.
disable_tlsv1_1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.1 אסורים; או שקר אם פרוטוקול TLSv1.1 מותר.
disable_tlsv1_2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.2 אסורים; או שקר אם פרוטוקול TLSv1.2 מותר.
error414 מחרוזת הודעה מותאמת אישית עבור תגובה לקוד השגיאה של 414 HTTP.
error500 מחרוזת הודעה מותאמת אישית עבור תגובה לקוד השגיאה של 500 HTTP.
error501 מחרוזת הודעה מותאמת אישית עבור תגובה לקוד השגיאה של 501 HTTP.
error503 מחרוזת הודעה מותאמת אישית עבור תגובה לקוד השגיאה של 503 HTTP.
http מחרוזת שדה זה מציין את הפעולות שיהיו מותרות בבקשות הלקוח של HTTP. הערכים הזמינים הם: סטנדרטי, בקשות naccepted http קבל, פוסט, HEAD. extendedHTTP, קיבל בקשות http הקודמת בתוספת PUT, DELETE. תקן, קיבל בקשות HTTP הקודם בתוספת LOCK, UNLOCK, PROPPATCH, חיפוש, MKCOL, MOVE, COPY, אפשרויות, TRACE, MKACTIVITY, CHECKOUT, MERGE, MSextWebDAV קיבל בקשות HTTP קודמות ועוד הירשם, בטל רישום, ציין, BPROPFIND, BPROPPATCH, POLL, BMOV, BCOPY, BDELETE, CONNECT או MSRPCext, קיבל בקשות HTTP קודמות ו- RPC_IN_DATA, RPC_OUT_DATA. שים לב כי ערכים אלה הם רגישים למקרה.
מאזין מחרוזת המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח.
זמן מספר כמה זמן החווה הולך לחכות לבקשת הלקוח בתוך שניות.
restimeout מספר כמה זמן החווה הולך לחכות תגובה מן backends בתוך שניות.
לתחייה מספר התקופה לצאת שרת אמיתי נפל, לאחר תקופה זו איזון עומס בודק אם השרת האמיתי הוא חי, בתוך שניות.
שכתוב מחדש מחרוזת אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל, מופעל נכה, אינו פעיל או מאופשר- backends רק את כתובת backend מושווה.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.

אובייקט Certlist:

שדה סוּג תיאור
פילה מחרוזת שם האישור, הפניות לאישור בחנות אישורים.
id מספר מזהה תעודה.

אובייקט שירותים עבור חוות HTTP:

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
fgenabled מחרוזת הפעל את השימוש באפוטרופוס החווה. נכון אפוטרופוס החווה מופעלת ובודקת מצב backends, שקר אפוטרופוס החווה מושבת ולא בודק מצב backenders. בפרופילי HTTP, check_tcp מבוצע כברירת מחדל גם אם האפוטרופוס של החווה מושבת.
fglog מחרוזת הפעל את השימוש ביומנים באפוטרופוס של החווה. נכון מאופשר, שקר, מושבת. fgenabled נדרש.
fgscript מחרוזת הפקודה אשר אפוטרופוס החווה ישתמש לבדיקת בריאות backends. נכון מאופשר, שקר, מושבת. fgenabled נדרש.
לבדוק מספר אפוטרופוס החווה יבדוק בכל 'שניות' בדיקות את מצב הבריאות. fgenabled נדרש.
https מחרוזת פרמטר זה מציין לחווה כי שרתי backend שהוגדרו בשירות הנוכחי משתמשים בשפה HTTPS ולאחר מכן הנתונים יהיו מוצפנים לפני שנשלחו. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.
id מחרוזת שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות.
leastresp מחרוזת זה מאפשר את שיטת האיזון לפחות להגיב. נכון frecuently פרופיל בודק אשר backend לוקח פחות זמן להגיב על מנת לשלוח קשרים נוספים זה, שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
הפניה מחרוזת זה מתנהג כמו backend מיוחד, כמו בקשת הלקוח הוא ענה על ידי הפנייה מחדש לכתובת חדשה באופן אוטומטי. אם הוגדרה כתובת אתר להפניה מחדש, הבקשה לא תועבר אל ה- backend, במקום זאת, כתובת אתר להפניה מחדש תגיב ללקוח.
redirecttype מחרוזת כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה.
sessionid מחרוזת זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת http וינהל את הפעלת הלקוח.
Ttl מספר רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך.
ווסט מחרוזת הוא מציין את המצב שנקבע על ידי שם התחום באמצעות אותה כתובת IP וירטואלית ויציאה שהוגדרו על ידי חוות HTTP. ביטוי רגיל PCRE נתמך.

אובייקט Backend עבור חוות HTTP:

שדה סוּג תיאור
id מספר מזהה לאחור בתוך השירות הנתון.
ip מחרוזת ה- IP של Backend שבו פועל השירות האמיתי.
נמל מספר הנמל של Backend שבו פועל השירות האמיתי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. אם מערכת null תשתמש בפרמטר הגלובלי Backends Backout.
מִשׁקָל מספר זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"farmname":"newHTTPfarm", "profile":"http", "vip":"192.168.100.23", 
"vport":80}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms

POST /farms

צור חוות HTTP חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם תיאור החווה. הוא משמש כמזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות ה- http הוא http. נכון
החברים מחרוזת IP של החווה, שבו השירות הווירטואלי הולך לרוץ. כתובת ה- IP שצוינה חייבת להיות מוגדרת במערכת ו- UP נכון
גווניה מספר נמל של החווה, שבו השירות הווירטואלי הולך להקשיב. אותו נמל וירטואלי וכתובת IP וירטואלית אינם חייבים להיות בשימוש על ידי חוות אחרת. נכון

דוגמה לתגובה:

{
   "description" : "Creating farm 'newHTTPfarm'",
   "params" : {
      "farmname" : "newHTTPfarm",
      "profile" : "http",
      "vip" : "192.168.100.23",
      "vport" : 80
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP", 
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501", 
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP 

PUT /farms/<farmname>

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

פרמטרים של בקשה

שדה סוּג תיאור
ת מספר כמה זמן את החווה הולך לחכות חיבור backend בתוך שניות.
restimeout מספר כמה זמן החווה הולך לחכות תגובה מן backends בתוך שניות.
לתחייה מספר ערך זה בשניות הוא פרק הזמן להוציא backended backend ובודק אם הוא חי.
זמן מספר כמה זמן החווה הולך לחכות לבקשת הלקוח בתוך שניות.
disable_sslv2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון את הקישורים באמצעות פרוטוקול אבטחה SSL עם גרסה 2 אסור; או שקר אם פרוטוקול SSLv2 מותר.
disable_sslv3 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון את הקישורים באמצעות פרוטוקול אבטחה SSL עם גרסה 3 אסור; או שקר אם פרוטוקול SSLv3 מותר.
disable_tlsv1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1 אסורים; או שקר אם פרוטוקול TLSv1 מותר.
disable_tlsv1_1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.1 אסורים; או שקר אם פרוטוקול TLSv1.1 מותר.
disable_tlsv1_2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.2 אסורים; או שקר אם
שכתוב מחדש מחרוזת אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל, מופעל נכה, אינו פעיל או מאופשר- backends רק את כתובת backend מושווה.
http מחרוזת שדה זה מציין את הפעולות שיהיו מותרות בבקשות הלקוח של HTTP. הערכים הזמינים הם: סטנדרטי, בקשות naccepted http קבל, פוסט, HEAD. extendedHTTP, קיבל בקשות http הקודמת בתוספת PUT, DELETE. תקן, קיבל בקשות HTTP הקודם בתוספת LOCK, UNLOCK, PROPPATCH, חיפוש, MKCOL, MOVE, COPY, אפשרויות, TRACE, MKACTIVITY, CHECKOUT, MERGE, MSextWebDAV קיבל בקשות HTTP קודמות ועוד הירשם, בטל רישום, ציין, BPROPFIND, BPROPPATCH, POLL, BMOV, BCOPY, BDELETE, CONNECT או MSRPCext, קיבל בקשות HTTP קודמות ו- RPC_IN_DATA, RPC_OUT_DATA. שים לב כי ערכים אלה הם רגישים למקרה.
error414 מחרוזת הודעת שגיאה מותאמת אישית 414.
error500 מחרוזת הודעת שגיאה מותאמת אישית 500.
error501 מחרוזת הודעת שגיאה מותאמת אישית 501.
error503 מחרוזת הודעת שגיאה מותאמת אישית 503.
מאזין מחרוזת המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח.
Ciphers מחרוזת רק מאזין עם ערך https. משמש כדי לבנות רשימה של צופן המקובל על ידי חיבורי SSL כדי להקשיח את חיבור SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; או - מכס, רק ciphers טעון ב cipherc שדה יתקבל.
cipherc מחרוזת רק במאזין https. זוהי רשימה מותאמת אישית של צופן שיתקבל על ידי חיבור SSL, שהוא מחרוזת באותו פורמט כמו בצופן OpenSSL. זה atribute משמש רק כאשר Ciphers שדה יש ​​ערך sutomsecurity.
newfarmname מחרוזת שם החווה החדשה. חייבים להפסיק את החווה.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב, IP זה חייב להיות מוגדר ומעלה במערכת.

דוגמה לתגובה:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
      "ciphers" : "customsecurity",
      "contimeout" : 22,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "error414" : "Message error 414",
      "error500" : "Message error 500",
      "error501" : "Message error 501",
      "error503" : "Message error 503",
      "httpverb" : "standardHTTP",
      "listener" : "https",
      "newfarmname" : "FarmHTTP",
      "reqtimeout" : 32,
      "restimeout" : 47,
      "resurrectime" : 12,
      "rewritelocation" : "enabled",
      "vip" : "178.62.126.152",
      "vport" : 88
   }
}

פרמטרים של תגובה

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

הוסף אישור

הוסף אישור

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"file":"example.pem"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/httpFarm/certificates

POST /farms/<farmname>/certificates

שנה את אישור ה- PEM של חוות HTTP עם מאזין HTTPS. התעודה המשומשת חייבת להיות מועלית כבר במערכת, ראה אישורים> רשום את כל האישורים עבור רשימת האישורים הזמינים.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פילה מחרוזת שם קובץ אישור, בעבר יש להעלות את האישור במערכת. נכון

דוגמה לתגובה:

{
   "description" : "Add certificate",
   "message" : "The certificate example.pem has been added to the farm httpFarm, you need restart the farm to apply",
   "success" : "true",
   "status": "needed restart"
}

HTTP - שירותים

השירותים בתוך חוות פרופיל HTTP מספק שיטת מיתוג תוכן כדי לספק מספר שירותי אינטרנט עם מאפיינים שונים, backends או אפילו שיטות התמדה, באמצעות כמה תנאים דטרמיניסטי בשימוש על ידי הליבה החווה על מנת להתאים את השירות הנכון עבור כל בקשה ללקוח. הגדרת שירות זו תשמש את החווה על מנת לקבוע את שרתי backend שיכולים לספק את התגובה ללקוח.

אובייקט שירות פנים ישנם שני סוגים של ערכים: הקשורים שירות הקשורים farmguardian.

Farmguardian משמש לניטור מתקדמות המדינה backends ו אישית לחלוטין עבור scripts משלך עבור השירות הנוכחי. כאשר בעיה מזוהה על ידי חקלאי משבית באופן אוטומטי את השרת האמיתי ויהיה מסומן כרשימה שחורה.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/cookiefarm/services/serv

GET /farms/<farmname>/services/<id>

הצג את כל התצורה לגבי שירות מסוים.

דוגמה לתגובה:

{
   "description" : "Get services of a farm",
   "services" : {
      "backends" : [
         {
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : 20,
            "weight" : null
         },
         {
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null
         }
      ],
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "check_tcp -H HOST -p PORT",
      "fgtimecheck" : 5,
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : ""
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט שירותים עבור חוות HTTP:

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
fgenabled מחרוזת הפעל את השימוש באפוטרופוס החווה. נכון אפוטרופוס החווה מופעלת ובודקת מצב backends, שקר אפוטרופוס החווה מושבת ולא בודק מצב backenders. בפרופילי HTTP, check_tcp מבוצע כברירת מחדל גם אם האפוטרופוס של החווה מושבת.
fglog מחרוזת הפעל את השימוש ביומנים באפוטרופוס של החווה. נכון מאופשר, שקר, מושבת. fgenabled נדרש.
fgscript מחרוזת הפקודה אשר אפוטרופוס החווה ישתמש לבדיקת בריאות backends. נכון מאופשר, שקר, מושבת. fgenabled נדרש.
לבדוק מספר אפוטרופוס החווה יבדוק בכל 'שניות' בדיקות את מצב הבריאות. fgenabled נדרש.
https מחרוזת פרמטר זה מציין לחווה כי שרתי backend שהוגדרו בשירות הנוכחי משתמשים בשפה HTTPS ולאחר מכן הנתונים יהיו מוצפנים לפני שנשלחו. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.
id מחרוזת שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות.
leastresp מחרוזת זה מאפשר את שיטת האיזון לפחות להגיב. נכון frecuently פרופיל בודק אשר backend לוקח פחות זמן להגיב על מנת לשלוח קשרים נוספים זה, שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
הפניה מחרוזת זה מתנהג כמו backend מיוחד, כמו בקשת הלקוח הוא ענה על ידי הפנייה מחדש לכתובת חדשה באופן אוטומטי. אם הוגדרה כתובת אתר להפניה מחדש, הבקשה לא תועבר אל ה- backend, במקום זאת, כתובת אתר להפניה מחדש תגיב ללקוח.
redirecttype מחרוזת כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה.
sessionid מחרוזת זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת http וינהל את הפעלת הלקוח.
Ttl מספר רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך.
ווסט מחרוזת הוא מציין את המצב שנקבע על ידי שם התחום באמצעות אותה כתובת IP וירטואלית ויציאה שהוגדרו על ידי חוות HTTP. ביטוי רגיל PCRE נתמך.

אובייקט Backend עבור חוות HTTP:

שדה סוּג תיאור
id מספר מזהה לאחור בתוך השירות הנתון.
ip מחרוזת ה- IP של Backend שבו פועל השירות האמיתי.
נמל מספר הנמל של Backend שבו פועל השירות האמיתי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. אם מערכת null תשתמש בפרמטר הגלובלי Backends Backout.
מִשׁקָל מספר זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה.

צור שירות חדש

צור שירות חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services

POST /farms/<farmname>/services

יצירת שירות בפרופיל HTTP נתון בחווה. החווה זקוקה לפעולת הפעלה מחדש כדי להחיל שינוי זה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
id מחרוזת שם שירות המשמש כמזהה ייחודי. רק ערכים אלפאנומריים מותרים. נכון

דוגמה לתגובה:

{
   "description" : "New service newserv",
   "params" : {
      "id" : "newserv"
   },
   "status" : "needed restart"
}

שינוי שירות

שינוי שירות

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL",
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","leastresp":"true",
"httpsb":"true"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/sev2

PUT /farms/<farmname>/services/<id>

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

פרמטרים של בקשה

שדה סוּג תיאור
ווסט מחרוזת מציין את המצב שנקבע על-ידי שם התחום באמצעות אותו כתובת IP וירטואלית ויציאה שהוגדרו על-ידי חוות פרופיל של HTTP. ביטוי רגיל PCRE נתמך.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך.
הפניה מחרוזת זה עובד כמו backend מיוחד, בקשת הלקוח הוא ענה על ידי הפנייה מחדש כתובת אתר חדשה באופן אוטומטי.
redirecttype מחרוזת כיצד תבוצע הפנייה מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת הפניה שדה. התנהגות זו תחול רק אם הפניה אינו ערך ריק.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם מושב ההתמדה נעשה בבסיס ערך המופרד על ידי ";" בסוף ה- URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
Ttl מספר רק בהתמדה. הזמן המרבי של החיים עבור הפעלת לקוח לא פעיל (גיל הפעלה מירבי) בשניות.
sessionid מחרוזת זה זמין אם התמדה שדה כתובת האתר, עוגייה or HEADER, ערך הפרמטר יחפש על ידי הפרופיל בכותרת http וינהל את הפעלת הלקוח.
leastresp מחרוזת זה מאפשר את שיטת האיזון לפחות להגיב. נכון, באופן חופשי את הפרופיל בודק אשר backend לוקח פחות זמן להגיב על מנת לשלוח קשרים נוספים זה, שקר, הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
https מחרוזת זה מציין לחווה כי שרתי backends שהוגדרו בשירות הנוכחי משתמשים בשפה HTTPS ולאחר מכן הנתונים יהיה מוצפן לפני להישלח. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.

דוגמה לתגובה:

{
   "description" : "Modify service newsrv in farm newHTTPfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "backends" : [],
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "",
      "fgtimecheck" : 5,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirecttype" : "default",
      "sessionid" : "sid",
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com"
   },
   "status" : "needed restart"
}

פרמטרי תגובה

התגובה תהיה json עם פרמטרים המבוקש עודכן מצב שדה עם יש צורך מחדש ערך. יש לבצע פעולת הפעלה מחדש כדי להחיל את השינויים.

שינוי אפוטרופוס החווה

שינוי אפוטרופוס החווה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"check_tcp","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/fg

Farmguardian משמש לניטור מתקדמות המדינה backends ו אישית לחלוטין עבור scripts משלך עבור השירות הנוכחי. כאשר בעיה מזוהה על ידי חקלאי משבית באופן אוטומטי את השרת האמיתי ויהיה מסומן כרשימה שחורה.

PUT /farms/<farmname>/fg

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

פרמטרים של בקשה

שדה סוּג תיאור דרוש
לבדוק מספר האפוטרופוס החקלאי יבדוק את מצב הבריאות האחורי בכל שניות 'לוח בדיקה'.
fgscript מחרוזת הפקודה אשר אפוטרופוס החווה יפעל לבדיקת מצב בריאותי backends
fgenabled מחרוזת הוא מאפשר אפוטרופוס החווה בשירות המצוין. נכון משק אפריקאי הולך לשמש לבדיקת מצב backenders, שקר אפוטרופוס החווה הולך להיות מושבת
fglog מחרוזת הפעל את השימוש ביומנים באפוטרופוס של החווה. נכון אפוטרופוס החווה עומד להיכנס כל פעולה, שקר אפוטרופוס החווה לא הולך להיכנס כל פעולה, מומלץ להפעיל fglog רק לפתרון בעיות.
שרות מחרוזת שם השירות משמש כמזהה ייחודי. נכון

דוגמה לתגובה:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "fgenabled" : "true",
      "fglog" : "true",
      "fgscript" : "checktcp",
      "fgtimecheck" : 5,
      "service" : "service1"
   }
}

מחיקת שירות

מחיקת שירות

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/service1

DELETE /farms/<farmname>/services/<id>

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

דוגמה לתגובה:

{
  "description" : "Delete service service1 in farm FarmHTTP",
  "message" : "The service service1 in farm FarmHTTP has been deleted.",
  "success" : "true",
  "status": "needed restart"
}

HTTP - שירותים - Backends

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/service1/backends

GET /farms/<farmname>/services/<id>/backends

קבל את רשימת backends בשירות. id הוא המזהה הייחודי לשירות.

דוגמה לתגובה:

{
   "description" : "List service backends",
   "params" : [
      {
         "id" : 0,
         "ip" : "192.168.0.10",
         "port" : 88,
         "status" : "up",
         "timeout" : 12,
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.168.102.245",
         "port" : 80,
         "status" : "up",
         "timeout" : 22,
         "weight" : 2
      }
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
id מספר מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/newsrv/backends

POST /farms/<farmname>/services/<id>/backends

צור Backend חדש בפרופיל HTTP נתון. id הוא המזהה הייחודי לשירות.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין. נכון
נמל מספר הנמל של Backend שבו השירות מאזין. נכון
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי.

דוגמה לתגובה:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 0,
      "ip" : "192.168.102.244",
      "port" : 80,
      "timeout" : 2,
      "weight" : 2
   },
   "status" : "needed restart"
}

פרמטרי תגובה

התגובה תהיה json עם פרמטרים המבוקש עודכן מצב שדה עם יש צורך מחדש אם החווה חייבת להיות מופעלת מחדש. יש לבצע פעולת הפעלה מחדש כדי להחיל את השינויים.

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.0.10","port":88,"timeout":12,"service":"sev2", "weight":1}' 
  https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/service/service1/backends/1

PUT /farms/<farmname>/service/<id>/backends/<id>

שינוי הפרמטרים של backend בשירות של פרופיל HTTP.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי.

דוגמה לתגובה:

{
   "description" : "Modify service backend",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.0.10",
      "port" : 88,
      "timeout" : 12,
      "weight" : 1
   },
   "status" : "needed restart"
}

פרמטרי תגובה

התגובה תהיה json עם פרמטרים המבוקש עודכן מצב שדה עם יש צורך מחדש אם החווה חייבת להיות מופעלת מחדש. יש לבצע פעולת הפעלה מחדש כדי להחיל את השינויים.

אחורה בתחזוקה

אחורה בתחזוקה

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance

PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance

הגדר פעולה מסוימת בגב של חומת HTTP, הפעולות הזמינות מתוארות בהמשך.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת הגדר את הפעולה הרצויה. הפעולות הן: up backend הוא מוכן לקבל בקשות הלקוח, תחזוקה backend אינו מוכן לקבל בקשות לקוח, פעולה זו שימושית עבור עצירת שרת backend מבלי להשפיע על הלקוחות. נכון
מצב מחרוזת בחר מצב תחזוקה. האפשרויות הזמינות הן: לנקז, ה- backend אינו מקבל חיבורים חדשים, אך הוא ימשיך לטפל בחיבורים הנוכחיים; אוֹ לחתוך, הקשרים הנוכחיים ייסגרו. אם שדה זה לא צוין, מצב ברירת המחדל יהיה לנקז.

דוגמה לתגובה:

{
   "description" : "Set service backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4

DELETE /farms/<farmname>/services/<id>/backends/<id>

מחיקת backend נתון בשירות של פרופיל HTTP.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete service backend",
   "message" : "Backend removed",
   "success" : "true"
}

L4xNAT חוות

החווה פרופיל L4xAT מאפשר ליצור חוות L4 עם ביצועים גבוהים מאוד חיבורים בו זמנית הרבה יותר מאשר ליבות איזון עומסים בשכבה 7 כמו פרופילים החווה HTTP. זה שיפור ביצועים 4 שכבת counteracts את הטיפול תוכן מתקדם כי פרופילי שכבת 7 יכול לנהל.

בנוסף, חוות L4xNAT יכולים לקשור טווח של יציאות, לא רק יציאה וירטואלית אחת, כפי שהיא משמשת עם פרופילי 7 שכבה אחרים. כדי שתוכל לבחור טווח של יציאות וירטואליות או יציאה וירטואלית ספציפית בחוות L4xNAT, חובה לבחור סוג פרוטוקול. במקרה אחר, החווה תהיה הקשבה על כל היציאות של ה- IP וירטואלי (מסומן עם תו ''). לאחר בחירת פרוטוקול TCP או UDP, הוא יהיה זמין כדי לציין יציאה, מספר יציאות בין ',', טווחי היציאות בין ':' או כל היציאות עם ''. שילוב של כולם יהיה תקף גם כן.

אחזר את החווה לפי שם

אחזר את החווה לפי שם

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm

GET /farms/<farmname>

הצג את כל תצורת החווה.

תגובה BODY:

{
   "backends" : [
      {
         "id" : 0,
         "ip" : "192.168.55.40",
         "max_conns" : 0,
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.168.55.41",
         "max_conns" : 0,
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "",
      "fgtimecheck" : 5,
      "listener" : "l4xnat",
      "nattype" : "nat",
      "persistence" : "",
      "protocol" : "tcp",
      "status" : "down",
      "ttl" : 120,
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
params חפץ פרמטרים של תצורה חקלאית.
backends אובייקט [] כל השרתים האמיתיים שנוצרו בחווה זו ואת התצורה שלה.

אובייקט פרמטרים עבור חוות L4xNAT:

שדה סוּג תיאור
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: postier חיבור תמיד לשרת חיבור לפחות, מִשׁקָל חיבור שיגור ליניארי לפי משקל, פריו קשרים תמיד לפריו הכי זמין.
מאזין מחרוזת מאזין מגדיר כיצד החווה הולכת לשחק עם הבקשות מהלקוחות. שדה מידע, לא ניתן לשנותו.
nattype מחרוזת איך שכבת איזון שכבת 4 הליבה הולך לפעול. האפשרויות הן: נת המכונה גם מצב sNAT, backend מגיב לאיזון עומס על מנת לשלוח את התגובה ללקוח, dnat backend יגיב ישירות ללקוח, איזון עומס צריך להיות מוגדר כשער בשרת backend.
התמדה מחרוזת אותה כתובת IP תחובר לאותו שרת. האפשרויות הן: "" ערך ריק, התמדה מושבתת, ip ההתמדה מופעלת דרך, מקור ה- IP משמש מזהה ייחודי במפגש.
פרוטוקול מחרוזת פרוטוקול להיות מאוזן בשכבה 4. האפשרויות הן: את כל הפרופיל יהיה לטעון איזון כל פרוטוקול L4, TCP האיזון עומס רק איזון פרוטוקול TCP L4, UDP האיזון עומס רק לאזן את הפרוטוקול UDP L4, לגימה איזון עומס רק לאזן SIP או פרוטוקול VoIP L7, FTP איזון עומס רק לאזן את פרוטוקול L7 FTP, tftp איזון העומס יאזן רק את פרוטוקול TFTP L7.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
Ttl מספר ערך שדה זה מציין את מספר השניות שההקפדה בין מקור הלקוח לבין ה- backend מוקצית, תוך שניות. ההתמדה צריכה להיות מוגדרת.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב. נמל ייחודי ניתן especified, נמל טווח יכול להיות especified עם מפריד : ואת מספר יציאות ניתן especified עם מפריד ,.
fgenabled מחרוזת מאפשר שימוש באפוטרופוס החווה. נכון אפוטרופוס החווה מאופשר, שקר אפוטרופוס החווה מושבת.
fglog מחרוזת מאפשר שימוש ביומנים באפוטרופוס החווה. fgenabled חייב להיות מופעל.
fgscript מחרוזת הפקודה אשר אפוטרופוס החווה יבדוק. פקודות זמינות אלה נמצאות בנתיב libexec. fgenabled חייב להיות מופעל.
לבדוק מספר האפוטרופוס החקלאי יבדוק כל שניות 'בדיקת לוח זמנים'. fgenabled חייב להיות מופעל.

אובייקט Backend עבור חוות L4xNAT:

שדה סוּג תיאור
id מספר מזהה כדי לזהות את backend בחווה.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
max_conns מספר זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
נמל מספר הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms

POST /farms

צור חוות L4xNAT חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה, מזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות L4xNAT הוא l4xnat, הודעת מידע, לא ניתן לשנות ערך זה נכון
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב. נכון
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב. L4xNAT חוות לאפשר multport מופרדים על ידי , או יציאה טווח מופרדים על ידי :. נכון

דוגמה לתגובה:

{
   "description" : "Creating farm 'newl4farm'",
   "params" : {
      "farmname" : "newl4farm",
      "interface" : "eth0",
      "profile" : "l4xnat",
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"algorithm":"weight","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81"}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarml4

PUT /farms/<farmname>

שנה את התצורה של חוות L4xNAT.

פרמטרים של בקשה

שדה סוּג תיאור
newfarmname מחרוזת שם החווה החדשה. את החווה חייבים לעצור את זה.
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: postier חיבור תמיד לשרת חיבור לפחות, מִשׁקָל חיבור שיגור ליניארי לפי משקל, פריו קשרים תמיד לפריו הכי זמין.
nattype מחרוזת איך שכבת איזון שכבת 4 הליבה הולך לפעול. האפשרויות הן: נת המכונה גם מצב sNAT, backend מגיב לאיזון עומס על מנת לשלוח את התגובה ללקוח, dnat backend יגיב ישירות ללקוח, איזון עומס צריך להיות מוגדר כשער בשרת backend.
התמדה מחרוזת אותה כתובת IP תחובר לאותו שרת. האפשרויות הן: "" ערך ריק, התמדה מושבתת, ip ההתמדה מופעלת דרך, מקור ה- IP משמש מזהה ייחודי במפגש.
פרוטוקול מחרוזת פרוטוקול להיות מאוזן בשכבה 4. האפשרויות הן: את כל הפרופיל יהיה לטעון איזון כל פרוטוקול L4, TCP האיזון עומס רק איזון פרוטוקול TCP L4, UDP האיזון עומס רק לאזן את הפרוטוקול UDP L4, לגימה איזון עומס רק לאזן SIP או פרוטוקול VoIP L7, FTP איזון עומס רק לאזן את פרוטוקול L7 FTP, tftp איזון העומס יאזן רק את פרוטוקול TFTP L7.
Ttl מספר ערך שדה זה מציין את מספר השניות שההקפדה בין מקור הלקוח לבין ה- backend מוקצית, תוך שניות. ההתמדה צריכה להיות מוגדרת.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב. נמל ייחודי ניתן especified, נמל טווח יכול להיות especified עם מפריד : ואת מספר יציאות ניתן especified עם מפריד ,.

דוגמה לתגובה:

{
   "description" : "Modify farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "nattype" : "nat",
      "newfarmname" : "l4farm",
      "persistence" : "",
      "protocol" : "tcp",
      "ttl" : 125,
      "vip" : "178.62.126.152",
      "vport" : "81"
   }
}

פרמטרים של תגובה

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

שינוי אפוטרופוס החווה

שינוי אפוטרופוס החווה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"Command of Farm Guardian","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/fg

Farmguardian משמש לניטור מתקדמות המדינה backends ו אישית לחלוטין עבור scripts משלך עבור השירות הנוכחי. כאשר בעיה מזוהה על ידי חקלאי משבית באופן אוטומטי את השרת האמיתי ויהיה מסומן כרשימה שחורה.

PUT /farms/<farmname>/fg

שינוי הפרמטרים של האפוטרופוס החווה בשירות L4xNAT.

פרמטרים של בקשה

שדה סוּג תיאור
fgenabled מחרוזת מאפשר שימוש באפוטרופוס החווה. נכון אפוטרופוס החווה מאופשר, שקר אפוטרופוס החווה מושבת.
fglog מחרוזת מאפשר שימוש ביומנים באפוטרופוס החווה. fgenabled חייב להיות מופעל.
fgscript מחרוזת הפקודה אשר אפוטרופוס החווה יבדוק. פקודות זמינות אלה נמצאות בנתיב libexec. fgenabled חייב להיות מופעל.
לבדוק מספר האפוטרופוס החקלאי יבדוק כל שניות 'בדיקת לוח זמנים'. fgenabled חייב להיות מופעל.

דוגמה לתגובה:

{
   "description" : "Modify farm guardian",
   "message" : "Success, some parameters have been changed in farm guardian in farm l4farm.",
   "params" : {
      "fgenabled" : "true",
      "fglog" : "true",
      "fgscript" : "check_tcp",
      "fgtimecheck" : 5
   }
}

פרמטרים של תגובה

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

L4xNAT - Backends

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends

GET /farms/<farmname>/backends

קבל את רשימת backends בשירות.

דוגמה לתגובה:

{
   "description" : "List backends",
   "params" : [
      {
         "id" : 0,
         "ip" : "192.5.1.1",
         "max_conns" : 400,
         "port" : 787,
         "priority" : 1,
         "status" : "up",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.5.1.3",
         "max_conns" : 200,
         "port" : 787,
         "priority" : 2,
         "status" : "up",
         "weight" : 1
      },
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
id מספר מזהה כדי לזהות את backend בחווה.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
max_conns מספר זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends

POST /farms/<farmname>/backends

צור Backend חדש בחווה L4xNAT.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין. נכון
נמל מספר הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות.
max_conns מספר זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר. ערך ברירת המחדל הוא 1.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. ערך ברירת המחדל הוא 1.

דוגמה לתגובה:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 5,
      "ip" : "192.168.5.100",
      "port" : 8080,
      "max_conns" : 400,
      "priority" : null,
      "weight" : null
   }
}

פרמטרים של תגובה

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

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.5.40","port":8080,"max_conns":220,"priority":4,"weight":7}' 
  https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/2

PUT /farms/<farmname>/backends/<id>

שינוי הפרמטרים של backend בשירות של חוות L4xNAT. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות.
max_conns מספר זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים.

דוגמה לתגובה:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.5.40",
      "port" : 8080,
      "max_conns" : 220,
      "priority" : 4,
      "weight" : 7
   }
}

פרמטרים של תגובה

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

אחורה בתחזוקה

אחורה בתחזוקה

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/1/maintenance

PUT /farms/<farmname>/backends/<id>/maintenance

הגדרת פעולה מסוימת backend של L4xNAT החווה. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת הגדר את הפעולה הרצויה. הפעולות הן: up backend הוא מוכן לקבל בקשות הלקוח, תחזוקה backend אינו מוכן לקבל בקשות לקוח, פעולה זו שימושית עבור עצירת שרת backend מבלי להשפיע על הלקוחות. נכון
מצב מחרוזת בחר מצב תחזוקה. האפשרויות הזמינות הן: לנקז, ה- backend אינו מקבל חיבורים חדשים, אך הוא ימשיך לטפל בחיבורים הנוכחיים; אוֹ לחתוך, הקשרים הנוכחיים ייסגרו. אם שדה זה לא צוין, מצב ברירת המחדל יהיה לנקז.

דוגמה לתגובה:

{
   "description" : "Set backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

פרמטרים של תגובה

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

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/4

DELETE /farms/<farmname>/backends/<id>

מחיקת backend נתון בשירות של חוות L4xNAT.

id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete backend",
   "message" : "Backend removed",
   "success" : "true"
}

Datalink חוות

פרופיל החווה datalink מאפשר ליצור חוות מבוסס מסלולים שבו backends הם נתבים uplink או שערים. זה סוג של פרופיל החווה מוכן לשתף כמה Uplink WAN נתב כניסות באמצעות איזון עומס כמו multipllexor ערוץ uplink (קלט 1 וכמה יציאות קו נתב). לכן, חוות datalink יכול לשמש קישורים תקשורת גבוהה זמין בנוסף יכול לשמש רוחב פס להגדיל שהצטרף כמות רוחב הפס בין נתבים backends קישורים.

אחזר את החווה לפי שם

אחזר את החווה לפי שם

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/dlink

GET /farms/<farmname>

הצג את כל תצורת החווה.

דוגמה לתגובה:

{
   "backends" : [
      {
         "id" : 0,
         "interface" : "eth0",
         "ip" : "192.168.100.10",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 2
      },
      {
         "id" : 1,
         "interface" : "eth0",
         "ip" : "192.168.100.11",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      }
   ],
   "description" : "List farm dlink",
   "params" : {
      "algorithm" : "weight",
      "status" : "down",
      "vip" : "192.168.100.199"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
params חפץ פרמטרים של תצורה חקלאית.
backends אובייקט [] שרתים אמיתיים שנוצרו בחווה זו ובתצורה שלה.

אובייקט פרמטרים עבור חוות datalink:

שדה סוּג תיאור
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: מִשׁקָל, האיזון מפיץ בין כל backends זמין נתון backends תשלום נוסף עם משקל גבוה יותר ב להפיץ או פריו, אשר שולח את כל החיבורים אל backend עם ערך קטין של עדיפות.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא מעלה את כל backends הם בלתי מושגת; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.

אובייקט backend עבור חוות datalink:

שדה סוּג תיאור
id מספר מזהה ייחודי עבור backend בחווה.
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הוא ישמש כאשר אַלגוֹרִיתְם שדה הוא תצורה כמו פריו ועדיפות נמוכה תהיה העדפה
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה הוא תצורה כמו משקל.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms

POST /farms

צור חוות datalink חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה, מזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות datalink הוא DataLink נכון
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב. נכון

דוגמה לתגובה:

{
   "description" : "Creating farm 'dlink'",
   "params" : {
      "farmname" : "dlink",
      "interface" : "eth0",
      "profile" : "datalink",
      "vip" : "192.168.100.241"
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink

PUT /farms/<farmname>

שינוי התצורה של חוות datalink.

פרמטרים של בקשה

שדה סוּג תיאור
newfarmname מחרוזת שם החווה החדש. יש לעצור את החווה.
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: מִשׁקָל, האיזון מפיץ בין כל backends זמין נתון backends תשלום נוסף עם משקל גבוה יותר ב להפיץ או פריו, אשר שולח את כל החיבורים אל backend עם ערך קטין של עדיפות.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.

דוגמה לתגובה:

{
   "description" : "Modify farm dlink",
   "params" : {
      "algorithm" : "weight",
      "vip" : "192.168.100.199",
      "newfarmname" : "dlink2"
   }
}

פרמטרים של תגובה

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

Datalink - Backends

Backends בחוות datalink הם השערים דרך ניתוב השירות. השירות יהיה multiplexor בין השערים, וחלקם אינו זמין, השירות משתמש אחרים (ים).

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends

GET /farms/<farmname>/backends

קבל את רשימת backends בשירות.

דוגמה לתגובה:

[
   {
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 2
   },
   {
      "id" : 7,
      "interface" : "eth0",
      "ip" : "192.168.100.11",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 1
   }
]

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
id מספר מזהה ייחודי עבור backend בחווה. מזהה זה נוצר על ידי המערכת.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
עדיפות מספר זהו ערך העדיפות עבור ה- backend הנוכחי. הוא ישמש כאשר אַלגוֹרִיתְם שדה הוא תצורה כמו פריו ועדיפות נמוכה תהיה העדפה.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה הוא תצורה כמו משקל.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends

POST /farms/<farmname>/backends

יצירת backend חדש בחוות datalink נתון.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב. נכון
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר. נכון
עדיפות מספר זה ערך העדיפות עבור השרת האמיתי הנוכחי. זה יהיה בשימוש כאשר אַלגוֹרִיתְם שדה הוא תצורה כמו פריו ועדיפות נמוכה תהיה העדפה. ערך ברירת המחדל הוא 1.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה הוא תצורה כמו משקל. ערך ברירת המחדל הוא 1.

דוגמה לתגובה:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "weight" : 2
   }
}

פרמטרים של תגובה

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

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"timeout":1}' 
  https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/datalink/backends/2

PUT /farms/<farmname>/backends/<id>

שינוי הפרמטרים של backend בשירות של חוות datalink. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
מחרוזת ip IP של backend, שבו השירות האמיתי הוא מקשיב.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי.

דוגמה לתגובה:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "interface" : "eth0",
      "ip" : "192.168.102.50",
      "timeout" : 1,
      "weight" : 1
   }
}

פרמטרים של תגובה

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

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends/4

DELETE /farms/<farmname>/backends/<id>

מחק backend נתון בשירות של חוות datalink. id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete backend",
   "message" : "Backend removed",
   "success" : "true"
}

רשת

Zevenet יכול לעבוד עם סוגים שונים של ממשקי רשת.

בסעיף זה ניתן לרשום, ליצור, להגדיר, למחוק ולהגדיר פעולה ב- NIC, VLAN וממשקים וירטואליים.

nic: או כרטיס ממשק רשת, זהו רכיב חומרה של המחשב ואת סוג זה של ממשק הוא הבסיס עבור סוג של ממשקים הבאים ניתן להגדיר ומנוהל בזובנט.

vlan: או כרטיס LAN וירטואלי הוא סוג או ממשק רשת המספקים שירותי פילוח רשת. יותר vlan אחד ניתן ליצור באמצעות ממשק nic.

וירטואלי: זה סוג של ממשק ניתן ליצור מעל כל סוג של ממשק המתואר לעיל. סוג זה של ממשק צריך לשמש עבור חוות והוא נדרש כי ממשק וירטואלי מוגדר באותה רשת משנה מאשר ההורה.

רשימת כל הממשקים

רשימת כל הממשקים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic

GET /interfaces

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

דוגמה לתגובה:

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic"
      },
      {
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "type" : "vlan"
      },
      {
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "virtual"
      },
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק.

אובייקט ממשק:

שדה סוּג תיאור
ip מחרוזת IP של הממשק. IP חייב להיות באותו קטע רשת מאשר ממשק האב בממשק וירטואלי.
has_vlan מחרוזת שדה זה מראה אם ​​ממשק זה הוא הורה לממשק VLAN. שדה זה מיועד רק עבור ממשקי NIC.
מסכת רשת מחרוזת Netmask של הממשק. ערך זה לא יכול להיות שונה בממשקים וירטואליים, הוא עובר בירושה מן inteface האב.
שער כניסה מחרוזת שער של הממשק. ערך זה לא יכול להיות שונה בממשקים וירטואליים, הוא עובר בירושה מן inteface האב.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.
סוג מחרוזת הממשקים השונים הם: nic, vlan or וירטואלי.

אחזר שער ברירת מחדל

אחזר שער ברירת מחדל

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/interfaces/gateway

GET /interfaces/gateway

שער ברירת המחדל הוא הצומת שבה נשלח כל תעבורת היעד שאינה ניתנת להשגה מקומית מכל ממשק בממשק העומס.

קבל את הפרמטרים של ממשק שער ברירת המחדל.

דוגמה לתגובה:

{
   "description" : "Default gateway",
   "params" : {
      "address" : "192.168.100.5",
      "interface" : "eth0"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כתובת מחרוזת זהו ה- IP של השער.
ממשק מחרוזת שם הממשק עבור השער.

שינוי שער ברירת המחדל

שינוי שער ברירת המחדל

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"interface":"eth0","address":"192.168.100.5"}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces

PUT /interfaces/gateway

שינוי התצורה של ממשק השער.

דוגמה לתגובה:

{
   "description" : "Modify default gateway",
   "message" : "The default gateway has been changed successfully",
   "success" : "true"
}

פרמטרים של בקשה

שדה סוּג תיאור
כתובת מחרוזת זהו ה- IP של השער.
ממשק מחרוזת שם הממשק עבור השער.

מחק את תצורת השער

DELETE /interfaces/gateway

מחק את התצורה של תצורת ברירת המחדל של שער השער.

אזהרה: אם השער הוא disconfigured, Zevenet הוא לא הולך להיות נגיש מתוך קטע רשת חיצוני.

מחק את תצורת השער

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/gateway

הודעת תגובה

אם השער אינו מוגדר מאותו קטע רשת, הודעה זו תופיע, אחרת החיבור יפסיד.

דוגמה לתגובה:

{
   "description" : "Remove default gateway",
   "message" : "The default gateway has been deleted successfully",
   "params" : {
      "address" : null,
      "interface" : null
   }
}

רשת - ממשקי NIC

ממשקי NIC הם הממשקים הפיזיים המחוברים לאיזון העומס שלך ב- Zevenet.

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

באמצעות ממשקי NIC כהורים, סוג אחר של ממשקים עם מאפיינים שונים ניתן ליצור. הממשקים הזמינים הם: VLAN ו וירטואלי.

רשימת ממשקי NIC

GET /interfaces/nic

קבל את כל הפרמטרים של ממשקי NIC.

רשימת ממשקי NIC

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic

דוגמה לתגובה:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך של אובייקטי ממשק NIC.

אובייקט ממשק NIC:

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
has_vlan מחרוזת שדה זה מראה אם ​​ממשק זה הוא הורה לממשק VLAN. שדה זה מיועד רק עבור ממשקי NIC.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות לפלח רשת אחר.
מק מחרוזת קישור שכבת מזהה ייחודי. זה לא ניתן לשינוי.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.

אחזור ממשק NIC

אחזור ממשק NIC

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1

GET /interfaces/nic/<name>

קבל את כל הפרמטרים של ממשק NIC. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Show NIC interface",
   "interface" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "mac" : "62:30:43:36:29:ac",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "up"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות לפלח רשת אחר.
מק מחרוזת קישור שכבת מזהה ייחודי. זה לא ניתן לשינוי.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.

שינוי ממשק NIC

שינוי ממשק NIC

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.102","netmask":"255.255.255.0","gateway":"192.168.100.5"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1

PUT /interfaces/nic/<name>

שינוי הפרמטרים של ממשק NIC. שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.

דוגמה לתגובה:

{
   "description" : "Configure nic interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

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

מחיקת תצורת NIC

מחיקת תצורת NIC

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth3

DELETE /interfaces/nic/<name>

מחק את התצורה עבור ממשק NIC. לאחר פעולה זו, הממשק יהיה חסר תועלת, ומוכן להיות מוגדר שוב. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete nic interface",
   "message" : "The configuration for the network interface eth3 has been deleted.",
   "success" : "true"
}

הגדר פעולה ממשק NIC

הגדר פעולה ממשק NIC

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1/actions

POST /interfaces/nic/<name>/actions

החל פעולה על ממשק NIC. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on nic interface",
   "params" : {
      "action" : "up"
   }
}

פרמטרים של תגובה

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

רשת - ממשקי VLAN

ממשק VLAN מאפשר ממשק NIC עובד ברשת אחרת, כך IP, שער כניסה ו מסכת רשת שדות יכולים להיות שונים של ממשק האב. ממשק VLAN יורש את כתובת ה- MAC מממשק האב שלו.

השדה ממשקי VLAN שם יופיע עם תו נקודה. "" שישמש ליצירת תג מזהה עבור ממשק VLAN.

רשימת ממשקי VLAN

רשימת ממשקי VLAN

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan

GET /interfaces/vlan

קבל את כל הפרמטרים של ממשקי VLAN.

דוגמה לתגובה:

{
   "description" : "List VLAN interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק VLAN.

הפרמטרים של VLAN הם:

שדה סוּג תיאור
ip מחרוזת IP של הממשק. זה יכול להיות שונה ל- IP inteface ה- IP.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי שם ממשק אב, תו נקודה "." ומספר עבור ממשק רשת vlan או תג vlan.
הורה מחרוזת זהו ממשק המשמש ליצירת זה.
מצב מחרוזת הערכים יכולים להיות up הממשק יכול לקבל מנות, מטה הממשק אינו יכול לקבל מנות.

לאחזר ממשק VLAN

לאחזר ממשק VLAN

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1

GET /interfaces/vlan/<name>

קבל את כל הפרמטרים של ממשק VLAN. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Show VLAN interface",
   "interface" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0.1",
      "netmask" : "255.255.255.0",
      "status" : "up"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי שם ממשק אב, תו נקודה "." ומספר לממשק רשת vlan.
מצב מחרוזת הערכים יכולים להיות up הממשק יכול לקבל מנות, מטה הממשק אינו יכול לקבל מנות.

צור ממשק VLAN

צור ממשק VLAN

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1", "name":"eth0.1"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan

POST /interfaces/vlan

יצירת ממשק VLAN מממשק NIC. ממשק VLAN החדש יחלק MAC, אם כי הפרמטרים הבאים של הרשת חייבים להיות שונים: ip, והפעולות הבאות עשויות להשתנות: שער כניסה, מסכת רשת.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של הממשק. זה חייב להיות שונה ל- IP inteface ה- IP. נכון
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק. נכון
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר. נכון
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי שם ממשק אב, תו נקודה "." ומספר לממשק רשת vlan. נכון

דוגמה לתגובה:

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : null,
      "name" : "eth0.1",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

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

שינוי ממשק VLAN

שינוי ממשק VLAN

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1

PUT /interfaces/vlan/<name>

שינוי הפרמטרים של ממשק VLAN. שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק. זה יכול להיות שונה ל- IP inteface ה- IP.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.

דוגמה לתגובה:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

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

מחק ממשק VLAN

מחק ממשק VLAN

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1

DELETE /interfaces/vlan/<name>

מחק ממשק VLAN. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete VLAN interface",
   "message" : "The VLAN interface eth0.1 has been deleted.",
   "success" : "true"
}

הגדרת פעולה ממשק VLAN

הגדרת פעולה ממשק VLAN

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1/actions

POST /interfaces/vlan/<name>/actions

החל פעולה על ממשק VLAN. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.

שם הוא שם ייחודי מזהה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on vlan interface",
   "params" : {
      "action" : "down"
   }
}

פרמטרים של תגובה

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

רשת - ממשקים וירטואליים

ממשקי רשת מאפשרים למשתמשים ממשק רשת אחר באותו פלח רשת מאשר האב, כך שממשקים וירטואליים תמיד יורשים את תצורת הרשת מהורה. הפרמטר השונה יהיה ip. ממשק וירטואלי ניתן ליצור מ NIC או VLAN. יצירת ממשק וירטואלי חדש תופיע בשדה עם תו קולון ":" אשר ישמש ליצירת זיהוי עבור הממשק הווירטואלי.

רשימת ממשקים וירטואליים

רשימת ממשקים וירטואליים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual

GET /interfaces/virtual

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

דוגמה לתגובה:

{
   "description" : "List virtual interfaces",
   "interfaces" : [
      {
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "up"
      },
      {
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.41",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virtiface",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק. הוא יורש מממשק האב.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר. הוא יורש מממשק האב.
מק מחרוזת MAC של הממשק. הוא יורש מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי ממשק אב, תו נקודתיים ":" והשם עבור ממשק הרשת הווירטואלית, תווים אלפאנומריים מותרים.
הורה מחרוזת זהו ממשק המשמש ליצירת זה.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.

לאחזר ממשק וירטואלי

לאחזר ממשק וירטואלי

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface

GET /interfaces/virtual/<name>

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

דוגמה לתגובה:

{
   "description" : "Show virtual interface",
   "interface" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0",
      "status" : "down"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק. הוא יורש מממשק האב.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר. הוא יורש מממשק האב.
מק מחרוזת MAC של הממשק. הוא יורש מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-נומרית עבור ממשק הרשת הווירטואלית.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.

יצירת ממשק וירטואלי

יצירת ממשק וירטואלי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.41", "name":"eth0:virtiface"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual

POST /interfaces/virtual

יצירת ממשק וירטואלי.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב. נכון
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-נומרית עבור ממשק הרשת הווירטואלית. נכון

דוגמה לתגובה:

{
   "description" : "Add a virtual interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

התגובה תהיה json עם תצורת הממשק. ראה דוגמה לתגובה לקבלת מידע נוסף.

שדה סוּג תיאור
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק. הוא יורש מממשק האב.
שער כניסה מחרוזת IP שימש לשלוח מנות לפלח רשת אחר. הוא יורש מממשק האב.
מק מחרוזת MAC של הממשק. הוא יורש מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שנוצרה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-מספרים עבור ממשק הרשת הווירטואלית.

שינוי ממשק וירטואלי

שינוי ממשק וירטואלי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface

PUT /interfaces/virtual/<name>

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

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב.

דוגמה לתגובה:

{
   "description" : "Modify virtual interface",
   "params" : {
      "ip" : "192.168.100.10"
   }
}

פרמטרים של תגובה

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

מחיקת ממשק וירטואלי

מחיקת ממשק וירטואלי

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface

DELETE /interfaces/virtual/<name>

מחק ממשקים וירטואליים. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete virtual interface",
   "message" : "The virtual interface eth0:virtiface has been deleted.",
   "success" : "true"
}

הגדרת פעולה ממשק וירטואלי

הגדרת פעולה ממשק וירטואלי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface/actions

POST /interfaces/virtual/<name>/actions

החל פעולה על ממשק וירטואלי. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on virtual interface",
   "params" : {
      "action" : "down"
   }
}

פרמטרים של תגובה

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

ניטור - סטטיסטיקה

הצג מידע אודות מערכת ומשקים. מידע זה יהיה שימושי כדי לפקח על מצב איזון עומס Zevenet.

הצג נתונים סטטיסטיים של המערכת

הצג נתונים סטטיסטיים של המערכת

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats

GET /stats

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

דוגמה לתגובה:

{
   "description" : "System stats",
   "params" : {
      "cpu" : {
         "cores" : 2,
         "idle" : 94.42,
         "iowait" : 0,
         "irq" : 0,
         "nice" : 0,
         "softirq" : 0,
         "sys" : 2.54,
         "usage" : 5.58,
         "user" : 3.05
      },
      "date" : "Fri Jan 27 11:40:32 2017",
      "hostname" : "api3",
      "load" : {
         "Last_1" : 1.17,
         "Last_15" : 0.36,
         "Last_5" : 0.6
      },
      "memory" : {
         "Buffers" : 21.68,
         "Cached" : 147.95,
         "MemFree" : 348.06,
         "MemTotal" : 2005.01,
         "MemUsed" : 1656.95,
         "SwapCached" : 2.67,
         "SwapFree" : 614.38,
         "SwapTotal" : 672,
         "SwapUsed" : 57.62
      },
      "network" : {
         "eth0 in in" : 2702.29,
         "eth0 out out" : 50701.95,
         "eth0.1 in in" : 0,
         "eth0.1 out out" : 0,
         "eth1 in in" : 234.72,
         "eth1 out out" : 0,
      }
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
מעבד חפץ נתונים סטטיסטיים של המעבד.
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.
לִטעוֹן חפץ נתונים סטטיסטיים של עומס הליבה.
זיכרון חפץ נתונים סטטיסטיים של זיכרון משומש.
רשת חפץ נתונים סטטיסטיים של תעבורת הרשת.

אובייקט CPU:

שדה סוּג תיאור
ליבות מספר מספר הליבות במעבד.
להתבטל מספר CPU לא להשתמש על ידי כל תוכנית.
כן מספר מעבד המשמש בתהליך קלט או פלט.
Irq מספר מעבד המשמש interropcions חומרה.
נחמד מספר עדיפות תזמון CPU.
רך מספר CPU המשמשים interrrupcions תוכנה.
sys מספר CPU המשמש את המערכת.
שימוש מספר סה"כ מעבד משומש.
המשתמש מספר CPU המשמש את המשתמש.

טען אובייקט:

שדה סוּג תיאור
Last_1 מספר טען מערכת porcentage ברגע האחרון.
Last_5 מספר טען מערכת porcentage לפני 5 דקות.
Last_15 מספר טען מערכת porcentage לפני חמש עשרה דקות.

אובייקט זיכרון.

שדה סוּג תיאור
חוצצים מספר זהו הזיכרון המשמש את המאגרים. סכום זה מצוין ב- Mb.
שמור במטמון מספר זה הזיכרון הכולל במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
ממפיס מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
MemTotal מספר זה זיכרון RAM הכולל על המערכת. סכום זה מצוין ב- Mb.
נמחק מספר זה הזיכרון המשמש את המערכת. סכום זה מצוין ב- Mb.
SwapCached מספר זה זיכרון המטמון הכולל שמור.
SwapFree מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
SwapTotal מספר זה סה"כ זיכרון החלפה שמור.
הוחלף מספר זה להחליף את הזיכרון בשימוש על ידי המערכת, על מערכות אופטימלי צריך להיות 0.

אובייקט רשת:

שדה סוּג תיאור
בתוך בתוך מספר הזן תנועה עבור זה ממשק.
לצאת החוצה מספר תנועה פלט עבור זה ממשק.

הצג נתונים סטטיסטיים ברשת

הצג נתונים סטטיסטיים ברשת

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/system/network

GET /stats/system/network

קבל סיכום של סך קלט ותשומת פלט דרך ממשק רשת.

דוגמה לתגובה:

{
   "description" : "Network interfaces usage",
   "params" : {
      "date" : "Fri Jan 27 11:58:05 2017",
      "hostname" : "api3",
      "interfaces" : [
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "eth0.1",
            "out" : "4300.38"
        }
      ]
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם מפתח params אשר ערך הוא אובייקט עם המפתחות followeing:

שדה סוּג תיאור
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.
ממשקים אובייקט [] נתונים סטטיסטיים של תעבורת הרשת.

ממשקי אובייקט

שדה סוּג תיאור
in מחרוזת סה"כ תעבורת קלט ב- MB.
ממשק מחרוזת שם הממשק.
הַחוּצָה מחרוזת סך כל התפוקה.

הצג נתונים סטטיסטיים של חוות

הצג נתונים סטטיסטיים של חוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/farms

GET /stats/farms

קבל סיכום של חיבורים ותצורה עבור כל החוות במערכת.

דוגמה לתגובה:

{
   "description" : "List all farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "testHttps",
         "pending" : 0,
         "profile" : "https",
         "status" : "up",
         "vip" : "192.168.101.20",
         "vport" : "120"
      },
      {
         "established" : 0,
         "farmname" : "httpFarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "8080"
      },
      {
         "established" : 0,
         "farmname" : "testDL",
         "pending" : 0,
         "profile" : "datalink",
         "status" : "up",
         "vip" : "192.168.102.72",
         "vport" : "eth1"
      },
      {
         "established" : 0,
         "farmname" : "testL4",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "30"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
נוסד מספר סך כל הקשרים הקיימים.
שם החווה מחרוזת שם החווה, מזהה ייחודי.
תלוי ועומד מספר מספר החיבורים הממתינים.
פרופיל מחרוזת סוג החווה. הערכים האפשריים הם: DataLink, l4xnat, http or https. כל פרופיל מוגדר בקטע שלו.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב.

הצג נתונים סטטיסטיים בחווה

הצג נתונים סטטיסטיים בחווה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/farms/httpFarm

GET /stats/farms/<farmname>

מציג את מצב החווה הנוכחי, מצב backend שלהם וחיבורים. כל חוות תהיה תגובה עם אובייקט אחר, בהתאם לפרופיל.

דוגמת תגובה עבור חוות HTTP:

{
   "backends" : [
      {
         "established" : 0,
         "id" : 0,
         "ip" : "192.168.0.168",
         "pending" : 0,
         "port" : 80,
         "service" : "srv1",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
         "client" : "0",
         "id" : "0",
         "service" : "srv1",
         "session" : "192.168.0.186"
      }
   ]
}

פרמטרי תגובה בחוות HTTP

שדה סוּג תיאור
backends אובייקט [] הצג מידע על backends.
הפעלות אובייקט [] הצג מידע על פעילויות באתר.

אובייקט Backend

שדה סוּג תיאור
נוסד מספר סך כל החיבורים שנקבעו.
id מספר מזהה ייחודי של Backend.
ip מחרוזת IP שבו השירות האמיתי מקשיב.
תלוי ועומד מספר מספר החיבורים הממתינים.
נמל מספר נמל שבו השירות האמיתי מקשיב.
שרות מחרוזת שם השירות משמש כמזהה ייחודי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.

אובייקט מושב

שדה סוּג תיאור
לקוחות מחרוזת מזהה ייחודי של לקוח.
id מחרוזת מזהה ייחודי של Backend שהוקצה ללקוח.
שרות מחרוזת מזהה ייחודי של שירות שהוקצה ללקוח.
מושב מחרוזת מזהה ייחודי של פעילות באתר. ערך זה תלוי בסוג ההתמדה.

דוגמת תגובה עבור חוות L4xNAT:

{
   "backends" : [
      {
         "established" : 5,
         "id" : 1,
         "ip" : "192.168.5.40",
         "pending" : 0,
         "port" : "8080",
         "status" : "maintenance"
      },
      {
         "established" : null,
         "id" : 3,
         "ip" : "192.5.1.1",
         "pending" : 0,
         "port" : "787",
         "status" : "down"
      },
      {
         "established" : null,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats"
}

פרמטרי תגובה בחוות L4xNAT

התגובה תהיה JSON עם מפתח backends ואת הערך מערך אובייקט עם הפרמטרים הבאים.

אובייקט Backend:

שדה סוּג תיאור
נוסד מספר סך כל הקשרים הקיימים.
id מספר מזהה ייחודי של Backend.
ip מחרוזת IP שבו השירות האמיתי מקשיב.
תלוי ועומד מספר מספר החיבורים הממתינים.
נמל מספר נמל שבו השירות האמיתי מקשיב.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.

הנתונים הסטטיסטיים של Datalink אינם זמינים בפועל.

ניטור - גרפים

סעיף זה שימושי כדי לפקח על המערכת הפנימית איזון עומס כדי לזהות בעיות באמצעות הפרמטרים של השימוש ב- CPU, זיכרון החלפה, זיכרון RAM, כל ממשקי Nework מוגדר, לטעון אחסון דיסק קשיח.

כמו כן, תוכל לגשת להיסטוריה השבועית, העשירה והשנתית.

גרפים עם מידע הם הגיבו בפורמט base64.

רשימת תרשימים זמינים

רשימת תרשימים זמינים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs

GET /graphs

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

דוגמה לתגובה:

{
   "description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
   "farms" : [
      "l4farm",
      "newfarm",
      "nwl4farm",
      "httpweb"
   ],
   "interfaces" : [
      "eth0.1",
      "eth1",
      "eth0"
   ],
   "system" : [
      "cpu",
      "load",
      "ram",
      "swap",
      {
         "disk" : [
            "root/",
            "root/boot",
            "root/usr/local/zenloadbalancer/config",
            "root/var/log"
         ]
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה JSON שלושה סוגים של גרפים, חוות, ממשקים ו מערכת.

שדה סוּג תיאור
חוות מחרוזת [] רשימת חוות חקלאיות availables.
ממשקים מחרוזת [] רשימה של ממשקים גרפים availables.
מערכת אובייקט [] רשימה של גרפים מערכת availables. במערך יש אובייקט עם מערך שבו הוא מציין נקודות דיסק דיסק.

אובייקט מערכת:

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

שדה סוּג תיאור
דיסק מחרוזת [] הערכים של מערך זה הם כולם קיימים נקודות במערכת, לכל אחד יש גרפים זמינים.

הצג תרשימים

הצג תרשימים

בקש דוגמה לחווה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/farms/httpweb

בקש דוגמה עבור ממשק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/interfaces/eth0

בקש דוגמה לדיסק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot

GET /graphs/<graph>

הערכים הזמינים עבור גרף הם:

ערך תיאור
farms/<farmname> שם החווה, מזהה ייחודי לחווה.
interfaces/<interface> ממשק, מזהה ייחודי של ממשק.
system/<system> מערכת, גרפים אפשריים של המערכת הם: מעבד, לִטעוֹן, RAM or להחליף.
system/disk/<mount point> נקודת הר, הוא ערך של דיסק אובייקט, הוחזר בשיחת 'GET / graphs'.

דוגמה לתגובה:

{
   "description" : "Get cpu graphs",
   "graphs" : [
      {
         "frequency" : "daily",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "weekly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "monthly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "yearly",
         "graph" : "PNG IN BASE 64"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
תדר מחרוזת תקופת הזמן המשמשת ליצירת התרשים. הערכים האפשריים הם: יומי, שבועי, אחת לחודש or שְׁנָתִי.
גרפים מחרוזת גרף בפורמט 64 בסיס.

הצג תרשים תדירות

הצג תרשים תדירות

בקש דוגמה לחווה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/farms/httpweb/daily

בקש דוגמה עבור ממשק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/interfaces/eth0/monthly

בקש דוגמה לדיסק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot/yearly

GET /graphs/<graph>/<frequency>

הערכים הזמינים עבור גרף הם:

ערך תיאור
farms/<farmname> שם החווה, מזהה ייחודי לחווה.
interfaces/<interface> ממשק, מזהה ייחודי של ממשק.
system/<system> מערכת, גרפים אפשריים של המערכת הם: מעבד, לִטעוֹן, RAM or להחליף.
system/disk/<mount point> נקודת הר, הוא ערך של דיסק אובייקט, הוחזר בשיחת 'GET / graphs'.

הערכים הזמינים עבור תדר הם:

שדה סוּג תיאור
תדר מחרוזת תקופת הזמן המשמשת ליצירת התרשים. הערכים האפשריים הם: יומי, שבועי, אחת לחודש or שְׁנָתִי.

דוגמה לתגובה:

{
    "description" : "Get farm graphs",
    "graph" : "PNG IN BASE 64"
}

פרמטרים של תגובה

שדה סוּג תיאור
גרפים מחרוזת גרף בפורמט 64 בסיס.

מערכת

אפשרויות מערכת מציעים לך את האפשרות של התאמה אישית של השירותים הפועלים באיזון ואת הפרמטרים הגלובליים.

הצג גרסה

הצג גרסה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/version

GET /system/version

הצג מידע על גרסת המוצר.

דוגמה לתגובה:

{
   "description" : "Get version",
   "params" : {
      "appliance_version" : "ZVA 4100, hypervisor: xen",
      "hostname" : "DEV5",
      "kernel_version" : "3.16.7-ckt20",
      "system_date" : "Thu Feb  2 10:34:27 2017",
      "zevenet_version" : "5.0"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

שדה סוּג תיאור
גרסה מחרוזת גרסה. הצג גם hypervisor אם הוא מכונה וירטואלית.
המארח מחרוזת שם מארח.
kernel_version מחרוזת גרסת לינוקס לינוקס - -.
תאריך מערכת מחרוזת תאריך מערכת.
zevenet_version מחרוזת מהדורת קהילת זבנט.

הצג DNS

הצג DNS

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/dns

GET /system/dns

הצג את תצורת שירות DNS.

דוגמה לתגובה:

{
   "description" : "Get dns",
   "params" : {
      "primary" : "8.8.8.8",
      "secondary" : null
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

שדה סוּג תיאור
יְסוֹדִי מחרוזת DNS ראשי מוגדר במערכת.
משני מחרוזת DNS משני מוגדר במערכת.

שינוי DNS

שינוי DNS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/dns

POST /system/dns

שינוי תצורת שירות DNS.

פרמטרים של בקשה

שדה סוּג תיאור
יְסוֹדִי מחרוזת DNS ראשי מוגדר במערכת.
משני מחרוזת DNS משני מוגדר במערכת.

דוגמה לתגובה:

{
   "description" : "Post dns",
   "params" : {
      "primary" : "8.8.4.4",
      "secondary" : "8.8.8.8"
   }
}

פרמטרים של תגובה

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

הצג SNMP

הצג SNMP

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/snmp

GET /system/snmp

הצג את תצורת השירות SNMP.

דוגמה לתגובה:

{
   "description" : "Get snmp",
   "params" : {
      "community" : "public",
      "ip" : "*",
      "port" : "161",
      "scope" : "0.0.0.0/0",
      "status" : "false"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

שדה סוּג תיאור
קהילה מחרוזת שם קהילה. משתמשים בקהילה לקריאה בלבד.
ip מחרוזת ממשק IP שבו פועל שירות SNMP. זה בטוח לשמור את כל הממשקים מופעלת באמצעות דמות *.
נמל מחרוזת יציאה שבה פועל שירות SNMP.
היקף מחרוזת IP או רשת משנה עם גישה (IP / bit). כתובות IP מורשות כדי לקבל שירות SNMPD, במקרה שאתה רוצה לאפשר גישה רק IP אחד בבקשה להשתמש קצת "/ 32".
מצב מחרוזת מצב שירות SNMP. הערכים האפשריים הם: נכון, השירות פועל; או שקר, השירות מופסק.

שינוי SNMP

שינוי SNMP

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'  
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/snmp

POST /system/snmp

שנה את תצורת השירות SNMP.

פרמטרים של בקשה

שדה סוּג תיאור
קהילה מחרוזת שם קהילה. משתמשים בקהילה לקריאה בלבד.
ip מחרוזת ממשק IP שבו פועל שירות SNMP. זה בטוח לשמור את כל הממשקים מופעלת באמצעות דמות *.
נמל מחרוזת יציאה שבה פועל שירות SNMP.
היקף מחרוזת IP או רשת משנה עם גישה (IP / bit). כתובות IP מורשות כדי לקבל שירות SNMPD, במקרה שאתה רוצה לאפשר גישה רק IP אחד בבקשה להשתמש קצת "/ 32".
מצב מחרוזת מצב שירות SNMP. הערכים האפשריים הם: נכון, השירות פועל; או שקר, השירות מופסק.

דוגמה לתגובה:

{
   "description" : "Post snmp",
   "params" : {
      "community" : "public",
      "ip" : "192.168.100.241",
      "port" : "170",
      "scope" : "0.0.0.0/0",
      "status" : "true"
   }
}

פרמטרים של תגובה

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

אחזר רישיון

אחזר רישיון

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/license/txt

GET /system/license/<format>

הצג את הרישיון של Zevenet בפורמט. זמין פוּרמָט הערכים הם html or txt.

הצג NTP

הצג NTP

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/ntp

GET /system/ntp

הצג את תצורת שירות NTP.

דוגמה לתגובה:

{
   "description" : "Get ntp",
   "params" : {
      "server" : "pool.ntp.org"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

שדה סוּג תיאור
שרת מחרוזת שרת שבו לקוח NTP עושה את הבקשות.

שינוי NTP

שינוי NTP

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"server":"pool.ntp.org"}' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/ntp

POST /system/ntp

שינוי תצורת שירות NTP.

פרמטרים של בקשה

שדה סוּג תיאור
שרת מחרוזת שרת שבו לקוח NTP עושה את הבקשות.

דוגמה לתגובה:

{
   "description" : "Post ntp",
   "params" : "pool.ntp.org"
}

פרמטרים של תגובה

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

רשום את כל המשתמשים

רשום את כל המשתמשים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users

GET /system/users

רשום את המשתמשים הזמינים במערכת.

דוגמה לתגובה:

{
   "description" : "Get users",
   "params" : [
      {
         "status" : "true",
         "user" : "root"
      },
      {
         "status" : "true",
         "user" : "zapi"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך של הפרמטרים הבאים.

שדה סוּג תיאור
מצב מחרוזת סטטוס משתמש. הערכים האפשריים הם: נכון, המשתמש מופעל; או שלא שקר, המשתמש מושבת.
המשתמש מחרוזת שם משתמש.

אחזר משתמש zapi

אחזר משתמש zapi

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi

GET /system/users/zapi

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

דוגמה לתגובה:

{
   "description" : "Zapi user configuration.",
   "params" : {
      "key" : "root",
      "status" : "true"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך של הפרמטרים הבאים.

שדה סוּג תיאור
מפתח מחרוזת מפתח כדי לאמת ב zapi. זה הפרמטר ZAPI_KEY המשמש שיחות ל zapi.
מצב מחרוזת Zapi מצב המשתמש. אם הערך שלה הוא נכון, ניתן להשתמש zapi; או שלא שקר, zapi הוא disactivated ולא ניתן לשלוח את הבקשה.

שינוי תצורת משתמש zapi

שינוי תצורת משתמש zapi

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
 -d '{"key":"newzapikey","status":"enable","newpassword":"password1234"}' 
 https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi

POST /system/users/zapi

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

פרמטרים של בקשה

שדה סוּג תיאור
מפתח מחרוזת מפתח כדי לאמת ב zapi. זה הפרמטר ZAPI_KEY המשמש שיחות ל zapi.
סיסמה חדשה מחרוזת סיסמה חדשה עבור המשתמש zapi.
מצב מחרוזת Zapi מצב המשתמש. הערכים האפשריים הם: לאפשר כדי לאפשר למשתמש zapi או להשבית להשבית משתמש zapi - -. אם המשתמש zapi מושבת, לא תוכל לשלוח בקשות.

דוגמה לתגובה:

{
   "description" : "Zapi user settings.",
   "message" : "Settings was changed successful.",
   "params" : {
      "key" : "newzapikey",
      "newpassword" : "password1234",
      "status" : "enable"
   }
}

פרמטרים של תגובה

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

שינוי סיסמת השורש

שינוי סיסמת השורש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
{"password":"admin","newpassword":"alwaysisbetterastrongpass"} 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/root

POST /system/users/root

שנה את סיסמת הבסיס. משתמש זה משמש לגישה לשירותי zevenet דרך GUI

פרמטרים של בקשה

שדה סוּג תיאור דרוש
סיסמא מחרוזת סיסמת משתמש שורש נוכחי. נכון
סיסמה חדשה מחרוזת סיסמה חדשה עבור משתמש root. נכון

דוגמה לתגובה:

{
   "description" : "User settings.",
   "message" : "Settings was changed succesful.",
   "params" : {
      "newpassword" : "alwaysisbetterastrongpass",
      "password" : "admin"
   }
}

פרמטרים של תגובה

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

רשימת קובצי יומן

רשימת קובצי יומן

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs

GET /system/logs

רשום את קובצי היומן הזמינים.

דוגמה לתגובה:

{
   "description" : "Get logs",
   "params" : [
      {
         "date" : "Mon Jan 30 06:25:02 2017",
         "file" : "syslog.4.gz"
      },
      {
         "date" : "Tue Jan 31 06:25:03 2017",
         "file" : "syslog.3.gz"
      },
      {
         "date" : "Wed Feb  1 06:25:04 2017",
         "file" : "syslog.2.gz"
      },
      {
         "date" : "Thu Feb  2 06:25:03 2017",
         "file" : "syslog.1"
      },
      {
         "date" : "Sun Jan 29 06:25:03 2017",
         "file" : "syslog.5.gz"
      },
      {
         "date" : "Fri Feb  3 04:28:56 2017",
         "file" : "syslog"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה JSON עם מערך של קובץ יומן. הפרמטרים של כל אובייקט הם:

שדה סוּג תיאור
נתונים מחרוזת תאריך השינוי האחרון בקובץ.
פילה מחרוזת שם קובץ של קובצי יומן. הוא משמש כמזהה יומן ייחודי.

הצג שורות של קובצי יומן

הצג שורות של קובצי יומן

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs/kern.log/lines/2

GET /system/logs/<file>/lines/<lines>

רשום מספר שורות של קובץ יומן. פרמטר URI פילה הוא קובץ היומן מקריאה. קווים הוא מספר שורות להראות הסופי.

דוגמה לתגובה:

{
   "description" : "Show a log file",
   "log" : [
      "Aug 28 09:44:00 maq2 kernel: [258451.740173] Netfilter messages via NETLINK v0.30.\n",
      "Aug 28 09:44:00 maq2 kernel: [258451.775666] ctnetlink v0.93: registering with nfnetlink.\n"
   ]
}

פרמטרים של תגובה

התגובה תהיה JSON עם מערך של קובץ יומן. המפתח הוא יומן וערכו הוא מערך עם מספר השורות המבוקשות.

הורד קובץ יומן

הורדת קובצי יומן

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs/syslog.2.gz > log.gz

GET /system/logs/<file>

הורד קובץ יומן של קובצי יומן avayable המפורטים בעת בקשת GET.

פילה הוא מזהה הקובץ היומן הייחודי.

מערכת - גיבויים

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

בסעיף זה, תוכל ליצור, לשחזר, להעלות ולהוריד קבצי גיבוי.

רשימת גיבויים

רשימת גיבויים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup

GET /system/backup

דוגמה לתגובה:

{
   "description" : "Get backups",
   "params" : [
      {
         "date" : "Fri Feb  3 06:01:04 2017",
         "name" : "newbackup"
      },
      {
         "date" : "Fri Feb  3 05:50:48 2017",
         "name" : "firstConf"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה JSON עם מערך של גיבויים. הפרמטרים של כל אלמנט מערך הם:

שדה סוּג תיאור
נתונים מחרוזת תאריך השינוי האחרון.
שם מחרוזת זהו שם הקובץ המשמש כמזהה ייחודי. סיומת הקובץ היא .tar.gz.

צור גיבוי

צור גיבוי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
 -d '{"name":"firstConf"}' 
 https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup

POST /system/backup

צור גיבוי תצורת מערכת של התצורה הנוכחית.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת זהו שם הקובץ המשמש כמזהה ייחודי. סיומת הקובץ היא .tar.gz.

דוגמה לתגובה:

{
   "description" : "Create a backups",
   "message" : "Backup firstConf was created successful.",
   "params" : "firstConf"
}

הורד גיבוי

הורד גיבוי

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
 https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz

קובץ הגיבוי הוא בפורמט TAR GZ.

GET /system/backup/<name>

הורד גיבוי של תצורת המערכת. שם הוא מזהה הגיבוי הייחודי.

העלה גיבוי

העלה גיבוי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: text/plain' 
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/newbackup

PUT /system/backup/<name>

טען גיבוי מקומי מאוחסן ל- Zevenet. שם הוא מזהה הגיבוי הייחודי אשר יאוחסן בזובנט.

פרמטרים של בקשה

יש צורך להשתמש ב - data-binary כדי להעלות גיבוי.

דוגמה לתגובה:

{
   "description" : "Upload a backup",
   "message" : "Backup newbackup was created successful.",
   "params" : "newbackup"
}

מחק גיבוי

מחק גיבוי

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf

DELETE /system/backup/<name>

מחיקת קובץ גיבוי ממערכת Zevenet. שם הוא מזהה הגיבוי הייחודי.

דוגמה לתגובה:

{
   "description" : "Delete backup firstConf'",
   "message" : "The list firstConf has been deleted successful.",
   "success" : "true"
}

החל גיבוי

החל גיבוי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"action":"apply"}' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf/actions

POST /system/backup/<name>/actions

שחזור התצורה מקובץ גיבוי. שם הוא מזהה הגיבוי הייחודי.

פרמטרים של בקשה

שדה סוּג תיאור
פעולה מחרוזת כדי לשחזר את תצורת הגיבוי, הערך חייב להיות להגיש מועמדות.

דוגמה לתגובה:

{
   "description" : "Apply a backup to the system",
   "params" : {
      "action" : "apply"
   }
}

הורד תומך

הורד תומך

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/supportsave > supportsave.tar.gz

GET /system/supportsave

קבל תמונת מצב מערכת עם כל התצורה והתהליך הפועלים במערכת. זה תומך יש צורך למצוא בעיות או תמיכה.