NAV نافبار
الشعار
قذيفة

Zevenet API v3.2 Reference

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 سوف يكون الحصول على, سأعين, ضع or حذف. يحتاج طلب PUT أو POST دائمًا إلى معلمة تقريبًا على الرغم من أن هذا لا يحتاج إلى أي معلمة مطلوبة.

الشهادات

يدعم Zevenet cetificates في تنسيق PEM لاستخدامها مع مزارع HTTP الخاصة بك مع موزع رسائل HTTPS. إذا كنت ترغب في معرفة المزيد عن كيفية إنشاء شهادات 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 خيط اسم المجال الشائع.
خلق خيط تاريخ الإنشاء.
الانتهاء خيط تاريخ إنتهاء الصلاحية.
ملف خيط اسم الملف للشهادة ، المعرف الفريد.
المصدر خيط سلطة معتمدة توقيع الشهادة.
نوع خيط المسؤولية الاجتماعية للشركات أو الشهادة.

تحميل الشهادة

تحميل الشهادة

طلب مثال:

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

احذف شهادة التنشيط المثبتة في مخزن الشهادات. إذا تم حذف هذه الشهادة ، فسيتم إلغاء تحميل Load Balancer.

مثال على الاستجابة:

{
   "description" : "Delete activation certificate",
   "message" : "The activation certificate has been deleted",
   "success" : "true"
}

قم بإنشاء شهادة CSR

قم بإنشاء شهادة CSR

طلب مثال:

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 ، هذه الشهادة مطلوبة لتمكين جميع الوظائف. يتم حفظ هذه الشهادة في مخزن الشهادات ، إذا كانت شهادة التنشيط موجودة في مخزن الشهادات ، فستكون الشهادة السابقة فوق مبالغة.

مثال على الاستجابة:

{
   "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 لا يتوفر جهاز chiper إلا إذا كان مدعومًا من المعالج.

ستكون الاستجابة كائن 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 موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
الأصفار خيط يتم استخدامه كمعرف فريد.
وصف خيط اسم مألوف.

المزارع

بإمكان Zevenet إدارة حركة المرور بثلاث طرق مختلفة ، حيث يتم إدارة كل طريقة بواسطة وحدة مختلفة ، أو موازن حمل الخدمة المحلي أو وحدة LSLB ، أو موازن الحمل العالمي للخدمة أو وحدة GSLB ووحدة ربط تحميل خدمة Datalink أو وحدة DSLB.

تعمل جميع الوحدات مع مفهوم فارم بروفيل ، والملف الشخصي للمزرعة هو مجموعة من المعلمات جاهزة للقيام بعمل معين مع حركة مرور الشبكة ، من المهم أن نفهم ما هو قادر على القيام بكل ملف تعريف مزرعة من أجل الحصول على أفضل النتائج من Zevenet ADC.

قائمة جميع المزارع

قائمة جميع المزارع

طلب مثال:

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

GET /farms

قائمة جميع المزارع المتاحة

ستكون الاستجابة كائن JSON مع ضبط مفتاح على params. ستكون قيمة هذا مجموعة من كائنات استئناف المجال ، كل منها يحتوي على سمات المفتاح أدناه.

كائن المزرعة

الحقل النوع الوصف
farmname خيط اسم وصفي مزرعة. يتم استخدامه كتعريف فريد.
البيانات الشخصية خيط نوع الملف الشخصي ، القيم المتاحة في الملف الشخصي هي: HTTP, HTTPS or l4xnat لوحدة LSLB ، gslb لوحدة GLSB و وصلة البيانات لوحدة DSLB
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
كبار الشخصيات خيط عنوان IP ظاهري حيث تتلقى المزرعة حركة المرور
vport خيط المنفذ الافتراضي حيث تستقبل المزرعة حركة المرور ، والقيم المتاحة للمنفذ هي: رقم منفذ لملفات تعريف http [s] و l4xnat و gslb ، أو مجموعة من المنافذ مفصولة بعلامة "،" أو نطاق منفذ مفصول بـ ":" لملفات تعريف l4xnat ، l4xn في كلتا القيم الفاصلة ("،" و ":") يمكن استخدامها في نفس الحقل.

مثال على الاستجابة:

{
   "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>

حذف مزرعة من خلال معرف المزرعة الخاص به.

مثال على الاستجابة:

{
  "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 (أو وحدة تحكم تسليم التطبيقات) ذات خصائص خاصة بالوكيل. يقدم هذا التوصيف بعض الميزات مثل موازنة تحميل HTTPS طبقة 7 والمدمجة مع تسريع إلغاء تحميل SSL. يتم تخصيص هذا الملف الشخصي لخدمات الويب (يتم تضمين خوادم تطبيقات الويب) وكافة بروتوكولات التطبيق التي تعتمد على بروتوكولات HTTP و HTTPS مثل WebDav و RDP عبر HTTP و ICA عبر 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 بالتنسيق أدناه.

كائن المزرعة:

الحقل النوع الوصف
IPDS هدف قائمة قواعد IPDS المطبقة على هذه المزرعة.
params هدف معلمات التكوين الزراعي.
الخدمات موضوع[] صفيف مع جميع الخدمات التي تم إنشاؤها في هذه المزرعة وتكوينها.

كائن IPDS:

الحقل النوع الوصف
القوائم السوداء موضوع[] قواعد القوائم السوداء المطبقة على المزرعة.
دوس موضوع[] قواعد DoS تطبيقها على المزرعة.
ربل موضوع[] قواعد RBL تطبيقها على المزرعة.

القائمة السوداء و DoS و RBL:

الحقل النوع الوصف
الاسم خيط اسم القاعدة.
الحالة خيط حالة القاعدة.

كائن المعلمات لمزارع HTTP:

الحقل النوع الوصف
addheader موضوع[] وهي قائمة بالكائنات ذات الرؤوس التي تريد إضافتها إلى الواجهة الخلفية.
certlist موضوع[] فقط في ملف https. قائمة الشهادات التي تم تنشيطها في المزرعة ، بتنسيق pem ، يُسمح لها بإضافة أكثر من شهادة Pem واحدة إلى نفس المزرعة لدعم SNI. مطلوب المستمع مع قيمة HTTPS. يمكن استخدام أي شهادة في مخزن الشهادات هنا.
cipherc خيط فقط في المستمع https. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها بواسطة اتصال SSL ، وهي سلسلة بنفس التنسيق كما هو الحال في الأصفار OpenSSL. يستخدم هذا السهم فقط عندما الأصفار المجال لديه قيمة sutomsecurity.
الأصفار خيط فقط في المستمع مع قيمة HTTPS. تستخدم لإنشاء قائمة من الأصفار المقبولة بواسطة اتصالات SSL لتصلب اتصال SSL. الخيارات هي: من جميع، سيتم قبول جميع الأصفار. حماية عالية، سيتم قبول الأصفار للأمن العالي فقط ؛ customsecurity، فقط الأصفار تحميلها cipherc سيتم قبول المجال أو ssloffloading، فإنه يؤول مهمة تشفير للعملية ، يعتمد هذا التشفير على المعالج.
contimeout رقم الهاتف إلى متى ستنتظر المزرعة اتصال TCP إلى الواجهة الخلفية في ثوانٍ.
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 خيط رسالة مخصصة للاستجابة لرمز خطأ HTTP 414.
error500 خيط رسالة مخصصة للاستجابة لرمز خطأ HTTP 500.
error501 خيط رسالة مخصصة للاستجابة لرمز خطأ HTTP 501.
error503 خيط رسالة مخصصة للاستجابة لرمز خطأ HTTP 503.
headremove موضوع[] إنها قائمة بالكائنات ذات الأنماط لإزالة الرأس من طلبات العميل.
httpverb خيط يشير هذا الحقل إلى العمليات التي سيتم السماح بها لطلبات عميل HTTP. القيم المتاحة هي: standardHTTP، قبول طلبات http GET ، POST ، HEAD. extendedHTTPقبول طلبات http السابقة بالإضافة إلى PUT و DELETE. standardWebDAV، قبول طلبات http السابقة بالإضافة إلى LOCK ، UNLOCK ، PROPFIND ، PROPPATCH ، SEARCH ، MKCOL ، MOVE ، COPY ، OPTIONS ، TRACE ، MKACTIVITY ، CHECKOUT ، MERGE ، REPORT ، MSextWebDAV قبول طلبات http السابقة بالإضافة إلى الاشتراك أو إلغاء الاشتراك أو الإخطار أو BPROPFIND أو BPROPPATCH أو POLL أو BMOVE أو BCOPY أو BDELETE أو CONNECT أو MSRPCextقبول طلبات http السابقة بالإضافة إلى RPC_IN_DATA ، RPC_OUT_DATA. لاحظ أن تلك القيم تحسس حالة الأحرف.
ignore_100_continue خيط إذا كان هذا المجال لديه القيمة صحيح ال استمر 100 سيتم تجاهل رأس HTTP ؛ إذا كانت القيمة زائفأطلقت حملة استمر 100 سيكون رأس العملية.
مستمع خيط يحدد المستمع كيف ستقوم المزرعة باللعب مع الطلبات الواردة من العملاء. الخيارات هي: HTTP لبروتوكول غير آمن أو HTTPS للبروتوكول المؤمن.
الجذوع خيط المزرعة بتسجيل أثر اتصالات HTTP. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
reqtimeout رقم الهاتف إلى متى ستنتظر المزرعة طلب العميل في ثوانٍ.
restimeout رقم الهاتف إلى متى ستنتظر المزرعة استجابة من الخلفيات في ثوانٍ.
resurrectime رقم الهاتف فترة الخروج من الخادم الحقيقي الساقط ، بعد هذه الفترة يتحقق توازن التحميل إذا كان الخادم الحقيقي على قيد الحياة ، في ثوانٍ.
rewritelocation خيط إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، نشط معاقأو غير نشط أو تمكين الخلفيات تتم مقارنة فقط عنوان الخلفية.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.

كائن الشهادة

الحقل النوع الوصف
ملف خيط اسم الشهادة ، مراجع للشهادة في مخزن الشهادات.
id رقم الهاتف معرف الشهادة ، الترتيب الموجود في القائمة ، سيتم استخدام أول واحد بشكل افتراضي إذا كان رأس المضيف الظاهري لا يتطابق مع حقل CN في الشهادة. تستخدم مع SNI.

كائن الخدمات لمزارع HTTP:

الحقل النوع الوصف
الخلفيات موضوع[] الخلفيات المحددة في الخدمة.
cookiedomain خيط سيتم تنفيذ ملف تعريف الارتباط إذا كان النطاق مطابقًا في محتوى ملف تعريف الارتباط. مكن cookieinsert الحقل مطلوب.
cookieinsert خيط تمكن من إدراج ملف تعريف الارتباط للجلسات اللزجة الخلفية. الخيارات هي صحيح، سيبحث الملف الشخصي ملف تعريف الارتباط المحدد في الحقل cookiename، إذا لم يكن موجودًا ، فسيتم إضافة ملف تعريف الارتباط هذا ، زائف، لا يتم اتخاذ إجراءات.
cookiename خيط سيتم استخدام اسم ملف تعريف الارتباط (معرف جلسة العمل) لتحديد عملية لزجة إلى الخلفية. مكن cookieinsert الحقل مطلوب.
cookiepath خيط يدير قيمة مسار ملف تعريف الارتباط لملف تعريف الارتباط المحدد. مكن cookieinsert الحقل مطلوب.
cookiettl رقم الهاتف هذا هو الحد الأقصى لوقت الحياة لملف تعريف الارتباط ، في ثوان. مكن cookieinsert الحقل مطلوب.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.
httpsb خيط تشير هذه المعلمة إلى المزرعة إلى أن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات.
id خيط اسم الخدمة ، لا يمكن تعديله بمجرد إنشاء الخدمة.
leastresp خيط تمكن أقل طريقة موازنة المستجيب. صحيح بشكل فاحش يتحقق الملف الشخصي الذي تستغرقه الخلفية وقتا أقل للرد من أجل إرسال المزيد من الاتصالات لهذا ، زائف الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد.
إصرار خيط تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، اساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM يتم إجراء جلسة المثابرة في قاعدة قيمة في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس.
إعادة توجيه خيط ويتصرف كخلفية خاصة ، حيث يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا. إذا تم تكوين إعادة التوجيه ، فلن تتم إعادة توجيه الطلب إلى الواجهة الخلفية ، فسيتم رد "إعادة التوجيه" إلى العميل بدلاً من ذلك.
redirect_code رقم الهاتف هو رمز HTTP الذي يتم إرجاعه عند تكوين إعادة توجيه. القيم المحتملة هي 301, 302, 307,
redirecttype خيط كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته مع الخيار الافتراضي. إذا إعادة توجيه لم يتم تكوين الحقل ، سيكون هذا الحقل عبارة عن سلسلة فارغة.
معرف جلسة العمل خيط هو متوافرة إذا إصرار الحقل هو URL أو COOKIE أو HEADER ، سيتم البحث في قيمة المعلمة من قبل المزرعة في رأس http وسيتم إدارة جلسة عمل العميل.
sts_status خيط حالة رأس أمان النقل المقيد. لتمكين هذه الميزة ، من الضروري تعيين وحدة إصغاء المزرعة بتنسيق HTTPS. القيم المحتملة هي: صحيح لتمكين التوجيه STS في الخدمة ؛ أو زائف لتعطيل STS التوجيه في الخدمة.
sts_timeout رقم الهاتف الوقت (بالثواني) يتذكر العميل أن الخدمة متوفرة فقط مع HTTS.
TTL رقم الهاتف فقط مع استمرار. تشير هذه القيمة إلى أقصى مدة للحياة لجلسة عمل غير نشطة (الحد الأقصى لعمر الجلسة) في ثوانٍ.
urlp خيط يسمح بتحديد خدمة ويب فيما يتعلق بعنوان URL الذي يطلبه العميل من خلال نمط محدد لعنوان URL والذي سيتم فحصه بناءًا. ويدعم التعبير العادي PCRE.
عشقتك خيط وهي تحدد الشرط الذي يحدده اسم النطاق من خلال نفس IP الظاهري والمنفذ المحدد بواسطة مجموعة HTTP. ويدعم التعبير العادي PCRE.

كائن الخلفية لمزارع HTTP:

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف الخلفية داخل الخدمة المعينة.
ip خيط عنوان IP الخاص بـ Backend حيث يتم تشغيل الخدمة الحقيقية.
ميناء رقم الهاتف منفذ Backend حيث يتم تشغيل الخدمة الحقيقية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
مهلة رقم الهاتف إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. إذا كان النظام الفارغ سيستخدم المعلمة العمومية Backend timeout.
وزن رقم الهاتف إنها قيمة الوزن للخادم الحقيقي الحالي ، وستتلقى الواجهة الخلفية ذات القيمة الأعلى للوزن مزيدًا من الاتصالات. القيمة الافتراضية خالية ، وليس وزنًا خاصًا مستخدمًا لهذه الخلفية. القيم المحتملة من 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 جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم وصفي مزرعة. يتم استخدامه كمعرف فريد. صحيح
البيانات الشخصية خيط الملف الشخصي للمزرعة المنشأة. لمزارع http هو HTTP. صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث سيتم تشغيل الخدمة الافتراضية. يجب تكوين IP المشار إليه في النظام و UP صحيح
vport رقم الهاتف ميناء المزرعة ، حيث ستستمع الخدمة الافتراضية. يجب ألا يكون المنفذ الظاهري ذاته وعنوان 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 محددة.

طلب المعلمات

الحقل النوع الوصف
contimeout رقم الهاتف كم من الوقت ستنتظر المزرعة للاتصال بالخلفية في ثوانٍ.
restimeout رقم الهاتف إلى متى ستنتظر المزرعة استجابة من الخلفيات في ثوانٍ.
resurrectime رقم الهاتف هذه القيمة بالثواني هي فترة إخراج الواجهة الخلفية وتدقيقها إذا كانت على قيد الحياة.
reqtimeout رقم الهاتف إلى متى ستنتظر المزرعة طلب العميل في ثوانٍ.
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 ؛ أو زائف إذا كان
rewritelocation خيط إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، نشط معاقأو غير نشط أو تمكين الخلفيات تتم مقارنة فقط عنوان الخلفية.
httpverb خيط يشير هذا الحقل إلى العمليات التي سيتم السماح بها لطلبات عميل HTTP. القيم المتاحة هي: standardHTTP، قبول طلبات http GET ، POST ، HEAD. extendedHTTPقبول طلبات http السابقة بالإضافة إلى PUT و DELETE. standardWebDAV، قبول طلبات http السابقة بالإضافة إلى LOCK ، UNLOCK ، PROPFIND ، PROPPATCH ، SEARCH ، MKCOL ، MOVE ، COPY ، OPTIONS ، TRACE ، MKACTIVITY ، CHECKOUT ، MERGE ، REPORT ، MSextWebDAV قبول طلبات http السابقة بالإضافة إلى الاشتراك أو إلغاء الاشتراك أو الإخطار أو BPROPFIND أو BPROPPATCH أو POLL أو BMOVE أو BCOPY أو BDELETE أو CONNECT أو MSRPCextقبول طلبات http السابقة بالإضافة إلى RPC_IN_DATA ، RPC_OUT_DATA. لاحظ أن تلك القيم تحسس حالة الأحرف.
ignore_100_continue خيط إذا كان هذا المجال لديه القيمة صحيح ال استمر 100 سيتم تجاهل رأس HTTP ؛ إذا كانت القيمة زائفأطلقت حملة استمر 100 سيكون رأس العملية.
error414 خيط خطأ في رسالة شخصية 414.
error500 خيط خطأ في رسالة شخصية 500.
error501 خيط خطأ في رسالة شخصية 501.
error503 خيط خطأ في رسالة شخصية 503.
مستمع خيط يحدد المستمع كيف ستقوم المزرعة باللعب مع الطلبات الواردة من العملاء. الخيارات هي: HTTP لبروتوكول غير آمن أو HTTPS للبروتوكول المؤمن.
الجذوع خيط المزرعة بتسجيل أثر اتصالات HTTP. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
الأصفار خيط فقط في المستمع مع قيمة HTTPS. تستخدم لإنشاء قائمة من الأصفار المقبولة بواسطة اتصالات SSL لتصلب اتصال SSL. الخيارات هي: من جميع، سيتم قبول جميع الأصفار. حماية عالية، سيتم قبول الأصفار للأمن العالي فقط ؛ customsecurity، فقط الأصفار تحميلها cipherc سيتم قبول المجال أو ssloffloading، فإنه يؤول مهمة تشفير للعملية ، يعتمد هذا التشفير على المعالج.
cipherc خيط فقط في المستمع https. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها بواسطة اتصال SSL ، وهي سلسلة بنفس التنسيق كما هو الحال في الأصفار OpenSSL. يستخدم هذا السهم فقط عندما الأصفار المجال لديه قيمة sutomsecurity.
newfarmname خيط اسم المزرعة الجديد. يجب إيقاف المزرعة.
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.
كبار الشخصيات خيط 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

ستضيف المزرعة رأس الصفحة إلى الواجهة الخلفية.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط هو عبارة عن سلسلة مع العنوان الذي سيتم إرساله إلى الواجهة الخلفية. صحيح

مثال على الاستجابة:

{
   "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>

قم بحذف الشهادة التي تحمل اسم الملف المحدد من قائمة الشهادات في مزرعة 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 طريقة تبديل المحتوى لتقديم العديد من خدمات الويب مع خصائص مختلفة ، أو طرق الدعم ، أو حتى الاستمرار ، من خلال بعض الشروط الحتمية التي يستخدمها مركز المزرعة من أجل مطابقة الخدمة الصحيحة لكل طلب عميل. سيتم استخدام تعريف الخدمة هذا بواسطة المزرعة لتحديد الخوادم الخلفية التي يمكنها تقديم الاستجابة إلى العميل.

استرجاع الخدمة عن طريق ID

استرجاع الخدمة عن طريق ID

طلب مثال:

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:

الحقل النوع الوصف
الخلفيات موضوع[] الخلفيات المحددة في الخدمة.
cookiedomain خيط سيتم تنفيذ ملف تعريف الارتباط إذا كان النطاق مطابقًا في محتوى ملف تعريف الارتباط. مكن cookieinsert الحقل مطلوب.
cookieinsert خيط تمكن من إدراج ملف تعريف الارتباط للجلسات اللزجة الخلفية. الخيارات هي صحيح، سيبحث الملف الشخصي ملف تعريف الارتباط المحدد في الحقل cookiename، إذا لم يكن موجودًا ، فسيتم إضافة ملف تعريف الارتباط هذا ، زائف، لا يتم اتخاذ إجراءات.
cookiename خيط سيتم استخدام اسم ملف تعريف الارتباط (معرف جلسة العمل) لتحديد عملية لزجة إلى الخلفية. مكن cookieinsert الحقل مطلوب.
cookiepath خيط يدير قيمة مسار ملف تعريف الارتباط لملف تعريف الارتباط المحدد. مكن cookieinsert الحقل مطلوب.
cookiettl رقم الهاتف هذا هو الحد الأقصى لوقت الحياة لملف تعريف الارتباط ، في ثوان. مكن cookieinsert الحقل مطلوب.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.
httpsb خيط تشير هذه المعلمة إلى المزرعة إلى أن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات.
id خيط اسم الخدمة ، لا يمكن تعديله بمجرد إنشاء الخدمة.
leastresp خيط تمكن أقل طريقة موازنة المستجيب. صحيح بشكل فاحش يتحقق الملف الشخصي الذي تستغرقه الخلفية وقتا أقل للرد من أجل إرسال المزيد من الاتصالات لهذا ، زائف الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد.
إصرار خيط تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، اساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM يتم إجراء جلسة المثابرة في قاعدة قيمة في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس.
إعادة توجيه خيط ويتصرف كخلفية خاصة ، حيث يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا. إذا تم تكوين إعادة التوجيه ، فلن تتم إعادة توجيه الطلب إلى الواجهة الخلفية ، فسيتم رد "إعادة التوجيه" إلى العميل بدلاً من ذلك.
redirect_code رقم الهاتف هو رمز HTTP الذي يتم إرجاعه عند تكوين إعادة توجيه. القيم المحتملة هي 301, 302, 307,
redirecttype خيط كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته مع الخيار الافتراضي. إذا إعادة توجيه لم يتم تكوين الحقل ، سيكون هذا الحقل عبارة عن سلسلة فارغة.
معرف جلسة العمل خيط هو متوافرة إذا إصرار الحقل هو URL أو COOKIE أو HEADER ، سيتم البحث في قيمة المعلمة من قبل المزرعة في رأس http وسيتم إدارة جلسة عمل العميل.
sts_status خيط حالة رأس أمان النقل المقيد. لتمكين هذه الميزة ، من الضروري تعيين وحدة إصغاء المزرعة بتنسيق HTTPS. القيم المحتملة هي: صحيح لتمكين التوجيه STS في الخدمة ؛ أو زائف لتعطيل STS التوجيه في الخدمة.
sts_timeout رقم الهاتف الوقت (بالثواني) يتذكر العميل أن الخدمة متوفرة فقط مع HTTS.
TTL رقم الهاتف فقط مع استمرار. تشير هذه القيمة إلى أقصى مدة للحياة لجلسة عمل غير نشطة (الحد الأقصى لعمر الجلسة) في ثوانٍ.
urlp خيط يسمح بتحديد خدمة ويب فيما يتعلق بعنوان URL الذي يطلبه العميل من خلال نمط محدد لعنوان URL والذي سيتم فحصه بناءًا. ويدعم التعبير العادي PCRE.
عشقتك خيط وهي تحدد الشرط الذي يحدده اسم النطاق من خلال نفس IP الظاهري والمنفذ المحدد بواسطة مجموعة HTTP. ويدعم التعبير العادي PCRE.

كائن الخلفية لمزارع HTTP:

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف الخلفية داخل الخدمة المعينة.
ip خيط عنوان IP الخاص بـ Backend حيث يتم تشغيل الخدمة الحقيقية.
ميناء رقم الهاتف منفذ Backend حيث يتم تشغيل الخدمة الحقيقية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
مهلة رقم الهاتف إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. إذا كان النظام الفارغ سيستخدم المعلمة العمومية Backend timeout.
وزن رقم الهاتف إنها قيمة الوزن للخادم الحقيقي الحالي ، وستتلقى الواجهة الخلفية ذات القيمة الأعلى للوزن مزيدًا من الاتصالات. القيمة الافتراضية خالية ، وليس وزنًا خاصًا مستخدمًا لهذه الخلفية. القيم المحتملة من 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 خيط يسمح بتحديد خدمة ويب فيما يتعلق بعنوان URL الذي يطلبه العميل من خلال نمط محدد لعنوان URL والذي سيتم فحصه بناءًا. ويدعم التعبير العادي PCRE.
إعادة توجيه خيط يعمل كخلفية خاصة ، يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا.
redirect_code رقم الهاتف هو رمز HTTP الذي يتم إرجاعه عند تكوين إعادة توجيه. القيم المحتملة هي 301, 302, 307,
redirecttype خيط كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته في إعادة توجيه حقل. سينطبق هذا السلوك فقط إذا إعادة توجيه ليست قيمة فارغة.
cookieinsert خيط تمكن من إدراج ملف تعريف الارتباط للجلسات اللزجة الخلفية. الخيارات هي صحيح، سيبحث الملف الشخصي ملف تعريف الارتباط المحدد في الحقل cookiename، إذا لم يكن موجودًا ، فسيتم إضافة ملف تعريف الارتباط هذا ، زائف، يتم تعطيل ملف تعريف ارتباط الإدراج.
cookiename خيط سيتم استخدام اسم ملف تعريف الارتباط (معرف جلسة العمل) لتحديد عملية لزجة إلى الخلفية. مكن cookieinsert الحقل مطلوب.
cookiedomain خيط سيتم تنفيذ ملف تعريف الارتباط إذا كان النطاق مطابقًا في محتوى ملف تعريف الارتباط. مكن cookieinsert الحقل مطلوب.
cookiepath خيط يدير قيمة مسار ملف تعريف الارتباط لملف تعريف الارتباط المحدد ، إذا لم يتطابق عنوان URL في طلب العميل أو استجابة الخلفية مع ملف تعريف الارتباط ، فلن يتم تطبيق طريقة استمرار إدراج ملف تعريف الارتباط. ممكن cookieinsert الحقل مطلوب.
cookiettl رقم الهاتف هذا هو الحد الأقصى لوقت الحياة لملف تعريف الارتباط ، في ثوان. مكن cookieinsert الحقل مطلوب.
إصرار خيط تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، اساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM تتم جلسة المثابرة على أساس قيمة مفصولة بعلامة "؛" في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس.
TTL رقم الهاتف فقط مع استمرار. أقصى وقت للحياة لجلسة عمل غير نشطة (الحد الأقصى لعمر الجلسة) في ثوانٍ.
معرف جلسة العمل خيط هو متوافرة إذا إصرار الميدان هو URL, كوكي or HEADER، سيتم البحث في قيمة المعلمة بواسطة ملف التعريف في رأس http وسيدير ​​جلسة عمل العميل.
sts_status خيط حالة رأس أمان النقل المقيد. لتمكين هذه الميزة ، من الضروري تعيين وحدة إصغاء المزرعة بتنسيق HTTPS. القيم المحتملة هي: صحيح لتمكين التوجيه STS في الخدمة ؛ أو زائف لتعطيل STS التوجيه في الخدمة.
sts_timeout رقم الهاتف الوقت (بالثواني) يتذكر العميل أن الخدمة متوفرة فقط مع HTTS.
leastresp خيط تمكن أقل طريقة موازنة المستجيب. صحيحبشكل فاحش ، يتحقق الملف الشخصي من الخلفية التي تستغرق وقتًا أقل للرد من أجل إرسال المزيد من الاتصالات إلى هذا الشخص ، زائف، الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد.
httpsb خيط يشير إلى المزرعة بأن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات.

مثال على الاستجابة:

{
   "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 - خدمات - الخلفيات

قائمة الخلفية

قائمة الخلفية

طلب مثال:

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

الحصول على قائمة الخلفية في الخدمة. 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
      }
   ]
}

معلمات الاستجابة

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف فريد للواجهة الخلفية في الخدمة. يتم إنشاء هذا المعرف من قبل النظام.
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية.
مهلة رقم الهاتف إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان.
وزن رقم الهاتف إنها قيمة الوزن للواجهة الخلفية الحالية. القيم المحتملة من 1 إلى 9.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

إنشاء الخلفية الجديدة

إنشاء الخلفية الجديدة

طلب مثال:

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

إنشاء خلفية جديدة في ملف تعريف HTTP محدد. id هو معرف الخدمة الفريد.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ip خيط IP الخاص بـ 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 مع المعلمات المطلوبة المحدثة و الحالة المجال مع هناك حاجة لإعادة التشغيل قيمة إذا كان يجب إعادة تشغيل المزرعة. يجب اتخاذ إجراء إعادة التشغيل لتطبيق التغييرات.

تعديل الخلفية

تعديل الخلفية

طلب مثال:

 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>

قم بتعديل معلمات الخلفية في خدمة ملف تعريف HTTP.

الاسم الأول id هو معرف الخدمة الفريد ، التالي id هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف
ip خيط IP الخاص بـ 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 هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف مطلوب:
عمل خيط حدد الإجراء المطلوب. الإجراءات هي: up الخلفية جاهزة لاستقبال طلبات العميل ، صيانة الخلفية ليست جاهزة لتلقي طلبات العميل ، وهذا الإجراء مفيد لإيقاف خادم الواجهة الخلفية دون التأثير على العملاء.
طريقة خيط اختر وضع الصيانة. الخيارات المتاحة هي: استنزاف، لا تقبل الواجهة الخلفية اتصالات جديدة ، لكنها ستستمر في التعامل مع الاتصالات الحالية ؛ أو قطع، سيتم إغلاق الاتصالات الحالية. إذا لم يتم تحديد هذا الحقل ، فسيكون الوضع الافتراضي استنزاف.

مثال على الاستجابة:

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

حذف الخلفية

حذف الخلفية

طلب مثال:

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>

احذف خلفية معينة في خدمة ملف تعريف HTTP.

الاسم الأول id هو معرف الخدمة الفريد ، التالي id هو معرف فريد الخلفية.

مثال على الاستجابة:

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

مزارع L4xNAT

تسمح مجموعة الملف الشخصي L4xNAT بإنشاء مزرعة L4 بأداء عالٍ جدًا وتوصيلات أكثر تواصلاً من نوى موازن الحمل في طبقة 7 مثل ملفات تعريف مزرعة HTTP. يعوق تحسين أداء طبقة 4 معالجة المحتوى المتقدم التي يمكن أن تديرها ملفات تعريف طبقة 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>

عرض جميع التهيئة حول مزرعة معينة.

جسم الرد:

{
   "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 بالتنسيق أدناه.

كائن المزرعة:

الحقل النوع الوصف
IPDS هدف قائمة قواعد IPDS المطبقة على هذه المزرعة.
params هدف معلمات التكوين الزراعي.
الخلفيات موضوع[] جميع الخوادم الحقيقية التي تم إنشاؤها في هذه المزرعة وتكوينها.

كائن IPDS:

الحقل النوع الوصف
القوائم السوداء موضوع[] قواعد القائمة السوداء تطبق على المزرعة.
دوس موضوع[] قواعد DoS تطبيقها على المزرعة.
ربل موضوع[] قواعد RBL تطبيقها على المزرعة.

القائمة السوداء و DoS و RBL:

الحقل النوع الوصف
الاسم خيط اسم القاعدة.
الحالة خيط حالة القاعدة.

كائن معلمات لمزارع L4xNAT:

الحقل النوع الوصف
خوارزمية خيط نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: leastconn اتصال دائم إلى أقل خادم اتصال ، وزن اتصال خطي الإرسال حسب الوزن ، PRIO اتصالات دائما إلى معظم prio المتاحة.
مستمع خيط يحدد المستمع كيف ستلعب المزرعة بطلبات العملاء. المعلومات لا يمكن تعديله.
الجذوع خيط معلومات حزمة سجلات المزرعة لطبقة النقل ، فهي لا تتوفر معلومات طبقة التطبيق. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
nattype خيط كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات تسمى أيضًا وضع sNAT ، تستجيب الواجهة الخلفية لموازن التحميل من أجل إرسال الاستجابة إلى العميل ، DNAT الخلفية سوف تستجيب مباشرة إلى العميل ، يجب أن يتم تكوين موازن التحميل كبوابة في الخادم الخلفي.
إصرار خيط سيتم توصيل عنوان IP نفسه بنفس الخادم. الخيارات هي: "" قيمة فارغة ، يتم تعطيل المثابرة ، ip يتم تمكين استمرار من خلال ، يتم استخدام IP المصدر مثل معرف فريد في الجلسة.
بروتوكول خيط البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيقوم الملف الشخصي بتحميل التوازن لأي بروتوكول L4 ، برنامج التعاون الفني موازن التحميل فقط سوف يوازن بروتوكول TCP L4 ، UDP موازن التحميل فقط سيوازن بروتوكول UDP L4 ، رشفة موازن التحميل فقط سيوازن بروتوكول SIP أو VoIP L7 ، بروتوكول نقل الملفات موازن التحميل فقط سيوازن بروتوكول FTP L7 ، المبسط موازن التحميل فقط سيوازن بروتوكول TFTP L7.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
TTL رقم الهاتف تشير قيمة الحقل هذه إلى عدد الثواني التي يتم تعيين استمرارها بين مصدر العميل والخلفية ، بالثواني. يجب تكوين المثابرة.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. يمكن أن يكون المنفذ الفريد محددًا ، يمكن تعيين منفذ مجموعة باستخدام فاصل : وعدة منافذ يمكن أن تكون محددة مع فاصل ,.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.

الكائن الخلفي للمزارع L4xNAT:

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف لتعريف الواجهة الخلفية في المزرعة.
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 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 جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم المزرعة ، معرف فريد. صحيح
البيانات الشخصية خيط الملف الشخصي للمزرعة المنشأة. للمزارع L4xNAT هو l4xnatرسالة معلومات لا يمكن تغيير هذه القيمة صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية. صحيح
vport خيط ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. تسمح مزارع L4xNAT بفصل المنفذ المتعدد عن بعضها البعض , أو منفذ النطاق مفصولة :. صحيح

مثال على الاستجابة:

{
   "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 خيط اسم المزرعة الجديد. يجب إيقاف المزرعة.
خوارزمية خيط نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: leastconn اتصال دائم إلى أقل خادم اتصال ، وزن اتصال خطي الإرسال حسب الوزن ، PRIO اتصالات دائما إلى معظم prio المتاحة.
الجذوع خيط معلومات حزمة سجلات المزرعة لطبقة النقل ، فهي لا تتوفر معلومات طبقة التطبيق. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
nattype خيط كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات تسمى أيضًا وضع sNAT ، تستجيب الواجهة الخلفية لموازن التحميل من أجل إرسال الاستجابة إلى العميل ، DNAT الخلفية سوف تستجيب مباشرة إلى العميل ، يجب أن يتم تكوين موازن التحميل كبوابة في الخادم الخلفي.
إصرار خيط سيتم توصيل عنوان IP نفسه بنفس الخادم. الخيارات هي: "" قيمة فارغة ، يتم تعطيل المثابرة ، ip يتم تمكين استمرار من خلال ، يتم استخدام IP المصدر مثل معرف فريد في الجلسة.
بروتوكول خيط البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيقوم الملف الشخصي بتحميل التوازن لأي بروتوكول L4 ، برنامج التعاون الفني موازن التحميل فقط سوف يوازن بروتوكول TCP L4 ، UDP موازن التحميل فقط سيوازن بروتوكول UDP L4 ، رشفة موازن التحميل فقط سيوازن بروتوكول SIP أو VoIP L7 ، بروتوكول نقل الملفات موازن التحميل فقط سيوازن بروتوكول FTP L7 ، المبسط موازن التحميل فقط سيوازن بروتوكول TFTP L7.
TTL رقم الهاتف تشير قيمة الحقل هذه إلى عدد الثواني التي يتم تعيين استمرارها بين مصدر العميل والخلفية ، بالثواني. يجب تكوين المثابرة.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. يمكن أن يكون المنفذ الفريد محددًا ، يمكن تعيين منفذ مجموعة باستخدام فاصل : وعدة منافذ يمكن أن تكون محددة مع فاصل ,.

مثال على الاستجابة:

{
   "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 - الخلفية

قائمة الخلفية

قائمة الخلفية

طلب مثال:

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

الحصول على قائمة الخلفية في الخدمة.

مثال على الاستجابة:

{
   "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
      },
   ]
}

معلمات الاستجابة

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف لتعريف الواجهة الخلفية في المزرعة.
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
max_conns رقم الهاتف إنه أقصى عدد من الاتصالات المتزامنة للواجهة الخلفية. إذا كان هذا الحقل يحتوي على القيمة 0 ، فإن الواجهة الخلفية لم تقم بتكوين أي حد للاتصال.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 1 هي الأكثر أولوية و 9 هي الأقل أولوية.
وزن رقم الهاتف إنها قيمة الوزن للخادم الحقيقي الحالي. الخلفية ذات الوزن الأكبر ستتلقى المزيد من الوصلات. القيم المحتملة من 1 إلى 9.

إنشاء الخلفية الجديدة

إنشاء الخلفية الجديدة

طلب مثال:

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

إنشاء الخلفية الجديدة في مزرعة L4xNAT معينة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. صحيح
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
max_conns رقم الهاتف إنه أقصى عدد من الاتصالات المتزامنة للواجهة الخلفية. إذا كان هذا الحقل يحتوي على القيمة 0 ، فإن الواجهة الخلفية لم تقم بتكوين أي حد للاتصال.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 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 مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

تعديل الخلفية

تعديل الخلفية

طلب مثال:

 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>

تعديل معلمات الخلفية في خدمة L4xNAT Farm. id هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
max_conns رقم الهاتف إنه أقصى عدد من الاتصالات المتزامنة للواجهة الخلفية. إذا كان هذا الحقل يحتوي على القيمة 0 ، فإن الواجهة الخلفية لم تقم بتكوين أي حد للاتصال.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 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

تعيين إجراء معين في الخلفية من مزرعة L4xNAT. id هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف
عمل خيط حدد الإجراء المطلوب. الإجراءات هي: up الخلفية جاهزة لاستقبال طلبات العميل ، صيانة الخلفية ليست جاهزة لتلقي طلبات العميل ، وهذا الإجراء مفيد لإيقاف خادم الواجهة الخلفية دون التأثير على العملاء.
طريقة خيط اختر وضع الصيانة. الخيارات المتاحة هي: استنزاف، لا تقبل الواجهة الخلفية اتصالات جديدة ، لكنها ستستمر في التعامل مع الاتصالات الحالية ؛ أو قطع، سيتم إغلاق الاتصالات الحالية.

مثال على الاستجابة:

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

معلمات الاستجابة

سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

حذف الخلفية

حذف الخلفية

طلب مثال:

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>

حذف الخلفية المعطاة في خدمة مزرعة L4xNAT.

id هو معرف فريد الخلفية.

مثال على الاستجابة:

{
   "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 بالتنسيق أدناه.

كائن المزرعة:

الحقل النوع الوصف
IPDS هدف قائمة قواعد IPDS المطبقة على هذه المزرعة.
params هدف معلمات التكوين الزراعي.
الخدمات موضوع[] صفيف مع جميع الخدمات التي تم إنشاؤها في هذه المزرعة وتكوينها.
المناطق موضوع[] صفيف مع جميع المناطق التي تم إنشاؤها في هذه المزرعة وتكوينها.

كائن IPDS:

الحقل النوع الوصف
القوائم السوداء موضوع[] القوائم السوداء تطبق على المزرعة.
دوس موضوع[] قواعد DoS تطبيقها على المزرعة.
ربل موضوع[] قواعد RBL تطبيقها على المزرعة.

القائمة السوداء و DoS و RBL:

الحقل النوع الوصف
الاسم خيط اسم القاعدة.
الحالة خيط حالة القاعدة.

كائن المعلمة لمزارع GSLB:

الحقل النوع الوصف
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، المزرعة متروك وجميع الخلفيات غير قابلة للوصول ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.

كائن الخدمة لمزارع GSLB:

الحقل النوع الوصف
الخلفيات موضوع[] الخلفيات المحددة في الخدمة.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى. سجلات Farmguardian غير متوفرة لمزارع GSLB
id خيط اسم الخدمة الذي يتم استخدامه كمعرّف فريد.
خوارزمية خيط نوع من خوارزمية موازنة التحميل المستخدمة في الخدمة. الخيارات هي: roundrobin، والتي سوف توازن بين الاتصالات amoung جميع الخلفيات ، أو PRIO التي سترسل جميع الاتصالات إلى الخلفية المتاحة الأولى.
deftcpport رقم الهاتف افتراضي فحص منفذ TCP. هذا هو منفذ TCP للتحقق من الصحة الذي ستقوم الخدمة بفحصه لتحديد أن خدمة الواجهة الخلفية على قيد الحياة. يتم تعطيل قيمة فارغة.

الكائن الخلفي للمزارع GSLB:

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف فريد للواجهة الخلفية في الخدمة. يتم إنشاء هذا المعرف من قبل النظام.
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

كائن المنطقة:

الحقل النوع الوصف
id رقم الهاتف يستخدم اسم المنطقة كمُحدد فريد.
defnamesv خيط سيكون هذا هو خادم اسم جذر نقطة الإدخال الذي سيكون متاحًا كسجل DNS الخاص بسجل بدء التشغيل (SOA).
موارد موضوع[] المصادر محددة في المنطقة.

كائن المورد:

الحقل النوع الوصف
id رقم الهاتف معرف فريد للمصدر في المنطقة.
rname خيط اسم المورد هو النك الذي ستترجمه خدمة DNS للبيانات المطلوبة الحقيقية في هذا المجال rdata.
TTL رقم الهاتف قيمة وقت البقاء (اختياري) للسجل الحالي المطلوب تحديد مدة التخزين المؤقت للاسم الحالي.
نوع خيط نوع سجل DNS. الخيارات هي: NS, A, AAAA, CNAME, داينا, 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 جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم مزرعة ، معرف فريد للمزرعة. صحيح
البيانات الشخصية خيط الملف الشخصي للمزرعة المنشأة. لمزارع GSLB هو gslb. صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية. صحيح
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. صحيح

مثال على الاستجابة:

{
   "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 خيط اسم المزرعة الجديد. يجب إيقاف المزرعة للقيام بهذا التغيير.
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.
كبار الشخصيات خيط 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

الحقل النوع الوصف
الخلفيات موضوع[] الخلفيات المحددة في الخدمة.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.
id خيط اسم الخدمة الذي يتم استخدامه كمعرّف فريد.
خوارزمية خيط نوع من خوارزمية موازنة التحميل المستخدمة في الخدمة. الخيارات هي: roundrobin، والتي سوف توازن بين الاتصالات amoung جميع الخلفيات ، أو PRIO التي سترسل جميع الاتصالات إلى الخلفية المتاحة الأولى.
deftcpport خيط افتراضي فحص منفذ TCP. هذا هو منفذ TCP للتحقق من الصحة الذي ستقوم الخدمة بفحصه لتحديد أن خدمة الواجهة الخلفية على قيد الحياة. يتم تعطيل قيمة فارغة.

قم بإنشاء خدمة جديدة

قم بإنشاء خدمة جديدة

طلب مثال:

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 خيط اسم الخدمة الذي يتم استخدامه كمعرّف فريد. صحيح
خوارزمية خيط نوع من خوارزمية موازنة التحميل المستخدمة في الخدمة. الخيارات هي: roundrobin، والتي سوف توازن بين الاتصالات amoung جميع الخلفيات ، أو PRIO التي سترسل جميع الاتصالات إلى الخلفية المتاحة الأولى. صحيح

مثال على الاستجابة:

{
   "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 للتحقق من الصحة الذي ستقوم الخدمة بفحصه لتحديد أن خدمة الواجهة الخلفية على قيد الحياة.

مثال على الاستجابة:

{
   "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 - الخدمات - الخلفيات

سيقوم هذا القسم بإدارة قائمة الخدمات الحقيقية المرتبطة بالخدمة.

قائمة الخلفية

قائمة الخلفية

طلب مثال:

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

الحصول على قائمة الخلفية في الخدمة. 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"
      }
   ]
}

معلمات الاستجابة

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف فريد للواجهة الخلفية في الخدمة. يتم إنشاء هذا المعرف من قبل النظام.
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

إنشاء الخلفية الجديدة

إنشاء الخلفية الجديدة

طلب مثال:

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

إنشاء الخلفية الجديدة في خدمة معينة في مزرعة GSLB. id هو المعرف الفريد للخدمة حيث ستتم إضافة الواجهة الخلفية.

تشتمل الخدمات ذات الأولوية على 2 backends كـ maximun والمضيف النشط والمضيف السلبي.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية. صحيح

مثال على الاستجابة:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 4,
      "ip" : "192.135.10.2"
   },
   "status" : "needed restart"
}

معلمات الاستجابة

سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

تعديل الخلفية

تعديل الخلفية

طلب مثال:

 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>

تعديل معلمات الخلفية في خدمة من مزرعة GSLB.

ملاحظة في PUT فوق ذلك الأول id هو معرف الخدمة الفريد والقادم id هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.

مثال على الاستجابة:

{
   "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 مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

حذف الخلفية

حذف الخلفية

طلب مثال:

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>

حذف خلفية معينة في خدمة من مزرعة 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.

معلمات الطلب

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف مطلوب:
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 هو المعرّف الفريد للمنطقة والذي سيتم تعديله.

معلمات الطلب

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف
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 هي:

  1. NS. اسم سجل نوع الخادم ، يقوم بتفويض منطقة DNS لاستخدام خوادم الأسماء الموثوقة المعينة.
  2. A. سجل نوع العنوان ، تقوم بإرجاع عنوان IPv4 لمضيف.
  3. CNAME. سجل نوع الاسم الكنسي ، فإنه يمثل اسم مستعار لاسم معين.
  4. داينا. سجل نوع العنوان الديناميكي ، تقوم بإرجاع عنوان ديناميكي محدد بواسطة خدمة GSLB تم إنشاؤها بالفعل داخل تكوين المزرعة وفقًا للخوارزمية المحددة لهذه الخدمة.
  5. AAAA. سجل نوع العنوان ، تقوم بإرجاع عنوان IPv6 لمضيف.
  6. MX. سجل نوع تبادل البريد ، يقوم بتعيين اسم مجال إلى قائمة بعوامل نقل الرسائل لهذا المجال.
  7. SRV. سجل نوع محدد مواقع الخدمة ، سجل موقع خدمة عام ، يُستخدم للبروتوكولات الأحدث بدلاً من إنشاء سجلات خاصة بالبروتوكول مثل MX.
  8. TXT. سجل نوع النص ، يتم استخدامه لتخزين أي معلومات نصية يمكن استئصالها عند الضرورة. نشاهد في الغالب سجلات TXT المستخدمة لحفظ بيانات SPF وإثبات ملكية النطاق.
  9. PTR. سجل المؤشر ، المؤشر إلى اسم متعارف عليه. بخلاف CNAME ، تتوقف معالجة DNS ويتم إرجاع الاسم فقط. الاستخدام الأكثر شيوعًا هو تنفيذ عمليات البحث العكسي عن نظام أسماء النطاقات.
  10. 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, AAAA, CNAME, داينا, 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 رقم الهاتف قيمة وقت البقاء للسجل الحالي. هذا هو أقصى عدد من أجهزة التوجيه التي يمكن أن الطلب من خلال سمسم يموت. من المفيد أن الحزمة لا تدخل في حلقة الشبكة.
نوع خيط نوع سجل DNS. الخيارات هي: NS, A, AAAA, CNAME, داينا, MX, SRV, TXT, PTR or NAPTR). لمزيد من المعلومات ، انظر في GSLB - المناطق - الموارد والقسم الخاص به. صحيح
rdata خيط إنها البيانات الحقيقية التي يحتاجها نوع السجل ، حيث تعتمد قيمة الإدخال على نوع اسم المورد ، rname ونوع المورد ، نوع. إذا داينا تم اختياره نوع ثم يجب أن تكون قيمة 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, AAAA, CNAME, داينا, MX, SRV, TXT, PTR or NAPTR). لمزيد من المعلومات ، انظر في GSLB - المناطق - الموارد والقسم الخاص به.
rdata خيط إنها البيانات الحقيقية التي يحتاجها نوع السجل ، حيث تعتمد قيمة الإدخال على نوع اسم المورد ، rname ونوع المورد ، نوع. إذا نوع يتم تحميلها مع القيمة داينا then 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 بإنشاء مزرعة تستند إلى المسارات حيث تكون backend أجهزة توجيه أو بوابات للوصلة الصاعدة. هذا النوع من التشكيل الجانبي للمزرعة جاهز لمشاركة العديد من عمليات الوصول إلى موجه WAN للوصلة الصاعدة باستخدام موازن الحمل كمرسل متعدد القنوات في القناة الصاعدة (دخل 1 والعديد من مخرجات خط الموجه). لذلك ، يمكن استخدام مزارع ارتباطات البيانات كواجهات اتصالات عالية متاحة ويمكن بالإضافة إلى ذلك استخدام زيادة عرض النطاق الترددي في ضم مقدار عرض النطاق الترددي بين روابط أجهزة التوجيه الخلفية.

استرجاع المزرعة بالاسم

استرجاع المزرعة بالاسم

طلب مثال:

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 بالتنسيق أدناه.

كائن المزرعة:

الحقل النوع الوصف
IPDS هدف قائمة قواعد IPDS المطبقة على هذه المزرعة.
params هدف معلمات التكوين الزراعي.
الخلفيات موضوع[] خوادم حقيقية تم إنشاؤها في هذه المزرعة وتكوينها.

كائن IPDS:

الحقل النوع الوصف
القوائم السوداء خيط[] القوائم السوداء تطبق على المزرعة.

كائن المعلمات لمزارع ربط البيانات:

الحقل النوع الوصف
خوارزمية خيط نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: وزنيوزع الموازن بين جميع الخلفيات المتاحة مع زيادة الشحنات الخلفية مع زيادة الوزن PRIOوالتي ترسل جميع الاتصالات إلى الخلفية مع القيمة الثانوية الأولوية.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، المزرعة متروك وجميع الخلفيات غير قابلة للوصول ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.

الكائن الخلفي لمزارع ربط البيانات:

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف فريد للواجهة الخلفية في المزرعة.
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.
الواجهة خيط إنها واجهة الشبكة المحلية حيث يتم توصيل الخلفية.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. سيتم استخدامه عندما خوارزمية الحقل هو التكوين كما prio والأولوية الأقل سيكون لها تفضيل
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
وزن رقم الهاتف إنها قيمة الوزن للخادم الحقيقي الحالي. سيتم استخدامه عندما خوارزمية الحقل هو التكوين كالوزن.

إنشاء مزرعة جديدة

إنشاء مزرعة جديدة

طلب مثال:

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 جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم المزرعة ، معرف فريد. صحيح
البيانات الشخصية خيط الملف الشخصي للمزرعة المنشأة. لمزارات قاتلة هو وصلة البيانات صحيح
كبار الشخصيات خيط 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 خيط اسم المزرعة الجديد. يجب أن تتوقف المزرعة.
خوارزمية خيط نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: وزنيوزع الموازن بين جميع الخلفيات المتاحة مع زيادة الشحنات الخلفية مع زيادة الوزن PRIOوالتي ترسل جميع الاتصالات إلى الخلفية مع القيمة الثانوية الأولوية.
كبار الشخصيات خيط 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>

تطبيق قاعدة قائمة سوداء للمزرعة. لا يقبل ملف ارتباط daticink إلا قواعد القائمة السوداء.

طلب المعلمات

الحقل النوع الوصف
الاسم خيط يستخدم اسم قاعدة 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 - الخلفية

الخلفيات في مزارع ربط البيانات هي بوابات من خلال توجيه الخدمة. وستكون الخدمة متعددة الإرسال بين هذه البوابات ، وبعضها غير متوفر ، بينما تستخدم الخدمة الأخرى (الأفرقة).

قائمة الخلفية

قائمة الخلفية

طلب مثال:

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

الحصول على قائمة الخلفية في الخدمة.

مثال على الاستجابة:

[
   {
      "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
   }
]

معلمات الاستجابة

تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.

الحقل النوع الوصف
الاسم المستعار خيط ومن النك للمساعدة في تحديد الخلفية. الاسم المستعار
id رقم الهاتف معرف فريد للواجهة الخلفية في المزرعة. يتم إنشاء هذا المعرف من قبل النظام.
الواجهة خيط إنها واجهة الشبكة المحلية حيث يتم توصيل الخلفية.
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للواجهة الخلفية الحالية. سيتم استخدامه عندما خوارزمية الحقل هو التكوين كما هو الحال والأولوية الأقل سيكون لها تفضيل.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ غير محدد، لم يتم التحقق من حالة الخلفية.
وزن رقم الهاتف إنها قيمة الوزن للواجهة الخلفية الحالية. سيتم استخدامه عندما خوارزمية الحقل هو التكوين كالوزن.

إنشاء الخلفية الجديدة

إنشاء الخلفية الجديدة

طلب مثال:

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

إنشاء الخلفية الجديدة في مزرعة datalink معينة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية. صحيح
الواجهة خيط إنها واجهة الشبكة المحلية حيث يتم توصيل الخلفية. صحيح
الأولوية رقم الهاتف انها قيمة الأولوية للخادم الحقيقي الحالي.سيستخدم عندما خوارزمية الحقل هو التكوين كما هو الحال والأولوية الأقل سيكون لها تفضيل. القيمة الافتراضية هي 1.
وزن رقم الهاتف إنها قيمة الوزن للواجهة الخلفية الحالية. سيتم استخدامه عندما خوارزمية الحقل هو التكوين كالوزن. القيمة الافتراضية هي 1.

مثال على الاستجابة:

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

معلمات الاستجابة

سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

تعديل الخلفية

تعديل الخلفية

طلب مثال:

 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>

تعديل المعلمات من الخلفية في خدمة من مزرعة وصلة. id هو معرف فريد الخلفية.

طلب المعلمات

الحقل النوع الوصف
ip خيط IP من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.
الواجهة خيط إنها واجهة الشبكة المحلية حيث يتم توصيل الخلفية.
الأولوية رقم الهاتف إنها الأولوية الخلفية للاستجابة لطلب معين.
وزن رقم الهاتف إنها قيمة الوزن للواجهة الخلفية الحالية.

مثال على الاستجابة:

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

معلمات الاستجابة

سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

حذف الخلفية

حذف الخلفية

طلب مثال:

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>

حذف الخلفية المعطاة في خدمة من مزرعة datalink. id هو معرف فريد الخلفية.

مثال على الاستجابة:

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

شبكة

Zevenet يمكن أن تعمل مع أنواع مختلفة من واجهات الشبكة.

في هذا القسم ، يمكنك سرد وإنشاء وتكوين وحذف وتعيين إجراء في NIC و VLAN والواجهات الظاهرية والترابطية.

NIC: أو بطاقة واجهة الشبكة ، هو مكون أجهزة الكمبيوتر ونوع tis من الواجهة هو الأساس للنوع التالي من الواجهات التي يمكن تعريفها وإدارتها في Zevenet.

شبكة محلية ظاهرية: أو بطاقة lan الظاهرية هي واجهة أو واجهة شبكة اتصال توفر خدمات تجزئة الشبكة. يمكن إنشاء أكثر من vlan من خلال واجهة 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.
قناع الشبكة خيط قناع الشبكة للواجهة. لا يمكن تعديل هذه القيمة في واجهات ظاهرية ، بل يتم توريثها من inteface الأصل.
بوابة خيط بوابة الواجهة. لا يمكن تعديل هذه القيمة في واجهات ظاهرية ، بل يتم توريثها من inteface الأصل.
لجنة الهدنة العسكرية خيط ماك من واجهة. يتم توارث هذه القيمة من أول NIC التابع في واجهات الترابط. في الواجهات الظاهرية و VLAN ، يتم توارثها من واجهة الأصل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
نوع خيط نوع مختلف من واجهات: NIC, شبكة محلية ظاهرية, واقعي 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

حذف تكوين تكوين العبّارة الافتراضية.

تحذير: إذا تم إلغاء تشكيل العبارة ، لن يكون Zevenet قابلة للوصول من شريحة شبكة خارجية.

حذف تكوين البوابة

طلب مثال:

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

رسالة الرد

إذا كانت البوابة هي disconfigure من نفس مقطع الشبكة ، ستظهر هذه الرسالة ، وإلا سوف يفقد الاتصال.

مثال على الاستجابة:

{
   "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 يستخدم لإرسال الحزم إلى مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط طبقة فريدة من نوعها indentifier. إنه غير قابل للتعديل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون 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 يستخدم لإرسال الحزم إلى مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط طبقة فريدة من نوعها indentifier. إنه غير قابل للتعديل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
نوع خيط نوع مختلف من واجهات: NIC, شبكة محلية ظاهرية, واقعي 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 مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

شبكة - واجهات الربط

توفر واجهة ربط Linux أو التي يطلق عليها أيضًا بائعون آخرون باسم Trunk طريقة لتجميع واجهات متعددة للشبكة في واجهة منطقية واحدة "مُرْتَسَمة". يعتمد سلوك الواجهات المرتبطة على الوضع ، يعتمد Zevenet Load Balancer الطرق التالية:

سياسة Round-robin: نقل الحزم بالترتيب التسلسلي من أول الرقيق المتوفر خلال الأخير. يوفر هذا الوضع موازنة الحمل والتسامح مع الخطأ.

سياسة النسخ الاحتياطي النشط: نشط واحد فقط في السند نشط. يصبح الرقيق مختلفًا إذا لم ينجح العبد النشط ، وفقط إذا حدث ذلك. يكون عنوان MAC الخاص بالوصلة مرئيًا من الخارج على منفذ واحد فقط (محول الشبكة) لتجنب إرباك المفتاح. يوفر هذا الوضع التسامح مع الخطأ. يؤثر الخيار الأساسي على سلوك هذا الوضع.

سياسة XOR: الإرسال استنادًا إلى عنوان MAC المصدر XOR'd بعنوان MAC الوجهة. هذا يحدد نفس العبد لكل عنوان MAC للوجهة. يوفر هذا الوضع موازنة الحمل والتسامح مع الخطأ.

سياسة البث: ينقل كل شيء على جميع واجهات الرقيق. يوفر هذا الوضع التسامح مع الخطأ.

IEEE 802.3ad LACP: ينشئ مجموعات التجميع التي تشترك في نفس السرعة وإعدادات الطباعة المزدوجة. يستخدم جميع العبيد في التجميع النشط وفقًا لمواصفات 802.3ad.

الشروط المسبقة:

  1. دعم واجهة الشبكة في برامج التشغيل الأساسية لاسترداد السرعة ودوبلكس لكل من الرقيق.

  2. محول يدعم تجميع الارتباط الديناميكي لـ 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 يستخدم لإرسال الحزم من مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط طبقة فريدة من نوعها indentifier. انها لجنة الهدنة العسكرية من أول عبد واجهة NIC.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
السلافية موضوع[] أعضاء واجهة NIC من inteface الترابط.
طريقة خيط هذا هو وضع العمل لواجهة الترابط. الخيارات هي: ميزان ص ص، سياسة Round-robin نشط النسخ الاحتياطي، سياسة النسخ الاحتياطي النشط ؛ ميزان XORسياسة XOR بثسياسة البث 802.3ad، IEEE 802.3ad LACP؛ ميزان يقول:، موازنة تحميل نقل مواكبة ؛ ميزان الرداء، موازنة تحميل التكيف. يتم تعريف هذه القيم في القسم شبكة - واجهات الربط.

العبيد وجوه:

الحقل النوع الوصف
الاسم خيط الاسم هو معرف فريد لواجهة NIC slave.

استرداد واجهة الترابط

استرداد واجهة الترابط

طلب مثال:

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 يستخدم لإرسال الحزم من مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط طبقة فريدة من نوعها indentifier. انها لجنة الهدنة العسكرية من أول عبد واجهة NIC.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
السلافية موضوع[] أعضاء واجهة NIC من inteface الترابط.
طريقة خيط هذا هو وضع العمل لواجهة الترابط. الخيارات هي: ميزان ص ص، سياسة Round-robin نشط النسخ الاحتياطي، سياسة النسخ الاحتياطي النشط ؛ ميزان XORسياسة XOR بثسياسة البث 802.3ad، IEEE 802.3ad LACP؛ ميزان يقول:، موازنة تحميل نقل مواكبة ؛ ميزان الرداء، موازنة تحميل التكيف. يتم تعريف تلك القيم في الشبكة> واجهات الربط.

عبد موضوع:

الحقل النوع الوصف
الاسم خيط الاسم هو معرف فريد لواجهة NIC slave.

إنشاء واجهة الربط

إنشاء واجهة الربط

طلب مثال:

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 الأولى. لا يمكن تغيير وضع الربط عندما يتم إنشاء واجهة الترابط ، ولكن يمكن إضافة واجهات الأعضاء أو حذفها في واجهة الربط حسب الحاجة. سيتم قفل واجهة NIC إذا كانت جزءًا من واجهة الربط.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة. صحيح
السلافية خيط[] جميع واجهات NIC التي تبني الترابط. مطلوب معلمة NIC الاسم. صحيح
طريقة خيط هذا هو وضع العمل لواجهة الترابط. الخيارات هي: ميزان ص ص، سياسة Round-robin نشط النسخ الاحتياطي، سياسة النسخ الاحتياطي النشط ؛ ميزان XORسياسة XOR بثسياسة البث 802.3ad، IEEE 802.3ad LACP؛ ميزان يقول:، موازنة تحميل نقل مواكبة ؛ ميزان الرداء، موازنة تحميل التكيف. يتم تعريف تلك القيم في الشبكة> واجهات الربط. صحيح

مثال على الاستجابة:

{
   "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 مع معلمات تكوين الرابطة.

الحقل النوع الوصف
لجنة الهدنة العسكرية خيط طبقة فريدة من نوعها indentifier. انها لجنة الهدنة العسكرية من أول عبد واجهة NIC.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
السلافية موضوع[] واجهات NIC التي تبني inteface الترابط.
طريقة خيط هذا هو وضع العمل لواجهة الترابط. الخيارات هي: ميزان ص ص، سياسة Round-robin نشط النسخ الاحتياطي، سياسة النسخ الاحتياطي النشط ؛ ميزان XORسياسة XOR بثسياسة البث 802.3ad، IEEE 802.3ad LACP؛ ميزان يقول:، موازنة تحميل نقل مواكبة ؛ ميزان الرداء، موازنة تحميل التكيف. يتم تعريف تلك القيم في الشبكة> واجهات الربط.

عبد موضوع:

الحقل النوع الوصف
الاسم خيط الاسم هو معرف فريد لواجهة NIC slave.

تعديل واجهة الربط

تعديل واجهة الربط

طلب مثال:

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 من الواجهة. يمكن أن يكون مختلفًا عن inteface IP.
قناع الشبكة خيط حدد جزء الشبكة حيث تعمل الواجهة.
بوابة خيط IP يستخدم لإرسال الحزم من مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط ماك من واجهة. هذه القيمة موروثة من الواجهة الأصلية.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من اسم الواجهة الأصل ، وهو حرف النقطة "." ورقم لواجهة شبكة 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 يستخدم لإرسال الحزم من مقطع شبكة مختلف.
لجنة الهدنة العسكرية خيط ماك من واجهة. هذه القيمة موروثة من الواجهة الأصلية.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من اسم واجهة أصل ، وهو حرف النقطة "." ورقم لواجهة شبكة 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 من الواجهة. يجب أن يكون مختلفًا عن 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 من الواجهة. يمكن أن يكون مختلفًا عن 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 يستخدم لإرسال الحزم من مقطع شبكة مختلف. يرث من واجهة الأصل.
لجنة الهدنة العسكرية خيط ماك من واجهة. يرث من واجهة الأصل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من واجهة رئيسية ، حرف النقطتين ":" واسم واجهة الشبكة الافتراضية ، يُسمح باستخدام الأحرف الأبجدية الرقمية.
أصل خيط هو واجهة المستخدم لإنشاء هذا واحد.
الحالة خيط القيم يمكن أن يكون 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 يستخدم لإرسال الحزم من مقطع شبكة مختلف. يرث من واجهة الأصل.
لجنة الهدنة العسكرية خيط ماك من واجهة. يرث من واجهة الأصل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من واجهة رئيسية ، وحرف النقطتين ":" وسلسلة أبجدية رقمية لواجهة الشبكة الافتراضية.
أصل خيط هو واجهة المستخدم لإنشاء هذا واحد.
الحالة خيط القيم يمكن أن يكون 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 يستخدم لإرسال الحزم إلى مقطع شبكة مختلف. يرث من واجهة الأصل.
لجنة الهدنة العسكرية خيط ماك من واجهة. يرث من واجهة الأصل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من واجهة رئيسية ، وحرف نقطتين ":" وسلسلة أبجدية رقمية لواجهة الشبكة الافتراضية.

تعديل الواجهة الافتراضية

تعديل الواجهة الافتراضية

طلب مثال:

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 مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.

شبكة - واجهات عائمة

يستخدم هذا النوع من الواجهة واجهة افتراضية محددة ويخفي حركة مرور البيانات الصادرة NIC, الرابطة or VLAN واجهة مع طفل واقعي جهة تعامل. يتم استخدام هذه الواجهة لسلوك تجاوز الفشل stateful في التشكيلات الجانبية 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

إظهار كل التوافر أو الواجهات المكونة حيث تم إنشاء عنوان 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 خيط هذا هو الاسم المستعار للواجهة الافتراضية.
floating_ip خيط IP العائم المستخدمة في الواجهة. floating_ip يجب أن تكون موجودة كواجهة واجهة افتراضية لل الواجهة.
الواجهة خيط واجهة ملثمين من قبل IP العائمة.
interface_virtual خيط هو اسم الواجهة الظاهرية لعنوان 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 عائم تمت تهيئته. إذا كان يحتوي على واحد ، فسيظهر هنا.

الاسم هو المعرّف الفريد للواجهة الذي يمكن أن يكون من النوع nic أو bonding أو 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 خيط هذا هو الاسم المستعار للواجهة الافتراضية.
floating_ip خيط IP العائم المستخدمة في الواجهة. floating_ip يجب أن تكون موجودة كواجهة واجهة افتراضية لل الواجهة.
الواجهة خيط واجهة ملثمين من قبل IP العائمة.
interface_virtual خيط هو اسم الواجهة الظاهرية لعنوان 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 أو bonding أو vlan.

طلب المعلمات

الحقل النوع الوصف مطلوب:
floating_ip خيط IP العائم المستخدمة في الواجهة. floating_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 أو bonding أو vlan.

مثال على الاستجابة:

{
   "description" : "Remove floating interface",
   "message" : "The floating interface has been removed.",
   "success" : "true"
}

رصد - FarmGuardian

يستخدم FarmGuardian لدولة رصد متقدمة من الخلفية. عندما يتم اكتشاف مشكلة بواسطة 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 والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف صغير حول الشيك.
المزارع خيط[] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان 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 والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف صغير حول الشيك.
المزارع خيط[] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان 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 والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف صغير حول الشيك.
المزارع خيط[] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان 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 والتنسيق أدناه:

الحقل النوع الوصف مطلوب:
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف صغير حول الشيك.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
القوة خيط إذا كانت مزرعة قيد التشغيل تستخدم 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 والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف صغير حول الشيك.
المزارع خيط[] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان 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>

حذف FarmGuardian.

معامل 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
      }
   }
}

معلمات الاستجابة

الحقل النوع الوصف
وحدة المعالجة المركزية هدف إحصائيات وحدة المعالجة المركزية.
تاريخ خيط تاريخ النظام.
اسم المضيف خيط اسم المضيف.
تحميل هدف إحصائيات الحمولة الأساسية.
ذاكرة هدف إحصائيات الذاكرة المستخدمة.
شبكة هدف إحصائيات حركة مرور الشبكة.

كائن وحدة المعالجة المركزية:

الحقل النوع الوصف
النوى رقم الهاتف عدد النوى في المعالج.
الخمول رقم الهاتف وحدة المعالجة المركزية لا تستخدم من قبل أي برنامج.
iowait رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل عملية الإدخال أو الإخراج.
IRQ رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل الأجهزة interrrupcions.
رحلة جميلة رقم الهاتف أولوية جدولة وحدة المعالجة المركزية.
softirq رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل البرامج interrrupcions.
SYS رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل النظام.
استعمال رقم الهاتف إجمالي وحدة المعالجة المركزية المستخدمة.
المستخدم رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل المستخدم.

تحميل الكائن:

الحقل النوع الوصف
Last_1 رقم الهاتف تحميل نظام التحميل في اللحظة الأخيرة.
Last_5 رقم الهاتف تحميل نظام porgesage قبل خمس دقائق.
Last_15 رقم الهاتف تحميل نظام porgesage قبل خمس عشرة دقيقة.

كائن الذاكرة.

الحقل النوع الوصف
مخازن رقم الهاتف إنها الذاكرة المستخدمة من قبل المخازن المؤقتة. يشار إلى هذا المبلغ في ميغابايت.
مؤقتا رقم الهاتف إنه إجمالي الذاكرة المخزنة مؤقتًا من قبل النظام. يشار إلى هذا المبلغ في ميغابايت.
MemFree رقم الهاتف إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت.
MemTotal رقم الهاتف إنها ذاكرة ذاكرة الوصول العشوائي الكاملة على النظام. يشار إلى هذا المبلغ في ميغابايت.
MemUsed رقم الهاتف إنها الذاكرة المستخدمة من قبل النظام. يشار إلى هذا المبلغ في ميغابايت.
SwapCached رقم الهاتف انها ذاكرة التخزين المؤقت الإجمالية محفوظة.
SwapFree رقم الهاتف إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت.
SwapTotal رقم الهاتف انها الذاكرة المبادلة الإجمالية محفوظة.
SwapUsed رقم الهاتف إنها الذاكرة المستخدمة من قبل النظام ، على الأنظمة المثلى يجب أن تكون 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

احصل على متوسط ​​بالثانية لحركة مرور الإدخال والإخراج من أجل كل وصلة nic و linking و vlan interfaces.

مثال على الاستجابة:

{
   "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 قيمتها عبارة عن كائن بمفاتيح المتابعة:

الحقل النوع الوصف
تاريخ خيط تاريخ النظام.
اسم المضيف خيط اسم المضيف.
واجهات موضوع[] إحصائيات حركة مرور الشبكة.

كائن واجهات

الحقل النوع الوصف
in خيط إجمالي حركة الإدخال بالميغابايت.
الواجهة خيط اسم الواجهة.
خارج خيط مجموع الانتاج trafficin ميغابايت.

عرض إحصائيات الواجهات

عرض إحصائيات الواجهات

طلب مثال:

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 موضوع[] إحصائيات واجهة NIC.

كائن السندات:

الحقل النوع الوصف
in خيط إجمالي حركة الإدخال بالميغابايت.
الواجهة خيط اسم الواجهة المستخدم كمعرّف فريد.
ip خيط IP للواجهة.
لجنة الهدنة العسكرية خيط MAC للواجهة.
خارج خيط إجمالي حركة الإخراج بالميغابايت.
السلافية خيط [] قائمة العبيد التي تبني واجهة السندات.
الحالة خيط حالة الواجهة. يمكن أن تكون القيمة إلى أسفل، تم تعطيل الواجهة ؛ up، يتم تمكين الواجهة.
واقعي خيط [] واجهات الظاهرية التي ترث من هذه الواجهة.
شبكة محلية ظاهرية خيط [] واجهات VLAN التي ترث من هذه الواجهة.

كائن نيك:

الحقل النوع الوصف
in خيط إجمالي حركة الإدخال بالميغابايت.
الواجهة خيط اسم الواجهة المستخدم كمعرّف فريد.
ip خيط IP للواجهة.
لجنة الهدنة العسكرية خيط MAC للواجهة.
خارج خيط إجمالي حركة الإخراج بالميغابايت.
الحالة خيط حالة الواجهة. يمكن أن تكون القيمة إلى أسفل، تم تعطيل الواجهة ؛ up، يتم تمكين الواجهة.
واقعي خيط [] واجهات الظاهرية التي ترث من هذه الواجهة.
شبكة محلية ظاهرية خيط [] واجهات 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 قيمتها هي كائن ذاكرة.

مكبر الصوت : يدعم، مع دعم ميكروفون مدمج لمنع الضوضاء موضوع.

الحقل النوع الوصف
مخازن رقم الهاتف إنها الذاكرة المستخدمة من قبل المخازن المؤقتة. يشار إلى هذا المبلغ في ميغابايت.
مؤقتا رقم الهاتف إنه إجمالي الذاكرة المخزنة مؤقتًا من قبل النظام. يشار إلى هذا المبلغ في ميغابايت.
MemFree رقم الهاتف إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت.
MemTotal رقم الهاتف إنها ذاكرة ذاكرة الوصول العشوائي الكاملة على النظام. يشار إلى هذا المبلغ في ميغابايت.
MemUsed رقم الهاتف إنها الذاكرة المستخدمة من قبل النظام. يشار إلى هذا المبلغ في ميغابايت.
SwapCached رقم الهاتف انها ذاكرة التخزين المؤقت الإجمالية محفوظة.
SwapFree رقم الهاتف إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت.
SwapTotal رقم الهاتف انها الذاكرة المبادلة الإجمالية محفوظة.
SwapUsed رقم الهاتف إنها الذاكرة المستخدمة من قبل النظام ، على الأنظمة المثلى يجب أن تكون 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 رقم الهاتف استخدام نظام التحميل لآخر خمس عشرة دقيقة.
تاريخ خيط تاريخ النظام.
اسم المضيف خيط اسم المضيف.

إظهار إحصائيات وحدة المعالجة المركزية

إظهار إحصائيات وحدة المعالجة المركزية

طلب مثال:

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
   }
}

معلمات الاستجابة

الحقل النوع الوصف
النوى رقم الهاتف عدد النوى في المعالج.
الخمول رقم الهاتف وحدة المعالجة المركزية لا تستخدم من قبل أي برنامج.
iowait رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل عملية الإدخال أو الإخراج.
IRQ رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل الأجهزة interrrupcions.
رحلة جميلة رقم الهاتف أولوية جدولة وحدة المعالجة المركزية.
softirq رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل البرامج interrrupcions.
SYS رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل النظام.
استعمال رقم الهاتف إجمالي وحدة المعالجة المركزية المستخدمة.
المستخدم رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل المستخدم.
تاريخ خيط تاريخ النظام.
اسم المضيف خيط اسم المضيف.

إظهار إحصائيات الاتصالات

إظهار إحصائيات الاتصالات

طلب مثال:

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"
      }
   ]
}

معلمات الاستجابة

الحقل النوع الوصف
أنشئ رقم الهاتف مجموع عدد الاتصالات الحالية.
farmname خيط اسم المزرعة ، معرف فريد.
ريثما رقم الهاتف عدد الاتصالات المعلقة.
البيانات الشخصية خيط نوع المزرعة. القيم المحتملة هي: وصلة البيانات, l4xnat, HTTP, HTTPS or gslb. يتم تعريف كل ملف تعريف في قسمه.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.

عرض إحصائيات المزرعة

عرض إحصائيات المزرعة

طلب مثال:

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>

يعرض حالة المزرعة الحالية وحالة backs الخاصة بهم والاتصالات. سوف تستجيب كل مزرعة مع كائن مختلف ، اعتمادا على ملف التعريف.

مثال الاستجابة لمزرعة 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

الحقل النوع الوصف
الخلفيات موضوع[] عرض معلومات حول الخلفيات.
دورات موضوع[] عرض معلومات حول الجلسات.

كائن الخلفية

الحقل النوع الوصف
أنشئ رقم الهاتف العدد الإجمالي للاتصالات القائمة.
id رقم الهاتف معرف فريد الخلفية.
ip خيط IP حيث تستمع الخدمة الحقيقية.
ريثما رقم الهاتف عدد الاتصالات المعلقة.
ميناء رقم الهاتف الميناء حيث تستمع الخدمة الحقيقية.
خدمة خيط اسم الخدمة المستخدم كمعرّف فريد.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

كائن الجلسة

الحقل النوع الوصف
زبون خيط معرف فريد للعميل.
id خيط الخلفية المعرف الفريد المخصص للعميل.
خدمة خيط معرف فريد للخدمة يتم تعيينه للعميل.
الجلسة خيط معرف فريد للجلسة. هذه القيمة تعتمد على نوع المثابرة.

مثال للاستجابة لمزرعة 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

الحقل النوع الوصف
الخلفيات موضوع[] عرض معلومات حول الخلفيات.
زبون هدف الاحصائيات المتعلقة بالعميل.
مدد هدف معلومات موسعة حول الخدمة.
الخادم هدف الإحصائيات المتعلقة بالخادم.

كائن خلفي

الحقل النوع الوصف
id رقم الهاتف معرف فريد الخلفية.
ip خيط IP حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف الميناء حيث تستمع الخدمة الحقيقية.
خدمة خيط اسم الخدمة المستخدم كمعرّف فريد.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

كائن العميل

الحقل النوع الوصف
edns_big رقم الهاتف الردود التي كانت أكبر من 512 بايت.
edns_tc رقم الهاتف كان حجم المخزن المؤقت لنظام أسماء النطاقات الموسع المحدد للعميل صغيرًا جدًا بالنسبة للبيانات المطلوبة.
recvfail رقم الهاتف عدد أخطاء UDP ، حيث أشار نظام التشغيل إلى حدوث شيء سيء عند استلامه.
reqs رقم الهاتف إجمالي عدد طلبات UDP التي تمت معالجتها بواسطة الخادم.
sendfail رقم الهاتف عدد أخطاء UDP ، حيث أشار نظام التشغيل إلى حدوث أمر سيء عند الإرسال.
tc رقم الهاتف الردود التي تم اقتطاعها مع مجموعة TC bit.

كائن موسع

الحقل النوع الوصف
badvers رقم الهاتف طلب يحتوي على EDNS OPT-RR مع إصدار غير معتمد.
إسقاط رقم الهاتف الطلبات المسقطة للتنسيق غير الصحيح.
edns رقم الهاتف يحتوي الطلب على EDNS OPT-RR.
edns_clientsub رقم الهاتف مجموعة فرعية من طلبات edns التي حددت خيار edns_client_subnet.
formerr رقم الهاتف تم تنسيق الطلب بشكل سيئ ، ولكنه كان عاقلًا إلى حدٍ ما ، بحيث أننا أرسلنا ردًا باستخدام رمز FORDERR.
noerror رقم الهاتف طلبات ناجحة.
notimp رقم الهاتف لم يتم تنفيذ الخدمة المطلوبة بواسطة هذا البرنامج الخفي ، مثل طلبات نقل المنطقة.
NXDOMAIN رقم الهاتف طلب اسم نطاق غير موجود.
رفض رقم الهاتف تم رفض الطلب من قبل الخادم لأن الخادم غير موثوق به لاسم المستعلم.
v6 رقم الهاتف طلب من عميل IPv6.

كائن الخادم

الحقل النوع الوصف
recvfail رقم الهاتف عدد أخطاء TCP ، حيث أشار نظام التشغيل إلى حدوث شيء سيئ عند استلامه.
reqs رقم الهاتف إجمالي عدد طلبات TCP التي تمت معالجتها بواسطة الخادم.
sendfail رقم الهاتف عدد أخطاء 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 مع الكائن الخلفيات و دورات:

كائن خلفي:

الحقل النوع الوصف
أنشئ رقم الهاتف مجموع عدد الاتصالات الحالية.
id رقم الهاتف معرف فريد الخلفية.
ip خيط IP حيث تستمع الخدمة الحقيقية.
ريثما رقم الهاتف عدد الاتصالات المعلقة.
ميناء رقم الهاتف الميناء حيث تستمع الخدمة الحقيقية.
الحالة خيط حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية.

كائن الجلسة:

الحقل النوع الوصف
id رقم الهاتف معرف فريد الخلفية حيث يتم تعيين العميل.
الجلسة خيط معرف فريد للجلسة. هو IP العميل.

إحصائيات مزارع 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, gslb و lslb.

الحقل النوع الوصف
حرج رقم الهاتف عدد المزارع في حالة حرجة. المزرعة حرجة عندما تكون في وضع التشغيل ولا يمكن الوصول إلى جميع الخلفيات (أسفل أو صيانة).
إلى أسفل رقم الهاتف عدد المزارع المتوقفة. يتم إيقاف المزارع من قبل مسؤول النظام.
مشكلة رقم الهاتف عدد المزارع في حالة المشكلة. تعتبر المزرعة مشكلة عندما تكون في وضع التشغيل وتكون الخلفية تقريبًا في حالة منخفضة.
مجموع رقم الهاتف عدد المزارع الكلية.
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>

إظهار إحصائيات المزارع لوحدة نمطية محددة.

القيم المتاحة لل وحدة المعلمة هي: lslb, gslb 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 مع معلومات حول المزارع في الوحدة النمطية.

الحقل النوع الوصف
أنشئ رقم الهاتف مجموع عدد الاتصالات الحالية.
farmname خيط اسم مزرعة ، معرف فريد للمزارع.
ريثما رقم الهاتف عدد الاتصالات المعلقة.
البيانات الشخصية خيط نوع المزرعة. القيم المحتملة هي: وصلة البيانات, l4xnat, HTTP, HTTPS or gslb. يتم تعريف كل ملف تعريف في القسم نفسه.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.

الرصد - الرسوم البيانية

هذا القسم هو مفيد لmonitorize النظام موازن التحميل الداخلي للكشف عن المشاكل من خلال المعلمات من استخدام وحدة المعالجة المركزية والذاكرة المبادلة ذاكرة رام، كل واجهات ارتباط بشبكة تكوين، وتحميل وتخزين على القرص الثابت.

أيضا ، سوف تكون قادرا على الوصول إلى التاريخ الأسبوعية ، mothly والسنوية.

يتم استيفاء الرسوم البيانية مع المعلومات بتنسيق 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 النظام. يحتوي المصفوفة على كائن مع صفيف والذي يشير إلى نقاط تحميل القرص.

كائن النظام:

يحتوي كائن النظام على قائمة مصفوفة مرتبطة بالنظام ، وكائن قرص بالتنسيق التالي.

الحقل النوع الوصف
أسطوانة خيط[] قيم هذه المجموعة كلها موجودة نقاط جبل في النظام ، كل واحد لديه الرسوم البيانية المتاحة.

عرض الرسوم البيانية

عرض الرسوم البيانية

طلب مثال للمزرعة:

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> farmnameوالمعرّف الفريد للمزرعة.
interfaces/<interface> الواجهةواجهة معرف فريد.
system/<system> نظاموالرسوم البيانية الممكنة للنظام هي: وحدة المعالجة المركزية, تحميل, ذاكرة الوصول العشوائي or مقايضة.
system/disk/<mount point> نقطة جبل، هي قيمة أسطوانة تم إرجاعه بواسطة استدعاء "GET / الرسوم البيانية".

مثال على الاستجابة:

{
   "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> farmnameوالمعرّف الفريد للمزرعة.
interfaces/<interface> الواجهةواجهة معرف فريد.
system/<system> نظاموالرسوم البيانية الممكنة للنظام هي: وحدة المعالجة المركزية, تحميل, ذاكرة الوصول العشوائي or مقايضة.
system/disk/<mount point> نقطة جبل، هي قيمة أسطوانة تم إرجاعه بواسطة استدعاء "GET / الرسوم البيانية".

القيم المتاحة لـ تردد هي:

الحقل النوع الوصف
تردد خيط الفترة الزمنية المستخدمة لإنشاء الرسم البياني. القيم المحتملة هي: يوميا, أسبوعي, شهريا or سنويا.

مثال على الاستجابة:

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

معلمات الاستجابة

الحقل النوع الوصف
الرسوم البيانية خيط الرسم البياني بتنسيق 64 الأساسي.

رصد - الأسماء المستعارة

ضع اسمًا مستعارًا على واجهة أو واجهة خلفية لتحديدها بسرعة.

يوجد نوعان من الأسماء المستعارة ، يمكن تطبيق الاسم المستعار للواجهة في جميع أنواع الواجهات: NIC أو الربط أو الشبكة المحلية الظاهرية أو الظاهرية. إنها طريقة سهلة لربط اسم الواجهة باسم أكثر ودية.

النوع الآخر من الاسم المستعار هو ل backend. هذا يتعلق IP الخلفية مع اسم مستعار.

الأسماء المستعارة ليست سوى معلومات مرئية ، ولا تحل محل عنوان IP الخلفي أو اسم الواجهة في طلب 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>

أدرج الأسماء المستعارة في النظام للواجهات أو الخلفية.

مثال على الاستجابة:

{
   "description" : "List the aliases",
   "params" : [
      {
         "id" : "192.168.11.13",
         "alias" : "http-backend"
      },
      {
         "id" : "127.0.0.1",
         "alias" : "localhost"
      }
   ]
}

معلمات الاستجابة

ترجع api علامة تجزئة حيث يكون المفتاح هو عنوان IP للواجهة الخلفية أو اسم الواجهة وتكون القيمة هي الاسم المستعار الخاص بها.

إنشاء أو تعديل اسم مستعار

إنشاء أو تعديل اسم مستعار

طلب مثال:

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 الخلفية أو اسم الواجهة.

طلب المعلمات

الحقل النوع الوصف
الاسم المستعار خيط هو النيك للعنصر 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>

حذف الاسم المستعار للواجهة أو الخلفية.

يوفر id معلمة URI هي IP الخلفية أو اسم الواجهة.

مثال على الاستجابة:

{
   "description" : "Delete an alias",
   "message" : "The alias has been deleted.",
   "success" : "true"
}

معلمات الاستجابة

إرجاع zapi رسالة نجاح إذا كانت العملية بشكل صحيح.

IPDS

هذه الوحدة هي تنفيذ أ IPS (نظام منع التطفل) و IDS (نظام كشف التسلل) ليعرض على المستخدم طبقة أمان. تقوم وحدة IPDS بفحص حركة المرور قبل الوصول إلى وحدات Load Balancing LSLB or GSLBإذا تم اكتشاف حركة المرور على أنها ضارة ، فسيتم رفضها.

إنه يعمل على تطبيق قواعد الأمن على النظام الذي سيتم تعريفه على أنه كائن ذو طبيعة مختلفة. كل واحد يقدم حلاً للإجراءات الخبيثة أو المشبوهة الخارجية. تساعد هذه الأداة مسؤولي النظام على التحكم في التهديدات والهجمات.

يمكن أن تكون القواعد المتاحة للتطبيق على Zevenet القوائم السوداء, دوس 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 ربل.
نوع خيط يظهر هذا الحقل في قواعد dos و يحدد ما إذا كانت القاعدة نظام، ينطبق على موازن؛ أو مزرعةتنطبق القواعد على المزرعة.

IPDS - القوائم السوداء

القوائم السوداء يتيح للمستخدمين استخدام القوائم لتصفية أو السماح بحركة المرور وفقًا لـ IPs المصدر (Incomming traffic).

هناك نوعان من القوائم:

  1. أجهزة التحكم عن بُعد: يتم الحصول على القوائم من عنوان URL ، وهذه القوائم ليست قابلة للتعديل ويمكن إهمالها ليتم تنزيلها.
  2. محلي: يمكن للمستخدمين إنشاء قوائمهم الخاصة بسياسة معينة ، تنكر إذا تطابق IP incomming فسيتم رفض حركة المرور أو السماح إذا تطابق IP incomming سيتم السماح حركة المرور.

هذه الوحدة تتضمن مسبقة القوائم التي قدمها فريق Zevenet ، القائمة جاهزة للتطبيق على المزارع. من ناحية أخرى ، يمكن للمستخدمين إنشاء قوائم مخصصة خاصة بهم.

يمكن تطبيق العديد من القوائم على نفس المزرعة ، إذا كان عنوان IP المصدر مطابقًا في بعض القائمة ، فسيتم السماح بمرور حركة المرور أو رفضه وفقًا لسياسة القائمة السوداء. في اللحظة التي تطابق فيها IP ، لن يتم إجراء أي فحص للقائمة السوداء على عنوان IP المصدر.

إذا كان عنوان IP المصدر موجودًا في قائمتين مختلفتين ، أحدهما من النوع تنكر وغيرها من النوع السماح، ثم دائمًا يتم تقييم سياسة السماح أولاً.

قائمة جميع القواعد blacklists

قائمة جميع القوائم السوداء

طلب مثال:

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. ستكون قيمة هذا مجموعة من كائنات القائمة السوداء ، يحتوي كل منها على سمات المفتاح أدناه.

الحقل النوع الوصف
المزارع خيط[] قائمة المزارع حيث يتم تطبيق القائمة السوداء.
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد.
سياسة خيط الإجراء المطلوب تطبيقه على المصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
التحميل المسبق خيط القيم المحتملة هي: صحيح، تم تحميل القائمة السوداء مسبقًا في النظام ؛ أو زائف، تم إنشاء القائمة السوداء من قبل مسؤول النظام.
الحالة خيط القيم المحتملة هي: up، يتم تنشيط القائمة السوداء وتمنع (أو السماح) من نقل مصادر البيانات من القائمة ؛ أو إلى أسفل، في الواقع القاعدة ليست قيد التشغيل وأنه لا يتم تصفية حركة المرور.
نوع خيط حيث يتم حفظ القائمة ومن يحافظ عليها. القيم هي: محلي، يتم حفظ القائمة في النظام المحلي ويمكن تعديلها محليا ، أو عن بعديتم تحميل القائمة من المصدر البعيد من خلال URL، لا يمكن تعديله محليًا ، لذا يجب إجراء التعديلات في المصدر البعيد.

استرداد قاعدة قائمة سوداء

استرداد القائمة السوداء

طلب مثال:

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"
   }
}

كائن القائمة السوداء المحلي:

الحقل النوع الوصف
المزارع خيط[] قائمة المزارع حيث يتم تطبيق القائمة السوداء.
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد.
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
التحميل المسبق خيط القيم المحتملة هي: صحيح، تم تحميل القائمة السوداء مسبقًا في النظام ؛ أو زائف، تم إنشاء القائمة السوداء بواسطة مسؤول النظام.
الحالة خيط القيم المحتملة هي: up، يتم تنشيط القائمة السوداء وتمنع (أو السماح) من نقل مصادر البيانات من القائمة ؛ أو إلى أسفل، في الواقع القاعدة ليست قيد التشغيل وأنه لا يتم تصفية حركة المرور.
نوع خيط حيث يتم حفظ القائمة ومن يحافظ عليها. القيم هي: محلي، يتم حفظ القائمة في النظام ويحتفظ بها مسؤول النظام ؛ أو عن بعد، يتم تنزيل القائمة من عنوان url بعيد.
تقارير عن مصادر العطور بدون العلبة موضوع[] قائمة عناوين IP التي تقوم القائمة بالتحقق منها. صيغة شبكة المصدر مقبولة: عنوان الشبكة / قناع بت أو 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"
   }
}

كائن القائمة السوداء عن بعد:

الحقل النوع الوصف
المزارع خيط[] قائمة المزارع حيث يتم تطبيق القائمة السوداء.
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد.
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
التحميل المسبق خيط القيم المحتملة هي: صحيح، تم تحميل القائمة السوداء مسبقًا في النظام ؛ أو زائف، تم إنشاء القائمة السوداء بواسطة مسؤول النظام.
نوع خيط حيث يتم حفظ القائمة ومن يحافظ عليها. القيم هي: محلي، يتم حفظ القائمة في النظام ويحتفظ بها مسؤول النظام ؛ أو عن بعد، يتم تحميل القائمة من جهاز تحكم عن بعد URL.
تقارير عن مصادر العطور بدون العلبة موضوع[] Ssource IPs التي تدرج الشيكات. إذا كانت القائمة من نوع عن بعد ثم لا يتم عرض محتوى القائمة حتى أول عملية تنزيل.
تحديث الحالة خيط حالة آخر تنزيل لقائمة وتاريخ آخر تحديث ناجح في النظام المحلي.
URL خيط حيث يتم تنزيل القائمة عن بعد. يجب أن يكون التنسيق عن بعد قائمة واحدة مصدر قناع الشبكة / بت أو IP لكل سطر.
تردد خيط تردد تحديث قائمة عن بعد. الخيارات هي: يومياأو تحديث كل الأيام ، مرة واحدة أو بشكل دوري ، يشار إلى هذا في frequency_type حقل؛ أسبوعي، تحديث مرة واحدة في الأسبوع. أو شهريا، وتحديث مرة واحدة في الشهر.
frequency_type خيط هذه المعلمة تكمل تردد يوميا عندما تكون قيمتها يومية. القيم المحتملة هي: دقيق. حدد ساعة في اليوم ؛ أو فترة، حدد فترة زمنية للتحديث خلال اليوم.
يوم سلسلة أو رقم هذه المعلمة تكمل المعلمة تردد متى 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

إنشاء قائمة سوداء لاستخدامها في المزارع. يمكن أن تكون القوائم السوداء من نوعين:

  1. محلي: يتم إضافة المصادر من قبل المستخدم. يتم حفظ القائمة محليا.
  2. عن بعد: يتم الحصول على المصادر من موقع بعيد. يشار إلى هذا الموقع من خلال عنوان URL. تنسيق القائمة عن بعد المدعومة هو واحد عنوان الشبكة / قناع بت or IP خط لكل سطر.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد. صحيح
نوع خيط حيث يتم حفظ القائمة ومن يقوم بصيانتها. القيم هي: محلي، يتم حفظ القائمة في النظام والصيانة لنظام الإدارة ؛ أو عن بعد، تؤخذ القائمة من خارج الخدمة من خلال URL وستقوم خدمة المسؤول بصيانة القائمة. صحيح
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة. القيمة الافتراضية هي رفض.
URL خيط حيث يتم تنزيل القائمة عن بعد. يجب أن يكون التنسيق عن بعد قائمة واحدة مصدر لكل سطر في الشكل عنوان الشبكة / قناع بت or IP. صحيح للقائمة عن بعد
{
   "description" : "Post list list1",
   "params" : {
      "farms" : [],
      "name" : "newListLoc",
      "policy" : "deny",
      "preload" : "false",
      "type" : "local"
   }
}

معلمات الاستجابة

ستكون الاستجابة كائن JSON مع ضبط مفتاح على params. ستكون قيمة هذا مجموعة من كائنات القائمة السوداء ، يحتوي كل منها على سمات المفتاح التالية.

الحقل النوع الوصف
المزارع خيط[] قائمة المزارع حيث يتم تطبيق القائمة السوداء.
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد.
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
التحميل المسبق خيط القيم المحتملة هي: صحيح، تم تحميل القائمة السوداء مسبقًا في النظام ؛ أو زائف، تم إنشاء القائمة السوداء لمسؤول النظام.
نوع خيط حيث يتم حفظ القائمة ومن يقوم بصيانتها. القيم هي: محلي، يتم حفظ القائمة في النظام والصيانة لنظام الإدارة ؛ أو عن بعد، تؤخذ القائمة من خارج الخدمة من خلال URL وستقوم خدمة المسؤول بصيانة القائمة.

تعديل قاعدة قائمة سوداء

تعديل قائمة سوداء

طلب مثال لقائمة محلية:

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 على لا التحميل المسبق القوائم.
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
مصدر خيط[] وهي قائمة بعناوين IP أو الشرائح الصافية التي تقوم القائمة بالتحقق منها. لتغيير تغيير مصدر واحد فقط ، يرجى الاطلاع على قسم الوثائق IPDS> القوائم السوداء> تعديل مصدر القائمة السوداء. لا يتم تعديل المصادر إلا في لا التحميل المسبق القوائم.

مثال على الاستجابة:

{
   "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 مساء:

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

طلب معلمات لقائمة عن بعد

الحقل النوع الوصف
المزارع خيط[] قائمة المزارع حيث يتم تطبيق القائمة السوداء.
الاسم خيط اسم القائمة السوداء. يتم استخدامه كمعرف فريد.
سياسة خيط العمل على تطبيق على مصدر. الخيارات هي: تنكرمنع حركة مرور الإدخال من مصادر القائمة ؛ أو السماح قبول المرور من مصادر القائمة.
URL خيط حيث يتم تنزيل القائمة عن بعد.
تردد خيط تردد تحديث قائمة عن بعد. الخيارات هي: يومياأو تحديث كل الأيام ، مرة واحدة أو بشكل دوري ، يشار إلى هذا في frequency_type حقل؛ أسبوعي، تحديث مرة واحدة في الأسبوع. أو شهريا، وتحديث مرة واحدة في الشهر.
frequency_type خيط هذه المعلمة تكمل تردد يوميا عندما تكون قيمتها يومية. القيم المحتملة هي: دقيق. حدد ساعة في اليوم ؛ أو فترة، حدد فترة زمنية للتحديث خلال اليوم.
يوم سلسلة أو رقم هذه المعلمة تكمل تردد عندما تكون قيمته أسبوعية أو شهرية. إذا كانت هذه المعلمة أسبوعية يجب أن يكون يومًا في الأسبوع (يوم الاثنين, يوم الثلاثاء, الأربعاء, الخميس, الجمعة, يوم السبت or الأحد) آخر لو تردد شهريًا ، يجب أن تكون هذه المعلمة شهرًا (عدد بين 1 و 31).
الوقت هدف إنها بنية تعتمد على الحقول تردد.

كائن الفترة الزمنية

هذه هي الحقول عندما يتم تكوين فترة زمنية.

هو تكوين الضرورة تردد مع القيمة يومياو frequency_type مع القيمة فترة.

الحقل النوع الوصف
فترة رقم الهاتف كم مرة لتحديث القائمة.
وحدة خيط وحدة الفترة. الخيارات هي: دقائق or ساعات، تشير إلى وحدة القياس لتحديثات القائمة.

كائن الساعة الزمنية الدقيقة

هذه هي الحقول عندما يتم تكوين وقت ساعة بالضبط.

يتم استخدام هذا الكائن مع التكوينات التالية:

تردد الحقل لديه القيمة يوميا و frequency_type 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

تطبيق إجراء على قائمة سوداء. الاسم هو المعرف الفريد للقائمة السوداء.

طلب المعلمات

الحقل النوع الوصف مطلوب:
عمل خيط الإجراء المطلوب لتطبيقه على قاعدة القائمة السوداء. القيم المتاحة هي: بدايةتنشط القائمة في جميع المزارع حيث يتم تطبيقها ؛ توقف، توقف القائمة السوداء لجميع المزارع حيث يتم تطبيق قاعدة القائمة السوداء ، لن يتم حظر حركة المرور أو السماح بها ؛ تحديث، يمكن تطبيق هذا الإجراء فقط عن بعد القوائم السوداء ، هذا الإجراء تحديث قائمة المصدر من جهاز التحكم عن بعد URL. صحيح

مثال على الاستجابة:

{
   "description" : "Update a remote list",
   "update" : "Sync OK. Last update: 2017-02-01 05:31:57"
}

معلمات الاستجابة

سيكون الرد json مع حالة التنزيل. انظر مثال الاستجابة لمزيد من المعلومات.

الحقل النوع الوصف مطلوب:
تحديث خيط حالة آخر تنزيل لقائمة وتاريخ آخر تحديث ناجح.

IPDS - DoS

لدى حماية DoS نوع مختلف من القواعد ، تعتمد على قاعدة الحماية ، يتم تطبيقها على جزء مختلف من الموازن. لذلك هناك نظام القواعد التي تطبق كل الموازن. قواعد اتصال موجهة ، محددة ل مزرعة العمل مع بروتوكول TCP. قبل تطبيق القاعدة على مزرعة، إنشاء كائن مع تمني التكوين. بعد ذلك ، قم بتطبيقه على جميع المزارع التي تحتاج إليها. ال نظام قواعد يكون الكائن الذي تم إنشاؤه بالفعل وليس لديك سوى تكوين واحد ممكن. بمجرد تكوينها ، قم بتمكينها.

قواعد Farm DoS

من الضروري إنشاء كائن من قبل لتطبيق قاعدة على مزرعة.

limitsec

الحد من اتصال جديد في الثانية والمصدر. متاح فقط في المزارع يعمل مع بروتوكول TCP.

الحقل النوع الوصف
الاسم خيط هو معرف فريد لقاعدة الكائن.
قصر رقم الهاتف هذا هو العدد الأقصى للاتصالات الجديدة في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها للاتصالات الجديدة. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

limitconns

الحد من إجمالي الاتصالات الحالية لكل مصدر. متاح فقط في المزارع يعمل مع بروتوكول TCP.

الحقل النوع الوصف
الاسم خيط هو معرف فريد لقاعدة الكائن.
limit_conns رقم الهاتف هذا هو العدد الأقصى للاتصال الحالي من المصدر.

bogustcpflags

تحقق من بروتوكول TCP يتم احترامه. لا تتضمن هذه القاعدة معلمات التهيئة ، لذا قم بإنشاء كائن فقط يمكنك استخدامه في جميع المزارع. متاح فقط في المزارع يعمل مع بروتوكول TCP.

الحقل النوع الوصف
الاسم خيط هو معرف فريد لقاعدة الكائن.

limitrst

الحد من عدد طلبات إعادة الاتصال في الثانية. متاح فقط في المزارع يعمل مع بروتوكول TCP.

الحقل النوع الوصف
الاسم خيط هو معرف فريد لقاعدة الكائن.
قصر رقم الهاتف هذا هو أقصى عدد من إعادة تعيين الطلب في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها لطلب إعادة التعيين. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

قواعد النظام 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 على صفحتين مزرعة و نظام. كل عنصر صفيف هو نوع من القواعد لتطبيقه على المزرعة أو النظام.

الحقل النوع الوصف
وصف خيط وصف موجز للقاعدة.
حكم خيط اكتب معرف فريد للقاعدة.

اذكر جميع قواعد 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

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
قصر رقم الهاتف هذا هو العدد الأقصى للاتصالات الجديدة في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها للاتصالات الجديدة. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

limitconns

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
limit_conns رقم الهاتف هذا هو العدد الأقصى للاتصال الحالي من المصدر.

bogustcpflags

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.

limitrst

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
قصر رقم الهاتف هذا هو أقصى عدد من إعادة تعيين الطلب في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها لطلب إعادة التعيين. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

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

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
قصر رقم الهاتف هذا هو العدد الأقصى للاتصالات الجديدة في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها للاتصالات الجديدة. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

limitconns

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
limit_conns رقم الهاتف هذا هو العدد الأقصى للاتصال الحالي من المصدر.

bogustcpflags

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.

limitrst

الحقل النوع الوصف
المزارع خيط[] المزارع حيث يتم تطبيق القاعدة.
قصر رقم الهاتف هذا هو أقصى عدد من إعادة تعيين الطلب في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها لطلب إعادة التعيين. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

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 تهيئة مختلفة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الاسم خيط هو معرف فريد لقاعدة الكائن. صحيح
حكم خيط هو معرف قاعدة النوع. الخيارات هي: limitconns, 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

الحقل النوع الوصف
قصر رقم الهاتف هذا هو العدد الأقصى للاتصالات الجديدة في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها للاتصالات الجديدة. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

limitconns

الحقل النوع الوصف
limit_conns رقم الهاتف هذا هو العدد الأقصى للاتصال الحالي من المصدر.

bogustcpflags

لا يوجد معلمات.

limitrst

الحقل النوع الوصف
قصر رقم الهاتف هذا هو أقصى عدد من إعادة تعيين الطلب في الثانية لمصدر.
limit_burst رقم الهاتف إنها ذروة مسموح بها لطلب إعادة التعيين. تتجدد وحدة الرشقة عندما تمر الثواني "المحددة".

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 rule.

طلب المعلمات

الحقل النوع الوصف مطلوب:
عمل خيط الإجراء المطلوب لتطبيقه على قاعدة DoS. القيم المتاحة هي: بداية، ينشط قاعدة DoS في جميع المزارع حيث يتم تطبيقه ؛ توقف، يؤدي إلى تعطيل DoS لجميع المزارع التي يتم فيها تطبيق قاعدة DoS ، ولن يتم حظر حركة المرور أو السماح بها. صحيح

مثال على الاستجابة:

{
   "description" : "Apply a action to a DoS rule",
   "params" : {
      "action" : "start"
   }
}

معلمات الاستجابة

إذا لم تكن هناك مشكلات في التهيئة ، فسيعرض zapi الإجراء المطلوب.

IPDS - RBL

RBLتتيح قوائم blackhole الموجودة في الوقت الفعلي إنشاء نظام أمان مفوض ، مهمة مضنية لصيانة نظام أمان محدّث ، إلى عامل speclialist. يقوم RBL بفحص حركة مرور موازن التحميل في قاعدة بيانات extern عبر بروتوكول DNS. مالك خادم DNS هو المسؤول عن تحديث وتوفير مصادر الجودة. سيتم إسقاط حركة مرور الإدخال من مصدر IP في قاعدة بيانات DNS.

للعمل مع خدمة RBL ، ستتم إضافة نطاقات DNS الأولى ، كل مجال DNS يحتوي على قائمة providor محددة تقوم بفرز المصدر لمعيار مختلف كنوع الهجوم المحقق أو شدة الهجوم.

بمجرد إنشاء نطاقات 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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 العام.
تسجيل مستوى رقم الهاتف هذا هو مستوى سجل شدة. يمكن أن يكون له قيمة بين 0 و 7 ، حيث يكون 0 emergency و 7 debug.
الاسم خيط اسم القاعدة 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

اذكر جميع النطاقات المتاحة للتواصل مع قواعد 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 ونوعان من النطاقات يتم إدراجهما كقيمة.

كائن المصدر:

الحقل النوع الوصف
مسبقة موضوع[] إنها قائمة بالنطاقات التي أضافها فريق Zevenet.
المستخدم موضوع[] هي قائمة بالنطاقات المضافة بواسطة مسؤول موازن التحميل.

كائن تم تحميله مسبقًا ومستخدم:

الحقل النوع الوصف
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 providor حيث قاعدة 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

إظهار informacion حول إصدار المنتج.

مثال على الاستجابة:

{
   "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 مع المعلمات أدناه.

الحقل النوع الوصف
appliance_version خيط نسخة الطلب. اعرض أيضًا hypervisor إذا كان جهاز ظاهري.
اسم المضيف خيط اسم المضيف.
إصدار النواة خيط إصدار Linux kernel.
تاريخ النظام خيط تاريخ النظام.
zevenet_version خيط نسخة Zevenet.

عرض 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. ال حرف * يستخدم للاستماع في جميع IPs شكلي.
ميناء خيط ميناء التكوين لخدمة 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. ال حرف * يستخدم للاستماع في جميع IPs شكلي.
ميناء خيط ميناء التكوين لخدمة 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 / بت). تسمح عناوين 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 / بت). تسمح عناوين 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 في تنسيق. المتاح شكل القيم هي أتش تي أم أل 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. ال حرف * يستخدم للاستماع في جميع IPs شكلي.
ميناء خيط المنفذ حيث تستمع خدمة 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. ال حرف * يستخدم للاستماع في جميع IPs شكلي.
ميناء خيط المنفذ حيث تستمع خدمة 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 خيط إذا كانت القيمة صحيح، يمكن للمستخدم استخدام Zevenet api باستخدام 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 ، يمكن للمستخدم القيام بعمل من خلال zapikey بأذونات دور المستخدم.
zapi_permissions خيط القيم المحتملة هي: صحيحلتمكين الوصول إلى موازن التحميل عبر zapi؛ أو زائف، لعدم السماح بالوصول من خلال 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 param ملف هو ملف السجل من القراءة. خطوط هو عدد الخطوط المراد إظهارها من النهائي.

مثال على الاستجابة:

{
   "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. الاسم هو المعرف الفريد للنسخ الاحتياطي الذي سيتم تخزينه في 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"
   }
}

النظام - الإخطارات

يتم تكوين الإعلامات من عنصرين: مرسل طريقة ونوع إنذار.

في قسم التنبيهات ، ستتمكن من اختيار نوع التنبيه الذي ترغب في تلقيه. في الواقع ، تكون التنبيهات في الخلفية أو حالة الكتلة ، لذا سيرسل الميزان إخطارًا عند بعض التبديل.

في قسم الطريقة ، ستتمكن من اختيار المرسل الذي سيتم استخدامه عندما يرسل 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"
      }
   ]
}

معلمات الاستجابة

الحقل النوع الوصف
إنذار خيط نوع التنبيه ، يتم استخدامه كمعرف فريد للتنبيه. التنبيهات المتاحة هي: الخلفية، وإخطار عندما تكون التغييرات الخلفية للحالة. أو كتلة، إرسال إعلام عند تبديل عقدة نظام المجموعة الرئيسي إلى عقدة أخرى.
الحالة خيط إظهار ما إذا كان التنبيه معاق، لا يرسل النظام إشعارًا عند وجود حدث ؛ أو تمكين، يرسل النظام تنبيهًا عندما يتم الكشف عن تغيير الحالة.

استرجاع التنبيهات الإخطار

استرجاع التنبيهات الإخطار

طلب مثال:

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"
   }
}

معلمات الاستجابة

الحقل النوع الوصف
avoidflappingtime رقم الهاتف في بعض الأحيان ، تكون الدعامات الخلفية متوفرة أو لا تكون في فترة زمنية قصيرة ، يسمح هذا الحقل بتكوين فترة زمنية لتجنب رسالة الإخطارات بينما تقوم الخلفية بتغيير الحالة ، بمجرد انتهاء هذه الفترة الزمنية ، إذا كانت حالة الواجهة الخلفية مختلفة عن البدء ، يتم إرسال الإخطار.
بادئة خيط وهي عبارة عن بادئة لموضوع البريد الإلكتروني ، والتي يتم إرسالها من قبل النظام لهذا النوع من التنبيه.
الحالة خيط إظهار ما إذا كان التنبيه معاق، لا يرسل النظام إشعارًا عند وجود حدث ؛ أو تمكين، يرسل النظام تنبيهًا عندما يتم الكشف عن تغيير الحالة.

تعديل تنبيه الإشعار

تعديل تنبيهات الإخطار

طلب مثال:

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>

إنذار هو المعرف الفريد للتنبيه.

طلب المعلمات

الحقل النوع الوصف
avoidflappingtime رقم الهاتف في بعض الأحيان ، تكون الدعامات الخلفية متوفرة أو لا تكون في فترة زمنية قصيرة ، يسمح هذا الحقل بتكوين فترة زمنية لتجنب رسالة الإخطارات بينما تقوم الخلفية بتغيير الحالة ، بمجرد انتهاء هذه الفترة الزمنية ، إذا كانت حالة الواجهة الخلفية مختلفة عن البدء ، يتم إرسال الإخطار. هذه المعلمة ليست في تنبيهات الكتلة ، الكتلة لديها وقت 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

احصل على صورة حالة النظام مع جميع التكوينات وعملية التشغيل في النظام. هذا supportave من الضروري العثور على القضايا أو المساعدة في الدعم.

النظام - الكتلة

الكتلة هي العنصر الذي تقوم به العقدة الرئيسية ، حيث تقوم بإدارة الاتصالات من أجل الخلفيات الخلفية ، وعقدة احتياطية تقوم بالتحقق من المعلمة الرئيسية ، وهي مستعدة للتأرجح إلى العقدة الرئيسية إذا كانت تنتقل إلى حالة أدنى.

عندما تكون هناك حالة تبديل ، ستقوم العقدة الاحتياطية باستعادة كل حالة الاتصال في حد ذاتها. لذلك ، لا يكتشف العميل حدوث انقطاع في الخدمة.

هذا دعونا وضع موازن الحمل في توافر عالية. لذلك إذا كانت هناك أية مشكلة في 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

إظهار كافة التكوين حول الكتلة.

جسم الرد:

{
   "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 مهيأ في العقدة للتحقق من حالة العقدة ولعمل النسخ المتماثل للمعلومات.
الاسم خيط إنه اسم المضيف للعقدة ، ويتم استخدامه كمعرف فريد للعقدة.
العقدة خيط القيم المحتملة هي: محليإذا كانت العقدة هي التي تتلقى طلب zapi ؛ أو عن بعدإذا كانت العقدة الأخرى مهيأة في المجموعة.

تمكين كتلة

تمكين كتلة

طلب مثال:

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 للمضيف المحلي المستخدم في المجموعة. صحيح
remote_password خيط كلمة مرور المستخدم الجذر لموازنة عن بعد. صحيح

جسم الرد:

{
   "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 رقم الهاتف إنه وقت الانتظار بين عمليتي تدقيق لحالة العقدة الرئيسية.
الإعادة بعد الفشل خيط أي عقدة لها تفضيل أن تكون رئيسية. القيم يمكن ان تكون الاسم العقدة ، لإعطاء الأفضلية لعقدة ؛ أو معاق، إذا كان أي عقدة يمكن أن تكون رئيسية وليس لها أولوية لأحد.

جسم الرد:

{
   "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

قم بإزالة الكتلة.

جسم الرد:

{
   "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

تغيير عقدة نظام المجموعة المحلي إلى وضع الصيانة.

جسم الرد:

{
   "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

إظهار حالة جميع العقد.

جسم الرد:

{
   "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 مهيأ في العقدة للتحقق من حالة العقدة ولعمل النسخ المتماثل للمعلومات.
الاسم خيط إنه اسم المضيف للعقدة ، ويتم استخدامه كمعرف فريد للعقدة.
العقدة خيط القيم المحتملة هي: محليإذا كانت العقدة هي التي تتلقى طلب zapi ؛ أو عن بعدإذا كانت العقدة الأخرى مهيأة في المجموعة.
الرسالة خيط رسالة وصفية تشير إلى الحالة ووضع العمل للعقدة.
دور خيط وضع العمل الفعلي لهذه العقدة. القيم المحتملة هي: رئيسي، هذه العقدة هي إدارة الاتصالات بين الخلفيات والعملاء ؛ أو دعم، لقد ردت هذه العقدة على اتصالات الحالة الرئيسية والتكوين الرئيسي ، وتتحقق من أن الخدمة الرئيسية تعمل.
الحالة خيط الإشارة إلى ما إذا كان هناك فشل في عملية الكتلة.

إظهار حالة كتلة المضيف المحلي

إظهار حالة كتلة المضيف المحلي

طلب مثال:

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

إظهار حالة العقدة المحلية.

جسم الرد:

{
   "description" : "Cluster status for localhost",
   "params" : {
      "message" : "Node online and active",
      "name" : "canoDEV4100",
      "role" : "master",
      "status" : "ok"
   }
}

معلمات الاستجابة

الحقل النوع الوصف
الرسالة خيط رسالة وصفية تشير إلى الحالة ووضع العمل للعقدة.
الاسم خيط إنه اسم المضيف للعقدة ، ويتم استخدامه كمعرف فريد للعقدة.
دور خيط وضع العمل الفعلي لهذه العقدة. القيم المحتملة هي: رئيسي، هذه العقدة هي إدارة الاتصالات بين الخلفيات والعملاء ؛ أو دعم، لقد ردت هذه العقدة على اتصالات الحالة الرئيسية والتكوين الرئيسي ، وتتحقق من أن الخدمة الرئيسية تعمل.
الحالة خيط الإشارة إلى ما إذا كان هناك فشل في عملية الكتلة.

RBAC

RBAC هو الحل للتحكم في الوصول المستند إلى الدور. لذلك ، يمكن أن يكون Zevenet مديرًا وإدارته من خلال أدوار مختلفة ، مما يحد من الوصول إلى التكوينات والموارد للمجموعات.

تستطيع المجموعة رؤية الموارد والمزارع والواجهات الافتراضية ، وهذا هو المالك. من الممكن تحديد إذن مختلف لتطبيق الإجراءات المتعلقة بالموارد ، فعلى سبيل المثال ، يمكن للمجموعة إدارة مزرعة ومراقبة أخرى.

يتم استخدام ثلاثة عناصر للعمل مع RBAC: الأدوار، rol عبارة عن مجموعة من الأذونات لعناصر مختلفة في موازن التحميل. المستخدمين، سيتمكن كل مستخدم من الوصول إلى موازن التحميل لـ api أو webgui أو كليهما ، مع دور مجموعة المستخدم. رأس التجميعإنها مجموعة من المستخدمين ومجموعة من الموارد (المزارع والواجهات الظاهرية). يجب أن يكون للمجموعة دور معين.

RBAC - المستخدمين

يمكن للمستخدم الوصول إلى موازن التحميل مع دور مجموعة المستخدم من خلال واجهة برمجة التطبيقات ، باستخدام zapikey للمستخدم وتطبيق أذونات zapi ، أو من خلال واجهة الويب باستخدام اسم المستخدم وكلمة المرور إذا كان لدى المستخدم أذونات واجهة المستخدم الرسومية على الويب.

قائمة المستخدمين

قائمة بجميع المستخدمين

طلب مثال:

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؛ أو زائف، لعدم السماح بالوصول من خلال 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؛ أو زائف، لعدم السماح بالوصول من خلال 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

إنشاء مستخدم ، يتم إنشاء المستخدم دون دور ومجموعة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الاسم خيط اسم المستخدم ، فإنه يحدد للمستخدم ويستخدم للوصول من خلال واجهة المستخدم الرسومية على شبكة الإنترنت. صحيح
كلمه السر خيط إنها كلمة المرور التي يستخدمها المستخدم للوصول إلى واجهة المستخدم الرسومية على الويب. صحيح
{
   "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؛ أو زائف، لعدم السماح بالوصول من خلال 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 يمكن للمستخدم القيام بعمل من خلال zapikey مع أذونات دور المستخدم. .
webgui_permissions خيط القيم المحتملة هي: صحيح، لتمكين الوصول إلى موازن التحميل من خلال واجهة المستخدم الرسومية على الويب ؛ أو زائف، لعدم السماح بالوصول من خلال واجهة المستخدم الرسومية على شبكة الإنترنت.
zapi_permissions خيط القيم المحتملة هي: صحيحلتمكين الوصول إلى موازن التحميل عبر zapi؛ أو زائف، لعدم السماح بالوصول من خلال 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؛ أو زائف، لعدم السماح بالوصول من خلال 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"
}

RBAC - الأدوار

بنية الدور

مثال دور ، هذه كلها مجموعة محتملة من الكائنات والإجراءات:

{
   "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.
كتلة يحدد الإجراءات لإدارة الكتلة.
مزرعة يحدد إجراءات لإدارة المزارع. سيتمكن المستخدم فقط من إدارة مزارع مجموعة المستخدمين.
farmguardian ويحدد إجراءات لإدارة الفحوصات الصحية بالمزرعة. لتطبيق farmguardian إلى مزرعة ، فإن الكائن المطلوب هو مزرعة.
الواجهة يحدد الإجراءات لإدارة شبكة قائمة طعام. الواجهات الافتراضية هي استثناء ، يتم إدارتها من قبل واجهات افتراضية موضوع.
واجهة افتراضية يحدد الإجراءات لإدارة الواجهات الافتراضية. سيتمكن المستخدم فقط من إدارة واجهات مجموعة المستخدمين.
IPDS يحدد الإجراءات لإدارة قواعد ipds. لتطبيق قاعدة على مزرعة ، يكون الكائن المطلوب مزرعة.
سجل يحدد الإجراءات لإدارة سجلات موازن التحميل.
إعلام يحدد إجراءات لإدارة الإشعارات: التنبيهات والأساليب المرسلة.
RBAC-مجموعة يحدد الإجراءات لإدارة مجموعات RBAC.
RBAC-دور يحدد الإجراءات لإدارة أدوار RBAC.
RBAC المستخدم يحدد إجراءات لإدارة مستخدمي RBAC.
supportsave يحدد الإجراءات لإدارة Zevenet supportave.
نظام الخدمة يحدد إجراءات لإدارة الخدمات عن بعد والخدمات المحلية.

الافعال

الحقل الوصف
قائمة يسرد العناصر المتاحة للكائن.
إظهار فإنه يحبط كائن وتكوينه.
بإمكانك تحميله يقوم بتنزيل كائن من موازن التحميل.
تحميل يقوم بتحميل كائن إلى موازن التحميل.
صيانة إنه يعدل حالة الكائن بين الصيانة وأعلى.
عمل يتم تطبيق إجراء على الكائن. كل كائن له أفعاله.
خلق يقوم بإنشاء عنصر جديد لنوع من الكائنات.
حذف يحذف بشكل دائم كائن.
تعديل إنه يعدل تكوين كائن. في بعض الأحيان ، إذا لم يكن الكائن الإجراءات: خلق, حذف 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.
كتلة خلق, حذف, صيانة و تعديل يحدد الإجراءات لإدارة الكتلة.
مزرعة عمل, خلق, حذف, صيانة و تعديل يحدد إجراءات لإدارة المزارع. سيتمكن المستخدم فقط من إدارة مزارع مجموعة المستخدمين.
farmguardian تعديل ويحدد إجراءات لإدارة الفحوصات الصحية بالمزرعة. لتطبيق farmguardian إلى مزرعة ، فإن الكائن المطلوب هو مزرعة.
الواجهة تعديل يحدد الإجراءات لإدارة شبكة قائمة طعام. الواجهات الافتراضية هي استثناء ، يتم إدارتها من قبل واجهات افتراضية موضوع.
واجهة افتراضية عمل, خلق, حذف و تعديل يحدد الإجراءات لإدارة الواجهات الافتراضية. سيتمكن المستخدم فقط من إدارة واجهات مجموعة المستخدمين.
IPDS عمل و تعديل يحدد الإجراءات لإدارة قواعد ipds. لتطبيق قاعدة على مزرعة ، يكون الكائن المطلوب مزرعة.
سجل بإمكانك تحميله و إظهار يحدد الإجراءات لإدارة سجلات موازن التحميل.
إعلام عمل, تعديل, إظهار و تجربه بالعربي يحدد إجراءات لإدارة الإشعارات: التنبيهات والأساليب المرسلة.
RBAC-مجموعة خلق, حذف, قائمة, تعديل و إظهار يحدد الإجراءات لإدارة مجموعات RBAC.
RBAC-دور خلق, حذف, تعديل و إظهار يحدد الإجراءات لإدارة أدوار RBAC.
RBAC المستخدم خلق, حذف, قائمة, تعديل و إظهار يحدد إجراءات لإدارة مستخدمي RBAC.
supportsave بإمكانك تحميله يحدد الإجراءات لإدارة Zevenet supportave.
نظام الخدمة تعديل يحدد إجراءات لإدارة الخدمات عن بعد والخدمات المحلية.

    كل نوع من الإجراءات الموضحة أدناه:

الحالة الوصف
قائمة يسرد العناصر المتاحة للكائن. صحيح لمنح الإذن ، زائف لإزالة إذن.
إظهار فإنه يحبط كائن وتكوينه. صحيح لمنح الإذن ، زائف لإزالة إذن.
بإمكانك تحميله يقوم بتنزيل كائن من موازن التحميل. صحيح لمنح الإذن ، زائف لإزالة إذن.
تحميل يقوم بتحميل كائن إلى موازن التحميل. صحيح لمنح الإذن ، زائف لإزالة إذن.
صيانة إنه يعدل حالة الكائن بين الصيانة وأعلى. صحيح لمنح الإذن ، زائف لإزالة إذن.
عمل يتم تطبيق إجراء على الكائن. كل كائن له أفعاله. صحيح لمنح الإذن ، زائف لإزالة إذن.
خلق يقوم بإنشاء عنصر جديد لنوع من الكائنات. صحيح لمنح الإذن ، زائف لإزالة إذن.
حذف يحذف بشكل دائم كائن. صحيح لمنح الإذن ، زائف لإزالة إذن.
تعديل إنه يعدل تكوين كائن. في بعض الأحيان ، إذا لم يكن الكائن الإجراءات: خلق, حذف 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 لإضافة مزرعة إلى المجموعة. تحديد واجهات في واجهة المستخدم لإضافة واجهة افتراضية للمجموعة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الاسم خيط إنه اسم الكائن المراد إضافته إلى المجموعة صحيح

مثال على الاستجابة:

{
   "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 لإزالة مزرعة من المجموعة. تحديد واجهات في واجهة المستخدم لإزالة واجهة افتراضية من المجموعة.

مثال على الاستجابة:

{
   "description" : "Removing the user monica from the group development",
   "message" : "The user monica has been unlinked successful from the group development.",
   "success" : "true"
}