Zebet API v3.2 הפניה
ZAPI (Zevenet Application Programming Interface) הוא הכלי עבור מנהל המערכת כדי לפקח Zevenet עומס איזון התנהגות.
יש צורך פעיל zapi המשתמש מממשק האינטרנט לפני השימוש בו, מערכת / משתמשים.
לאחר שהמשתמש zapi נוצר, ניתן לשלוח בקשה לכתובת URL, https: // (zevenet_server): 444 / zapi / v3.2 / 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.2/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.2/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 GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/example.pem/info
GET /certificates/<file>/info
הצג את כל המידע הכלול בתעודה נתונה בחנות אישורים, כולל חתימות, נדרש שם הקובץ להפניה.
דוגמה לתגובה:
Certificate:
Data:
Version: 3 (0x2)
Serial Number: 14346016480403539444 (0xc71749fb005a45f4)
Signature Algorithm: sha1WithRSAEncryption
Issuer: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
Validity
Not Before: Jan 12 14:49:03 2011 GMT
Not After : Jan 9 14:49:03 2021 GMT
Subject: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
Subject Public Key Info:
Public Key Algorithm: rsaEncryption
Public-Key: (1024 bit)
Modulus:
...
הצג פרטי אישור הפעלה
הצג פרטי אישור הפעלה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/activation
GET /certificates/activation
הצג את כל המידע הכלול בתעודת ההפעלה, כולל חתימות, אישור זה נשמר בחנות אישורים. אם תעודת ההפעלה נמחקת, המוצר יופסק.
מחיקת אישור
מחיקת אישור
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/example.pem
DELETE /certificates/<file>
מחיקת אישור לפי שם קובץ בחנות אישורים.
דוגמה לתגובה:
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
מחק את אישור ההפעלה
מחק את אישור ההפעלה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/activation
DELETE /certificates/activation
מחק את אישור ההפעלה המותקן בחנות אישורים. אם האישור נמחק, אזי איזון העומס.
דוגמה לתגובה:
{
"description" : "Delete activation certificate",
"message" : "The activation certificate 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.2/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.2/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 POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/path/to/example.pem
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/activation
POST /certificates/activation
טען אישור הפעלה בפורמט PEM, אישור זה נחוץ כדי לאפשר את כל הפונקציות. אישור זה נשמר בחנות אישורים, אם אישור ההפעלה קיים בחנות אישורים ולאחר מכן האישור הקודם הוא overwriten.
דוגמה לתגובה:
{
"description" : "Upload activation certificate",
"message" : "Activation certificate uploaded",
"success" : "true"
}
רשימת צופן
רשימת צופן
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ciphers
GET /ciphers
רשום את הצופן הזמין שחוות HTTPS יכולה להשתמש בו.
אל האני פריקת SSL הצ'יפר יהיה זמין רק אם הוא נתמך על ידי המעבד.
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים אישור, שכל אחד מהם מכילים את תכונות המפתח להלן.
דוגמה לתגובה:
{
"description" : "Get the ciphers available",
"params" : [
{
"ciphers" : "all",
"description" : "All"
},
{
"ciphers" : "highsecurity",
"description" : "High security"
},
{
"ciphers" : "customsecurity",
"description" : "Custom security"
},
{
"ciphers" : "ssloffloading",
"description" : "SSL offloading"
}
]
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| params | אובייקט [] | רשימה של אובייקטים אישור. |
אובייקט אישור
| שדה | סוּג | תיאור |
|---|---|---|
| Ciphers | מחרוזת | הוא משמש כמזהה ייחודי. |
| תיאור | מחרוזת | שם ידידותי. |
חוות
Zevenet היא מסוגלת לנהל את התנועה בשלוש דרכים שונות, בכל דרך מנוהלת על ידי מודול אחר, איזון עומס שירות מקומי או מודול LSLB, איזון עומס שירות גלובלי או מודול GSLB ו- Datalink Service Load Balancer או מודול DSLB.
כל המודולים לעבוד עם המושג פרופיל משק, פרופיל משק היא קבוצה של פרמטרים מוכן לעשות פעולה ספציפית עם תעבורת הרשת, חשוב להבין מה הוא מסוגל לעשות כל פרופיל החווה על מנת להשיג את התוצאות הטובות ביותר של זאבנט ADC.
- LSLB: מודול זה מסוגל לעבוד עם http ו l4xnat פרופיל חוות. זה עובד כמו proxy הפוך האינטרנט או נתב
- GSLB: מודול זה הוא מסוגל לעבוד עם גסלב חקלאית זה עובד כמו שרת שמות דומיין
- DSLB: מודול זה מסוגל לעבוד עם DataLink חקלאית זה עובד כשער.
רשום את כל החוות
רשום את כל החוות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms
GET /farms
רשום את כל החוות הזמינות
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים לחידוש משק, שכל אחד מהם מכיל את תכונות המפתח להלן.
אובייקט החווה
| שדה | סוּג | תיאור |
|---|---|---|
| שם החווה | מחרוזת | שם תיאור החווה. הוא משמש כמזהה ייחודי. |
| פרופיל | מחרוזת | סוג הפרופיל, ערכי הפרופיל הזמינים הם: http, https or l4xnat עבור מודול LSLB, גסלב עבור מודול GLSB ו DataLink עבור מודול DSLB |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
| החברים | מחרוזת | Virtual IP שבו החווה מקבלת תנועה |
| גווניה | מחרוזת | יציאה וירטואלית שבה החווה מקבלת תנועה, הערכים הזמינים ליציאה הם: מספר יציאה לפרופילי http [s], l4xnat ו- gslb, קבוצת יציאות המופרדת על ידי "," או טווח יציאות המופרד על ידי ":" עבור פרופילי 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.2/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.2/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 עומס בשילוב עם האצת עומס SSL. פרופיל זה מיועד לשירותי אינטרנט (שרתי יישומי אינטרנט כלולים) וכל פרוטוקולי היישום המבוססים על פרוטוקולי 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.2/zapi.cgi/farms/httpFarm
GET /farms/<farmname>
הצג את כל תצורת החווה.
דוגמה לתגובה:
{
"description" : "List farm httpFarm",
"ipds" : {
"blacklists" : [
{
"name" : "men",
"status" : "down"
}
],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"addheader" : [
{
"header" : "load-balancer: true",
"id" : 0
}
],
"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.",
"headremove" : [
{
"id" : 0,
"pattern" : "^client"
}
],
"httpverb" : "MSRPCext",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "false",
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : "check_tcp",
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"redirect" : "http://192.168.101.254/index.html",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
{
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : null,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפורמט שלהלן.
אובייקט משק חקלאי:
| שדה | סוּג | תיאור |
|---|---|---|
| ipod | חפץ | רשימת הכללים IPDS החלים על החווה הזו. |
| params | חפץ | פרמטרים של תצורה חקלאית. |
| שירותים | אובייקט [] | מערך עם כל השירותים שנוצרו בחווה זו ואת התצורה שלה. |
אובייקט IPDS:
| שדה | סוּג | תיאור |
|---|---|---|
| רשימות שחורות | אובייקט [] | הכללים השחורים החלים על החווה. |
| דוס | אובייקט [] | הכללים DoS להחיל את החווה. |
| Rbl | אובייקט [] | הכללים RBL להחיל על החווה. |
רשימה שחורה, DoS ו- RBL אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל. |
| מצב | מחרוזת | מצב כלל. |
אובייקט פרמטרים עבור חוות HTTP:
| שדה | סוּג | תיאור |
|---|---|---|
| AddHeader | אובייקט [] | זוהי רשימה של אובייקטים עם הכותרות להוסיף backend. |
| certlist | אובייקט [] | רק בפרופיל https. רשימת אישורים מופעלת בחווה, בפורמט pem, מותר להוסיף יותר מאשר תעודת pem אחת לחווה זהה עבור תמיכה SNI. המאזין עם ערך https נדרש. ניתן להשתמש בכל אישור בחנות אישורים כאן. |
| cipherc | מחרוזת | רק במאזין https. זוהי רשימה מותאמת אישית של צופן שיתקבל על ידי חיבור SSL, שהוא מחרוזת באותו פורמט כמו בצופן OpenSSL. זה atribute משמש רק כאשר Ciphers שדה יש ערך sutomsecurity. |
| Ciphers | מחרוזת | רק מאזין עם ערך https. משמש כדי לבנות רשימה של צופן המקובל על ידי חיבורי SSL כדי להקשיח את חיבור SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; - מכס, רק ciphers טעון ב cipherc שדה יתקבל; או ssloffloading, זה devolves את העבודה להצפין את התהליך, צופן זה תלוי במעבד. |
| ת | מספר | כמה זמן החווה הולך לחכות חיבור 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. הערכים הזמינים הם: סטנדרטי, קיבל בקשות http GET, פוסט, 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. שים לב כי ערכים אלה הם רגישים למקרה. |
| התעלם_ 100_ המשך | מחרוזת | אם לשדה זה יש את הערך נָכוֹן מה היא 100 ממשיך HTTP heade יתעלם; אם הערך הוא שקר, ה 100 ממשיך הכותרת תהיה תהליך. |
| מאזין | מחרוזת | המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח. |
| יומני | מחרוזת | החווה מתעד את החיבורים של חיבורי HTTP. אם לפרמטר זה יש את הערך נָכוֹן, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים. |
| זמן | מספר | כמה זמן החווה הולך לחכות לבקשת הלקוח בתוך שניות. |
| restimeout | מספר | כמה זמן החווה הולך לחכות תגובה מן backends בתוך שניות. |
| לתחייה | מספר | התקופה לצאת שרת אמיתי נפל, לאחר תקופה זו איזון עומס בודק אם השרת האמיתי הוא חי, בתוך שניות. |
| שכתוב מחדש | מחרוזת | אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל, מופעל נכה, אינו פעיל או מאופשר- backends רק את כתובת backend מושווה. |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
| גווניה | מספר | נמל של החווה, שבו השירות וירטואלי מקשיב. |
אובייקט Certlist:
| שדה | סוּג | תיאור |
|---|---|---|
| פילה | מחרוזת | שם האישור, הפניות לאישור בחנות אישורים. |
| id | מספר | מזהה תעודה, הסדר ברשימה, הראשון יהיה המשמש כברירת מחדל אם כותרת המארח הווירטואלי אינה תואמת לשדה CN בתעודה. משמש ל- SNI. |
אובייקט שירותים עבור חוות HTTP:
| שדה | סוּג | תיאור |
|---|---|---|
| backends | אובייקט [] | Backends שהוגדרו בשירות. |
| cookiedomain | מחרוזת | הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיות. הפעל עוגיות שדה נדרש. |
| עוגיות | מחרוזת | זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נָכוֹן, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, לא מתבצעת פעולה. |
| cookiename | מחרוזת | שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש. |
| cookiepath | מחרוזת | הוא מנהל את הערך נתיב עוגיות עבור עוגיה נתון. הפעל עוגיות שדה נדרש. |
| cookiettl | מספר | זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש. |
| חקלאי | מחרוזת | זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. |
| https | מחרוזת | פרמטר זה מציין לחווה כי שרתי backend שהוגדרו בשירות הנוכחי משתמשים בשפה HTTPS ולאחר מכן הנתונים יהיו מוצפנים לפני שנשלחו. נָכוֹן, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends. |
| id | מחרוזת | שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות. |
| leastresp | מחרוזת | זה מאפשר את שיטת האיזון לפחות להגיב. נָכוֹן frecuently פרופיל בודק אשר backend לוקח פחות זמן להגיב על מנת לשלוח קשרים נוספים זה, שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב. |
| התמדה | מחרוזת | פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת. |
| הפניה | מחרוזת | זה מתנהג כמו backend מיוחד, כמו בקשת הלקוח הוא ענה על ידי הפנייה מחדש לכתובת חדשה באופן אוטומטי. אם הוגדרה כתובת אתר להפניה מחדש, הבקשה לא תועבר אל ה- backend, במקום זאת, כתובת אתר להפניה מחדש תגיב ללקוח. |
| קוד | מספר | זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307, |
| redirecttype | מחרוזת | כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה. |
| sessionid | מחרוזת | זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת http וינהל את הפעלת הלקוח. |
| sts_status | מחרוזת | מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נָכוֹן כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות. |
| sts_timeout | מספר | זמן (בשניות) כי הלקוח זוכר כי השירות זמין רק עם HTTS. |
| Ttl | מספר | רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות. |
| Urlp | מחרוזת | מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך. |
| ווסט | מחרוזת | הוא מציין את המצב שנקבע על ידי שם התחום באמצעות אותה כתובת IP וירטואלית ויציאה שהוגדרו על ידי חוות HTTP. ביטוי רגיל PCRE נתמך. |
אובייקט Backend עבור חוות HTTP:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה לאחור בתוך השירות הנתון. |
| ip | מחרוזת | ה- IP של Backend שבו פועל השירות האמיתי. |
| נמל | מספר | הנמל של Backend שבו פועל השירות האמיתי. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק. |
| פסק זמן | מספר | זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. אם מערכת null תשתמש בפרמטר הגלובלי Backends Backout. |
| מִשׁקָל | מספר | זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה. הערכים האפשריים הם מ 1 ל 9. |
יצירת חוות חדשה
יצירת חוות חדשה
דוגמה לבקשה:
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.2/zapi.cgi/farms
POST /farms
צור חוות HTTP חדשה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם החווה | מחרוזת | שם תיאור החווה. הוא משמש כמזהה ייחודי. | נָכוֹן |
| פרופיל | מחרוזת | הפרופיל של החווה שנוצרה. עבור חוות ה- http הוא http. | נָכוֹן |
| החברים | מחרוזת | IP של החווה, שבו השירות הווירטואלי הולך לרוץ. כתובת ה- IP שצוינה חייבת להיות מוגדרת במערכת ו- UP | נָכוֹן |
| גווניה | מספר | נמל של החווה, שבו השירות הווירטואלי הולך להקשיב. אותו נמל וירטואלי וכתובת IP וירטואלית אינם חייבים להיות בשימוש על ידי חוות אחרת. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"interface" : "eth0.2",
"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", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v3.2/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. הערכים הזמינים הם: סטנדרטי, קיבל בקשות http GET, פוסט, 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. שים לב כי ערכים אלה הם רגישים למקרה. |
| התעלם_ 100_ המשך | מחרוזת | אם לשדה זה יש את הערך נָכוֹן מה היא 100 ממשיך HTTP heade יתעלם; אם הערך הוא שקר, ה 100 ממשיך הכותרת תהיה תהליך. |
| error414 | מחרוזת | הודעת שגיאה מותאמת אישית 414. |
| error500 | מחרוזת | הודעת שגיאה מותאמת אישית 500. |
| error501 | מחרוזת | הודעת שגיאה מותאמת אישית 501. |
| error503 | מחרוזת | הודעת שגיאה מותאמת אישית 503. |
| מאזין | מחרוזת | המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח. |
| יומני | מחרוזת | החווה מתעד את החיבורים של חיבורי HTTP. אם לפרמטר זה יש את הערך נָכוֹן, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים. |
| Ciphers | מחרוזת | רק מאזין עם ערך https. משמש כדי לבנות רשימה של צופן המקובל על ידי חיבורי SSL כדי להקשיח את חיבור SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; - מכס, רק ciphers טעון ב cipherc שדה יתקבל; או ssloffloading, זה devolves את העבודה להצפין את התהליך, צופן זה תלוי במעבד. |
| 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",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "true",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף פקודת Addheader
הוסף פקודת Addheader
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/addheader
POST /farms/<farmname>/addheader
החווה תוסיף את הכותרת אל backend.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| כותרת | מחרוזת | זה מחרוזת עם הכותרת כי יישלחו backend. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add addheader directive.",
"message" : "Added a new item to the addheader list",
"status" : "needed restart",
"success" : "true"
}
מחיקת פקודת Addheader
מחיקת פקודת Addheader
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/addheader/0
DELETE /farms/<farmname>/addheader/<index>
מדד הוא האינדקס של מערך Addheader למחיקה.
דוגמה לתגובה:
{
"description" : "Delete addheader directive.",
"message" : "The addheader 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
הוסף הוראת headremove
הוסף הוראת headremove
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/headremove
POST /farms/<farmname>/headremove
הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה תואמים יוסרו.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| דפוס | מחרוזת | זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add headremove directive.",
"message" : "Added a new item to the headremove list",
"status" : "needed restart",
"success" : "true"
}
מחיקת פקודת headremove
מחיקת פקודת headremove
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/headremove/0
DELETE /farms/<farmname>/headremove/<index>
מדד הוא האינדקס של מערך headremove למחיקה.
דוגמה לתגובה:
{
"description" : "Delete headremove directive.",
"message" : "The headremove 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
הוסף אישור
הוסף אישור
דוגמה לבקשה:
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.2/zapi.cgi/farms/httpFarm/certificates
POST /farms/<farmname>/certificates
כלול תעודת PEM זמינה לרשימת ה- SNI או certlist מערך של חוות HTTP עם מאזין HTTPS. התעודה המשומשת חייבת להיות מועלית כבר במערכת, ראה אישורים> רשום את כל האישורים עבור רשימת האישורים הזמינים.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פילה | מחרוזת | שם קובץ אישור, בעבר יש להעלות את האישור במערכת. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add certificate",
"message" : "The certificate example.pem has been added to the SNI list of farm httpFarm, you need restart the farm to apply",
"success" : "true",
"status": "needed restart"
}
מחיקת אישור
מחיקת אישור
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
DELETE /farms/<farmname>/certificates/<file>
מחק את האישור עם שם הקובץ שנבחר מתוך ה- certlist בחוות ה- HTTP עם המאזין HTTPS. האישור לא יימחק מחנות האישורים.
דוגמה לתגובה:
{
"description" : "Delete farm certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true",
"status": "needed restart"
}
הוסף כלל IPDS
הוסף כלל IPDS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpFarm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists|rbl>
החלת רשימה שחורה, DoS או RBL הכלל לחווה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של IPDS משמש כמזהה ייחודי. |
דוגמה לתגובה:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm httpFarm.",
"success" : "true"
}
הסר כלל IPDS
הסר כלל IPDS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpFarm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>
הסר רשימה שחורה, DoS או RBL כלל מחווה נתון באמצעות idenficator שלה שם.
דוגמה לתגובה:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm httpFarm.",
"success" : "true"
}
HTTP - שירותים
השירותים בתוך חוות פרופיל HTTP מספק שיטת מיתוג תוכן כדי לספק מספר שירותי אינטרנט עם מאפיינים שונים, backends או אפילו שיטות התמדה, באמצעות כמה תנאים דטרמיניסטי בשימוש על ידי הליבה החווה על מנת להתאים את השירות הנכון עבור כל בקשה ללקוח. הגדרת שירות זו תשמש את החווה על מנת לקבוע את שרתי backend שיכולים לספק את התגובה ללקוח.
אחזר שירות לפי מזהה
אחזר שירות לפי מזהה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/cookiefarm/services/serv
GET /farms/<farmname>/services/<id>
הצג את כל התצורה לגבי שירות מסוים.
דוגמה לתגובה:
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null
},
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"cookiedomain" : "zevenet.cpm",
"cookieinsert" : "true",
"cookiename" : "peasocookie",
"cookiepath" : "/patfh",
"cookiettl" : 20,
"farmguardian" : "check_tcp-cut_conns",
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirect_code" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : ""
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפורמט שלהלן.
אובייקט שירותים עבור חוות HTTP:
| שדה | סוּג | תיאור |
|---|---|---|
| backends | אובייקט [] | Backends שהוגדרו בשירות. |
| cookiedomain | מחרוזת | הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיות. הפעל עוגיות שדה נדרש. |
| עוגיות | מחרוזת | זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נָכוֹן, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, לא מתבצעת פעולה. |
| cookiename | מחרוזת | שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש. |
| cookiepath | מחרוזת | הוא מנהל את הערך נתיב עוגיות עבור עוגיה נתון. הפעל עוגיות שדה נדרש. |
| cookiettl | מספר | זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש. |
| חקלאי | מחרוזת | זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. |
| https | מחרוזת | פרמטר זה מציין לחווה כי שרתי backend שהוגדרו בשירות הנוכחי משתמשים בשפה HTTPS ולאחר מכן הנתונים יהיו מוצפנים לפני שנשלחו. נָכוֹן, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends. |
| id | מחרוזת | שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות. |
| leastresp | מחרוזת | זה מאפשר את שיטת האיזון לפחות להגיב. נָכוֹן frecuently פרופיל בודק אשר backend לוקח פחות זמן להגיב על מנת לשלוח קשרים נוספים זה, שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב. |
| התמדה | מחרוזת | פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת. |
| הפניה | מחרוזת | זה מתנהג כמו backend מיוחד, כמו בקשת הלקוח הוא ענה על ידי הפנייה מחדש לכתובת חדשה באופן אוטומטי. אם הוגדרה כתובת אתר להפניה מחדש, הבקשה לא תועבר אל ה- backend, במקום זאת, כתובת אתר להפניה מחדש תגיב ללקוח. |
| קוד | מספר | זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307, |
| redirecttype | מחרוזת | כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה. |
| sessionid | מחרוזת | זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת http וינהל את הפעלת הלקוח. |
| sts_status | מחרוזת | מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נָכוֹן כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות. |
| sts_timeout | מספר | זמן (בשניות) כי הלקוח זוכר כי השירות זמין רק עם HTTS. |
| Ttl | מספר | רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות. |
| Urlp | מחרוזת | מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך. |
| ווסט | מחרוזת | הוא מציין את המצב שנקבע על ידי שם התחום באמצעות אותה כתובת IP וירטואלית ויציאה שהוגדרו על ידי חוות HTTP. ביטוי רגיל PCRE נתמך. |
אובייקט Backend עבור חוות HTTP:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה לאחור בתוך השירות הנתון. |
| ip | מחרוזת | ה- IP של Backend שבו פועל השירות האמיתי. |
| נמל | מספר | הנמל של Backend שבו פועל השירות האמיתי. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק. |
| פסק זמן | מספר | זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. אם מערכת null תשתמש בפרמטר הגלובלי Backends Backout. |
| מִשׁקָל | מספר | זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה. הערכים האפשריים הם מ 1 ל 9. |
צור שירות חדש
צור שירות חדש
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zevenet_server>:444/zapi/v3.2/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_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/services/sev2
PUT /farms/<farmname>/services/<id>
שינוי הפרמטרים של שירות בפרופיל HTTP. id הוא מזהה השירות הייחודי שישונה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| ווסט | מחרוזת | מציין את המצב שנקבע על-ידי שם התחום באמצעות אותו כתובת IP וירטואלית ויציאה שהוגדרו על-ידי חוות פרופיל של HTTP. ביטוי רגיל PCRE נתמך. |
| Urlp | מחרוזת | מאפשר לקבוע שירות אינטרנט לגבי כתובת האתר שהלקוח מבקש באמצעות תבנית כתובת אתר ספציפית שתבדוק באופן סינטקטי. ביטוי רגיל PCRE נתמך. |
| הפניה | מחרוזת | זה עובד כמו backend מיוחד, בקשת הלקוח הוא ענה על ידי הפנייה מחדש כתובת אתר חדשה באופן אוטומטי. |
| קוד | מספר | זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307, |
| redirecttype | מחרוזת | כיצד תבוצע הפנייה מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארחת מוחלטת ונתיב להפניה מחדש, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת הפניה שדה. התנהגות זו תחול רק אם הפניה אינו ערך ריק. |
| עוגיות | מחרוזת | זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נָכוֹן, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, קובץ Cookie ההכנסה מושבת. |
| cookiename | מחרוזת | שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש. |
| cookiedomain | מחרוזת | הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיות. הפעל עוגיות שדה נדרש. |
| cookiepath | מחרוזת | הוא מנהל את ערך נתיב ה- cookie עבור ה- cookie הנתון, אם ה- URI בבקשת הלקוח או בתגובת ה- backend לא תואם עם נתיב cookie, אז לא מוחלת שיטת התמדה להכנסת קובצי cookie. לְאַפשֵׁר עוגיות שדה נדרש. |
| cookiettl | מספר | זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש. |
| התמדה | מחרוזת | פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם מושב ההתמדה נעשה בבסיס ערך המופרד על ידי ";" בסוף ה- URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת. |
| Ttl | מספר | רק בהתמדה. הזמן המרבי של החיים עבור הפעלת לקוח לא פעיל (גיל הפעלה מירבי) בשניות. |
| sessionid | מחרוזת | זה זמין אם התמדה שדה כתובת האתר, עוגייה or HEADER, ערך הפרמטר יחפש על ידי הפרופיל בכותרת http וינהל את הפעלת הלקוח. |
| sts_status | מחרוזת | מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נָכוֹן כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות. |
| sts_timeout | מספר | זמן (בשניות) כי הלקוח זוכר כי השירות זמין רק עם HTTS. |
| 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" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "sid",
"sts_status" : "true",
"sts_timeout" : 21600000,
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com"
},
"status" : "needed restart"
}
פרמטרי תגובה
התגובה תהיה json עם פרמטרים המבוקש עודכן מצב שדה עם יש צורך מחדש ערך. יש לבצע פעולת הפעלה מחדש כדי להחיל את השינויים.
הוסף FarmGuardian
הוסף FarmGuardian
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/services/service1/fg
POST /farms/<farmname>/services/<id>/fg
החל FarmGuardian לשירות.
הפרמטר URI הוא המזהה הייחודי לשירות.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור. |
דוגמה לתגובה:
{
"description" : "Add the farm guardian check_tcp-cut_conns to the service service1 in the farm FarmHTTP",
"message" : "Success, The farm guardian check_tcp-cut_conns was added to the service service1 in the farm FarmHTTP"
}
הסר FarmGuardian
הסר FarmGuardian
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
DELETE /farms/<farmname>/services/<id>/fg/<name>
הסר את FarmGuardian משירות בחווה.
דוגמה לתגובה:
{
"description" : "Remove the farm guardian check_tcp-cut_conns from the service service1 in the farm FarmHTTP",
"message" : "Sucess, check_tcp-cut_conns was removed from the service service1 in the farm FarmHTTP"
}
העבר שירותים
העבר שירותים
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/services/service1/actions
POST /farms/<farmname>/services/<id>/actions
פעולות אלה מעבירות את השירות שניתן למעלה או למטה ברשימת השירות, אפשרות זו שימושית אם יש צורך לשנות את סדר העדיפות, שים לב שהשירותים מוערכים באותו סדר שמוצג. פעולה זו מפעילה מחדש את החווה באופן אוטומטי.
id הוא מזהה השירות הייחודי שישונה.
פרמטרים בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| עמדה | מספר | מיקום שבו יהיה השירות. המיקום הראשון יש את המדד 0. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Move service",
"message" : "service1 was moved successful.",
"params" : {
"position" : 0
}
}
מחיקת שירות
מחיקת שירות
דוגמה לבקשה:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
קבל את רשימת backends בשירות. id הוא המזהה הייחודי לשירות.
דוגמה לתגובה:
{
"description" : "List service backends",
"params" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1
},
{
"alias" : null,
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2
}
]
}
פרמטרי תגובה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת. |
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. |
| פסק זמן | מספר | זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. |
| מִשׁקָל | מספר | זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: 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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpfarm/services/newsrv/backends
POST /farms/<farmname>/services/<id>/backends
צור Backend חדש בפרופיל HTTP נתון. id הוא המזהה הייחודי לשירות.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. | נָכוֹן |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. | נָכוֹן |
| פסק זמן | מספר | זה פסק זמן backend להגיב על בקשה מסוימת. | |
| מִשׁקָל | מספר | זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9. |
דוגמה לתגובה:
{
"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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/services/<id>/backends/<id>
שינוי הפרמטרים של backend בשירות של פרופיל HTTP.
ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. |
| פסק זמן | מספר | זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות. |
| מִשׁקָל | מספר | זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9. |
דוגמה לתגובה:
{
"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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/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.2/zapi.cgi/farms/l4farm
GET /farms/<farmname>
הצג את כל תצורת החווה.
תגובה BODY:
{
"backends" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.168.55.40",
"port" : "88",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"alias" : "server-1",
"id" : 1,
"ip" : "192.168.55.41",
"port" : "88",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"ipds" : {
"blacklists" : [],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"algorithm" : "weight",
"farmguardian" : "check_tcp-cut_conns",
"listener" : "l4xnat",
"logs" : "false",
"nattype" : "nat",
"persistence" : "",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפורמט שלהלן.
אובייקט משק חקלאי:
| שדה | סוּג | תיאור |
|---|---|---|
| ipod | חפץ | רשימת הכללים IPDS החלים על החווה הזו. |
| params | חפץ | פרמטרים של תצורה חקלאית. |
| backends | אובייקט [] | כל השרתים האמיתיים שנוצרו בחווה זו ואת התצורה שלה. |
אובייקט IPDS:
| שדה | סוּג | תיאור |
|---|---|---|
| רשימות שחורות | אובייקט [] | כללים שחורים ברשימה החלים על החווה. |
| דוס | אובייקט [] | הכללים DoS להחיל את החווה. |
| Rbl | אובייקט [] | הכללים RBL להחיל על החווה. |
רשימה שחורה, DoS ו- RBL אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל. |
| מצב | מחרוזת | מצב כלל. |
אובייקט פרמטרים עבור חוות 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 עם מפריד ,. |
| חקלאי | מחרוזת | זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. |
אובייקט Backend עבור חוות L4xNAT:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה כדי לזהות את backend בחווה. |
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק. |
| עדיפות | מספר | זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר ו- 9 הוא העדיפות הנמוכה ביותר. |
| מִשׁקָל | מספר | זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9. |
יצירת חוות חדשה
יצירת חוות חדשה
דוגמה לבקשה:
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.2/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","logs":"true"}'
https://<zevenet_server>:444/zapi/v3.2/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",
"logs" : "true",
"nattype" : "nat",
"newfarmname" : "l4farm",
"persistence" : "",
"protocol" : "tcp",
"ttl" : 125,
"vip" : "178.62.126.152",
"vport" : "81"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף FarmGuardian
הוסף FarmGuardian
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4Farm/fg
POST /farms/<farmname>/fg
החל FarmGuardian לחווה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור. |
דוגמה לתגובה:
{
"description" : "Add the farm guardian check_tcp-cut_conns to the farm fgl4",
"message" : "Success, The farm guardian check_tcp-cut_conns was added to the farm fgl4"
}
הסר FarmGuardian
הסר FarmGuardian
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
DELETE /farms/<farmname>/fg/<name>
הסר את FarmGuardian מן החווה.
דוגמה לתגובה:
{
"description" : "Remove the farm guardian check_tcp-cut_conns from the farm fgl4",
"message" : "Sucess, check_tcp-cut_conns was removed from the farm fgl4"
}
הוסף כלל IPDS
הוסף כלל IPDS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4Farm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists|rbl>
להחיל רשימות שחורות, DoS או RBL כלל לחווה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של IPDS משמש כמזהה ייחודי. |
דוגמה לתגובה:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm l4Farm.",
"success" : "true"
}
הסר כלל IPDS
הסר כלל IPDS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4Farm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>
הסר רשימה שחורה, DoS או RBL כלל של מודול IPDS מחווה נתונה באמצעות idenficator שלה שם.
דוגמה לתגובה:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm l4Farm.",
"success" : "true"
}
L4xNAT - Backends
רשימת backends
רשימת backends
דוגמה לבקשה:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4farm/backends
GET /farms/<farmname>/backends
קבל את רשימת backends בשירות.
דוגמה לתגובה:
{
"description" : "List backends",
"params" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.5.1.1",
"max_conns" : 400,
"port" : 787,
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"alias" : "server-2",
"id" : 1,
"ip" : "192.5.1.3",
"max_conns" : 200,
"port" : 787,
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
פרמטרי תגובה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה כדי לזהות את backend בחווה. |
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק. |
| max_conns | מספר | זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי. |
| עדיפות | מספר | זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר ו- 9 הוא העדיפות הנמוכה ביותר. |
| מִשׁקָל | מספר | זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9. |
צור 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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4farm/backends
POST /farms/<farmname>/backends
צור Backend חדש בחווה L4xNAT.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. | נָכוֹן |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. מקבלים ערך ריק והוא ישתמש באותה תצורה מאשר יציאות וירטואליות. | |
| max_conns | מספר | זהו המספר המרבי של חיבור מקביל עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי. | |
| עדיפות | מספר | זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הקשרים תמיד לפריו הכי זמין כאשר 1 הוא העדיפות הגבוהה ביותר ו- 9 הוא העדיפות הנמוכה ביותר. | |
| מִשׁקָל | מספר | זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9. |
דוגמה לתגובה:
{
"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://<zevenet_server>:444/zapi/v3.2/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 הוא העדיפות הגבוהה ביותר ו- 9 הוא העדיפות הנמוכה ביותר. |
| מִשׁקָל | מספר | זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9. |
דוגמה לתגובה:
{
"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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4farm/backends/4
DELETE /farms/<farmname>/backends/<id>
מחיקת backend נתון בשירות של חוות L4xNAT.
id הוא מזהה ייחודי backend.
דוגמה לתגובה:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
חוות GSLB
איזון עומס השירות העולמי, הנקרא בדרך כלל GSLB, מאפשר ליצור שירות איזון עומס על בסיס הארכיטקטורה היררכית של שירות DNS. סוג זה של חוות מספק רשומת DNS בלבד עם אלגוריתמי איזון עומסים וגילוי מצב שירות בשכבת יישום DNS.
אחזר את החווה לפי שם
אחזר את החווה לפי שם
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm
GET /farms/<farmname>
הצג את כל תצורת החווה.
דוגמה לתגובה:
{
"description" : "List farm gslbfarm",
"ipds" : {
"blacklists" : [],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"status" : "needed restart",
"vip" : "192.168.100.155",
"vport" : 60
},
"services" : [
{
"algorithm" : "roundrobin",
"backends" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port" : 53,
"status" : "up"
},
{
"alias" : "dns-server",
"id" : 2,
"ip" : "192.168.55.40",
"port" : 53,
"status" : "up"
},
{
"alias" : null,
"id" : 4,
"ip" : "192.135.10.2",
"port" : 53,
"status" : "up"
}
],
"deftcpport" : 53,
"farmguardian" : "dns-request",
"id" : "service1"
},
{
"algorithm" : "prio",
"backends" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port" : 80,
"status" : "up"
},
{
"alias" : "localhost",
"id" : 2,
"ip" : "127.0.0.1",
"port" : 80,
"status" : "up"
}
],
"deftcpport" : 80,
"farmguardian" : null,
"id" : "prioServ"
}
],
"zones" : [
{
"defnamesv" : "ns3",
"id" : "global.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns3",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns3",
"ttl" : null,
"type" : "A"
},
{
"id" : 3,
"rdata" : "resource2",
"rname" : "ns2",
"ttl" : null,
"type" : "NS"
},
{
"id" : 4,
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
}
]
},
{
"defnamesv" : "ns1",
"id" : "DOM.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns1",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns1",
"ttl" : null,
"type" : "A"
}
]
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפורמט שלהלן.
אובייקט משק חקלאי:
| שדה | סוּג | תיאור |
|---|---|---|
| ipod | חפץ | רשימת הכללים IPDS החלים על החווה הזו. |
| params | חפץ | פרמטרים של תצורה חקלאית. |
| שירותים | אובייקט [] | מערך עם כל השירותים שנוצרו בחווה זו ואת התצורה שלה. |
| אזורי | אובייקט [] | מערך עם כל האזורים שנוצרו בחווה זו ואת התצורה שלה. |
אובייקט IPDS:
| שדה | סוּג | תיאור |
|---|---|---|
| רשימות שחורות | אובייקט [] | רשימות שחורות החלים על החווה. |
| דוס | אובייקט [] | הכללים DoS להחיל את החווה. |
| Rbl | אובייקט [] | הכללים RBL להחיל על החווה. |
רשימה שחורה, DoS ו- RBL אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל. |
| מצב | מחרוזת | מצב כלל. |
אובייקט פרמטר עבור חוות GSLB:
| שדה | סוּג | תיאור |
|---|---|---|
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
| גווניה | מספר | נמל של החווה, שבו השירות וירטואלי מקשיב. |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא מעלה את כל backends הם בלתי מושגת; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
אובייקט שירות עבור חוות GSLB:
| שדה | סוּג | תיאור |
|---|---|---|
| backends | אובייקט [] | Backends שהוגדרו בשירות. |
| חקלאי | מחרוזת | זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. יומני חקלאי אינם זמינים עבור חוות GSLB |
| id | מחרוזת | שם שירות המשמש כמזהה ייחודי. |
| אַלגוֹרִיתְם | מחרוזת | סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, אשר יתאזן חיבורים amoung כל backends, או פריו אשר ישלח את כל החיבורים לראש backend זמין. |
| deftcpport | מספר | ברירת המחדל של בדיקת יציאות TCP. זה לבדוק את יציאת TCP הבריאות כי השירות עומד לבדוק על מנת לקבוע כי שירות backend הוא חי. ערך ריק מושבת. |
אובייקט Backend עבור חוות GSLB:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת. |
| ip | מחרוזת | ה- IP של Backend שבו השירות האמיתי מאזין. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק. |
אובייקט Zone:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | שם האזור משמש כמו מפרט ייחודי. |
| defnamesv | מחרוזת | זה יהיה שרת השמות של נקודת הכניסה שיהיה זמין כרשומת DNS של רשות ההתחלה (SOA). |
| משאבים | אובייקט [] | מידע נוסף המוגדר באזור. |
אובייקט משאב:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | מזהה ייחודי עבור המשאב באזור. |
| rname | מחרוזת | שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata. |
| Ttl | מספר | הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון. |
| סוג | מחרוזת | סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף. |
| rdata | מחרוזת | זה הנתונים האמיתיים הדרושים על ידי סוג הרשומה, ערך קלט תלוי סוג של שם משאבים, rname ואת סוג המשאב, סוג. |
יצירת חוות חדשה
יצירת חוות חדשה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms
POST /farms
צור חוות GSLB חדשה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם החווה | מחרוזת | שם החווה, מזהה ייחודי לחווה. | נָכוֹן |
| פרופיל | מחרוזת | הפרופיל של החווה שנוצרה. עבור חוות GSLB הוא גסלב. | נָכוֹן |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. | נָכוֹן |
| גווניה | מספר | נמל של החווה, שבו השירות וירטואלי מקשיב. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Creating farm 'gslbfarm'",
"params" : {
"farmname" : "gslbfarm",
"interface" : "eth0",
"profile" : "gslb",
"vip" : "192.168.100.241",
"vport" : 53
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שינוי משק חקלאי
שינוי משק חקלאי
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"gslbnewname","vip":"192.168.100.155","vport":60}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm
PUT /farms/<farmname>
שינוי התצורה של חוות GSLB.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| newfarmname | מחרוזת | שם החווה החדשה. חייבים להפסיק את החווה כדי לעשות את השינוי הזה. |
| גווניה | מספר | נמל של החווה, שבו השירות וירטואלי מקשיב. |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
דוגמה לתגובה:
{
"description" : "Modify farm gslbnewname",
"params" : {
"newfarmname" : "gslbnewname",
"vip" : "192.168.100.155",
"vport" : 60
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף כלל IPDS
הוסף כלל IPDS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbFarm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists|rbl>
החלת רשימה שחורה, DoS או RBL הכלל לחווה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של IPDS משמש כמזהה ייחודי. |
דוגמה לתגובה:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
"success" : "true"
}
הסר כלל IPDS
הסר כלל IPDS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>
הסר רשימה שחורה, DoS או RBL כלל מחווה נתון באמצעות idenficator שלה שם.
דוגמה לתגובה:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
"success" : "true"
}
GSLB - שירותים
שירות GSLB מייצג קבוצה של שרתים אמיתיים ואלגוריתם קשור שישמש עבורם. כדי ליצור שירות חדש, עליך להגדיר שם זיהוי חוקי והאלגוריתם הרצוי לשימוש.
השירותים הזמינים הם:
סיבוב רובין: שיתוף שווה. איזון שווה של התנועה לכל השרתים האמיתיים הפעילים. עבור כל חיבור נכנס האיזון מקצה בסיבוב הבא רובין שרת אמיתי כדי לספק את הבקשה.
עדיפות: חיבורים תמיד לפריו הכי זמין. איזון כל החיבורים לאותו שרת עדיפות עליונה. אם שרת זה מושבת, החיבורים עוברים לשרת הבא הגבוה ביותר. עם אלגוריתם זה ניתן לבנות שירות אשכול Active-Pasive עם מספר שרתים אמיתיים.
שירותים אובייקטים עבור חוות GSLB
| שדה | סוּג | תיאור |
|---|---|---|
| backends | אובייקט [] | Backends שהוגדרו בשירות. |
| חקלאי | מחרוזת | זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. |
| id | מחרוזת | שם שירות המשמש כמזהה ייחודי. |
| אַלגוֹרִיתְם | מחרוזת | סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, אשר יתאזן חיבורים amoung כל backends, או פריו אשר ישלח את כל החיבורים לראש backend זמין. |
| deftcpport | מחרוזת | ברירת המחדל של בדיקת יציאות TCP. זה לבדוק את יציאת TCP הבריאות כי השירות עומד לבדוק על מנת לקבוע כי שירות backend הוא חי. ערך ריק מושבת. |
צור שירות חדש
צור שירות חדש
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"service1","algorithm":"roundrobin"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services
POST /farms/<farmname>/services
יצירת שירות בחוות GSLB נתון. יש להפעיל מחדש את החווה כדי להחיל את השינוי.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| id | מחרוזת | שם שירות המשמש כמזהה ייחודי. | נָכוֹן |
| אַלגוֹרִיתְם | מחרוזת | סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, אשר יתאזן חיבורים amoung כל backends, או פריו אשר ישלח את כל החיבורים לראש backend זמין. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "New service service1",
"params" : {
"algorithm" : "roundrobin",
"id" : "service1"
},
"status" : "needed restart"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שינוי שירות
שינוי שירות
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"deftcpport":53}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1
PUT /farms/<farmname>/services/<id>
שינוי הפרמטרים של שירות בחוות GSLB. id הוא מזהה השירות הייחודי שישונה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| deftcpport | מספר | זה לבדוק את יציאת TCP הבריאות כי השירות עומד לבדוק על מנת לקבוע כי שירות backend הוא חי. |
דוגמה לתגובה:
{
"description" : "Modify service service1 in farm gslbfarm",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"params" : {
"deftcpport" : 53
},
"status" : "needed restart"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף FarmGuardian
הוסף FarmGuardian
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"dns-request"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/service/service1/fg
POST /farms/<farmname>/services/<id>/fg
החל FarmGuardian לשירות.
הפרמטר URI הוא המזהה הייחודי לשירות.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור. יומני FarmGuardian אינם זמינים עבור חוות gslb. |
דוגמה לתגובה:
{
"description" : "Add the farm guardian dns-request to the service service1 in the farm gslbfarm",
"message" : "Success, The farm guardian dns-request was added to the service service1 in the farm gslbfarm"
}
הסר FarmGuardian
הסר FarmGuardian
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
DELETE /farms/<farmname>/fg/<name>
הסר את FarmGuardian משירות בחווה.
דוגמה לתגובה:
{
"description" : "Remove the farm guardian dns-request from the service service1 in the farm gslbfarm",
"message" : "Sucess, dns-request was removed from the service service1 in the farm gslbfarm"
}
מחיקת שירות
מחיקת שירות
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1
DELETE /farms/<farmname>/services/<id>
מחק שירות מסוים של חוות GSLB. id הוא המזהה הייחודי לשירות שיימחק.
דוגמה לתגובה:
{
"description" : "Delete service service1 in farm gslbfarm",
"message" : "The service service1 in farm gslbfarm has been deleted.",
"success" : "true",
"status": "needed restart"
}
GSLB - שירותים - Backends
סעיף זה ינהל את רשימת השירותים האמיתית המשויכת לשירות.
רשימת backends
רשימת backends
דוגמה לבקשה:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
קבל את רשימת backends בשירות. id הוא המזהה הייחודי לשירות.
דוגמה לתגובה:
{
"description" : "List service backends",
"params" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port":53,
"status":"up"
},
{
"alias" : "dns-server",
"id" : 2,
"ip" : "192.168.55.40",
"port":53,
"status":"up"
}
]
}
פרמטרי תגובה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| id | מספר | מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת. |
| ip | מחרוזת | IP של backend, שבו השירות האמיתי הוא מקשיב. |
| נמל | מספר | הנמל של Backend שבו השירות מאזין. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק. |
צור Backend חדש
צור Backend חדש
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.135.10.2"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends
POST /farms/<farmname>/services/<id>/backends
צור Backend חדש בשירות נתון בחוות GSLB. id הוא מזהה השירות הייחודי שבו יתווסף backend.
שירותי העדיפות יש 2 backends כמו maxun, המארח הפעיל המארח פסיבי.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| ip | מחרוזת | IP של backend, שבו השירות האמיתי הוא מקשיב. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 4,
"ip" : "192.135.10.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.2.30"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends/1
PUT /farms/<farmname>/services/<id>/backends/<id>
שינוי הפרמטרים של backend בשירות של חוות GSLB.
הערה ב PUT מעל זה הראשון id הוא מזהה השירות הייחודי הבא id הוא מזהה ייחודי backend.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | IP של 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.2.30"
},
"status" : "needed restart"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק backend
מחק backend
דוגמה לבקשה:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends/3
DELETE /farms/<farmname>/services/<servicename>/backends/<id>
מחק backend נתון בשירות של חוות GSLB
דוגמה לתגובה:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
GSLB - אזורים
החלק של אזור ה- GSLB יתאר את שם תחום ה- DNS, תת-הדומיינים, כינויים וכו ', שיידרש ליצירת אזור DNS שלם עם רשומות איזון עומס נוספות באמצעות השירותים המוגדרים.
צור אזור
צור אזור
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"global.conf"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones
POST /farms/<farmname>/zones
צור אזור DNS.
פרמטרים בקשה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| id | מספר | שם האזור משמש כמו מפרט ייחודי. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "New zone global.com",
"params" : {
"id" : "global.com"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שינוי אזור
שינוי אזור
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"defnamesv":"ns3"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com
PUT /farms/<farmname>/zones/<id>
שינוי הפרמטרים של אזור. id הוא המזהה הייחודי לאזור אשר ישונה.
פרמטרים בקשה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| defnamesv | מחרוזת | זה יהיה שרת השמות של נקודת הכניסה שיהיה זמין כרשומת DNS של רשות ההתחלה (SOA). |
דוגמה לתגובה:
{
"description" : "Modify zone global.com in farm gslbfarm",
"params" : {
"defnamesv" : "ns3"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחיקת אזור
מחיקת אזור
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/dom.com
DELETE /farms/<farmname>/zones/<id>
מחק אזור נתון של חוות GSLB.
דוגמה לתגובה:
{
"description" : "Delete zone dom.com in farm gslbfarm.",
"message" : "The zone dom.com in farm gslbfarm has been deleted.",
"success" : "true"
}
GSLB - אזורי - משאבים
משאבים המוגדרים כשירות ה- DNS פותר בקשות. משאבי ה- DNS האפשריים במאזן העומס של Zevenet הם:
- NS. שם הרשומה סוג שרת, הוא נציג אזור DNS כדי להשתמש בשרתי שם נתון סמכותי.
- A. כתובת סוג רשומה, הוא מחזיר כתובת IPv4 של המארח.
- CNAME. שם הקלטת שם קנוני, הוא מייצג כינוי של שם נתון.
- DYNA. רשומה מסוג כתובת דינמית, היא מחזירה כתובת דינמית שצוין על ידי שירות GSLB שכבר נוצר בתוך תצורת החווה בהתאם לאלגוריתם שנבחר עבור שירות כזה.
- אאאא. כתובת סוג רשומה, הוא מחזיר כתובת IPv6 של המארח.
- MX. סוג החלפת דואר דואר, מפות שם תחום לרשימה של סוכני העברת הודעות עבור תחום זה.
- SRV. רשומת סוג לאיתור שירות, רשומת מיקום שירות כללית, המשמשת לפרוטוקולים חדשים יותר במקום ליצור רשומות ספציפיות לפרוטוקול כגון MX.
- TXT. להקליד סוג טקסט, הוא משמש לאחסון כל מידע מבוסס טקסט שניתן לתפוס בעת הצורך. בדרך כלל אנו רואים רשומות TXT המשמשות לאחזקת נתוני SPF ולאמת בעלות על תחום.
- PTR. מצביע מצביע, מצביע לשם קנוני. שלא כמו CNAME, עיבוד DNS מפסיק ורק השם מוחזר. השימוש הנפוץ ביותר הוא ביישום חיפושי DNS הפוכים.
- NAPTR. מתן שמות של רשם רשות, מאפשר כתיבה מחדש המבוססת על ביטוי רגולרי של שמות דומיינים, אשר לאחר מכן ניתן להשתמש בהם כ- URI, שמות דומיין נוספים לחיפושים וכו '.
רשום את המשאבים
רשום את המשאבים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources
GET /farms/<farmname>/zones/<id>/resources
קבל את רשימת המשאבים באזור. id הוא מזהה ייחודי לאזור.
דוגמה לתגובה:
{
"description" : "List zone resources",
"params" : [
{
"id" : 0,
"rdata" : "ns3",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns3",
"ttl" : null,
"type" : "A"
},
{
"id" : 2,
"rdata" : "192.168.0.9",
"rname" : "resource2",
"ttl" : 10,
"type" : "A"
},
{
"id" : 3,
"rdata" : "resource2",
"rname" : "ns2",
"ttl" : null,
"type" : "NS"
}
]
}
פרמטרי תגובה
שיחה זו מחזירה מערך אובייקט משאבים עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | מזהה ייחודי עבור המשאב באזור. |
| rname | מחרוזת | שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata. |
| Ttl | מספר | הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון. |
| סוג | מחרוזת | סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף. |
| rdata | מחרוזת | זה הנתונים האמיתיים הדרושים על ידי סוג הרשומה, ערך קלט תלוי סוג של שם משאבים, rname ואת סוג המשאב, סוג. |
צור משאב חדש
צור משאב חדש
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.0.9", "ttl":10, "type":"A" }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources
POST /farms/<farmname>/zones/<id>/resources
צור משאב חדש באזור נתון בחוות GSLB. id הוא המזהה הייחודי לאזור אשר ישונה במקום שבו יתווסף המשאב.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| rname | מחרוזת | שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata. | נָכוֹן |
| Ttl | מספר | הערך 'זמן חי' עבור הרשומה הנוכחית. זהו מספר מקסימום של התקנים נתב כי הבקשה יכולה דרך למות til. שימושי שלה היא כי מנות לא קלט לולאה נטו. | |
| סוג | מחרוזת | סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף. | נָכוֹן |
| rdata | מחרוזת | זה הנתונים האמיתיים הדרושים על ידי סוג הרשומה, ערך קלט תלוי סוג של שם משאבים, rname ואת סוג המשאב, סוג. אם DYNA נבחר ב סוג אז הערך rdata צריך להיות אחד מוגדר שירותים באזור זה. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "New zone resource",
"message" : "Resource added",
"params" : {
"rdata" : "192.168.0.9",
"rname" : "resource2",
"ttl" : 10,
"type" : "A",
"zone" : "global.com"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שנה משאב
שנה משאב
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.200.30","ttl":null, "type":"A" }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
PUT /farms/<farmname>/zones/<id>/resources/<id>
שינוי הפרמטרים של resouce באזור של חוות GSLB.
ראשון id הוא מזהה אזור ייחודי, הבא id הוא מזהה ייחודי של משאב.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| rname | מחרוזת | שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata. |
| Ttl | מספר | הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון. |
| סוג | מחרוזת | סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף. |
| rdata | מחרוזת | זה הנתונים האמיתיים הדרושים על ידי סוג הרשומה, ערך קלט תלוי סוג של שם משאבים, rname ואת סוג המשאב, סוג. אם סוג טעון עם ערך DYNA אז rdata יש לטעון עם זמין שרות שם |
דוגמה לתגובה:
{
"description" : "Modify zone resource",
"message" : "Resource modified",
"params" : {
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
},
"success" : "true"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק משאב
מחק משאב
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
DELETE /farms/<farmname>/zones/<id>/resources/<id>
מחק resouce נתון באזור של חוות GSLB
שים לב כי ב DELETE URI מעל הראשון id הוא מזהה אזור ייחודי הבא id הוא מזהה ייחודי של משאב.
דוגמה לתגובה:
{
"description" : "Delete zone resource",
"message" : "Resource 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.2/zapi.cgi/farms/dlink
GET /farms/<farmname>
הצג את כל תצורת החווה.
דוגמה לתגובה:
{
"backends" : [
{
"alias" : "main-gateway",
"id" : 0,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"alias" : "secondary-gateway",
"id" : 1,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
],
"description" : "List farm dlink",
"ipds" : {
"blacklists" : []
},
"params" : {
"algorithm" : "weight",
"status" : "down",
"vip" : "192.168.100.199"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפורמט שלהלן.
אובייקט משק חקלאי:
| שדה | סוּג | תיאור |
|---|---|---|
| ipod | חפץ | רשימת הכללים IPDS החלים על החווה הזו. |
| params | חפץ | פרמטרים של תצורה חקלאית. |
| backends | אובייקט [] | שרתים אמיתיים שנוצרו בחווה זו ובתצורה שלה. |
אובייקט IPDS:
| שדה | סוּג | תיאור |
|---|---|---|
| רשימות שחורות | מחרוזת [] | רשימות שחורות החלים על החווה. |
אובייקט פרמטרים עבור חוות datalink:
| שדה | סוּג | תיאור |
|---|---|---|
| אַלגוֹרִיתְם | מחרוזת | סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: מִשׁקָל, האיזון מפיץ בין כל backends זמין נתון backends תשלום נוסף עם משקל גבוה יותר ב להפיץ או פריו, אשר שולח את כל החיבורים אל backend עם ערך קטין של עדיפות. |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא מעלה את כל backends הם בלתי מושגת; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
אובייקט backend עבור חוות datalink:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את backend. כינוי |
| 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.2/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://<zevenet_server>:444/zapi/v3.2/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 עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף כלל IPDS
הוסף כלל IPDS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists
POST /farms/<farmname>/ipds/<blacklists>
החלת כלל רשימה שחורה על החווה. פרופיל datalink מקבל רק כללים של רשימה שחורה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של IPDS משמש כמזהה ייחודי. |
דוגמה לתגובה:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm dlink2.",
"success" : "true"
}
הסר כלל IPDS
הסר כלל IPDS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<blacklists>/<name>
הסר רשימה שחורה מחווה נתונה באמצעות idenficator שלה שם.
דוגמה לתגובה:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm dlink2.",
"success" : "true"
}
הוסף כלל IPDS
הוסף כלל IPDS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists
POST /farms/<farmname>/ipds/<blacklists>
החלת חוק שחור על החווה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של הרשימה השחורה משמש כמזהה ייחודי. |
דוגמה לתגובה:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm dlink2.",
"success" : "true"
}
הסר כלל IPDS
הסר כלל IPDS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<blacklists>/<name>
הסרת כלל הרשימה השחורה של מודול IPDS מחווה נתונה באמצעות idenficator שלה שם.
דוגמה לתגובה:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm dlink2.",
"success" : "true"
}
Datalink - Backends
Backends בחוות datalink הם השערים דרך ניתוב השירות. השירות יהיה multiplexor בין השערים, וחלקם אינו זמין, השירות משתמש אחרים (ים).
רשימת backends
רשימת backends
דוגמה לבקשה:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink/backends
GET /farms/<farmname>/backends
קבל את רשימת backends בשירות.
דוגמה לתגובה:
[
{
"alias" : "main-gateway",
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"alias" : "secondary-gateway",
"id" : 7,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
]
פרמטרי תגובה
שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את 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://<zevenet_server>:444/zapi/v3.2/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,"priority":1}'
https://<zevenet_server>:444/zapi/v3.2/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",
"priority" : 1,
"weight" : 1
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק backend
מחק backend
דוגמה לבקשה:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.
קשר: גם נקרא על ידי ספקים אחרים כמו ממשקי המטען, זה סוג של nic ניתן ליצור עם יותר ממשק אחד nic. Zevenet תומך 7 סוגים שונים של ממשקים מליטה.
וירטואלי: זה סוג של ממשק ניתן ליצור מעל כל סוג של ממשק המתואר לעיל. סוג זה של ממשק צריך לשמש עבור חוות והוא נדרש כי ממשק וירטואלי מוגדר באותה רשת משנה מאשר ההורה.
רשימת כל הממשקים
רשימת כל הממשקים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic
GET /interfaces
קבל רשימה של ממשקים במערכת עם התצורה שלהם.
דוגמה לתגובה:
{
"description" : "List interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "bond2",
"netmask" : "",
"status" : "down",
"type" : "bond"
},
{
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "bond"
},
{
"alias" : null,
"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",
"is_slave" : "false"
},
{
"alias" : null,
"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"
},
{
"alias" : null,
"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"
},
{
"alias" : "gestion",
"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",
"is_slave" : "false"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "eth2",
"netmask" : "",
"status" : "up",
"type" : "nic",
"is_slave" : "true"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"status" : "up",
"type" : "nic",
"is_slave" : "true"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק.
אובייקט ממשק:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| ip | מחרוזת | IP של הממשק. IP חייב להיות באותו קטע רשת מאשר ממשק האב בממשק וירטואלי. |
| has_vlan | מחרוזת | נָכוֹן, הממשק הוא האב של ממשק VLAN; או שקר, הממשק לא קיבל שום ממשק VLAN המלווה אותו. שדה זה מיועד רק עבור ממשקי NIC. |
| מסכת רשת | מחרוזת | Netmask של הממשק. ערך זה לא יכול להיות שונה בממשקים וירטואליים, הוא עובר בירושה מן inteface האב. |
| שער כניסה | מחרוזת | שער של הממשק. ערך זה לא יכול להיות שונה בממשקים וירטואליים, הוא עובר בירושה מן inteface האב. |
| מק | מחרוזת | MAC של הממשק. ערך זה עובר בירושה מעבד ה- NIC הראשון בממשקי מליטה. בממשקים וירטואליים ו- VLAN הוא עובר בירושה ממשק האב. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| סוג | מחרוזת | הממשקים השונים הם: nic, vlan, וירטואלי or קשר. |
| is_slave | מחרוזת | רק availabe בממשקי NIC, נָכוֹן, הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה. |
אחזר שער ברירת מחדל
אחזר שער ברירת מחדל
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic
דוגמה לתגובה:
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"alias" : null,
"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"
},
{
"alias" : "gestion",
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"is_slave" : "false",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"status" : "down"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מערך של אובייקטי ממשק NIC.
אובייקט ממשק NIC:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| ip | מחרוזת | IP של הממשק. |
| has_vlan | מחרוזת | נָכוֹן, הממשק הוא האב של ממשק VLAN; או שקר, הממשק לא קיבל שום ממשק VLAN המלווה אותו. |
| מסכת רשת | מחרוזת | הגדר את קטע הרשת שבו פועל הממשק. |
| שער כניסה | מחרוזת | IP שימש לשלוח מנות לפלח רשת אחר. |
| מק | מחרוזת | קישור שכבת מזהה ייחודי. זה לא ניתן לשינוי. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| is_slave | מחרוזת | נָכוֹן הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה. |
אחזור ממשק NIC
אחזור ממשק NIC
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic/eth1
GET /interfaces/nic/<name>
קבל את כל הפרמטרים של ממשק NIC. שם הוא מזהה ייחודי של ממשק.
דוגמה לתגובה:
{
"description" : "Show NIC interface",
"interface" : {
"alias" : "gestion",
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| ip | מחרוזת | IP של הממשק. |
| מסכת רשת | מחרוזת | הגדר את קטע הרשת שבו פועל הממשק. |
| שער כניסה | מחרוזת | IP שימש לשלוח מנות לפלח רשת אחר. |
| מק | מחרוזת | קישור שכבת מזהה ייחודי. זה לא ניתן לשינוי. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| סוג | מחרוזת | הממשקים השונים הם: nic, vlan, וירטואלי or קשר. כל אחד מהם מוגדר בתפריט המשנה של הרשת. |
| is_slave | מחרוזת | נָכוֹן הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה. |
שינוי ממשק 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://<zevenet_server>:444/zapi/v3.2/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",
"force" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחיקת תצורת NIC
מחיקת תצורת NIC
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic/eth1/actions
POST /interfaces/nic/<name>/actions
החל פעולה על ממשק NIC. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.
שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Action on nic interface",
"params" : {
"action" : "up"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
רשת - ממשקי מליטה
ממשק מליטה לינוקס או נקרא גם על ידי ספקים אחרים כמו Trunk מספק שיטה לצבירה ממשקי רשת מרובים לתוך ממשק לוגי אחד "מלוכדות". ההתנהגות של הממשקים מלוכדות תלוי במצב, Zevenet Load Balancer תומך בשיטות הבאות:
מדיניות סיבוב רובין: להעביר מנות בסדר רציף מן העבד זמין הראשון דרך האחרון. מצב זה מספק איזון עומסים ועמידות בפני תקלות.
מדיניות גיבוי פעיל: רק עבד אחד באג"ח פעיל. עבד אחר הופך להיות פעיל אם ורק אם העבד הפעיל נכשל. כתובת ה- MAC של האג"ח מוצגת חיצונית רק ביציאה אחת (מתאם רשת) כדי למנוע בלבול של המתג. מצב זה מספק עמידות בפני תקלות. האפשרות הראשית משפיעה על אופן הפעולה של מצב זה.
XOR מדיניות: לשדר מבוסס על המקור כתובת MAC XOR'd עם כתובת MAC היעד. זה בוחר את אותו עבד עבור כל כתובת MAC היעד. מצב זה מספק איזון עומסים ועמידות בפני תקלות.
מדיניות שידור: מעביר הכל על כל ממשקי העבדים. מצב זה מספק עמידות בפני תקלות.
IEEE 802.3ad LACP: יצירת קבוצות צבירה המשותפות לאותה מהירות ולהגדרות דו-צדדיות. מנצל את כל העבדים בצובר הפעיל בהתאם למפרט 802.3ad.
מקדים:
תמיכה בממשק רשת במנהלי ההתקן הבסיסיים לאחזור המהירות והדופלקס של כל עבד.
מתג התומך ב- IEEE 802.3ad של צבירת קישורים דינמיים. רוב המתגים ידרוש איזה סוג של תצורה כדי לאפשר מצב 802.3ad.
איזון עומס מסתגל: מליטה ערוץ זה אינו דורש שום תמיכה מתג מיוחד. התנועה היוצאת מופצת בהתאם לעומס הנוכחי (מחושב ביחס למהירות) על כל עבדים. התנועה הנכנסת מתקבלת על ידי העבד הנוכחי. אם העבד המקבל נכשל, עבד אחר משתלט על כתובת ה- MAC של העבד המקבל.
מקדים:
בסיס תמיכה הנהג לאחזור המהירות של כל עבד.
איזון עומס מסתגל: כולל איזון מסתגל של עומס שידור וקבלת איזון עומסים עבור תעבורת IPV4, ואינו דורש תמיכה מיוחדת במתג. האיזון עומס לקבל מושגת על ידי משא ומתן ARP. הנהג מליטה מיירט את התגובות ARP שנשלחו על ידי המערכת המקומית בדרכם החוצה מחליף את כתובת החומרה המקור עם כתובת החומרה הייחודית של אחד העבדים ב מליטה כך עמיתים שונים להשתמש בכתובות חומרה שונות עבור השרת.
רשימת הממשקים מליטה
רשימת הממשקים מליטה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding
GET /interfaces/bonding
קבל תצורה על כל ממשקי מליטה במערכת.
דוגמה לתגובה:
{
"description" : "List bonding interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"mode" : "broadcast",
"name" : "bond2",
"netmask" : "",
"slaves" : [
{
"name" : "eth2"
}
],
"status" : "down"
},
{
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth4"
}
],
"status" : "up"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק מליטה.
פרמטרים מליטה הם:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| ip | מחרוזת | IP של הממשק. |
| מסכת רשת | מחרוזת | הגדר את קטע הרשת שבו פועל הממשק. |
| שער כניסה | מחרוזת | IP שימש לשלוח מנות של פלח רשת אחר. |
| מק | מחרוזת | קישור שכבת מזהה ייחודי. זה מק של העבד ממשק NIC הראשון. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| עבדים | אובייקט [] | NIC חברי ממשק של inteface מליטה. |
| מצב | מחרוזת | זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים בסעיף רשת - ממשקי מליטה. |
חפצי עבדים:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הוא מזהה ייחודי של ממשק של העבד NIC. |
לאחזר ממשק מליטה
לאחזר ממשק מליטה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface
GET /interfaces/bonding/<name>
קבל את כל הפרמטרים של הממשק. שם הוא מזהה ייחודי של ממשק.
דוגמה לתגובה:
{
"description" : "Show bonding interface",
"interface" : {
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
}
],
"status" : "up"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם אובייקט ממשק מליטה.
פרמטרים מליטה הם:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| ip | מחרוזת | IP של הממשק. |
| מסכת רשת | מחרוזת | הגדר את קטע הרשת שבו פועל הממשק. |
| שער כניסה | מחרוזת | IP שימש לשלוח מנות של פלח רשת אחר. |
| מק | מחרוזת | קישור שכבת מזהה ייחודי. זה מק של העבד ממשק NIC הראשון. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| עבדים | אובייקט [] | NIC חברי ממשק של inteface מליטה. |
| מצב | מחרוזת | זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה. |
עבד אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הוא מזהה ייחודי של ממשק של העבד NIC. |
יצירת ממשק מליטה
יצירת ממשק מליטה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"slaves":["eth3","eth2"],"name":"bondiface","mode":"balance-rr"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding
POST /interfaces/bonding
יצירת ממשק מליטה שהצטרף ממשקי NIC.
כתובת מליטה MAC יילקח ממשק NIC הראשון שלה. מצב Bonding לא ניתן לשנות ברגע ממשק מליטה נוצר, אבל ממשקי חבר ניתן להוסיף או למחוק ממשק מליטה לפי הצורך. ממשק NIC יהיה נעול אם הוא חלק ממשק מליטה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. | נָכוֹן |
| עבדים | מחרוזת [] | כל הממשקים NIC לבנות את מליטה. זה נדרש פרמטר NIC שם. | נָכוֹן |
| מצב | מחרוזת | זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add a bond interface",
"params" : {
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
}
],
"status" : "down"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפרמטרים configurated מליטה.
| שדה | סוּג | תיאור |
|---|---|---|
| מק | מחרוזת | קישור שכבת מזהה ייחודי. זה מק של העבד ממשק NIC הראשון. |
| שם | מחרוזת | שם הממשק. הוא משמש כמזהה ייחודי לממשק. |
| מצב | מחרוזת | הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות. |
| עבדים | אובייקט [] | ממשקי NIC אשר בונה את inteface מליטה. |
| מצב | מחרוזת | זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה. |
עבד אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הוא מזהה ייחודי של ממשק של העבד NIC. |
שינוי ממשק מליטה
שינוי ממשק מליטה
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.121","netmask":"255.255.255.0","gateway":"192.168.100.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface
PUT /interfaces/bonding/<name>
שינוי הפרמטרים של ממשק מליטה. שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | IP של הממשק. |
| מסכת רשת | מחרוזת | הגדר את קטע הרשת שבו פועל הממשק. |
| שער כניסה | מחרוזת | IP שימש לשלוח מנות של פלח רשת אחר. |
| כּוֹחַ | מחרוזת | אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נָכוֹן, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש. |
דוגמה לתגובה:
{
"description" : "Modify bond address",
"params" : {
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"netmask" : "255.255.255.0",
"force" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק את תצורת האיגום
מחק את תצורת האיגום
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface
DELETE /interfaces/bonding/<name>
מחק את תצורת הממשק מליטה. הפרמטרים של התצורה הם: שער כניסה, ip ו מסכת רשת.
שם הוא מזהה ייחודי של ממשק.
דוגמה לתגובה:
{
"description" : "Delete bonding network configuration",
"message" : "The configuration for the bonding interface bondiface has been deleted.",
"success" : "true"
}
הגדר פעולת ממשק מליטה
הגדר פעולת ממשק מליטה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"up"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface/actions
POST /interfaces/bonding/<name>/actions
החל פעולה על ממשק מליטה. שיחה זו מאפשרת למחוק את ממשק מליטה ולהפעיל או להשבית אותו.
יש צורך למחוק את ממשק מליטה באמצעות להרוס פעולה אם אתה רוצה לפתוח את ממשקי NIC בשימוש מליטה מנהל התקשרות יהיה לשחזר את כתובות MAC כי הממשקים חבר היה לפני שהם נוספו לממשק מליטה.
שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up לאפשר את ממשק ולהכין אותו לשימוש, מטה להשבית את הממשק כדי לא לקבל או לא לשלוח מנות, להרוס למחוק את מליטה לשחזר את הממשקים עבדים NIC. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Action on bond interface",
"params" : {
"action" : "up"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הוסף ממשק עבדים מליטה
הוסף ממשק עבדים מליטה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"eth4"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface/slaves
POST /interfaces/bonding/<name>/slaves
הוסף ממשק NIC כעבד לממשק מליטה קיים.
שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | ממשקי NIC שם כדי להוסיף לממשק מליטה. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add a slave to a bond interface",
"params" : {
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
},
{
"name" : "eth4"
}
],
"status" : "up"
}
}
פרמטרים של תגובה
התגובה תהיה json עם ערכים מעודכנים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הסר ממשק עבדים מליטה
הסר ממשק עבדים מליטה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
DELETE /interfaces/bonding/<name>/slaves/<name>
מחיקת ממשק עבדים NIC מממשק מליטה. ממשק מליטה חייב להיות כמעט אחד ממשק העבדים NIC.
ראשון שם האם ה DELETE השיחה היא שם החיבור המזהה הייחודי, הבא שם ב DELETE השיחה היא שם הממשק מזהה ייחודי של NIC.
דוגמה לתגובה:
{
"description" : "Remove bonding slave interface",
"message" : "The bonding slave interface eth2 has been removed.",
"success" : "true"
}
רשת - ממשקי VLAN
ממשק VLAN מאפשר ממשק NIC או מליטה עובד ברשת אחרת, כך IP, שער כניסה ו מסכת רשת שדות יכולים להיות שונים של ממשק האב. ממשק VLAN יורש את כתובת ה- MAC מממשק האב שלו.
השדה ממשקי VLAN שם יופיע עם תו נקודה. "" שישמש ליצירת תג מזהה עבור ממשק vlan.
רשימת ממשקי VLAN
רשימת ממשקי VLAN
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/vlan
GET /interfaces/vlan
קבל את כל הפרמטרים של ממשקי VLAN.
דוגמה לתגובה:
{
"description" : "List VLAN interfaces",
"interfaces" : [
{
"alias" : null,
"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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/vlan/eth0.1
GET /interfaces/vlan/<name>
קבל את כל הפרמטרים של ממשק VLAN. שם הוא מזהה ייחודי של ממשק.
דוגמה לתגובה:
{
"description" : "Show VLAN interface",
"interface" : {
"alias" : null,
"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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/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",
"force" : "true",
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק ממשק VLAN
מחק ממשק VLAN
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual
GET /interfaces/virtual
קבל את כל הפרמטרים של ממשקים וירטואליים.
דוגמה לתגובה:
{
"description" : "List virtual interfaces",
"interfaces" : [
{
"alias" : null,
"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"
},
{
"alias" : null,
"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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface
GET /interfaces/virtual/<name>
קבל את כל הפרמטרים של ממשק וירטואלי. שם הוא מזהה ייחודי של ממשק.
דוגמה לתגובה:
{
"description" : "Show virtual interface",
"interface" : {
"alias" : null,
"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://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface
PUT /interfaces/virtual/<name>
שינוי הפרמטרים של ממשק וירטואלי. שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור | נדרש |
|---|---|---|---|
| ip | מחרוזת | IP של הממשק. ה- IP חייב להיות באותו קטע רשת מאשר בממשק האב. | נָכוֹן |
| כּוֹחַ | מחרוזת | אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נָכוֹן, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש. |
דוגמה לתגובה:
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10",
"force" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחיקת ממשק וירטואלי
מחיקת ממשק וירטואלי
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
POST /interfaces/virtual/<name>/actions
החל פעולה על ממשק וירטואלי. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.
שם הוא מזהה ייחודי של ממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Action on virtual interface",
"params" : {
"action" : "down"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
רשת - ממשקים צפים
סוג זה של ממשק משתמש בממשק וירטואלי מוגדר ומסווה את התנועה היוצאת של a nic, קשר or VLAN ממשק עם ילד וירטואלי ממשק. ממשק זה משמש להתנהגות כשל בגיבוי כפרי בפרוטוקולי l4xnat אם אשכול מוגדר.
רשימת ממשקים צפים
רשימת ממשקים צפים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/floating
GET /interfaces/floating
הצג את כל הממשקים availables או configurated שבו IP צף נוצרה.
דוגמה לתגובה:
{
"description" : "List floating interfaces",
"params" : [
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : null,
"interface" : "bondiface",
"interface_virtual" : null
},
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : "192.168.100.41",
"interface" : "eth0",
"interface_virtual" : "eth0:virtiface"
},
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : null,
"interface" : "eth0.1",
"interface_virtual" : null
},
{
"alias" : "gestion",
"floating_alias" : null,
"floating_ip" : null,
"interface" : "eth1",
"interface_virtual" : null
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק צף:
צף אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| floating_alias | מחרוזת | זהו הכינוי של הממשק הווירטואלי. |
| צף | מחרוזת | צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק. |
| ממשק | מחרוזת | ממשק רעול על ידי ה- IP הצף. |
| ממשק | מחרוזת | זהו שם הממשק הווירטואלי של ה- IP הצף המשמש להסרת הממשק. |
אחזור ממשק צף
אחזור ממשק צף
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/floating/eth0
GET /interfaces/floating/<name>
מראה אם לממשק יש IP צף מוגדר. אם יש לו אחד configurated הוא יוצג כאן.
שם הוא מזהה ייחודי ממשק אשר יכול להיות סוג של nic, מליטה או vlan.
דוגמה לתגובה:
{
"description" : "Show floating interface",
"params" : {
"alias" : null,
"floating_alias" : null,
"floating_ip" : "192.168.100.41",
"interface" : "eth0",
"interface_virtual" : "eth0:virtiface"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זה ניק לעזור לזהות את הממשק. כינוי |
| floating_alias | מחרוזת | זהו הכינוי של הממשק הווירטואלי. |
| צף | מחרוזת | צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק. |
| ממשק | מחרוזת | ממשק רעול על ידי ה- IP הצף. |
| ממשק | מחרוזת | זהו שם הממשק הווירטואלי של ה- IP הצף המשמש להסרת הממשק. |
שינוי ממשק צף
שינוי ממשק צף
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"floating_ip":"192.168.100.199"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/floating/eth0
PUT /interfaces/floating/<name>
הגדר IP צף עבור ממשק NIC, מליטה או VLAN.
שם הוא מזהה ייחודי ממשק אשר יכול להיות סוג של nic, מליטה או vlan.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| צף | מחרוזת | צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Modify floating interface",
"message" : "Floating interface modification done",
"success" : "true"
}
מחק תצורה צפה
מחק תצורה צפה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/floating/eth0
DELETE /interfaces/floating/<name>
הסר את תצורת ה- IP הצפה בממשק.
שם הוא מזהה ייחודי ממשק אשר יכול להיות סוג של nic, מליטה או vlan.
דוגמה לתגובה:
{
"description" : "Remove floating interface",
"message" : "The floating interface has been removed.",
"success" : "true"
}
ניטור - FarmGuardian
FarmGuardian משמש למצב ניטור מתקדם של backends. כאשר בעיה מזוהה על ידי FarmGuardian משבית באופן אוטומטי את השרת האמיתי יהיה מסומן כמו ברשימה השחורה.
רשימת FarmGuardians
רשימת FarmGuardians
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg
GET /monitoring/fg
רשימה של FarmGuardians. תבניות availabe FarmGuardians מופיעים ברשימה.
דוגמה לתגובה:
{
"description" : "List farm guardian checks and templates",
"params" : [
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true"
},
{
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [
"web_service",
"my_welcome_web"
],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false"
},
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור |
|---|---|---|
| הפקודה | מחרוזת | פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec. |
| cut_conns | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| תיאור | מחרוזת | תיאור זעיר על ההמחאה. |
| חוות | מחרוזת [] | חוות שבהן החווה FarmGuardian מוחל. |
| הפסקה | מספר | זמן בין המחאות. |
| היכנס | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| שם | מחרוזת | מזהה ייחודי. |
| תבנית | מחרוזת | אם FarmGuardian היא תבנית, היא לא תחול על אף חווה. התבניות שימושיות ליצירת FarmGuardian חדש. |
אחזר FarmGuardian
אחזר FarmGuardian
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg/check_tcp
GET /monitoring/fg/<name>
הצג את התצורה של FarmGuardian.
פרמטר URI שם הוא מזהה ייחודי FarmGuardian.
דוגמה לתגובה:
{
"description" : "Retrive the farm guardian check_tcp",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור |
|---|---|---|
| הפקודה | מחרוזת | פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec. |
| cut_conns | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| תיאור | מחרוזת | תיאור זעיר על ההמחאה. |
| חוות | מחרוזת [] | חוות שבהן החווה FarmGuardian מוחל. |
| הפסקה | מספר | זמן בין המחאות. |
| היכנס | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| שם | מחרוזת | מזהה ייחודי. |
| תבנית | מחרוזת | אם FarmGuardian היא תבנית, היא לא תשתנה. התבניות שימושיות ליצירת FarmGuardian חדש או להחיל ישירות על חוות. |
יצירת FarmGuardian
יצירת FarmGuardian
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "parent":"check_tcp"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg
POST /monitoring/fg
צור FarmGuardian חדש.
פרמטרים של בקשה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | מזהה ייחודי. | נָכוֹן |
| הורה | מחרוזת | זהו FarmGuardian משמש כתבנית כדי ליצור את FarmGuardian חדש. אם שדה זה לא נשלח, FarmGuardian החדש נוצר ריק. |
דוגמה לתגובה:
{
"description" : "Create a farm guardian check_tcp-cut_conns",
"message" : "The farm guardian check_tcp-cut_conns has been created successfully",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור |
|---|---|---|
| הפקודה | מחרוזת | פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec. |
| cut_conns | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| תיאור | מחרוזת | תיאור זעיר על ההמחאה. |
| חוות | מחרוזת [] | חוות שבהן החווה FarmGuardian מוחל. |
| הפסקה | מספר | זמן בין המחאות. |
| היכנס | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| שם | מחרוזת | מזהה ייחודי. |
| תבנית | מחרוזת | אם FarmGuardian היא תבנית, היא לא תשתנה. התבניות שימושיות ליצירת FarmGuardian חדש או להחיל ישירות על חוות. |
שינוי FarmGuardian
שינוי FarmGuardian
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg/custom-tcp
PUT /monitoring/fg/<name>
שינוי FarmGuardian.
פרמטר URI שם הוא מזהה ייחודי FarmGuardian.
פרמטרים של בקשה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| הפקודה | מחרוזת | פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec. | |
| cut_conns | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. | |
| תיאור | מחרוזת | תיאור זעיר על ההמחאה. | |
| הפסקה | מספר | זמן בין המחאות. | |
| היכנס | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. | |
| כּוֹחַ | מחרוזת | אם משק פועל משתמש ב- FarmGuardian, לא ניתן יהיה לשנות את FarmGuardian. לאחר מכן, אם פרמטר זה נשלח עם הערך נָכוֹן, FarmGuardian ייאלץ לקחת את התצורה החדשה. |
דוגמה לתגובה:
{
"description" : "Modify farm guardian custom-tcp",
"message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
"params" : {
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:
| שדה | סוּג | תיאור |
|---|---|---|
| הפקודה | מחרוזת | פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec. |
| cut_conns | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| תיאור | מחרוזת | תיאור זעיר על ההמחאה. |
| חוות | מחרוזת [] | חוות שבהן החווה FarmGuardian מוחל. |
| הפסקה | מספר | זמן בין המחאות. |
| היכנס | מחרוזת | הערכים האפשריים הם: נָכוֹן, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים. |
| שם | מחרוזת | מזהה ייחודי. |
| תבנית | מחרוזת | אם FarmGuardian היא תבנית, היא לא תחול על אף חווה. התבניות שימושיות ליצירת FarmGuardian חדש. |
מחק FarmGuardian
מחק FarmGuardian
דוגמה לבקשה:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg/custom-tcp
DELETE /monitoring/fg/<name>
מחק מחווה.
פרמטר URI שם הוא מזהה ייחודי FarmGuardian.
דוגמה לתגובה:
{
"description" : "Delete the farm guardian custom-tcp",
"message" : "custom-tcp has been deleted successful.",
"success" : "true"
}
ניטור - סטטיסטיקה
הצג מידע אודות מערכת ומשקים. מידע זה יהיה שימושי כדי לפקח על מצב איזון עומס Zevenet.
הצג נתונים סטטיסטיים של המערכת
הצג נתונים סטטיסטיים של המערכת
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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" : {
"bond0 in in" : 234.72,
"bond0 out out" : 0,
"bond0.10 in in" : 0,
"bond0.10 out out" : 0,
"bond1 in in" : 234.72,
"bond1 out out" : 0,
"bond3 in in" : 815.69,
"bond3 out out" : 4300.38,
"eth0 in in" : 2702.29,
"eth0 out out" : 50701.95,
"eth0.2 in in" : 0,
"eth0.2 out out" : 0,
"eth1 in in" : 234.72,
"eth1 out out" : 0,
"eth2 in in" : 234.72,
"eth2 out out" : 0,
"eth3 in in" : 0,
"eth3 out out" : 0,
"eth4 in in" : 436.89,
"eth4 out out" : 4300.38,
"eth4.6 in in" : 0,
"eth4.6 out out" : 0,
"eth5 in in" : 301.39,
"eth5 out out" : 0,
"eth5.5 in in" : 0,
"eth5.5 out out" : 0,
"eth6 in in" : 77.42,
"eth6 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.2/zapi.cgi/stats/interfaces/throughput
GET /stats/interfaces/throughput
קבל ממוצע של השני של קלט קלט פלט פלט עבור כל ניקי, מליטה ו vlan ממשקים.
דוגמה לתגובה:
{
"description" : "throughput stats",
"params" : {
"bond" : {
"in" : {
"bytes" : "0",
"packets" : "0"
},
"out" : {
"bytes" : "0",
"packets" : "0"
}
},
"bond.2" : {
"in" : {
"bytes" : "0",
"packets" : "0"
},
"out" : {
"bytes" : "0",
"packets" : "0"
}
},
"eth0" : {
"in" : {
"bytes" : "2672",
"packets" : "20"
},
"out" : {
"bytes" : "8234",
"packets" : "22"
}
},
"eth1" : {
"in" : {
"bytes" : "56",
"packets" : "1"
},
"out" : {
"bytes" : "0",
"packets" : "0"
}
},
"eth1.2" : {
"in" : {
"bytes" : "0",
"packets" : "0"
},
"out" : {
"bytes" : "0",
"packets" : "0"
}
},
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט ממשק עם שם הממשק כמפתח וכערך אובייקטים של קלט ופלט עם השדות:
| שדה | סוּג | תיאור |
|---|---|---|
| בתים | מספר | מספר B / s עובר בממשק. |
| מנות | מספר | מספר מנות על ידי שניות עובר ממשק. |
הצג נתונים סטטיסטיים ברשת
הצג נתונים סטטיסטיים ברשת
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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" : "234.72",
"interface" : "bond1",
"out" : "0.00"
},
{
"in" : "77.42",
"interface" : "eth6",
"out" : "0.00"
},
{
"in" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
},
{
"in" : "815.69",
"interface" : "bond2",
"out" : "4300.38"
}
]
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם מפתח params אשר ערך הוא אובייקט עם המפתחות followeing:
| שדה | סוּג | תיאור |
|---|---|---|
| נתונים | מחרוזת | תאריך מערכת. |
| המארח | מחרוזת | שם המארח. |
| ממשקים | אובייקט [] | נתונים סטטיסטיים של תעבורת הרשת. |
ממשקי אובייקט
| שדה | סוּג | תיאור |
|---|---|---|
| in | מחרוזת | סה"כ תעבורת קלט ב- MB. |
| ממשק | מחרוזת | שם הממשק. |
| הַחוּצָה | מחרוזת | סך כל התפוקה. |
הצג נתונים סטטיסטיים של ממשקים
הצג נתונים סטטיסטיים של ממשקים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/system/network/interfaces
GET /stats/system/network/interfaces
קבל סיכום של כל ממשק רשת.
דוגמה לתגובה:
{
"description" : "Interfaces info",
"params" : {
"bond" : [
{
"in" : "234.72",
"interface" : "bond1",
"ip" : "",
"mac" : "3a:3a:a7:e3:33:73",
"out" : "0.00",
"slaves" : [
"eth2"
],
"status" : "down",
"virtual" : [],
"vlan" : []
},
{
"in" : "815.70",
"interface" : "bond3",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "4300.38",
"slaves" : [
"eth4",
"eth5",
"eth6"
],
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "234.72",
"interface" : "bond0",
"ip" : "",
"mac" : "c2:d0:d7:64:df:68",
"out" : "0.00",
"slaves" : [
"eth1"
],
"status" : "down",
"virtual" : [],
"vlan" : [
"bond0.10"
]
}
],
"nic" : [
{
"in" : "77.42",
"interface" : "eth6",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "2704.81",
"interface" : "eth0",
"ip" : "192.168.101.46",
"mac" : "9e:2e:3e:a5:2e:6a",
"out" : "51039.13",
"status" : "up",
"virtual" : [
"eth0:1",
"eth0:2",
"eth0.2:6"
],
"vlan" : [
"eth0.2"
]
},
{
"in" : "234.72",
"interface" : "eth1",
"ip" : "192.168.101.58",
"mac" : "c2:d0:d7:64:df:68",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "234.72",
"interface" : "eth2",
"ip" : "",
"mac" : "3a:3a:a7:e3:33:73",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "0.00",
"interface" : "eth3",
"ip" : "192.168.101.72",
"mac" : "16:97:ab:43:87:02",
"out" : "0.00",
"status" : "down",
"virtual" : [
"eth3:1",
"eth3:8",
"eth3:6"
],
"vlan" : []
},
{
"in" : "436.89",
"interface" : "eth4",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "4300.38",
"status" : "up",
"virtual" : [
"eth4.6:5"
],
"vlan" : [
"eth4.6"
]
},
{
"in" : "301.39",
"interface" : "eth5",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : [
"eth5.5"
]
}
]
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט עם המקשים קשר ו nic.
| שדה | סוּג | תיאור |
|---|---|---|
| קשר | אובייקט [] | סטטיסטיקות ממשק. |
| nic | אובייקט [] | נתונים סטטיסטיים ממשק. |
אובייקט בונד:
| שדה | סוּג | תיאור |
|---|---|---|
| in | מחרוזת | סה"כ תעבורת קלט ב- MB. |
| ממשק | מחרוזת | שם הממשק משמש כמזהה ייחודי. |
| ip | מחרוזת | ה- IP של הממשק. |
| מק | מחרוזת | ממשק ה- MAC. |
| הַחוּצָה | מחרוזת | סה"כ תעבורת פלט ב- MB. |
| עבדים | מחרוזת [] | רשימת עבדים הבונים את ממשק האג"ח. |
| מצב | מחרוזת | מצב ממשק. הערך יכול להיות מטה, הממשק מושבת; up, הממשק מאופשר. |
| וירטואלי | מחרוזת [] | ממשקים וירטואליים שירשו מממשק זה. |
| vlan | מחרוזת [] | ממשקי VLAN היורשים מממשק זה. |
אובייקט Nic:
| שדה | סוּג | תיאור |
|---|---|---|
| in | מחרוזת | סה"כ תעבורת קלט ב- MB. |
| ממשק | מחרוזת | שם הממשק משמש כמזהה ייחודי. |
| ip | מחרוזת | ה- IP של הממשק. |
| מק | מחרוזת | ממשק ה- MAC. |
| הַחוּצָה | מחרוזת | סה"כ תעבורת פלט ב- MB. |
| מצב | מחרוזת | מצב ממשק. הערך יכול להיות מטה, הממשק מושבת; up, הממשק מאופשר. |
| וירטואלי | מחרוזת [] | ממשקים וירטואליים שירשו מממשק זה. |
| vlan | מחרוזת [] | ממשקי VLAN היורשים מממשק זה. |
הצג נתונים סטטיסטיים של זיכרון
הצג נתונים סטטיסטיים של זיכרון
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/system/memory
GET /stats/system/memory
קבל סיכום של זיכרון המערכת.
דוגמה לתגובה:
{
"description" : "Memory usage",
"params" : {
"Buffers" : 1.01,
"Cached" : 42.47,
"MemFree" : 880.11,
"MemTotal" : 2005.01,
"MemUsed" : 1124.91,
"SwapCached" : 8.27,
"SwapFree" : 565.15,
"SwapTotal" : 672,
"SwapUsed" : 106.84,
"date" : "Fri Jan 27 12:27:11 2017",
"hostname" : "api3"
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט זיכרון.
זכרון אובייקט.
| שדה | סוּג | תיאור |
|---|---|---|
| חוצצים | מספר | זהו הזיכרון המשמש את המאגרים. סכום זה מצוין ב- 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.2/zapi.cgi/stats/system/load
GET /stats/system/load
קבל סיכום של עומס מערכת ה- CPU.
דוגמה לתגובה:
{
"description" : "System load",
"params" : {
"Last_1" : 0.66,
"Last_15" : 0.39,
"Last_5" : 0.49,
"date" : "Fri Jan 27 13:15:01 2017",
"hostname" : "api3"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| Last_1 | מספר | טען את השימוש במערכת בפעם האחרונה. |
| Last_5 | מספר | טען את השימוש בחמש הדקות האחרונות. |
| Last_15 | מספר | טען את השימוש במערכת במשך חמש עשרה הדקות האחרונות. |
| נתונים | מחרוזת | תאריך מערכת. |
| המארח | מחרוזת | שם המארח. |
הצג נתונים סטטיסטיים של CPU
הצג נתונים סטטיסטיים של CPU
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/system/cpu
GET /stats/system/cpu
דוגמה לתגובה:
{
"description" : "System CPU usage",
"params" : {
"cores" : 2,
"date" : "Fri Jan 27 13:30:52 2017",
"hostname" : "api3",
"idle" : 94.9,
"iowait" : 0,
"irq" : 0,
"nice" : 0,
"softirq" : 0,
"sys" : 3.06,
"usage" : 5.1,
"user" : 2.04
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| ליבות | מספר | מספר הליבות במעבד. |
| להתבטל | מספר | CPU לא להשתמש על ידי כל תוכנית. |
| כן | מספר | מעבד המשמש בתהליך קלט או פלט. |
| Irq | מספר | מעבד המשמש interropcions חומרה. |
| נחמד | מספר | עדיפות תזמון CPU. |
| רך | מספר | CPU המשמשים interrrupcions תוכנה. |
| sys | מספר | CPU המשמש את המערכת. |
| שימוש | מספר | סה"כ מעבד משומש. |
| המשתמש | מספר | CPU המשמש את המשתמש. |
| נתונים | מחרוזת | תאריך מערכת. |
| המארח | מחרוזת | שם המארח. |
הצג נתונים סטטיסטיים של חיבורים
הצג נתונים סטטיסטיים של חיבורים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/system/connections
GET /stats/system/connections
קבל את סך החיבורים הנוכחיים במערכת. הדלפק מסכם כל סוג של חיבורים במעקב: ASSURED, ESTABLISHED, SYN_SENT, TIME_WAIT, LISTEN ...
דוגמה לתגובה:
{
"description" : "System connections",
"params" : {
"connections" : 324
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| חיבורים | מספר | סך כל החיבורים המעוקבים בפועל. |
הצג מספר חוות
הצג מספר חוות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/farms/total
GET /stats/farms/total
הצג את סך החוות שנוצרו במערכת.
דוגמה לתגובה:
{
"description" : "Number of farms.",
"number" : 8
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| מספר | מספר | זהו מספר החוות הקיימות במערכת. |
הצג נתונים סטטיסטיים של חוות
הצג נתונים סטטיסטיים של חוות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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"
},
{
"established" : 0,
"farmname" : "testGSLB",
"pending" : 0,
"profile" : "gslb",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "53"
}
]
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| נוסד | מספר | סך כל הקשרים הקיימים. |
| שם החווה | מחרוזת | שם החווה, מזהה ייחודי. |
| תלוי ועומד | מספר | מספר החיבורים הממתינים. |
| פרופיל | מחרוזת | סוג החווה. הערכים האפשריים הם: DataLink, l4xnat, http, https or גסלב. כל פרופיל מוגדר בקטע שלו. |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
| גווניה | מחרוזת | נמל של החווה, שבו השירות וירטואלי מקשיב. |
הצג נתונים סטטיסטיים בחווה
הצג נתונים סטטיסטיים בחווה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/farms/farmname
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 שהוקצה ללקוח. |
| שרות | מחרוזת | מזהה ייחודי של שירות שהוקצה ללקוח. |
| מושב | מחרוזת | מזהה ייחודי של פעילות באתר. ערך זה תלוי בסוג ההתמדה. |
דוגמת תגובה לחוות GSLB:
{
"backends" : [
{
"id" : 1,
"ip" : "127.0.0.1",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 2,
"ip" : "192.168.55.40",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 4,
"ip" : "192.135.10.2",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 1,
"ip" : "127.0.0.1",
"port" : 80,
"service" : "prioServ",
"status" : "down"
},
{
"id" : 2,
"ip" : "127.0.0.1",
"port" : 80,
"service" : "prioServ",
"status" : "down"
}
],
"client" : {
"edns_big" : 0,
"edns_tc" : 0,
"recvfail" : 0,
"reqs" : 0,
"sendfail" : 0,
"tc" : 0
},
"description" : "List farm stats",
"extended" : {
"badvers" : 0,
"dropped" : 0,
"edns" : 0,
"edns_clientsub" : 0,
"formerr" : 0,
"noerror" : 0,
"notimp" : 0,
"nxdomain" : 0,
"refused" : 0,
"v6" : 0
},
"server" : {
"recvfail" : 0,
"reqs" : 0,
"sendfail" : 0
}
}
פרמטרי תגובה בחוות GSLB
| שדה | סוּג | תיאור |
|---|---|---|
| backends | אובייקט [] | הצג מידע על backenders. |
| לקוחות | חפץ | סטטיסטיקה הקשורים ללקוח. |
| מוּרחָב | חפץ | מידע מורחב על השירות. |
| שרת | חפץ | נתונים סטטיסטיים הקשורים לשרת. |
אובייקט Backend
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | מזהה ייחודי של Backend. |
| ip | מחרוזת | IP שבו השירות האמיתי מקשיב. |
| נמל | מספר | נמל שבו השירות האמיתי מקשיב. |
| שרות | מחרוזת | שם השירות משמש כמזהה ייחודי. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק. |
אובייקט לקוח
| שדה | סוּג | תיאור |
|---|---|---|
| edns_big | מספר | תגובות שהיו גדולות מ 512 בתים. |
| edns_tc | מספר | גודל חיץ ה- dns המורחב שצוין של הלקוח היה קטן מדי לנתונים המבוקשים. |
| recvfail | מספר | מספר שגיאות UDP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת קבלתן. |
| reqs | מספר | המספר הכולל של בקשת UDP מטופל על ידי השרת. |
| לשלוח | מספר | מספר שגיאות UDP, שבהן מערכת ההפעלה הצביעה על כך שמשהו רע קרה בעת השליחה. |
| tc | מספר | תגובות שנקטעו עם bit סיביות להגדיר. |
אובייקט מורחב
| שדה | סוּג | תיאור |
|---|---|---|
| רע | מספר | בקשה עם EDNS OPT-RR עם גרסה לא נתמכת. |
| ירד | מספר | בקשות שהושלכו לפורמט לא תקין. |
| אדנס | מספר | הבקשה הכילה EDNS OPT-RR. |
| edns_clientsub | מספר | Subset of edns מבקש לציין את האפשרות edns_client_subnet. |
| צורה | מספר | הבקשה היתה בפורמט גרוע, אבל היה שפוי מספיק שעשינו תגובה עם rcode FORMERR. |
| טרור | מספר | בקשות מוצלחות. |
| לא | מספר | שירות המבוקש לא מיושם על ידי daemon זה, כגון בקשות להעביר אזור. |
| nxdomain | מספר | בקשה לשם דומיין שאינו קיים. |
| סירב | מספר | הבקשה נדחתה על ידי השרת משום שהשרת אינו סמכותי עבור שם השאילתה. |
| v6 | מספר | בקשה מלקוח IPv6. |
אובייקט שרת
| שדה | סוּג | תיאור |
|---|---|---|
| recvfail | מספר | מספר שגיאות TCP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת קבלתן. |
| reqs | מספר | המספר הכולל של בקשת TCP המטופל על ידי השרת. |
| לשלוח | מספר | מספר שגיאות TCP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת שליחתן. |
דוגמת תגובה עבור חוות 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" : 1,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"id" : 5,
"session" : "192.168.5.100"
}
]
}
פרמטרי תגובה בחוות L4xNAT
התגובה תהיה JSON עם אובייקט backends ו הפעלות:
אובייקט Backend:
| שדה | סוּג | תיאור |
|---|---|---|
| נוסד | מספר | סך כל הקשרים הקיימים. |
| id | מספר | מזהה ייחודי של Backend. |
| ip | מחרוזת | IP שבו השירות האמיתי מקשיב. |
| תלוי ועומד | מספר | מספר החיבורים הממתינים. |
| נמל | מספר | נמל שבו השירות האמיתי מקשיב. |
| מצב | מחרוזת | מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק. |
אובייקט מושב:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | אחורה מזהה ייחודי שבו הלקוח מוקצה. |
| מושב | מחרוזת | מזהה ייחודי של פעילות באתר. זהו ה- IP של הלקוח. |
פרמטרי תגובה בחוות datalink
הנתונים הסטטיסטיים של Datalink אינם זמינים בפועל.
הצגת מצב מודול
הצגת מצב מודול
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/farms/modules
GET /stats/farms/modules
קבל סיכום של נתונים סטטיסטיים של מודולים. שיחה זו מציגה כל מצב מודול, מספר התצורה, מספר החוות המוטלות ומעלה.
ההגדרה על מודולים היא ב חוות סָעִיף.
דוגמה לתגובה:
{
"description" : "Module status",
"params" : {
"dslb" : {
"critical" : 0,
"down" : 1,
"problem" : 0,
"total" : 2,
"up" : 1
},
"gslb" : {
"critical" : 0,
"down" : 0,
"problem" : 0,
"total" : 1,
"up" : 1
},
"lslb" : {
"critical" : 0,
"down" : 2,
"problem" : 0,
"total" : 4,
"up" : 2
}
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם שלושה מפתחות: dslb, גסלב ו לסלב.
| שדה | סוּג | תיאור |
|---|---|---|
| קריטי | מספר | מספר חוות במצב קריטי. החווה היא קריטית כאשר היא מעלה את כל backends הם בלתי מושגת (למטה או תחזוקה). |
| מטה | מספר | מספר חוות הפסיקו. החוות נעצרות על ידי מנהל המערכת. |
| בְּעָיָה | מספר | מספר חוות במצב בעיה. החווה היא בעיה כאשר היא למעלה כמעט backend הוא במצב למטה. |
| סה"כ | מספר | מספר החוות. |
| up | מספר | מספר החוות הפועלות. הנה מוצג maintenanced ו צריך להפעיל מחדש את מצב החווה. |
הצג נתונים סטטיסטיים של מודול
הצג נתונים סטטיסטיים של מודול
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/stats/farms/modules/lslb
GET /stats/farms/modules/<module>
הצג נתונים סטטיסטיים של חוות דעת של מודול מסוים.
הערכים הזמינים עבור מודול הפרמטר הם: לסלב, גסלב or dslb.
דוגמה לתגובה:
{
"description" : "List lslb farms stats",
"farms" : [
{
"established" : 0,
"farmname" : "newfarm",
"pending" : 0,
"profile" : "http",
"status" : "up",
"vip" : "192.168.100.199",
"vport" : "40"
},
{
"established" : 0,
"farmname" : "nwl4farm",
"pending" : 0,
"profile" : "l4xnat",
"status" : "down",
"vip" : "192.168.100.241",
"vport" : "88"
},
{
"established" : 0,
"farmname" : "l4farm",
"pending" : 0,
"profile" : "l4xnat",
"status" : "up",
"vip" : "192.168.100.102",
"vport" : "70"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מידע על חוות במודול.
| שדה | סוּג | תיאור |
|---|---|---|
| נוסד | מספר | סך כל הקשרים הקיימים. |
| שם החווה | מחרוזת | שם החווה, מזהה ייחודי עבור חוות. |
| תלוי ועומד | מספר | מספר החיבורים הממתינים. |
| פרופיל | מחרוזת | סוג החווה. הערכים האפשריים הם: DataLink, l4xnat, http, https or גסלב. כל פרופיל מוגדר בסעיף עצמי. |
| מצב | מחרוזת | מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה. |
| החברים | מחרוזת | IP של החווה, שבו השירות וירטואלי מקשיב. |
| גווניה | מחרוזת | נמל של החווה, שבו השירות וירטואלי מקשיב. |
ניטור - גרפים
סעיף זה שימושי כדי לפקח על המערכת הפנימית איזון עומס כדי לזהות בעיות באמצעות הפרמטרים של השימוש ב- CPU, זיכרון החלפה, זיכרון RAM, כל ממשקי Nework מוגדר, לטעון אחסון דיסק קשיח.
כמו כן, תוכל לגשת להיסטוריה השבועית, העשירה והשנתית.
גרפים עם מידע הם הגיבו בפורמט base64.
רשימת תרשימים זמינים
רשימת תרשימים זמינים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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",
"gslbfarm",
"nwl4farm",
"httpweb"
],
"interfaces" : [
"eth0.1",
"eth2",
"eth1",
"eth3",
"bondiface",
"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.2/zapi.cgi/graphs/farms/httpweb
בקש דוגמה עבור ממשק:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/graphs/interfaces/eth3
בקש דוגמה לדיסק:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.2/zapi.cgi/graphs/farms/httpweb/daily
בקש דוגמה עבור ממשק:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/graphs/interfaces/eth3/monthly
בקש דוגמה לדיסק:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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 בסיס. |
ניטור - כינויים
הוסף כינוי לממשק או ל- backend כדי לזהות אותו במהירות.
קיימים שני סוגים של כינויים, כינוי ממשק ניתן ליישם בכל סוגי הממשקים: NIC, מליטה, vlan או וירטואלי. זוהי דרך קלה להתייחס לשם ממשק עם שם ידידותי יותר.
הסוג השני של הכינוי הוא עבור backends. זה מתייחס IP backend עם כינוי.
כינויים הוא רק מידע חזותי, זה לא להחליף את ה- IP backend או את שם הממשק בבקשה zapi.
רשימת כינויים
רשימת כינויים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/aliases/backends
GET /aliases/<backends|interfaces>
רשימת הכינויים במערכת עבור ממשקים או backends.
דוגמה לתגובה:
{
"description" : "List the aliases",
"params" : [
{
"id" : "192.168.11.13",
"alias" : "http-backend"
},
{
"id" : "127.0.0.1",
"alias" : "localhost"
}
]
}
פרמטרים של תגובה
ה- Api מחזיר חשיש שבו המפתח הוא ה- IP של ה- backend או שם הממשק והערך הוא הכינוי שלו.
צור או שנה כינוי
צור או שנה כינוי
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"management"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/aliases/interfaces/eth0
PUT /aliases/<backends|interfaces>/<id>
אם לאובייקט יש כינוי, הוא יוחלף, אחרת ייקרא כינוי עבור האובייקט.
אל האני id הפרמטר URI הוא ה- IP של ה- backend או שם הממשק.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| כינוי | מחרוזת | זהו ניק עבור האלמנט id נשלח ב- URI. |
דוגמה לתגובה:
{
"description" : "Set an alias",
"message" : "Alias for eth0 has been updated successfully",
"success" : "true"
}
פרמטרים של תגובה
ה- zapi מחזיר הודעת הצלחה אם התהליך היה נכון.
מחק כינוי
מחק כינוי
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/aliases/interfaces/eth0
DELETE /aliases/<backends|interfaces>/<id>
זה מוחק את הכינוי של ממשק או backend.
אל האני id הפרמטר URI הוא ה- IP של ה- backend או שם הממשק.
דוגמה לתגובה:
{
"description" : "Delete an alias",
"message" : "The alias has been deleted.",
"success" : "true"
}
פרמטרים של תגובה
ה- zapi מחזיר הודעת הצלחה אם התהליך היה נכון.
IPDS
מודול זה הוא יישום של שב"ס (מערכת מניעת חדירת) ו IDS (מערכת איתור חדירה) מערכת המציעה למשתמש שכבת אבטחה. מודול ה- IPDS בודק את התנועה רק לפני הגעה למודולים של איזון עומס LSLB or GSLB, אם התנועה מזוהה כזדונית, היא תידחה.
זה עובד החלת כללי אבטחה למערכת אשר יוגדר כאובייקט בעל אופי שונה. כל אחד מהם מציע פתרון לפעולה זדונית או חשודה חיצונית. כלי זה מסייע למנהלי המערכת לשלוט איומים והתקפות.
הכללים הזמינים החלים על זאבנט יכולים להיות רשימות שחורות, DoS or RBL.
רשימה של כל כללי ipds
רשימת כללים ipds
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds
GET /ipds
רשום את כל כללי ה- ipds שיוצאים מהמערכת.
דוגמה לתגובה:
{
"description" : "List the available IPDS rules.",
"params" : [
{
"name" : "dosrst",
"rule" : "dos",
"type" : "farm"
},
{
"name" : "ssh_brute_force",
"rule" : "dos",
"type" : "system"
},
{
"name" : "geo_IL_israel",
"rule" : "blacklist"
},
{
"name" : "geo_ME_montenegro",
"rule" : "blacklist"
},
{
"name" : "sip",
"rule" : "rbl"
},
{
"name" : "ssh",
"rule" : "rbl"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים ברשימה השחורה, שכל אחד מהם מכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הכלל של IPDS. הוא משמש כמזהה ייחודי. |
| לשלוט | מחרוזת | זהו טבעו של הכלל ipds. זה יכול להיות לכלול ברשימה שחורה, דוס or Rbl. |
| סוג | מחרוזת | שדה זה מופיע בכללים dos והוא מגדיר אם הכלל הוא מערכת, הוא חל על איזון; או משק, הכללים חלים על משק. |
IPDS - רשימות שחורות
רשימות שחורות מאפשר למשתמשים להשתמש ברשימות כדי לסנן או לאפשר תנועה על פי כתובות IP המקור (תנועה Incomming).
קיימים שני סוגים של רשימות:
- הערות: רשימות מתקבלות מכתובת אתר, רשימות אלה אינן ניתנות לשינוי וניתן לשפוך אותן להורדה.
- מקומי: משתמשים יכולים ליצור רשימות משלהם במדיניות נתונה, להכחיש אם כתובת IP תואמת מכן התנועה תידחה או להתיר אם IP תואמת תואמת אז התנועה תהיה מותרת.
מודול זה כולל preloaded רשימות מסופק על ידי צוות Zevenet, הרשימה מוכנים להיות מיושם על חוות. Aditionally, משתמשים יכולים ליצור רשימות מותאמות אישית משלהם.
ניתן להחיל מספר רשימות על אותה החווה, אם מקור ה- IP תואם בחלק מהרשימה, התנועה תותר או תידחה בהתאם למדיניות הרשימה השחורה. כרגע IP ההתאמות אז לא עוד בדיקות שחורות הרשימה נעשים IP המקור.
אם כתובת IP של מקור נמצאת בשתי רשימות שונות, אחת מסוג להכחיש ואחרים מסוג להתיר, אז תמיד את מדיניות לאפשר מוערך הראשון.
רשימת כל רשימות שחורות
רשימת כל רשימות שחורות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists
GET /ipds/blacklists
רשימת כל רשימות שחורות שנוצרו על ידי המשתמש או טעון מראש במערכת שניתן להחיל על החוות.
דוגמה לתגובה:
{
"description" : "Get black lists",
"params" : [
{
"farms" : [],
"name" : "china",
"policy" : "deny",
"preload" : "true",
"status" : "down",
"type" : "local"
},
{
"farms" : [],
"name" : "russia",
"policy" : "deny",
"preload" : "true",
"status" : "down",
"type" : "local"
},
{
"farms" : [],
"name" : "northkorea",
"policy" : "deny",
"preload" : "true",
"status" : "down",
"type" : "local"
},
{
"farms" : [
"FarmHttp1",
"FarmGslb1",
],
"name" : "remoteList",
"policy" : "deny",
"preload" : "false",
"status" : "up",
"type" : "remote"
},
{
"farms" : [],
"name" : "myWhiteList",
"policy" : "allow",
"preload" : "false",
"status" : "down",
"type" : "local"
},
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים ברשימה השחורה, שכל אחד מהם מכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. |
| מדיניות | מחרוזת | פעולה כדי להחיל על המקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| preload | מחרוזת | הערכים האפשריים הם: נָכוֹן, הרשימה השחורה נטענה מראש במערכת; או שקר, הרשימה השחורה נוצרה על ידי מנהל המערכת. |
| מצב | מחרוזת | הערכים האפשריים הם: up, הרשימה השחורה מופעלת וחוסמת (או מאפשרת) תנועה של מקורות טופס הרשימה; או מטה, למעשה את הכלל אינו פועל וזה לא סינון התנועה. |
| סוג | מחרוזת | איפה הרשימה נשמרת ומי שומר אותו. הערכים הם: מקומי, הרשימה נשמרת במערכת המקומית וניתן לשנות אותה באופן מקומי, או מרחוק, הרשימה מורדת ממקור מרוחק באמצעות a כתובת אתר, לא ניתן לשנות אותו באופן מקומי ולכן יש לבצע את השינויים במקור המרוחק. |
אחזר כלל של רשימה שחורה
אחזר רשימה שחורה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/loc
GET /ipds/blacklists/<name>
הצג את תצורת הרשימה השחורה ופרמטרי התיאור. שם הוא המזהה הייחודי של הרשימה השחורה.
פרמטרים של תגובה
תגובה דוגמת רשימה מקומית:
{
"description" : "Get list loc",
"params" : {
"farms" : [],
"name" : "loc",
"policy" : "deny",
"preload" : "false",
"sources" : [
{
"id" : 0,
"source" : "192.168.0.167"
},
{
"id" : 1,
"source" : "192.168.0.186"
}
],
"status" : "up",
"type" : "local"
}
}
אובייקט מקומי ברשימה השחורה:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| preload | מחרוזת | הערכים האפשריים הם: נָכוֹן, הרשימה השחורה נטענה מראש במערכת; או שקר, הרשימה השחורה נוצרה על ידי מנהל המערכת. |
| מצב | מחרוזת | הערכים האפשריים הם: up, הרשימה השחורה מופעלת וחוסמת (או מאפשרת) תנועה של מקורות טופס הרשימה; או מטה, למעשה את הכלל אינו פועל וזה לא סינון התנועה. |
| סוג | מחרוזת | איפה הרשימה נשמרת ומי שומר אותו. הערכים הם: מקומי, הרשימה נשמרת במערכת ומתוחזק על ידי מנהל המערכת; או מרחוק, הרשימה מורדת מכתובת אתר מרוחקת. |
| מקורות | אובייקט [] | רשימה של כתובות IP שהרשימה בודקת. פורמט רשת המקור שאושר: כתובת רשת / מסכה bit או IP |
דוגמה לרשימה מרחוק של תגובה:
{
"description" : "Get list remoteList",
"params" : {
"day" : "thursday",
"farms" : [
"FarmHttp1",
"FarmGslb1",
],
"frequency" : "weekly",
"name" : "remoteList",
"policy" : "deny",
"sources" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
}
],
"time" : {
"hour" : 0,
"minutes" : 0
},
"status" : "up",
"update_status" : "This list isn't downloaded yet.",
"type" : "remote",
"url" : "http://192.168.10.10/lists/test.txt"
}
}
אובייקט רשימה שחורה מרחוק:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| שם | מחרוזת | שם רשימה שחורה. הוא משמש כמזהה ייחודי. |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| preload | מחרוזת | הערכים האפשריים הם: נָכוֹן, הרשימה השחורה נטענה מראש במערכת; או שקר, הרשימה השחורה נוצרה על ידי מנהל המערכת. |
| סוג | מחרוזת | איפה הרשימה נשמרת ומי שומר אותו. הערכים הם: מקומי, הרשימה נשמרת במערכת ומתוחזק על ידי מנהל המערכת; או מרחוק, הרשימה מורדת מרחוק כתובת אתר. |
| מקורות | אובייקט [] | Ssource IPs כי רשימת בדיקות. אם הרשימה של סוג מרחוק ולאחר מכן את תוכן הרשימה אינו מוצג עד ההורדה הראשונה. |
| עדכן סטטוס | מחרוזת | סטטוס ההורדה האחרון של הרשימה ותאריך העדכון האחרון המוצלח במערכת המקומית. |
| כתובת אתר | מחרוזת | איפה הרשימה מרחוק מורדת מ. הפורמט המרוחק חייב להיות רשימה של אחד מָקוֹר מסכת רשת / bit או IP לכל שורה. |
| תדר | מחרוזת | תדירות עדכון רשימה מרחוק. האפשרויות הן: יומי, לעדכן את כל הימים, פעם אחת או מעת לעת, זה מצוין ב תדירות שדה; שבועי, עדכון פעם בשבוע; או אחת לחודש, עדכון פעם בחודש. |
| תדירות | מחרוזת | פרמטר זה משלים את תדר יומי כאשר הערך שלו הוא יומי. הערכים האפשריים הם: מְדוּיָק. להגדיר שעה ביום; או תקופה, להגדיר פרק זמן לעדכון במהלך היום. |
| יְוֹם | מחרוזת או מספר | פרמטר זה משלים את הפרמטר תדר מתי frecuency הערך הוא שבועי or אחת לחודש. אם frecuency is שבועי פרמטר זה חייב להיות תשלום של השבוע (יום שני, יום שלישי, יום רביעי, יום חמישי, יום שישי, יום שבת or יום ראשון) אם תדר הערך הוא אחת לחודש אזי פרמטר זה חייב להיות יום בחודש (מספר בין 1 ו 31). |
| זמן | חפץ | זה מבנה שתלוי בשדות תדר. |
| מצב | מחרוזת | הערכים האפשריים הם: up, הרשימה השחורה מופעלת וחוסמת (או מאפשרת) תנועה של מקורות טופס הרשימה; או מטה, למעשה את הכלל אינו פועל וזה לא סינון התנועה. |
אובייקט זמן עבור תדירות וטרנספורמציה של תדירות יומית
| שדה | סוּג | תיאור |
|---|---|---|
| תקופה | מספר | באיזו תדירות הרשימה מעודכנת. |
| יחידות | מחרוזת | יחידה תקופתית. האפשרויות הן: דקות, לציין את הרשימה יעודכן כל דקות מוגדר; או שעות האחרונות, הרשימה תעודכן כל שעות מוגדרות. |
אובייקט זמן עבור תדרים אחרים
| שדה | סוּג | תיאור |
|---|---|---|
| שעה | מספר | שעה לעדכן את הרשימה. הערך חייב להיות מספר בין 0 ו 23. |
| דקות | מספר | דקות לעדכון הרשימה. הערך חייב להיות מספר בין 0 ו 59. |
מקורות אובייקט
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | מקור מזהה ייחודי ברשימה. |
| מָקוֹר | מחרוזת | כתובות IP או פלחים נטו כי הרשימה בודקת. |
צור כלל של רשימה שחורה
צור רשימה שחורה חדשה
בקש דוגמה לרשימה מקומית:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListLoc", "type":"local", "policy":"allow"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists
בקש דוגמה עבור רשימה מרוחקת:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListRem", "type":"remote", "url":"https://192.168.10.12/lists/test.txt"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists
POST /ipds/blacklists
צור רשימה שחורה לשימוש בחוות. רשימות שחורות יכולות להיות משני סוגים:
- מקומי: המקורות מתווספים על ידי המשתמש. הרשימה נשמרת באופן מקומי.
- מרחוק: המקורות מתקבלים ממיקום מרוחק. מיקום זה מצוין באמצעות כתובת אתר. פורמט הרשימה המרוחק הנתמך הוא אחד כתובת רשת / סיכת מסכה or IP שורה בכל שורה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. | נָכוֹן |
| סוג | מחרוזת | איפה הרשימה נשמרת ומי תחזיק את זה. הערכים הם: מקומי, הרשימה נשמרת במערכת ותחזוקה למערכת הניהול; או מרחוק, הרשימה נלקחת מתוך שירות דרך a כתובת אתר שירות המנהל ינהל את הרשימה. | נָכוֹן |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. ערך ברירת המחדל נדחה. | |
| כתובת אתר | מחרוזת | איפה הרשימה מרחוק מורדת מ. הפורמט המרוחק חייב להיות רשימה של אחד מָקוֹר לכל שורה בפורמט כתובת רשת / סיכת מסכה or IP. | נכון עבור רשימה מרחוק |
{
"description" : "Post list list1",
"params" : {
"farms" : [],
"name" : "newListLoc",
"policy" : "deny",
"preload" : "false",
"type" : "local"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים ברשימה השחורה, שכל אחד מהם מכיל את תכונות המפתח הבאות.
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| preload | מחרוזת | הערכים האפשריים הם: נָכוֹן, הרשימה השחורה נטענה מראש במערכת; או שקר, הרשימה השחורה נוצרה עבור מנהל המערכת. |
| סוג | מחרוזת | איפה הרשימה נשמרת ומי תחזיק את זה. הערכים הם: מקומי, הרשימה נשמרת במערכת ותחזוקה למערכת הניהול; או מרחוק, הרשימה נלקחת מתוך שירות דרך a כתובת אתר שירות המנהל ינהל את הרשימה. |
שינוי כלל של רשימה שחורה
שנה רשימה שחורה
בקש דוגמה לרשימה מקומית:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"policy":"allow","source":["78.12.0.4","68.100.15.5","65.12.12.95"]}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/whiteList
PUT /ipds/blacklists/<name>
שינוי התצורה של כלל רשימה שחורה. שם הוא המזהה הייחודי של הרשימה השחורה.
פרמטרים בקשה לרשימה מקומית:
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. רק הוא modificabled ב לא preload רשימות. |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| מָקוֹר | מחרוזת [] | זוהי רשימה של כתובות IP או פלחים נטו כי הרשימה בודקת. כדי לשנות שינוי רק מקור עיין בסעיף תיעוד IPDS> רשימות שחורות> שנה מקור לרשימה שחורה. מקורות בלבד הם modifiabled ב לא preload רשימות. |
דוגמה לתגובה:
{
"description" : "Modify list whiteList.",
"params" : {
"name" : "whiteList",
"policy" : "allow",
"preload" : "false",
"type" : "local"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
בקש דוגמה עבור רשימה מרוחקת:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"remoteList","url":"http://192.168.10.10/lists/test.txt","policy":"deny","frequency":"daily","frequency_type":"exact","time":{"hour":1,"minutes":0}}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/newListRem
בקש דוגמה לעדכון רשימה בכל 2 שעות:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"daily","frequency_type":"period","time":{"period":2,"units":"hours"}}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/newListRem
בקש דוגמה לעדכון רשימה בכל הימים ב- 2: 00 AM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"daily","frequency_type":"exact","time":{"hour":2,"minutes":0}}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/newListRem
בקש דוגמה לעדכון כל הימים ב- 0: 00 AM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"weekly","day":"monday","time":{"hour":0,"minutes":0}}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/newListRem
בקש דוגמה לעדכון 1 של החודש ב- 12: 00 PM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"monthly","day":"1","time":{"hour":12,"minutes":0}}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/newListRem
בקש פרמטרים עבור רשימה מרוחקת
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| שם | מחרוזת | שם הרשימה השחורה. הוא משמש כמזהה ייחודי. |
| מדיניות | מחרוזת | פעולה כדי להחיל על מקור. האפשרויות הן: להכחיש, לחסום את קלט קלט ממקורות של הרשימה; או להתיר לקבל את התנועה ממקורות של הרשימה. |
| כתובת אתר | מחרוזת | איפה הרשימה מרחוק מורדת מ. |
| תדר | מחרוזת | תדירות עדכון רשימה מרחוק. האפשרויות הן: יומי, לעדכן את כל הימים, פעם או תקופה, זה מצוין תדירות שדה; שבועי, עדכון פעם בשבוע; או אחת לחודש, עדכון פעם בחודש. |
| תדירות | מחרוזת | פרמטר זה משלים את תדר יומי כאשר הערך שלו הוא יומי. הערכים האפשריים הם: מְדוּיָק. להגדיר שעה ביום; או תקופה, להגדיר פרק זמן לעדכון במהלך היום. |
| יְוֹם | מחרוזת או מספר | פרמטר זה משלים את תדר כאשר הערך שלה הוא שבועי או חודשי. אם זה שבועי פרמטר זה חייב להיות יום בשבוע (יום שני, יום שלישי, יום רביעי, יום חמישי, יום שישי, יום שבת or יום ראשון) אחרת אם תדר הוא חודשי אז הפרמטר הזה חייב להיות יום בחודש (מספר בין 1 ו 31). |
| זמן | חפץ | זה מבנה שתלוי בשדות תדר. |
אובייקט פרק זמן
אלו הם השדות שבהם תוגדר תקופת זמן.
זה הקונפיגורציה neccessary תדר עם הערך יומי, ו תדירות עם הערך תקופה.
| שדה | סוּג | תיאור |
|---|---|---|
| תקופה | מספר | כמה פעמים לעדכן את הרשימה. |
| יחידה | מחרוזת | יחידה תקופתית. האפשרויות הן: דקות or שעות האחרונות, ציין את יחידת המדידה עבור עדכוני הרשימה. |
שעה מדויק אובייקט שעה
אלו השדות כאשר תצוצב שעה מדויקת.
אובייקט זה משמש לתצורות הבאות:
תדר בשדה יש את הערך יומי ו תדירות is מְדוּיָק.
תדר בשדה יש את הערך שבועי ו יְוֹם הוא יום בשבוע כאשר הרשימה מתעדכנת.
תדר בשדה יש את הערך אחת לחודש ו יְוֹם הוא מספר החודש שבו מתעדכנת הרשימה.
| שדה | סוּג | תיאור |
|---|---|---|
| שעה | מספר | שעה לעדכן את הרשימה. הערך חייב להיות מספר בין 0 ו 23. |
| דקות | מספר | דקות לעדכון הרשימה. הערך חייב להיות מספר בין 0 ו 59. |
דוגמה לתגובה:
{
"description" : "Modify list newListRem.",
"params" : {
"day": 1,
"frequency" : "monthly",
"name" : "newListRem",
"policy" : "deny",
"preload" : "false",
"time" : {
"hour" : 12,
"minutes" : 0
},
"type" : "remote",
"update_status" : "Sync fail. Last update: 2017-02-16 14:23:00",
"url" : "https://192.168.10.12/lists/test.txt"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל תצורת רשימה. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק כלל של רשימות שחורות
מחיקת רשימת רשימות שחורות
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/remoteList
DELETE /ipds/blacklists/<name>
מחק רשימה שחורה נתונה. שם הוא המזהה הייחודי של הרשימה השחורה.
דוגמה לתגובה:
{
"description" : "Delete list 'remoteList'",
"message" : "The list remoteList has been deleted successful.",
"success" : "true"
}
מקור רשימה מרשימה שחורה
מקור רשימה מרשימה שחורה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList
GET /ipds/blacklists/<name>/sources
רשימת מקורות של רשימה שחורה. שם הוא המזהה הייחודי של הרשימה השחורה.
דוגמה לתגובה:
{
"description" : "Get localList sources",
"params" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
}
]
}
פרמטרים של תגובה
התגובה תהיה JSON עם המפתח params ואת מערך אובייקט המקור כערך.
אובייקט מקור:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר | מקור מזהה ייחודי ברשימה. |
| מָקוֹר | מחרוזת [] | כתובות IP או פלחים נטו כי הרשימה בודקת. |
הוסף מקור לרשימה שחורה
הוסף מקור לרשימה שחורה
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources
POST /ipds/blacklists/<name>/sources
דחוף מקור חדש לרשימה השחורה. זמין רק עבור רשימות מקומיות ורשימות שלא נטענו מראש. שם הוא המזהה הייחודי של הרשימה השחורה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| מָקוֹר | מחרוזת | כתובת IP או קטע נטו כי הרשימה בודקת. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Post source to localList.",
"message" : "Added 192.168.3.1 successful.",
"params" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
},
{
"id" : 3,
"source" : "192.168.3.1"
}
]
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שינוי מקור של רשימה שחורה
שינוי מקור של רשימה שחורה
דוגמה לבקשה:
curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources/2
PUT /ipds/blacklists/<name>/sources/<id>
שינוי מקור של רשימה שחורה.
שם הוא המזהה הייחודי של הרשימה השחורה. id הוא המזהה הייחודי של המקור.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| מָקוֹר | מחרוזת | כתובת IP או קטע נטו כי הרשימה בודקת. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Put source into localList",
"message" : "Source 2 has been modified successful.",
"params" : {
"id" : 2,
"source" : "192.168.3.1"
}
}
פרמטרים של תגובה
התגובה תהיה json עם המקור עודכן. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחיקת מקור של רשימה שחורה
מחיקת מקור של רשימה שחורה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources/2
DELETE /ipds/blacklists/<name>/sources/<id>
הסרת מקור מרשימה שחורה.
שם הוא המזהה הייחודי של הרשימה השחורה. id הוא המזהה הייחודי של המקור.
דוגמה לתגובה:
{
"description" : "Delete source from the list localList",
"message" : "Source 2 has been deleted successful.",
"success" : "true"
}
החל פעולה על כלל של רשימה שחורה
החל פעולה
בקש דוגמה עבור רשימה מרוחקת:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"update"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/remoteList/actions
POST /ipds/blacklists/<name>/actions
החל פעולה על רשימה שחורה. שם הוא המזהה הייחודי של הרשימה השחורה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | הפעולה הרצויה להחלה על כלל רשימה שחורה. הערכים הזמינים הם: התחלה, זה actives blaclist בכל החוות שבו הוא מוחל; להפסיק, זה עוצר את הרשימה השחורה לכל החווה בה מוחל כלל הרשימה השחורה, התנועה לא תחסום או תתאפשר; עדכון, ניתן ליישם פעולה זו רק מרחוק רשימות שחורות, פעולה זו לעדכן את רשימת המקור מן השלט כתובת האתר. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Update a remote list",
"update" : "Sync OK. Last update: 2017-02-01 05:31:57"
}
פרמטרים של תגובה
התגובה תהיה json עם מצב ההורדה. ראה דוגמה לתגובה לקבלת מידע נוסף.
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| עדכון | מחרוזת | סטטוס ההורדה האחרון של הרשימה ותאריך העדכון האחרון המוצלח. |
IPDS - DoS
הגנה DoS יש סוג שונה של כללים, תלוי של כלל ההגנה, הוא מוחל על חלק אחר של איזון. אז יש מערכת הכללים כי הוא חל על כל איזון. כללים של חיבורים, ספציפיים עבור משק עבודה עם פרוטוקול TCP. לפני החלת כלל על a משק, ליצור אובייקט עם תצורה רצו. לאחר מכן, להחיל אותו על כל החוות שאתה צריך את זה. ה מערכת הכללים יצרו את האובייקט כבר ורק תצורה אחת אפשרית. לאחר התצורה, הפעל אותו.
החווה DoS הכללים
זה הכרחי יוצר אובייקט לפני להחיל כלל על החווה.
limitsec
הגבלת חיבור חדש לשנייה ולמקור. זמין רק בחוות עובד עם פרוטוקול TCP.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
| להגביל | מספר | זהו המספר המקסימלי של חיבורים חדשים לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של קשרים חדשים. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
גבולות
הגבל את סך החיבורים הנוכחיים למקור. זמין רק בחוות עובד עם פרוטוקול TCP.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
| גבולות | מספר | זהו המספר המקסימלי של החיבור הנוכחי ממקור. |
bogustcpflags
בדוק פרוטוקול TCP מכובד. לכלל זה אין פרמטרים של תצורה כך שיוצרים רק אובייקט שתוכלו להשתמש בו בכל החוות. זמין רק בחוות עובד עם פרוטוקול TCP.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
limitrst
הגבלת מספר בקשת החיבור לאיפוס לשנייה. זמין רק בחוות עובד עם פרוטוקול TCP.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
| להגביל | מספר | זהו המספר המקסימלי של בקשת איפוס לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של בקשת איפוס. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
כללי מערכת DoS
בכללי DoS של המערכת, האובייקט לא נוצר.
sshbruteforce
הגבלת חיבור ssh חדש.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. המזהה הוגדר כ ssh_brute_force. |
| להיטים | מספר | מספר ההתאמות של המקור לפני שהחיבורים נחסמים. |
| זמן | מספר | זמן בשניות כדי לאפס את להיטים דלפק. |
רשימת כל סוג של חוקי DoS
רשימת כל סוג של חוקי DoS
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/rules
GET /ipds/dos/rules
הצג רשימה של כללי DoS. הם לא אובייקט אלא סוגים להגדיר אותו.
לכל כלל יש פרמטרים שונים של תצורה
דוגמה לתגובה:
{
"description" : "Get DoS settings.",
"params" : {
"farm" : [
{
"description" : "Connection limit per seconds.",
"rule" : "limitsec"
},
{
"description" : "Total connections limit per source IP.",
"rule" : "limitconns"
},
{
"description" : "Check bogus TCP flags.",
"rule" : "bogustcpflags"
},
{
"description" : "Limit RST request per second.",
"rule" : "limitrst"
}
],
"system" : [
{
"description" : "SSH brute force.",
"rule" : "sshbruteforce"
},
]
}
}
פרמטרים של תגובה
התגובה JSON יש שני מערכים משק ו מערכת. כל פריט מערך הוא סוג של כלל להחיל על החווה o המערכת.
| שדה | סוּג | תיאור |
|---|---|---|
| תיאור | מחרוזת | תיאור קצר של הכלל. |
| לשלוט | מחרוזת | מזהה ייחודי של מזהה סוג. |
רשום את כל כללי ה- DoS
רשימת כל האובייקטים DoS
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos
GET /ipds/dos
הצג תצורה לגבי כל האובייקטים הקיימים של DoS.
דוגמה לתגובה:
{
"description" : "Get DoS settings.",
"params" : [
{
"farms" : [],
"limit_conns" : 10,
"name" : "limitConnHttp",
"rule" : "limitconns",
"status" : "down",
"type" : "farm"
},
{
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "limitUsers",
"rule" : "limitsec",
"status" : "down",
"type" : "farm"
},
{
"hits" : 5,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "down",
"time" : 180,
"type" : "system"
},
{
"farms" : [],
"name" : "tcpAuth",
"rule" : "bogustcpflags",
"status" : "down",
"type" : "farm"
},
{
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "dos4",
"rule" : "limitrst",
"status" : "down",
"type" : "farm"
},
]
}
פרמטרים של תגובה
התגובה תהיה מערך עם כל האובייקטים DoS זמין.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
| לשלוט | מחרוזת | זהו מזהה כלל הסוג. |
| סוג | מחרוזת | הערכים האפשריים הם: משק, הכלל חל על חוות; או מערכת, הכלל חל על המערכת. |
| מצב | מחרוזת | הערכים האפשריים הם: up, את חוק DoS מופעל וסינון התנועה; או מטה, הכלל אינו פועל והוא אינו מסנן תנועה. |
תלות נוספת של הכלל, האובייקט מכיל את הפרמטרים הבאים
limitsec
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| להגביל | מספר | זהו המספר המקסימלי של חיבורים חדשים לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של קשרים חדשים. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
גבולות
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| גבולות | מספר | זהו המספר המקסימלי של החיבור הנוכחי ממקור. |
bogustcpflags
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
limitrst
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| להגביל | מספר | זהו המספר המקסימלי של בקשת איפוס לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של בקשת איפוס. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
sshbruteforce
| שדה | סוּג | תיאור |
|---|---|---|
| להיטים | מספר | מספר ההתאמות של המקור לפני שהחיבורים נחסמים. |
| זמן | מספר | זמן בשניות כדי לאפס את להיטים דלפק. |
אחזר כלל DoS
אחזר כלל DoS
בקש דוגמה עבור כלל החווה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/limitConnHttp
בקש דוגמה עבור כלל המערכת:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/ssh_brute_force
GET /ipds/dos/<name>
כל אובייקט DoS יכול להיות תצורה אחרת. שם הוא מזהה הכללים של DoS.
דוגמה לתגובה עבור כלל החווה:
{
"description" : "Get DoS limitConnHttp settings",
"params" : {
"farms" : [],
"limit_conns" : 10,
"name" : "limitConnHttp",
"rule" : "limitconns",
"status" : "down",
"type" : "farm"
}
}
דוגמה לתגובה עבור כלל המערכת:
{
"description" : "Get DoS ssh_brute_force settings",
"params" : {
"hits" : 5,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "down",
"time" : 180,
"type" : "system"
}
}
פרמטרים של תגובה
התגובה תהיה מערך עם כל האובייקטים DoS זמין.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. |
| לשלוט | מחרוזת | זהו מזהה כלל הסוג. |
| סוג | מחרוזת | הערכים האפשריים הם: משק, הכלל חל על חוות; או מערכת, הכלל חל על המערכת. |
| מצב | מחרוזת | הערכים האפשריים הם: up, את חוק DoS מופעל וסינון התנועה; או מטה, הכלל אינו פועל והוא אינו מסנן תנועה. |
תלות נוספת של הכלל, האובייקט מכיל את הפרמטרים הבאים
limitsec
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| להגביל | מספר | זהו המספר המקסימלי של חיבורים חדשים לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של קשרים חדשים. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
גבולות
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| גבולות | מספר | זהו המספר המקסימלי של החיבור הנוכחי ממקור. |
bogustcpflags
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
limitrst
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | חוות שבהן החוקים מוחלים. |
| להגביל | מספר | זהו המספר המקסימלי של בקשת איפוס לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של בקשת איפוס. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
sshbruteforce
| שדה | סוּג | תיאור |
|---|---|---|
| להיטים | מספר | מספר ההתאמות של המקור לפני שהחיבורים נחסמים. |
| זמן | מספר | זמן בשניות כדי לאפס את להיטים דלפק. |
צור כלל DoS
צור כלל DoS
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"limitUsers", "rule":"limitsec"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos
POST /ipds/dos
יצירת אובייקט DoS להשתמש בו כמו חוות כפי הצורך.
כל אובייקט DoS יכול להיות תצורה אחרת.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | זהו הכלל הייחודי של כלל האובייקט. | נָכוֹן |
| לשלוט | מחרוזת | זהו מזהה כלל הסוג. האפשרויות הן: גבולות, limitsec, limitrst or bogustcpflags. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Post a DoS rule",
"params" : {
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "limitUsers",
"rule" : "limitsec",
"type" : "farm"
}
}
פרמטרים של תגובה
התגובה תהיה json עם תצורת ברירת המחדל עבור הכלל שנוצר. ראה דוגמה לתגובה לקבלת מידע נוסף.
שינוי כלל DoS
שינוי כלל DoS
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"hits":"10","status":"up","time":"100"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/ssh_brute_force
PUT /ipds/dos/<name>
שינוי כלל DoS. שם הוא מזהה הכללים של DoS.
פרמטרים של בקשה
כל סוג של כלל יכול להיות פרמטרים שונים. הפרמטרים לשינוי הם הבא:
limitsec
| שדה | סוּג | תיאור |
|---|---|---|
| להגביל | מספר | זהו המספר המקסימלי של חיבורים חדשים לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של קשרים חדשים. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
גבולות
| שדה | סוּג | תיאור |
|---|---|---|
| גבולות | מספר | זהו המספר המקסימלי של החיבור הנוכחי ממקור. |
bogustcpflags
אין פרמטרים.
limitrst
| שדה | סוּג | תיאור |
|---|---|---|
| להגביל | מספר | זהו המספר המקסימלי של בקשת איפוס לשנייה עבור מקור. |
| מגבלה | מספר | זהו שיא מותר של בקשת איפוס. יחידת פרץ מתחדשת כאשר יחלפו שניות "הגבלה". |
sshbruteforce
| שדה | סוּג | תיאור |
|---|---|---|
| להיטים | מספר | מספר ההתאמות של המקור לפני שהחיבורים נחסמים. |
| זמן | מספר | זמן בשניות כדי לאפס את להיטים דלפק. |
| מצב | מחרוזת | הערכים האפשריים הם: up, את חוק DoS מופעל וסינון התנועה; או מטה, הכלל אינו פועל והוא אינו מסנן תנועה. |
דוגמה לתגובה:
{
"description" : "Put DoS rule settings",
"params" : {
"hits" : 10,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "up",
"time" : 100,
"type" : "system"
},
"success" : "true"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
מחק כלל DoS
מחק כלל DoS
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/limitConnHttp
DELETE /ipds/dos/<name>
כללי המערכת אינם יכולים למחוק אותו. כדי להשבית אותו, העבר את הסטטוס ל מטה. שם הוא מזהה הכללים של DoS.
דוגמה לתגובה:
{
"description" : "Delete DoS rule",
"message" : "Deleted limitConnHttp successful.",
"success" : "true"
}
החל פעולה על כלל DoS
החל פעולה
בקש דוגמה עבור רשימה מרוחקת:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"start"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/conns_maximum/actions
POST /ipds/dos/<name>/actions
החל פעולה על כלל DOS. שם הוא מזהה דוס של מזהה ייחודי.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | הפעולה הרצוי להחיל על חוק DoS. הערכים הזמינים הם: התחלה, זה actives הכלל DoS בכל החוות שבו הוא מוחל; להפסיק, זה מנטרל את ה- DoS עבור כל החוות בהן מוחל כלל DoS, התנועה לא תחסום או תתאפשר. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Apply a action to a DoS rule",
"params" : {
"action" : "start"
}
}
פרמטרים של תגובה
אם אין בעיות בתצורה, zapi יחזיר את הפעולה המבוקשת.
IPDS - RBL
RBL, רשימות blackhole בזמן אמת מאפשר ליצור מערכת אבטחה האצלת, המשימה המייגעת של תחזוקה מערכת אבטחה מעודכנת, כדי speclistist. RBL בודק עומס קלט קלט נתונים במסד נתונים חיצוני באמצעות פרוטוקול DNS. הבעלים של שרת ה- DNS הוא האחראי לעדכון ולספק מקורות איכותיים. תנועת הקלט ממקור IP הנמצא במסד הנתונים של DNS תופסק.
כדי לעבוד עם שירות RBL, יתווספו דומיינים של DNS ראשונים, כל תחום DNS יכלול רשימה מוגדרת ספציפית שמייצרת את המקור לקריטריון אחר כסוג של התקפה או חומרת התקפה.
לאחר יצירת דומיינים DNS, יש צורך ליצור כלל RBL עם תצורת הכלל. לאחר מכן מקשר דומיינים DNS עם כלל RBL. כל חוק יכול לבחון תחומים שונים.
אחרון להחיל את חוק RBL לכל החוות הרצוי.
רשימת כל הכללים RBL
רשימת כל הכללים RBL
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl
GET /ipds/rbl
רשימה של כל כללי RBL הזמינים במאזן העומס.
דוגמה לתגובה:
{
"description" : "Get RBL rules",
"params" : [
{
"cache_size" : 8192,
"cache_time" : 3600,
"domains" : [
"ssh.rbl.zevenet.com",
"ssh.blocklist.de"
],
"farms" : [
"sshL4farm"
],
"local_traffic" : "false",
"log_level" : 4,
"name" : "protection_ssh",
"only_logging" : "true",
"queue_size" : 64538,
"status" : "down",
"threadmax" : 700
},
{
"cache_size" : 2048,
"cache_time" : 7200,
"domains" : [],
"farms" : [],
"local_traffic" : "true",
"log_level" : 4,
"name" : "sip",
"only_logging" : "true",
"queue_size" : 32269,
"status" : "down",
"threadmax" : 400
},
{
"cache_size" : 8192,
"cache_time" : 3600,
"domains" : [],
"farms" : [
"webAPP"
],
"local_traffic" : "false",
"log_level" : 4,
"name" : "web_attacks",
"only_logging" : "true",
"queue_size" : 64538,
"status" : "down",
"threadmax" : 700
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים RBL, שכל אחד מהם מכילים את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| תחומים | מחרוזת [] | זוהי רשימה עם כל התחומים כי הכלל הוא שאילתה. |
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| מצב | מחרוזת | הצג את מצב הכלל RBL. הערך שלה יכול להיות מטה, אם הכלל אינו פועל; או up זה הכלל עובד. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
אחזר כלל RBL
אחזור כלל RBL
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/protection_ssh
GET /ipds/rbl/<name>
הצג את תצורת RBL ופרמטרי התיאור שלה. שם הוא מזהה RBL מזהה ייחודי.
פרמטרים של תגובה
דוגמה לתגובה:
{
"description" : "Get RBL protection_ssh",
"params" : {
"cache_size" : 8192,
"cache_time" : 3600,
"domains" : [
"ssh.zevenet.com",
"ssh.blocklist.de"
],
"farms" : [
"sshL4farm"
],
"local_traffic" : "false",
"log_level" : 4,
"name" : "protection_ssh",
"only_logging" : "true",
"queue_size" : 64538,
"status" : "down",
"threadmax" : 700
}
}
אובייקט כלל RBL:
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| תחומים | מחרוזת [] | זוהי רשימה עם כל התחומים כי הכלל הוא שאילתה. |
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| מצב | מחרוזת | הצג את מצב הכלל RBL. הערך שלה יכול להיות מטה, אם הכלל אינו פועל; או up זה הכלל עובד. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
יצירת כלל RBL
צור כלל RBL חדש
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"all"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl
POST /ipds/rbl
יצירת כלל RBL לשמש בחוות.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. | נָכוֹן |
{
"description" : "Create a RBL rule.",
"params" : {
"cache_size" : 8192,
"cache_time" : 3600,
"domains" : [],
"farms" : [],
"local_traffic" : "false",
"log_level" : 4,
"name" : "all",
"only_logging" : "true",
"queue_size" : 64538,
"status" : "down",
"threadmax" : 700
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים RBL, שכל אחד מהם מכיל תכונות מפתח הבא.
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| תחומים | מחרוזת [] | זוהי רשימה עם כל התחומים כי הכלל הוא שאילתה. |
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| מצב | מחרוזת | הצג את מצב הכלל RBL. הערך שלה יכול להיות מטה, אם הכלל אינו פועל; או up זה הכלל עובד. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
שינוי כלל RBL
שינוי כלל RBL
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"all_reported","cache_size":16384, "cache_time":180000, "queue_size":32269, "threadmax":500, "local_traffic":"true", "log_level":4, "only_logging":"true"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/all
PUT /ipds/rule/<name>
שינוי התצורה של כלל RBL. שם הוא מזהה RBL מזהה ייחודי.
פרמטרים של בקשה:
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
דוגמה לתגובה:
{
"description" : "Modify RBL rule all.",
"params" : {
"cache_size" : 16384,
"cache_time" : 180000,
"domains" : [],
"farms" : [],
"local_traffic" : "true",
"log_level" : 4,
"name" : "all",
"only_logging" : "true",
"queue_size" : 32269,
"status" : "down",
"threadmax" : 500
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים RBL, שכל אחד מהם מכיל תכונות מפתח הבא.
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| תחומים | מחרוזת [] | זוהי רשימה עם כל התחומים כי הכלל הוא שאילתה. |
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| מצב | מחרוזת | הצג את מצב הכלל RBL. הערך שלה יכול להיות מטה, אם הכלל אינו פועל; או up זה הכלל עובד. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
העתק כלל RBL
העתק כלל RBL
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"copied_rule"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/all_reported
POST /ipds/rule/<name>
העתק כלל RBL כדי ליצור כלל חדש. שם הוא מזהה RBL מזהה ייחודי.
פרמטרים של בקשה:
| שדה | סוּג | תיאור | נדרש |
|---|---|---|---|
| שם | מחרוזת | RBL שם הכלל עבור הכלל החדש. הוא משמש כמזהה ייחודי. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Copy a RBL rule.",
"params" : {
"cache_size" : 16384,
"cache_time" : 180000,
"domains" : [],
"farms" : [],
"local_traffic" : "true",
"log_level" : 4,
"name" : "copied_rule",
"only_logging" : "true",
"queue_size" : 32269,
"status" : "down",
"threadmax" : 500
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים RBL, שכל אחד מהם מכיל תכונות מפתח הבא.
| שדה | סוּג | תיאור |
|---|---|---|
| גודל המטמון | מספר | זה המספר של מקור ה- IP כי הכלל RBL יכול מטמון. |
| cache_time | מספר | זה הזמן (בשניות) כי מקור ה- IP ייחסם. |
| תחומים | מחרוזת [] | זוהי רשימה עם כל התחומים כי הכלל הוא שאילתה. |
| חוות | מחרוזת [] | רשימת החווה שבה מוחל הרשימה השחורה. |
| local_traffic | מחרוזת | אם לשדה זה יש את הערך נָכוֹן, הכלל RBL יבחן תנועה מקטעי רשת פרטית; או אם הערך שלה הוא שקר את הכלל RBL יתעלם התנועה מקטעי רשת פרטית. התנועה המקומית לעולם לא תחסום על ידי DNS ציבורי. |
| log_level | מספר | זוהי רמת יומן החומרה. זה יכול להיות ערך בין 0 ו 7, להיות 0 חירום 7 באגים. |
| שם | מחרוזת | RBL שם הכלל. הוא משמש כמזהה ייחודי. |
| only_logging | מחרוזת | אם הערך הוא נָכוֹן, כאשר התאמות IP בתחום, הוא יירשם; או אם לשדה זה יש את הערך שקר, כאשר התאמות IP בתחום, ה- IP יירשם והחבילה תישמט. |
| queue_size | מספר | זה מספר החבילה כי הכלל יכול לשמור על התור. |
| מצב | מחרוזת | הצג את מצב הכלל RBL. הערך שלה יכול להיות מטה, אם הכלל אינו פועל; או up זה הכלל עובד. |
| threadmax | מחרוזת | זה זה מספר מנות כי הכלל יכול שאילתה בו זמנית שרתי DNS. הערך המרבי שלה הוא 700. כאשר מספר מנות קלט גדול יותר threadmax, מנות הבא יתקבלו באופן אוטומטי. |
מחק כלל RBL
מחק RBL
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/sip
DELETE /ipds/rbl/<name>
מחק כלל RBL נתון. שם הוא מזהה RBL מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Delete RBL 'sip'",
"message" : "The rule sip has been deleted successful.",
"success" : "true"
}
רשום את כל התחומים של RBL
רשום את כל התחומים של RBL
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains
GET /ipds/rbl/domains
רשימת כל התחומים availabled לקשר עם הכללים RBL.
דוגמה לתגובה:
{
"description" : "Get RBL domains",
"params" : {
"preloaded" : [
{
"domain" : "all.rbl.zevenet.com",
"id" : 0
},
{
"domain" : "ssh.rbl.zevenet.com",
"id" : 1
},
{
"domain" : "sip.rbl.zevenet.com",
"id" : 2
}
],
"user" : [
{
"domain" : "zen.spamhaus.org",
"id" : 0
},
{
"domain" : "web.dnsbl.sorbs.net",
"id" : 1
}
]
}
}
פרמטרים של תגובה
התגובה תהיה JSON עם המפתח params ושני סוגים של תחומים מוצגים כערך.
אובייקט מקור:
| שדה | סוּג | תיאור |
|---|---|---|
| preloaded | אובייקט [] | זוהי רשימה עם התחומים שנוספו על ידי צוות זבנט. |
| המשתמש | אובייקט [] | זוהי רשימה עם התחומים שנוספו על ידי מנהל איזון העומס. |
אובייקט שנרשם מראש ואובייקט משתמש:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר[] | זהו מזהה שמזהה דומיין. |
| תחום | מחרוזת [] | זהו תחום שבו הכלל rbl עושה שאילתות. |
הוסף דומיין
הוסף דומיין
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"domain":"web.dnsbl.sorbs.net"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains
POST /ipds/rbl/domains
הוסף דומיין חדש לרשימת הדומיינים של המשתמש.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| תחום | מחרוזת | זהו אזור של מפקח RBL שבו כלל RBL יעשה שאילתות. | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Post a RBL domain.",
"message" : "",
"params" : {
"domains" : [
"zen.spamhaus.org",
"sip.blocklist.de",
"web.dnsbl.sorbs.net"
]
}
}
פרמטרים של תגובה
התגובה תהיה json עם רשימה של כל התחומים שנוספו על ידי מנהל איזון עומס.
| שדה | סוּג | תיאור |
|---|---|---|
| תחומים | מחרוזת [] | זוהי רשימה עם התחומים שנוספו על ידי מנהל איזון העומס. |
שנה דומיין
שנה דומיין
דוגמה לבקשה:
curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"domain":"ssh.blocklist.de"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains/2
PUT /ipds/rbl/domains/<id>
שינוי תחום או רשימת דומיינים של משתמשים על ידי אחרים שנשלח כפרמטר.
id הוא מזהה משתמש תחום.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| תחום | מחרוזת | זהו תחום שהוא מחליף את הדומיין שנשלח ב- URI. |
דוגמה לתגובה:
{
"description" : "Replace a domain",
"message" : "RBL domain ssh.blocklist.de has been modified successful.",
"params" : {
"domains" : [
{
"domain" : "zen.spamhaus.org",
"id" : 0
},
{
"domain" : "web.dnsbl.sorbs.net",
"id" : 1
},
{
"domain" : "ssh.blocklist.de",
"id" : 2
}
]
}
}
פרמטרים של תגובה
התגובה תהיה json עם רשימה של כל התחומים שנוספו על ידי מנהל איזון עומס.
אובייקט דומיין:
| שדה | סוּג | תיאור |
|---|---|---|
| id | מספר[] | זהו מזהה שמזהה דומיין. |
| תחום | מחרוזת [] | זהו תחום שבו הכלל rbl עושה שאילתות. |
מחק דומיין
מחק דומיין
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains/1
DELETE /ipds/rbl/domains/<id>
מחק דומיין מרשימת הדומיינים של המשתמש.
id הוא מזהה המשתמש של התחום שהוא יימחק.
דוגמה לתגובה:
{
"description" : "Delete a RBL domain.",
"message" : "RBL domain web.dnsbl.sorbs.net has been deleted successful.",
"success" : "true"
}
החל פעולה על כלל RBL
החל פעולה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/<name>/action
POST /ipds/rbl/<name>/actions
החל פעולה על כלל RBL, עיין בטבלה פרמטרים בקשה לפעולות. כדי להחיל פעולה על כלל יש צורך שהכלל יחול לפחות לחווה אחת, והוא צריך לכלול לפחות דומיין מאופשר.
שם הוא מזהה RBL מזהה ייחודי.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| פעולה | מחרוזת | החל את הפעולה הרצויה. הפעולות הן: להפסיק, את הכלל RBL יופסק החוות קדימה התנועה שבו הוא מוחל הכלל לא יירד. התחלה, את הכלל RBL יופעל וכל התנועה קדימה החוות שבו הכלל הזה מוחל יופסק. |
דוגמה לתגובה:
{
"description" : "Apply a action to a RBL rule",
"params" : {
"action" : "start"
}
}
פרמטרים של תגובה
אם אין בעיות בתצורה, zapi יחזיר את הפעולה המבוקשת.
מערכת
אפשרויות מערכת מציעים לך את האפשרות של התאמה אישית של השירותים הפועלים באיזון ואת הפרמטרים הגלובליים.
הצג גרסה
הצג גרסה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.2/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.2/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 עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הצג SSH
הצג SSH
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/ssh
GET /system/ssh
הצג את תצורת השירות SSH.
דוגמה לתגובה:
{
"description" : "Get ssh",
"params" : {
"listen" : "*",
"port" : "22"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| להקשיב | מחרוזת | IP של המערכת שבה SSH שירות מקשיב. ה דמות * משמש להאזנה בכל ה- IP של התצורה. |
| נמל | מחרוזת | יציאה תצורה עבור שירות SSH. |
שינוי SSH
שינוי SSH
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"listen":"192.168.100.241","port":"22"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/ssh
POST /system/ssh
שנה את תצורת השירות SSH.
פרמטרים של בקשה
התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.
| שדה | סוּג | תיאור |
|---|---|---|
| להקשיב | מחרוזת | IP של המערכת שבה SSH שירות מקשיב. ה דמות * משמש להאזנה בכל ה- IP של התצורה. |
| נמל | מחרוזת | יציאה תצורה עבור שירות SSH. |
דוגמה לתגובה:
{
"description" : "Post ssh",
"params" : {
"listen" : "192.168.100.241",
"port" : "22"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הצג SNMP
הצג SNMP
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.2/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.2/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.2/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.2/zapi.cgi/system/ntp
POST /system/ntp
שינוי תצורת שירות NTP.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| שרת | מחרוזת | שרת שבו לקוח NTP עושה את הבקשות. |
דוגמה לתגובה:
{
"description" : "Post ntp",
"params" : "pool.ntp.org"
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הצג שרת HTTP
הצג שרת HTTP
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/http
GET /system/http
הצג את תצורת שירות HTTP. זה שם Zevenet API ו- GUI פועלים.
דוגמה לתגובה:
{
"description" : "Get http",
"params" : {
"ip" : "*",
"port" : "444"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | IP שבו שרת HTTP מקשיב. ה דמות * משמש להאזנה בכל ה- IP של התצורה. |
| נמל | מחרוזת | יציאה שבה שירות HTTP מקשיב. |
שינוי שרת HTTP
שינוי שרת HTTP
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"80"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/http
POST /system/http
שנה את תצורת שירות HTTP.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | IP שבו שרת HTTP מקשיב. ה דמות * משמש להאזנה בכל ה- IP של התצורה. |
| נמל | מחרוזת | יציאה שבה שירות HTTP מקשיב. |
דוגמה לתגובה:
{
"description" : "Post http",
"params" : {
"ip" : "192.168.100.241",
"port" : "80"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
אחזר את המשתמש הנוכחי
אחזר את המשתמש הנוכחי
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/users
GET /system/users
הצג מידע על המשתמש הנוכחי. המשתמש הנוכחי הוא מקבל את המשתמש ZAPI_KEY או המשתמש שנרשם על ידי webgui
דוגמה לתגובה:
{
"description" : "Retrieve the user root",
"params" : {
"user" : "root",
"zapi_permissions" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מערך של הפרמטרים הבאים.
| שדה | סוּג | תיאור |
|---|---|---|
| המשתמש | מחרוזת | זה הבעלים של המשתמש ZAPI_KEY. זה יכול להיות משתמש ברירת המחדל של השורש או משתמש RBAC. |
| zapi_permissions | מחרוזת | אם הערך הוא נָכוֹן, המשתמש יכול להשתמש ב- API של Zevenet באמצעות zapikey של המשתמש; או אם הערך הוא שקר, המשתמש ביטל את השימוש ב- zapi. |
שנה את המשתמש הנוכחי
שנה את המשתמש הנוכחי
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"password":"CDe0c3ck","newpassword":"v2mfcvv2","zapi_permissions":"false","zapikey":"vCeH60mQFf2MgH5"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/users
POST /system/users
שינוי התצורה של המשתמש הנוכחי. המשתמש הנוכחי הוא מקבל את המשתמש ZAPI_KEY או המשתמש שנרשם על ידי webgui.
פרמטרים של בקשה:
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| זאפיקי | מחרוזת | לכל משתמש יכול להיות zapikey. באמצעות zapikey זה המשתמש יכול לבצע פעולה באמצעות zapikey עם ההרשאות של תפקיד המשתמש. | |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. | |
| סיסמה חדשה | מחרוזת | סיסמת משתמש חדשה כדי לגשת דרך האינטרנט. | |
| סיסמא | מחרוזת | סיסמת משתמש נוכחי. | זה נדרש כאשר סיסמה חדשה נשלח. |
דוגמה לתגובה:
{
"description" : "Modify the user Shadi",
"message" : "Settings was changed successful."
}
רשימת קובצי יומן
רשימת קובצי יומן
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.2/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.2/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
הורד קובץ יומן של קובצי היומן הזמינים המפורטים בעת בקשת GET.
פילה הוא מזהה הקובץ היומן הייחודי.
מערכת - גיבויים
בעזרת אפשרות הגיבוי תוכל לשמור את תצורת המערכת הנוכחית ולהוריד אותה.
בסעיף זה, תוכל ליצור, לשחזר, להעלות ולהוריד קבצי גיבוי.
רשימת גיבויים
רשימת גיבויים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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.2/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.2/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.2/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.2/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.2/zapi.cgi/system/backup/firstConf/actions
POST /system/backup/<name>/actions
שחזור התצורה מקובץ גיבוי. שם הוא מזהה הגיבוי הייחודי.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| פעולה | מחרוזת | כדי לשחזר את תצורת הגיבוי, הערך חייב להיות להגיש מועמדות. |
דוגמה לתגובה:
{
"description" : "Apply a backup to the system",
"params" : {
"action" : "apply"
}
}
מערכת - הודעות
ההודעות נוצרות על ידי שני מרכיבים: שׁוֹלֵחַ שיטה וסוג ערני.
בקטע התראה תוכל לבחור איזה סוג של התראה שאתה רוצה לקבל. למעשה, ההתראות הן להתמקד backend או מצב אשכול, כך האיזון ישלח הודעה אם כמה בוררים.
בשיטה בסעיף תוכל לבחור איזה שולח ישמש כאשר Zevenet יש לשלוח הודעה.
הצג מצב התראה
הצג מצב התראה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts
GET /system/notifications/alerts
רשום את כל סוגי ההתראות עם הסטטוס שלהן.
דוגמה לתגובה:
{
"description" : "Get notifications alert status",
"params" : [
{
"alert" : "backends",
"status" : "disabled"
},
{
"alert" : "cluster",
"status" : "disabled"
}
]
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| ערני | מחרוזת | סוג ההתראה, הוא משמש כמזהה ייחודי להתראה. ההתראות הזמינות הן: Backend, להודיע כאשר backend משנה את המצב; או אשכול, שלח הודעה כאשר צומת המאסטר הראשי עובר לצומת אחר. |
| מצב | מחרוזת | הצג אם ההתראה היא נכה, המערכת לא שולחת הודעה כשיש אירוע; אוֹ מופעל, המערכת שולחת התראה כאשר היא מזוהה שינוי של הסטטוס. |
אחזר התראות על התראות
אחזר התראות על התראות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts/backends
GET /system/notifications/alerts/<alert>
הצג את התצורה לגבי סוג התראה.
ערני הוא המזהה הייחודי.
דוגמה לתגובה:
{
"description" : "Get notifications alert backends settings",
"params" : {
"avoidflappingtime" : 5,
"prefix" : "",
"status" : "disabled"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| להימנע | מספר | לפעמים backends זמינים או לא בתוך פרק זמן קצר, שדה זה מאפשר להגדיר את פרק הזמן כדי למנוע הודעות הודעה בעת backend משנה את המצב, לאחר תקופה זו של זמן מסכם, אם המצב backend זה שונה זה מזה, אז ההודעה נשלחת. |
| קידומת | מחרוזת | זוהי קידומת עבור נושא הדוא"ל, אשר נשלחים על ידי המערכת עבור סוג זה של התראה. |
| מצב | מחרוזת | הצג אם ההתראה היא נכה, המערכת לא שולחת הודעה כשיש אירוע; אוֹ מופעל, המערכת שולחת התראה כאשר היא מזוהה שינוי של הסטטוס. |
שנה התראה על התראה
שינוי התראות התראות
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"avoidflappingtime":10,"prefix":"[backend alert]"}
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts/backends
POST /system/notifications/alerts/<alert>
ערני הוא המזהה הייחודי.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| להימנע | מספר | לפעמים backends זמינים או לא בתוך פרק זמן קצר, שדה זה מאפשר להגדיר את פרק הזמן כדי למנוע הודעות הודעה בעת backend משנה את המצב, לאחר תקופה זו של זמן מסכם, אם המצב backend זה שונה זה מזה, אז ההודעה נשלחת. פרמטר זה אינו באשכולות התראות, אשכול יש זמן swich עצמו. |
| קידומת | מחרוזת | זוהי קידומת עבור נושא הדוא"ל, אשר נשלחים על ידי המערכת עבור סוג זה של התראה. |
דוגמה לתגובה:
{
"description" : "Set notifications alert backends",
"params" : {
"avoidflappingtime" : 10,
"prefix" : "[backend alert]"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
הפעל התראות
הפעל התראות
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"action":"enable"}
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts/backends/actions
POST /system/notifications/alerts/<alert>/actions
הפעל או השבת את ההתראות עבור סוג התראה.
ערני הוא המזהה הייחודי.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| פעולה | מחרוזת | הפעולות הזמינות עבור התראות הן להשבית, המערכת לא שולחת הודעה כשיש אירוע; אוֹ לאפשר, המערכת שולחת התראה כאשר היא מזוהה שינוי של הסטטוס. |
דוגמה לתגובה:
{
"description" : "Set notifications alert backends actions",
"params" : {
"action" : "enable"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
אחזר תצורת דוא"ל
אחזר תצורת דוא"ל
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/methods/email
GET /system/notifications/methods/email
הצג את כל התצורה של שולח הדוא"ל.
הערה: יציאת SMTP המשמשת לשליחת הודעות דוא"ל היא TCP 25 גם אם TLS מופעל.
דוגמה לתגובה:
{
"description" : "Get notifications email methods",
"params" : {
"from" : "user@zevenet.com",
"method" : "email",
"password" : "******",
"server" : "smtp.gmail.com",
"tls" : "true",
"to" : "adminuser@zevenet.net",
"user" : "user@zevenet.com"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| החל מ- | מחרוזת | חשבון דואר אלקטרוני ששולח את הדוא"ל, חשבון זה יופיע בכותרת ה- SMTP מאת: והוא ישמש אם המגיב עונה על האימייל. |
| שיטה | מחרוזת | זהו המזהה הייחודי של השיטה. למעשה השיטה הזמינה היא אמייל. |
| סיסמא | מחרוזת | סיסמה עבור המשתמש חשבון SMTP, סיסמה זו נחוצה אם השרת דורש אימות SMTP. |
| שרת | מחרוזת | שרת SMTP דרך הדוא"ל נשלח. |
| Tls | מחרוזת | אפשר אימות TLS לשליחת דוא"ל, מאפיין זה משתמש ב- STARTTLS ותכונה זו חייבת להיות נתמכת בשרת ה- SMTP. שרתי SMTP מסוימים דורשים להפעיל אותו. הערכים האפשריים הם: נָכוֹן, אימות TLS מופעל לשליחת דוא"ל; או שקר, שליחת דוא"ל אינה משתמשת באימות TLS. |
| ל | מחרוזת | חשבון דוא"ל שמקבל את הודעת האימייל, חשבון זה יופיע בכותרת ה- SMTP. |
| המשתמש | מחרוזת | חשבון דוא"ל מותר לשלוח הודעות דוא"ל, חשבון זה נחוץ אם השרת דורש אימות SMTP. |
שנה את תצורת האימייל
שנה את תצורת האימייל
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"from":"user@zevenet.com","password":"verystrongpass","server":"smtp.gmail.com","to":"adminuser@zevenet.net","tls":"true","user":"user@zevenet.com"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/methods/email
POST /system/notifications/methods/email
שנה את התצורה של שיטת שולח הדוא"ל.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| החל מ- | מחרוזת | חשבון דואר אלקטרוני ששולח את הדוא"ל, חשבון זה יופיע בכותרת ה- SMTP מאת: והוא ישמש אם המגיב עונה על האימייל. |
| סיסמא | מחרוזת | סיסמה עבור המשתמש חשבון SMTP, סיסמה זו נחוצה אם השרת דורש אימות SMTP. |
| שרת | מחרוזת | שרת SMTP דרך הדוא"ל נשלח. |
| Tls | מחרוזת | אפשר אימות TLS לשליחת דוא"ל, מאפיין זה משתמש ב- STARTTLS ותכונה זו חייבת להיות נתמכת בשרת ה- SMTP. שרתי SMTP מסוימים דורשים להפעיל אותו. הערכים האפשריים הם: נָכוֹן, אימות TLS מופעל לשליחת דוא"ל; או שקר, שליחת דוא"ל אינה משתמשת באימות TLS. |
| ל | מחרוזת | חשבון דוא"ל שמקבל את הודעת האימייל, חשבון זה יופיע בכותרת ה- SMTP. |
| המשתמש | מחרוזת | חשבון דוא"ל מותר לשלוח הודעות דוא"ל, חשבון זה נחוץ אם השרת דורש אימות SMTP. |
דוגמה לתגובה:
{
"description" : "Get notifications email methods",
"params" : {
"from" : "user@zevenet.com",
"method" : "email",
"password" : "verystrongpass",
"server" : "smtp.gmail.com",
"tls" : "true",
"to" : "adminuser@zevenet.net",
"user" : "user@zevenet.com"
}
}
פרמטרים של תגובה
התגובה תהיה json עם כל הערכים המבוקשים מעודכנים. ראה דוגמה לתגובה לקבלת מידע נוסף.
שלח הודעת בדיקה
שלח הודעת בדיקה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"test"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/methods/email/actions
POST /system/notifications/methods/email/actions
שלח הודעת בדיקה עם תצורת הדואר האלקטרוני, כדי לבדוק אותה.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| פעולה | מחרוזת | הערך לשליחת דואר בדיקה הוא מבחן. |
דוגמה לתגובה:
{
"description" : "Send test mail",
"message" : "Test mail sent successful.",
"success" : "true"
}
הורד תומך
הורד תומך
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/supportsave > supportsave.tar.gz
GET /system/supportsave
קבל תמונת מצב מערכת עם כל התצורה והתהליך הפועלים במערכת. זה תומך יש צורך למצוא בעיות או תמיכה.
מערכת - אשכול
אשכול הוא האלמנט נעשה על ידי הצומת הראשי, כי הוא מנהל את הקישורים fordward backends, ואת הצומת גיבוי בודקים את המאסטר, הוא מוכן swich כדי הצומת הראשי אם זה הולך למטה למצב.
כאשר המצב עובר, צומת הגיבוי תשחזר את כל מצב החיבור כשלעצמו. לכן, הלקוח לא זיהה הפרעה לשירות.
זה מאפשר לשים את איזון עומס בזמינות גבוהה. אז אם יש בעיה ב- Zevenet, השירות ימשיך לעבוד עם תצורה שהועלה.
הצג את תצורת האשכול
הצג את תצורת האשכול
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster
GET /system/cluster
הצג את כל התצורה לגבי האשכול.
תגובה BODY:
{
"description" : "Show the cluster configuration",
"params" : {
"check_interval" : 5,
"failback" : "disabled",
"interface" : "eth0",
"nodes" : [
{
"ip" : "192.168.100.241",
"name" : "canoDEV4100",
"node" : "local"
},
{
"ip" : "192.168.100.240",
"name" : "maqvir",
"node" : "remote"
}
]
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם תצורת אשכול ומערך עם הצמתים בו.
אובייקט אשכול:
| שדה | סוּג | תיאור |
|---|---|---|
| check_interval | מספר | זהו זמן ההמתנה בין שני בדיקות של מצב הצומת הראשי. |
| כישלון | מחרוזת | איזה צומת יש העדפה להיות הורים. הערכים יכולים להיות שם הצומת, כדי לתת עדיפות הצומת; או נכה, אם כל הצומת יכול להיות הורים ואין עדיפות עבור אחד. |
| ממשק | מחרוזת | ממשק שבו מוגדר IP של הצומת. |
| צמתים | אובייקט [] | צמתים של אשכול. |
אובייקט צומת:
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | זה ה- IP configurated הצומת כדי לבדוק את מצב הצומת ולעשות את שכפול המידע. |
| שם | מחרוזת | זהו המארח הצומת, והוא משמש כמזהה ייחודי הצומת. |
| צומת | מחרוזת | הערכים האפשריים הם: מקומי, אם הצומת הוא אשר מקבל את הבקשה zapi; או מרחוק, אם הוא הצומת השני configurated באשכול. |
הפעל אשכול
הפעל אשכול
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"local_ip":"192.168.100.241","remote_ip":"192.168.100.240","remote_password":"admin"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster
POST /system/cluster
האם אשכול מתקשר לשני בלנסים.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| מרוחק | מחרוזת | IP של המארח המרוחק המשמש לאשכול. | נָכוֹן |
| local_ip | מחרוזת | IP של המארח המקומי המשמש אשכול. | נָכוֹן |
| מילת מפתח מרוחקת | מחרוזת | סיסמת משתמש בסיסית לאיזון מרחוק. | נָכוֹן |
תגובה BODY:
{
"description" : "Enabling cluster",
"message" : "Cluster enabled successfully",
"success" : "true"
}
שינוי תצורת אשכול
שינוי תצורת אשכול
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"check_interval":4,"failback":"disabled"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster
PUT /system/cluster
קביעת פרמטרים של מצב עבודה עבור אשכולות.
פרמטרים של בקשה
| שדה | סוּג | תיאור |
|---|---|---|
| check_interval | מספר | זהו זמן ההמתנה בין שני בדיקות של מצב הצומת הראשי. |
| כישלון | מחרוזת | איזה צומת יש העדפה להיות הורים. הערכים יכולים להיות שם הצומת, כדי לתת עדיפות הצומת; או נכה, אם כל הצומת יכול להיות הורים ואין עדיפות עבור אחד. |
תגובה BODY:
{
"description" : "Modifying the cluster configuration",
"params" : {
"check_interval" : "4",
"failback" : "disabled"
}
}
השבת את האשכול
השבת את האשכול
דוגמה לבקשה:
curl -k -X DELETE -H 'Content-Type: application/json'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster
DELETE /system/cluster
הסר את האשכול.
תגובה BODY:
{
"description" : "Disabling cluster",
"message" : "Cluster disabled successfully",
"success" : "true"
}
מצב תחזוקה
מצב תחזוקה
דוגמה לבקשה:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance","status":"enable"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster/actions
POST /system/cluster/actions
שנה את הצומת המקבצי המקומי למצב תחזוקה.
תגובה BODY:
{
"description" : "Setting maintenance mode",
"message" : "Local cluster node changed to maintenance mode successfully",
"success" : "true"
}
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| פעולה | מחרוזת | פעולה להחיל על אשכול. הפעולה הזמינה היא תחזוקה. | נָכוֹן |
| מצב | מחרוזת | מצב לשים את הצומת, הערכים האפשריים הם לאפשר, לשים אותו במצב תחזוקה; או להשבית, לשים את הצומת זמין. | נָכוֹן |
הצג מצב צמתים
הצג מצב צמתים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster/nodes
GET /system/cluster/nodes
הצג את הסטטוס של כל הצמתים.
תגובה BODY:
{
"description" : "Cluster nodes status",
"params" : [
{
"ip" : "192.168.100.241",
"message" : "Node online and active",
"name" : "canoDEV4100",
"node" : "local",
"role" : "master",
"status" : "ok"
},
{
"ip" : "192.168.100.240",
"message" : "Node online and passive",
"name" : "maqvir",
"node" : "remote",
"role" : "backup",
"status" : "ok"
}
]
}
פרמטרים של תגובה
התגובה תהיה JSON עם מפתח להפסיק ואת הערך מערך של אובייקט מצב הצומת.
אובייקט מצב הצומת
| שדה | סוּג | תיאור |
|---|---|---|
| ip | מחרוזת | זה ה- IP configurated הצומת כדי לבדוק את מצב הצומת ולעשות את שכפול המידע. |
| שם | מחרוזת | זהו המארח הצומת, והוא משמש כמזהה ייחודי הצומת. |
| צומת | מחרוזת | הערכים האפשריים הם: מקומי, אם הצומת הוא אשר מקבל את הבקשה zapi; או מרחוק, אם הוא הצומת השני configurated באשכול. |
| הודעה | מחרוזת | הודעה תיאורית המציינת את המצב ואת מצב העבודה של הצומת. |
| תפקיד | מחרוזת | מצב עבודה בפועל של הצומת הזה. הערכים האפשריים הם: אב, הצומת הזה הוא ניהול הקשר בין backends ולקוחות; או גיבוי, הצומת הזה השיב חיבורי סטטוס האב ותצורת המאסטר, והוא בודק כי שירות ראשי עובד. |
| מצב | מחרוזת | ציין אם תהליך מצרר כלשהו נכשל. |
הצג מצב אשכול מקומי
הצג מצב אשכול מקומי
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster/nodes/localhost
GET /system/cluster/nodes/localhost
הצג את המצב של הצומת המקומי.
תגובה BODY:
{
"description" : "Cluster status for localhost",
"params" : {
"message" : "Node online and active",
"name" : "canoDEV4100",
"role" : "master",
"status" : "ok"
}
}
פרמטרים של תגובה
| שדה | סוּג | תיאור |
|---|---|---|
| הודעה | מחרוזת | הודעה תיאורית המציינת את המצב ואת מצב העבודה של הצומת. |
| שם | מחרוזת | זהו המארח הצומת, והוא משמש כמזהה ייחודי הצומת. |
| תפקיד | מחרוזת | מצב עבודה בפועל של הצומת הזה. הערכים האפשריים הם: אב, הצומת הזה הוא ניהול הקשר בין backends ולקוחות; או גיבוי, הצומת הזה השיב חיבורי סטטוס האב ותצורת המאסטר, והוא בודק כי שירות ראשי עובד. |
| מצב | מחרוזת | ציין אם תהליך מצרר כלשהו נכשל. |
RBAC
RBAC הוא הפתרון עבור בקרת גישה מבוססת תפקידים. לכן, Zevenet יכול להיות מנהל ולנהל על ידי תפקידים שונים, להגביל את הגישה תצורות ומשאבים עבור קבוצות.
קבוצה יכולה לראות את המשאבים, החוות וממשקים וירטואליים, כלומר הבעלים. ניתן להגדיר הרשאה אחרת ליישם פעולות על משאבים, אז לדוגמה קבוצה יכולה לנהל משק ועוד אחד יכול לפקח על זה.
שלושה elments משמשים לעבוד עם RBAC: תפקידים, rol הוא קבוצת הרשאות לאלמנטים שונים של איזון עומסים. משתמשים, כל משתמש יוכל לגשת למאזן העומסים עבור API, עבור webgui או שניהם, עם התפקיד של קבוצת המשתמש. קבוצה, היא קבוצה של משתמשים ומערכת של משאבים (חוות וממשקים וירטואליים). יש להקצות תפקיד לקבוצה.
RBAC - משתמשים
משתמש יכול לגשת למאזן העומסים עם התפקיד של קבוצת המשתמשים דרך ה- API, עם ה- zapikey של המשתמש ולהחיל עליו הרשאות zapi, או דרך ה- gui באינטרנט עם שם המשתמש והסיסמה אם למשתמש יש הרשאות של ממשקי אינטרנט.
רשום את המשתמשים
רשום את כל המשתמשים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users
GET /rbac/users
רשימת כל המשתמשים RBAC ותצורות שלהם
דוגמה לתגובה:
{
"description" : "List the RBAC users",
"params" : [
{
"group" : "monitor",
"name" : "sarah",
"webgui_permissions" : "true",
"zapi_permissions" : "true"
},
{
"group" : "system-admin",
"name" : "john",
"webgui_permissions" : "true",
"zapi_permissions" : "true"
},
{
"group" : "web-admin",
"name" : "aaron",
"webgui_permissions" : "true",
"zapi_permissions" : "false"
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים משתמשים, שכל אחד מהם מכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| קבוצה | מחרוזת | זהו שם הקבוצה שבו המשתמש נמצא. המשתמש יכול להיות רק בקבוצה אחת. |
| שם | מחרוזת | שם משתמש, הוא מזהה למשתמש וזה היה אמור לגשת דרך האינטרנט. |
| webgui_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. |
אחזר משתמש
אחזר משתמש
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users/sarah
GET /rbac/users/<name>
הצג את תצורת המשתמש. שם הוא שם המשתמש והוא מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Get the user sarah",
"params" : {
"group" : "monitor",
"name" : "sarah",
"webgui_permissions" : "true",
"zapi_permissions" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים משתמשים, שכל אחד מהם מכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| קבוצה | מחרוזת | זהו שם הקבוצה שבו המשתמש נמצא. המשתמש יכול להיות רק בקבוצה אחת. |
| שם | מחרוזת | שם משתמש, הוא מזהה למשתמש וזה היה אמור לגשת דרך האינטרנט. |
| webgui_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. |
צור משתמש
צור משתמש חדש
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"monica","password":"aCX2kl5m9"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users
POST /rbac/users
צור משתמש, המשתמש נוצר ללא תפקיד וקבוצה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | שם משתמש, הוא מזהה למשתמש וזה היה אמור לגשת דרך האינטרנט. | נָכוֹן |
| סיסמא | מחרוזת | זוהי הסיסמה המשמשת את המשתמש לגשת דרך GUI האינטרנט. | נָכוֹן |
{
"description" : "Create the RBAC user, monica",
"message" : "Added the RBAC user monica",
"params" : {
"user" : {
"group" : "",
"name" : "monica",
"webgui_permissions" : "false",
"zapi_permissions" : "false"
}
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט עם המפתח משתמשים עם תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| קבוצה | מחרוזת | זהו שם הקבוצה שבו המשתמש נמצא. המשתמש יכול להיות רק בקבוצה אחת. |
| שם | מחרוזת | שם משתמש, הוא מזהה למשתמש וזה היה אמור לגשת דרך האינטרנט. |
| webgui_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. |
שנה משתמש
שנה משתמש
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{ "zapi_permissions":"true","webgui_permissions":"true","newpassword":"8fhM42W1","zapikey":"m3dW2MyYt4Hgv3"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users/monica
PUT /rbac/users/<name>
שינוי התצורה של משתמש. שם הוא שם המשתמש והוא מזהה ייחודי.
פרמטרים של בקשה:
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| זאפיקי | מחרוזת | כל משתמש יכול להיות zapikey. עם זה zapikey המשתמש יכול לעשות פעולה דרך zapikey עם ההרשאות של תפקיד המשתמש. . | |
| webgui_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. | |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. | |
| סיסמה חדשה | מחרוזת | סיסמת משתמש חדשה כדי לגשת דרך האינטרנט. |
דוגמה לתגובה:
{
"description" : "Modify the RBAC user monica",
"message" : "Settings were changed successful.",
"params" : {
"group" : "",
"name" : "monica",
"webgui_permissions" : "true",
"zapi_permissions" : "true"
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט משתמש עם תכונות המפתח שלהלן.
| שדה | סוּג | תיאור |
|---|---|---|
| קבוצה | מחרוזת | זהו שם הקבוצה שבו המשתמש נמצא. המשתמש יכול להיות רק בקבוצה אחת. |
| שם | מחרוזת | שם משתמש, הוא מזהה למשתמש וזה היה אמור לגשת דרך האינטרנט. |
| webgui_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| zapi_permissions | מחרוזת | הערכים האפשריים הם: נָכוֹן, על מנת לאפשר גישה לאיזון העומסים באמצעות הזאפי; או שקר, כדי לא לאפשר את הגישה דרך zapi. |
מחק משתמש
מחק משתמש
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users/john
DELETE /rbac/users/<name>
מחיקת משתמש RBAC. שם הוא שם המשתמש והוא מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Delete the RBAC user john",
"message" : "The RBAC user john has been deleted successful.",
"success" : "true"
}
תפקידים -
מבנה התפקיד
דוגמה לתפקיד, כל אלה הם שילוב אפשרי של אובייקטים ופעולות:
{
"params" : {
"activation-certificate" : {
"delete" : "false",
"show" : "false",
"upload" : "false"
},
"alias" : {
"delete" : "false",
"list" : "false",
"modify" : "false"
},
"backup" : {
"apply" : "false",
"create" : "false",
"delete" : "false",
"download" : "false",
"upload" : "false"
},
"certificate" : {
"create" : "false",
"delete" : "false",
"download" : "false",
"show" : "false",
"upload" : "false"
},
"cluster" : {
"create" : "false",
"delete" : "false",
"maintenance" : "false",
"modify" : "false"
},
"farm" : {
"action" : "false",
"create" : "false",
"delete" : "false",
"maintenance" : "false",
"modify" : "false"
},
"farmguardian" : {
"modify" : "false"
},
"interface" : {
"modify" : "false"
},
"interface-virtual" : {
"action" : "false",
"create" : "false",
"delete" : "false",
"modify" : "false"
},
"ipds" : {
"modify" : "false"
},
"log" : {
"download" : "false",
"show" : "false"
},
"notification" : {
"action" : "false",
"modify" : "false",
"show" : "false",
"test" : "false"
},
"rbac-group" : {
"create" : "false",
"delete" : "false",
"list" : "false",
"modify" : "false",
"show" : "false"
},
"rbac-role" : {
"create" : "false",
"delete" : "false",
"modify" : "false",
"show" : "false"
},
"rbac-user" : {
"create" : "false",
"delete" : "false",
"list" : "false",
"modify" : "false",
"show" : "false"
},
"supportsave" : {
"download" : "false"
},
"system-service" : {
"modify" : "false"
}
}
}
תפקיד מגדיר קבוצת הרשאות המוחלת על קבוצה. כל משתמשי הקבוצה יורשים את תפקיד הקבוצה. תפקיד הוא קבוצה של אובייקטים, לכל אובייקט יש פעולות. פעולה יכולה להיות בעלת הערך: "נכון", כדי לאפשר לפעולה או "שקר" לחסום את הפעולה.
לכל אובייקט יש את הפעולות המוצגות בדוגמה לתפקיד. לדוגמא, עבור משק, הפעולות הזמינות הן: "פעולה", "צור", "מחק", "תחזוקה" ו"שנה "; או עבור אובייקט כינוי, הם: "מחק", "רשימה" ו"שנה ".
החפצים
| שדה | תיאור |
|---|---|
| אישור הפעלה | הוא מגדיר פעולות החלות על אישור ההפעלה של Zevenet. |
| כינוי | הוא מגדיר פעולות לניהול התכונה 'כינוי'. |
| גיבוי | הוא מגדיר פעולות לניהול הגיבויים. |
| תעודה | הוא מגדיר פעולות לניהול אישורי SSL. |
| אשכול | הוא מגדיר פעולות לניהול האשכול. |
| משק | הוא מגדיר פעולות לניהול החוות. המשתמש בלבד יוכל לנהל את חוות הקבוצה של המשתמש. |
| חקלאי | הוא מגדיר פעולות לניהול המחאות הבריאות. כדי להחיל חקלאי על החווה, האובייקט הנדרש הוא משק. |
| ממשק | הוא מגדיר פעולות לניהול רשת בתפריט. הממשקים הווירטואליים הם יוצאי דופן, הם מנוהלים על ידי ממשקים וירטואליים אובייקט. |
| ממשק וירטואלי | הוא מגדיר פעולות לניהול הממשקים הווירטואליים. המשתמש בלבד יוכל לנהל את הממשקים של קבוצת המשתמש. |
| ipod | היא מגדירה פעולות לניהול כללי ipds. כדי להחיל כלל על החווה, האובייקט הנדרש הוא משק. |
| היכנס | הוא מגדיר פעולות לניהול יומני איזון העומס. |
| הודעה | הוא מגדיר פעולות לניהול הודעות: התראות ושיטות שנשלחו. |
| rbac הקבוצה | הוא מגדיר פעולות לניהול קבוצות RBAC. |
| rbac- תפקיד | הוא מגדיר פעולות לניהול התפקידים של RBAC. |
| rbac משתמש | הוא מגדיר פעולות לניהול משתמשי RBAC. |
| נת עוצמה | הוא מגדיר פעולות לניהול תומך Zevenet. |
| שירות המערכת | הוא מגדיר פעולות לניהול מרחוק ושירותים מקומיים. |
הפעולות
| שדה | תיאור |
|---|---|
| רשימה | הוא מפרט את האלמנטים הזמינים של אובייקט. |
| לְהַצִיג | היא מחזירה אובייקט ותצורה שלו. |
| להורדה | זה מוריד אובייקט מתוך איזון עומס. |
| להעלות | הוא מעלה אובייקט למאזן העומס. |
| תחזוקה | זה משנה את הסטטוס של אובייקט בין תחזוקה ומעלה. |
| פעולה | הוא מחיל פעולה על האובייקט. לכל אובייקט יש את פעולותיו. |
| לִיצוֹר | הוא יוצר אלמנט חדש עבור סוג של אובייקט. |
| להסיר | הוא מוחק לצמיתות אובייקט. |
| לשנות | הוא משנה את התצורה של אובייקט. לפעמים, אם האובייקט לא את הפעולות: לִיצוֹר, להסיר or פעולה פעולות, פעולות אלה מוחלים על ידי לשנות רשות. |
רשום את התפקידים
רשום את כל התפקידים
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles
GET /rbac/roles
רשום את כל התפקידים של RBAC
דוגמה לתגובה:
{
"description" : "List the RBAC roles",
"params" : [
"example",
"admin",
"monitor"
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של תפקידים שם. כל שם הוא המזהה של תפקיד
אחזר תפקיד
אחזר תפקיד
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles/monitor
GET /rbac/roles/<name>
הצג את תצורת המשתמש. שם הוא שם המשתמש והוא מזהה ייחודי.
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מבנה תפקיד. המפתחות הם אובייקט ההרשאות, המזהים היכן הם יפעלו וכפרמטרים של אובייקט זה הם הפעולות שיש לשלוט בהן. אם לפעולה יש את הערך "נכון", הדבר יתאפשר לתפקיד; אם לפעולה יש את הערך "שקר", הפעולה תיחסם.
צור תפקיד
צור תפקיד חדש
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"web-monitor"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles
POST /rbac/roles
יצירת תפקיד תיצור תפקיד חדש מתבנית עם כל הרשאות שהוגדרו שקר כברירת מחדל.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | שם התפקיד, הוא משמש כמזהה ייחודי. | נָכוֹן |
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מבנה עם ההרשאות. הרשאה היא מפתח שמזהה את האובייקט בו הוא יפעל וכפרמטרים של אובייקט זה הם הפעולות שיש לשלוט בהן. אם לפעולה יש את הערך "נכון", הדבר יתאפשר לתפקיד; אם לפעולה יש את הערך "שקר", הפעולה תיחסם.
שינוי תפקיד
שינוי תפקיד
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d ''{ "ipds":{"action":"true"}, "farm":{"maintenance":"true", "action":"true"} }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles/web-monitor
PUT /rbac/users/<name>
שנה את הרשאות התפקיד. שם הוא שם התפקיד וזהו מזהה ייחודי.
פרמטרים של בקשה:
| שדה | פעולות | תיאור |
|---|---|---|
| אישור הפעלה | להסיר, לְהַצִיג ו להעלות | הוא מגדיר פעולות החלות על אישור ההפעלה של Zevenet. |
| כינוי | להסיר, רשימה ו לשנות | הוא מגדיר פעולות לניהול התכונה 'כינוי'. |
| גיבוי | להגיש מועמדות, לִיצוֹר, להסיר, להורדה ו להעלות | הוא מגדיר פעולות לניהול הגיבויים. |
| תעודה | לִיצוֹר, להסיר, להורדה, לְהַצִיג ו להעלות | הוא מגדיר פעולות לניהול אישורי SSL. |
| אשכול | לִיצוֹר, להסיר, תחזוקה ו לשנות | הוא מגדיר פעולות לניהול האשכול. |
| משק | פעולה, לִיצוֹר, להסיר, תחזוקה ו לשנות | הוא מגדיר פעולות לניהול החוות. המשתמש בלבד יוכל לנהל את חוות הקבוצה של המשתמש. |
| חקלאי | לשנות | הוא מגדיר פעולות לניהול המחאות הבריאות. כדי להחיל חקלאי על החווה, האובייקט הנדרש הוא משק. |
| ממשק | לשנות | הוא מגדיר פעולות לניהול רשת בתפריט. הממשקים הווירטואליים הם יוצאי דופן, הם מנוהלים על ידי ממשקים וירטואליים אובייקט. |
| ממשק וירטואלי | פעולה, לִיצוֹר, להסיר ו לשנות | הוא מגדיר פעולות לניהול הממשקים הווירטואליים. המשתמש בלבד יוכל לנהל את הממשקים של קבוצת המשתמש. |
| ipod | פעולה ו לשנות | היא מגדירה פעולות לניהול כללי ipds. כדי להחיל כלל על החווה, האובייקט הנדרש הוא משק. |
| היכנס | להורדה ו לְהַצִיג | הוא מגדיר פעולות לניהול יומני איזון העומס. |
| הודעה | פעולה, לשנות, לְהַצִיג ו מבחן | הוא מגדיר פעולות לניהול הודעות: התראות ושיטות שנשלחו. |
| rbac הקבוצה | לִיצוֹר, להסיר, רשימה, לשנות ו לְהַצִיג | הוא מגדיר פעולות לניהול קבוצות RBAC. |
| rbac- תפקיד | לִיצוֹר, להסיר, לשנות ו לְהַצִיג | הוא מגדיר פעולות לניהול התפקידים של RBAC. |
| rbac משתמש | לִיצוֹר, להסיר, רשימה, לשנות ו לְהַצִיג | הוא מגדיר פעולות לניהול משתמשי RBAC. |
| נת עוצמה | להורדה | הוא מגדיר פעולות לניהול תומך Zevenet. |
| שירות המערכת | לשנות | הוא מגדיר פעולות לניהול מרחוק ושירותים מקומיים. |
כל סוג של פעולה הסביר להלן:
| פעולה | תיאור |
|---|---|
| רשימה | הוא מפרט את האלמנטים הזמינים של אובייקט. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| לְהַצִיג | היא מחזירה אובייקט ותצורה שלו. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| להורדה | זה מוריד אובייקט מתוך איזון עומס. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| להעלות | הוא מעלה אובייקט למאזן העומס. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| תחזוקה | זה משנה את הסטטוס של אובייקט בין תחזוקה ומעלה. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| פעולה | הוא מחיל פעולה על האובייקט. לכל אובייקט יש את פעולותיו. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| לִיצוֹר | הוא יוצר אלמנט חדש עבור סוג של אובייקט. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| להסיר | הוא מוחק לצמיתות אובייקט. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
| לשנות | הוא משנה את התצורה של אובייקט. לפעמים, אם האובייקט לא את הפעולות: לִיצוֹר, להסיר or פעולה פעולות, פעולות אלה מוחלים על ידי לשנות רשות. נָכוֹן לתת את האישור, שקר כדי להסיר הרשאה. |
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מבנה עם ההרשאות. הרשאה היא מפתח שמזהה את האובייקט בו הוא יפעל וכפרמטרים של אובייקט זה הם הפעולות שיש לשלוט בהן. אם לפעולה יש את הערך "נכון", הדבר יתאפשר לתפקיד; אם לפעולה יש את הערך "שקר", הפעולה תיחסם.
מחק תפקיד
מחק תפקיד
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles/web-monitor
DELETE /rbac/roles/<name>
מחק תפקיד RBAC. שם הוא שם התפקיד וזהו מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Delete the RBAC role web-monitor",
"message" : "The RBAC role web-monitor has been deleted successful.",
"success" : "true"
}
RBAC - קבוצות
קבוצה היא קבוצה של משתמשים עם תפקיד. המשתמשים יכולים ליישם פעולות במשאבים (חוות וממשקים וירטואליים) של הקבוצה שלהם.
רשימת הקבוצות
רשום את כל הקבוצות
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups
GET /rbac/groups
רשום את כל ההגדרות של קבוצות RBAC והגדרות שלהן
דוגמה לתגובה:
{
"description" : "List the RBAC groups",
"params" : [
{
"name" : "system-admin",
"resources" : {
"farms" : [
"webHTTP",
"dns"
],
"interfaces" : [
"eth2:virt",
"eth2:vip"
]
},
"role" : "admin",
"users" : [
"john",
"monica"
]
},
{
"name" : "monitor",
"resources" : {
"farms" : [
"webHTTP",
"mailService"
],
"interfaces" : []
},
"role" : "monitor",
"users" : [
"sarah",
"kevin"
]
}
]
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים קבוצתיים, שכל אחד מהם מכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. |
| משאבים | חפץ | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| תפקיד | מחרוזת | התפקיד הוחל על הקבוצה. כל המשתמשים בקבוצה יורשים את התפקיד הזה. |
| משתמשים | מחרוזת [] | רשימת המשתמשים בקבוצה. שם המשתמשים הוא המזהים הייחודיים שלהם. |
אל האני משאב אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | זוהי רשימה עם חוות חבר של הקבוצה. |
| ממשקים | מחרוזת [] | זוהי רשימה עם ממשקים וירטואליים חבר של הקבוצה. |
אחזר קבוצה
אחזר קבוצה
דוגמה לבקשה:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/system-admin
GET /rbac/groups/<name>
הצג את תצורת הקבוצות. שם הוא שם המשתמש והוא מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Get the group corel7",
"params" : {
"name" : "monitor",
"resources" : {
"farms" : [
"webHTTP",
"mailService"
],
"interfaces" : []
},
"role" : "monitor",
"users" : [
"sarah",
"kevin"
]
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט קבוצתי, המכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. |
| משאבים | חפץ | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| תפקיד | מחרוזת | התפקיד הוחל על הקבוצה. כל המשתמשים בקבוצה יורשים את התפקיד הזה. |
| משתמשים | מחרוזת [] | רשימת המשתמשים בקבוצה. שם המשתמשים הוא המזהים הייחודיים שלהם. |
אל האני משאב אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | זוהי רשימה עם חוות חבר של הקבוצה. |
| ממשקים | מחרוזת [] | זוהי רשימה עם ממשקים וירטואליים חבר של הקבוצה. |
ליצור קבוצה
צור קבוצה חדשה
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"development"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups
POST /rbac/groups
צור קבוצה חדשה שבה משתמשים, משאבים ותפקידים קשורים.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. | נָכוֹן |
{
"description" : "Create the RBAC group, development",
"message" : "Added the RBAC group development",
"params" : {
"group" : {
"name" : "development",
"resources" : {
"farms" : [],
"interfaces" : []
},
"role" : "",
"users" : []
}
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט קבוצתי, המכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. |
| משאבים | חפץ | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| תפקיד | מחרוזת | התפקיד הוחל על הקבוצה. כל המשתמשים בקבוצה יורשים את התפקיד הזה. |
| משתמשים | מחרוזת [] | רשימת המשתמשים בקבוצה. שם המשתמשים הוא המזהים הייחודיים שלהם. |
אל האני משאב אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | זוהי רשימה עם חוות חבר של הקבוצה. |
| ממשקים | מחרוזת [] | זוהי רשימה עם ממשקים וירטואליים חבר של הקבוצה. |
שנה קבוצה
שנה קבוצה
דוגמה לבקשה:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{ "role":"true"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development
PUT /rbac/groups/<name>
שינוי התצורה של קבוצה. שם הוא שם הקבוצה והוא מזהה ייחודי.
פרמטרים של בקשה:
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| תפקיד | מחרוזת | זה התפקיד להחיל על הקבוצה. |
דוגמה לתגובה:
{
"description" : "Create the RBAC group, development",
"message" : "Added the RBAC group development",
"params" : {
"group" : {
"name" : "development",
"resources" : {
"farms" : [],
"interfaces" : []
},
"role" : "monitor",
"users" : []
}
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט קבוצתי, המכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. |
| משאבים | חפץ | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| תפקיד | מחרוזת | התפקיד הוחל על הקבוצה. כל המשתמשים בקבוצה יורשים את התפקיד הזה. |
| משתמשים | מחרוזת [] | רשימת המשתמשים בקבוצה. שם המשתמשים הוא המזהים הייחודיים שלהם. |
אל האני משאב אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | זוהי רשימה עם חוות חבר של הקבוצה. |
| ממשקים | מחרוזת [] | זוהי רשימה עם ממשקים וירטואליים חבר של הקבוצה. |
מחק קבוצה
מחק משתמש
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development
DELETE /rbac/groups/<name>
מחיקת משתמש RBAC. שם הוא שם המשתמש והוא מזהה ייחודי.
דוגמה לתגובה:
{
"description" : "Delete the RBAC group development",
"message" : "The RBAC group development has been deleted successful.",
"success" : "true"
}
הוסף משאב או משתמש לקבוצה
הוסף משאב או משתמש לקבוצה
דוגמה לבקשה:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"monica"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development/users
POST /rbac/groups/<name>/(interfaces|farms|users)
הפרמטר uri שם הוא שם הקבוצה.
בחר משתמשים ב uri להוסיף משתמש לקבוצה. בחר חוות ב uri להוסיף חווה לקבוצה. בחר ממשקים ב uri להוסיף ממשק וירטואלי לקבוצה.
פרמטרים של בקשה
| שדה | סוּג | תיאור | דרוש |
|---|---|---|---|
| שם | מחרוזת | זה השם של האובייקט להוספה לקבוצה | נָכוֹן |
דוגמה לתגובה:
{
"description" : "Add the user monica to the group development",
"message" : "Added the user monica to the group development",
"params" : {
"group" : {
"name" : "development",
"resources" : {
"farms" : [],
"interfaces" : []
},
"role" : "monitor",
"users" : [
"monica"
]
}
}
}
פרמטרים של תגובה
התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה אובייקט קבוצתי, המכיל את תכונות המפתח להלן.
| שדה | סוּג | תיאור |
|---|---|---|
| שם | מחרוזת | שם הקבוצה, הוא מזהה לקבוצה. |
| משאבים | חפץ | הערכים האפשריים הם: נָכוֹן, כדי לאפשר גישה לאיזון העומס דרך ממשק האינטרנט; או שקר, כדי לא לאפשר את הגישה דרך האינטרנט. |
| תפקיד | מחרוזת | התפקיד הוחל על הקבוצה. כל המשתמשים בקבוצה יורשים את התפקיד הזה. |
| משתמשים | מחרוזת [] | רשימת המשתמשים בקבוצה. שם המשתמשים הוא המזהים הייחודיים שלהם. |
אל האני משאב אובייקט:
| שדה | סוּג | תיאור |
|---|---|---|
| חוות | מחרוזת [] | זוהי רשימה עם חוות חבר של הקבוצה. |
| ממשקים | מחרוזת [] | זוהי רשימה עם ממשקים וירטואליים חבר של הקבוצה. |
מחק משאב או משתמש מקבוצה
מחק משאב או משתמש מקבוצה
דוגמה לבקשה:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development/users/monica
DELETE /rbac/groups/<name>/(interfaces|farms|users)/<name>
הפרמטר הראשון uri שם הוא שם הקבוצה. הפרמטר השני uri שם הוא משאב או שם משתמש.
בחר משתמשים ב uri כדי להסיר משתמש מהקבוצה. בחר חוות ב uri כדי להסיר את החווה מהקבוצה. בחר ממשקים ב uri להסיר ממשק וירטואלי מהקבוצה.
דוגמה לתגובה:
{
"description" : "Removing the user monica from the group development",
"message" : "The user monica has been unlinked successful from the group development.",
"success" : "true"
}