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

Zevenet API v4.0 Reference

ZAPI (Zevenet Application Programming Interface) هي أداة لمسؤولي النظام للتحكم في سلوك موازن تحميل Zevenet.

من الضروري نشط المستخدم الجذر zapi من واجهة الويب قبل استخدامه ، النظام> المستخدمون.

بمجرد إنشاء مستخدم ZAPI ، من الممكن إرسال الطلبات إلى خادم HTTP. يشبه طلب URI:

HTTP verb https://zevenet_server: 444 / ZAPI / v4.0 / zapi.cgi /URI_path,

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

يوفر HTTP verbs المقبولة ل ZAPI هي:

معلمات ZAPI

معلمات ZAPI

طلب مثال:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-H 'Content-Type: application/json' -d ''
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms

A ضع و سأعين تحتاج الطلبات دائمًا إلى معلمة تقريبًا على الرغم من أن استدعاء ZAPI لا يحتاج إلى أي معلمة (إلزامية) مطلوبة. إذا تم إرسال طلب PUT أو POST بدون معلمات ، فسوف يعرض ZAPI قائمة المعلمات المتوقعة وخياراتها الممكنة.

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

{
   "description" : "No parameter has been sent. Please, try with:",
   "params" : [
      {
         "name" : "profile",
         "options" : [
            "required"
         ],
         "possible_values" : [
            "http",
            "gslb",
            "l4xnat",
            "datalink"
         ]
      },
      {
         "format" : "ip_addr",
         "name" : "vip",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "expects a port",
         "name" : "vport",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "The farm name is required to have alphabet letters, numbers or hypens (-) only.",
         "format" : "farm_name",
         "name" : "farmname",
         "options" : [
            "required"
         ]
      }
   ]
}

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

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

وصف المعلمة:

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

قائمة الخيارات:

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

رموز الخطأ

يمكن لـ ZAPI الاستجابة لأحد رموز الخطأ التالية:

رمز الخطأ موجز الوصف
400 اقتراح غير جيد بعض معلمات الطلب غير صحيحة.
401 غير مصرح مفتاح ZAPI خاطئ.
402 الشهادة غير صالحة يحتاج موازن التحميل إلى شهادة صالحة لمعالجة الطلب.
403 ممنوع لا يملك مالك المستخدم لمفتاح ZAPI أذونات الطلب أو الكائن المستخدم فيه.
404 لم يتم العثور على الصفحه URI المستخدمة أو كائن واحد المستخدمة في الاستدعاء غير موجود.
405 أسلوب غير مسموح الفعل HTTP غير موجود أو لم يتم تنفيذه لاستدعاء ZAPI الحالي.
406 غير مقبول هذه الميزة ليست مؤقتة متاحة.
409 صراع الطلب صالح ، لكن لا يمكن معالجته ، فقد أحدث التكوين الجديد تعارضًا مع التكوين الحالي. يمكن أن تقدم Syslog مزيدًا من المعلومات.
410 ذهب تمت إزالة هذه الميزة.
500 خطأ في الخادم الداخلي حدث خطأ في الخادم.
504 مهلة العبارة تم الوصول إلى مهلة استجابة الخادم ولم يتم الانتهاء من معالجة الطلب.

سجل التغييرات

هذه هي قائمة التغييرات التي تم تضمينها في كل إصدار. قائمة التغييرات في إصدار ZAPI دائمًا فيما يتعلق قبل ذلك.

API 4.0.2

إصدار ZAPI هذا هو امتداد للإصدار 4.0.1. تمت إضافة بعض المعلمات ومعرفات الموارد المنتظمة (URI) ولكن تمت إزالة أي منها.

وحدة VPN الجديدة:

وأضاف GET|POST|PUT|DELETE /vpns/*

معلمات جديدة:

خطأ WAF, إعادة تحديد الموقع (تمت إضافة خيارات جديدة لـ zproxy فقط), إعادة كتابة, اتصال مثبت, سياسة التوجيه, اتصال_حد:

تم التعديل: GET|PUT /farms/<farmname>. تم التعديل: GET|PUT /farms/<farmname>/services/<id>.

واجهات برمجة تطبيقات جديدة لإضافة عنوان إعادة كتابة:

وأضاف ADD|DELETE /farms/<farmname>/service/<servicename>/rewriteurl/*

واجهات برمجة تطبيقات جديدة لإضافة قواعد إعادة كتابة الرؤوس:

وأضاف ADD|DELETE /farms/MyHttpFarm/replacerequestheader/* وأضاف ADD|DELETE /farms/MyHttpFarm/replaceresponseheader/*

الطلبات المضافة لإدارة الجلسات الثابتة (zproxy فقط):

وأضاف GET|POST|DELETE /farms/<farmname>/services/<servicename>/sessions/*

المعلمة المضافة مهلة:

تم التعديل: GET /monitoring/fg/<name>. تم التعديل: POST|PUT /monitoring/fg.

تكوين ips والمنافذ المتعددة:

تم التعديل ADD|POST /system/ssh، الآن قبول المصفوفات في الاستماع والمنفذ بارامترات.

تكوين IPS والمنافذ المتعددة لخادم Cherokee:

تم التعديل ADD|POST /system/http، الآن قبول المصفوفات في ip و port params.

تكوين شهادة الخادم:

وأضاف GET|POST /system/https/certificate.

المعلمات المضافة إجمالي الجلسات و TTL:

تم التعديل: GET /stats/farms/<farmname>

المعلمة المضافة waf_assistant:

تم التعديل GET|POST /system/global

واجهات برمجة تطبيقات rsyslog جديدة لتكوين السجلات لإرسالها إلى خادم بعيد:

وأضاف: GET|POST|DELETE /system/rsyslog.

المعلمة المضافة واجهة المسار:

تم التعديل: GET|PUT /system/cluster.

API 4.0.1

إصدار ZAPI هذا هو امتداد للإصدار 4.0. تمت إضافة بعض المعلمات ومعرفات الموارد المنتظمة (URI) ولكن تمت إزالة أي منها.

إضافة طلب لإظهار شجرة مع جميع كائنات موازن التحميل

أضف: GET / ids

خيار لنسخ مزرعة

تم التعديل: POST /farms

أضف معلمات العنوان و رأس مزيل وتوسيع المعلمة httpverb:

تم التعديل GET /farms/<farmname>

تم التعديل PUT /farms/<farmname>

أضف POST /farms/<farmname>/addresponseheader|removeresponseheader

أضف DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>

إضافة طلبات لإدارة الجلسات الثابتة:

أضف GET /farms/<farmname>/sessions

أضف POST /farms/<farmname>/sessions

أضف DELETE /farms/<farmname>/sessions/<session>

وحدة التوجيه الجديدة:

وأضاف GET|POST|PUT|DELETE /routing/*

يمكن لـ Farmguardian استخدام الاسم المستعار للخلفية كاسم مضيف للشيكات:

وأضاف GET|PUT /monitoring/fg*/<farmguardian>

إدارة الملفات لقواعد WAF:

وأضاف GET|PUT|DELETE /ipds/waf/files

الحصول على معلومات النظام:

وأضاف: GET /system/info

الإعدادات العامة المعدلة:

وأضاف: GET|POST /system/global

المصادقة باستخدام LDAP:

وأضاف GET|POST /rbac/services

وأضاف GET|POST /rbac/ldap*

تم التعديل GET|POST /rbac/users

تم التعديل GET|PUT /rbac/users/<user>

API 4.0

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

وأضاف: /farms/modules/summary

إجراءات لربط مجموعة قواعد WAF بمزارع HTTP:

وأضاف: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*

تم التعديل: GET /farms/<farm>

نقل الشهادات في مزارع HTTPS:

وأضاف: POST /farms/<farm>/certificates/<cert>/actions

تعديل دعوة المزارع المرتبطة l4xnat لدعم النواة الجديدة:

تم التعديل: GET|POST|PUT|DELETE /farms/<l4farm>

وأضاف DHCP و ماك الميزات في مكالمات ZAPI التالية:

تم التعديل: PUT /interfaces/nic/<if>

تم التعديل: PUT /interfaces/bonding/<if>

تم التعديل: POST /interfaces/vlan

تم التعديل: PUT /interfaces/vlan/<if>

إعادة تسمية المعلمة لنسخ ولي الأمر المزرعة:

تم التعديل: POST /monitoring/fg

إدارة حزمة IPDS:

وأضاف: GET /ipds/package

وأضاف: POST /ipds/package/actions

جدار حماية تطبيق ويب جديد ، WAF ، ميزة:

وأضاف: GET|POST|PUT|DELETE /ipds/waf/*

إزالة الدعوة لنسخ قواعد RBL. الآن هو معلمة الدعوة إنشاء:

إزالة: POST /ipds/rbl/<name>

تم التعديل: POST /ipds/waf/<name>

المميزات ضبط المصنع, الوكيل و تحقق تحديثات الحزم قد أضيف:

وأضاف: POST /system/factory

وأضاف: GET /system/proxy

وأضاف: POST /system/proxy

وأضاف: GET /system/packages

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

وأضاف: GET /rbac/menus

تم التعديل: PUT /rbac/roles/<ROLE>

شهادات التفعيل

شهادة التنشيط هي الترخيص الصادر عن Zevenet والذي يتيح الاستخدام الكامل لموازن التحميل في إصدار Enterprise الخاص به.

عرض تفاصيل شهادة التنشيط

عرض تفاصيل شهادة التنشيط

طلب مثال:

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

GET /certificates/activation

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

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

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

طلب مثال:

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/v4.0/zapi.cgi/certificates/activation

POST /certificates/activation

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

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

{
   "description" : "Upload activation certificate",
   "message" : "Activation certificate uploaded",
   "success" : "true"
}

حذف شهادة التنشيط

حذف شهادة التنشيط

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation

DELETE /certificates/activation

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

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

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

شهادة SSL

يدعم Zevenet الشهادات بتنسيق PEM لاستخدامها مع مزارع HTTP التي تم إعدادها باستخدام وحدة إصغاء HTTPS. إذا كنت تريد معرفة المزيد حول كيفية إنشاء بيم شهادات ، يرجى زيارة المادة التالية: شهادات جنرال في شكل بيم

قائمة جميع الشهادات

قائمة جميع الشهادات

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates
zcli certificate list

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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate download 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/v4.0/zapi.cgi/certificates/example.pem/info
zcli certificate get example.pem

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 DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate delete example.pem

DELETE /certificates/<file>

حذف شهادة حسب اسم الملف في مخزن الشهادات.

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

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

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

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

طلب مثال:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"host.domain.com","key":"-----BEGIN PRIVATE KEY-----\nRTQwew...",
"ca","-----BEGIN CERTIFICATE-----\nFQOEW...","intermediates":"-----BEGIN CERTIFICATE-----\nQWESw..."}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/pem
zcli certificate-pem create -name host.domain.com -key "-----BEGIN PRIVATE KEY..." -ca "-----BEGIN CERTIFICATE..." -intermediates "-----BEGIN CERTIFICATE..."
"

POST /certificates/pem

قم بإنشاء شهادة PEM (ملف PEM).

طلب المعلمات

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

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

{
   "description" : "Create certificate",
   "message" : "Certificate host.domain.com created",
   "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/v4.0/zapi.cgi/certificates
zcli certificate create -name NewCSR -fqdn host.domain.com -division IT -organization 'Example Corp.' -locality Madrid -state Madrid -country ES -mail info@domain.com

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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate upload example.pem /local_path/to/example.pem

POST /certificates/<file>

تحميل شهادة PEM لمزارع HTTP المزودة بمستمع HTTPS.

طلب معرفات URI

يتطلب المعلمة --tcp-nodelayو --data-binary لتحميل الملف في الوضع الثنائي.

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

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

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

قائمة الأصفار

قائمة الأصفار

طلب مثال:

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

GET /ciphers

اذكر الأصفار المتاحة التي يمكن لمزرعة HTTPS استخدامها.

يوفر تفريغ SSL لن يكون التشفير متاحًا إلا إذا كان مدعومًا من قِبل المعالج.

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

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

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

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

الحقل النوع الوصف
params موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

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

شهادات Letsencrypt SSL

يدعم Zevenet إنشاء وتجديد شهادات Letsencrypt. الشهادة النهائية هي شهادة ZEVENET PEM التي يمكن استخدامها مع HTTPS Farms. . إذا كنت تريد معرفة المزيد حول كيفية الإنشاء بيم شهادات ، يرجى زيارة المادة التالية: شهادات جنرال في شكل بيم

إظهار تكوين Letsencrypt

إظهار تكوين Letsencrypt

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificate-le-config list

GET /certificates/letsencryptz/config

إظهار تكوين Letsencrypt.

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

ستكون الاستجابة كائن JSON مع المعلمات أدناه.

{
   "description" : "Get LetsEncrypt Config",
   "params" : {
      "email" : "test_le@zevenet.com"
   }
}

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

الحقل النوع الوصف
البريد الإلكتروني خيط بريد إلكتروني لـ Letsencrypt

تعديل تكوين Letsencrypt

تعديل تكوين Letsencrypt

طلب مثال:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"email":"test_le@zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificates-le-config set -email test_le@zevenet.com

PUT /certificates/letsencryptz/config

تعديل تكوين Letsencrypt.

طلب المعلمات

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

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

ستكون الاستجابة كائن JSON مع المعلمات أدناه.

{
   "description" : "Modify LetsEncrypt Config",
   "message" : "The Letsencrypt Config has been updated successfully.",
   "params" : {
      "email" : "test_le@zevenet.com"
   },
   "success" : "true"
}


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

الحقل النوع الوصف
البريد الإلكتروني خيط بريد إلكتروني لـ Letsencrypt

قائمة بجميع شهادات Letsencrypt

قائمة بجميع شهادات Letsencrypt

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le list 

GET /certificates/letsencryptz

قائمة بجميع شهادات Letsencrypt التي تم إنشاؤها.

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

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

{
   "description" : "List LetsEncrypt certificates",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "May 31 05:51:49 2021 GMT",
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "Aug 29 05:51:49 2021 GMT",
         "file" : "/usr/local/zevenet/config/letsencrypt/acme/*.wildcard.test.zevenet.com/fullchain.cer",
         "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
         "status" : "valid",
         "type" : "LE Certificate",
         "wildcard" : "true"
      },
      {
         "CN" : "*.test1.wildcard.test.zevenet.io",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.test1.wildcard.test.zevenet.io",
               "txt" : "QpbOLzMrJapoQmcbrA5_dr6ciwLzNF-y3z5XR5i-I2c"
            }
         ],
         "domains" : [
            "*.test1.wildcard.test.zevenet.io"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }

   ]
}

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

الحقل النوع الوصف
params موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
CN خيط اسم المجال الشائع.
خلق خيط تاريخ الإنشاء.
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها.
الانتهاء خيط تاريخ إنتهاء الصلاحية.
dnstxt موضوع[] قائمة سجلات TXT لنظام أسماء النطاقات لكل مجال للتحقق من صحة ما إذا لم يتم إصدار الشهادة بعد.
ملف خيط إنه اسم ملف الشهادة ، المعرف الفريد.
المصدر خيط سلطة معتمدة توقيع الشهادة.
الحالة خيط حالة الشهادة.صالح، الشهادة صالحة.على وشك الانتهاء، الشهادة على وشك الانتهاء.انتهت، الشهادة منتهية الصلاحية.لم يصدر، الشهادة معلقة ليتم إصدارها.غير معروف، الشهادة غير صالحة.
نوع خيط شهادة LE.
البدل خيط صحيح، الشهادة لمجالات أحرف البدل. زائف، الشهادة لمجالات غير أحرف البدل.

كائن dnstxt

الحقل النوع الوصف
نطاق خيط اسم النطاق
TXT خيط يجب أن يتم التحقق من صحة سجل DNS TXT LetsEncrypt. سيكون سجل TXT لنظام أسماء النطاقات متاحًا بواسطة _acme-Challen.domain.

لنقم بتشفير شهادات SSL Wildcard

تُعد شهادات Let's Encrypt wildcard شهادات صالحة فقط لنطاقات أحرف البدل.

أنشئ شهادة Let's Encrypt Wildcard الجديدة

أنشئ شهادة Let's Encrypt Wildcard الجديدة

طلب مثال:

url -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"domains":["*.wildcard.test.zevenet.com"],"test":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard
zcli certificate-le-wildcard create -wildcard true 

POST /certificates/letsencryptz-wildcard

قم بإنشاء شهادة Let's Encrypt wildcard جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها. صحيح
تجربه بالعربي خيط صحيح، يتم إصدار الشهادة بواسطة LetsEncrypt Staging Server. زائف، يتم إصدار الشهادة عن طريق LetsEncrypt Server وستكون صالحة لبيئة الإنتاج. صحيح

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

{
   "description" : "Create Let's Encrypt Wildcard certificate",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.wildcard.test.zevenet.com",
               "txt" : "jtt2WBHXl0cRw33mgoHUo1hbFGLipNbeb2EtTWpRORM"
            }
         ],
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }
   ]
}

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

الحقل النوع الوصف
params موضوع[] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
CN خيط اسم المجال الشائع.
خلق خيط تاريخ الإنشاء.
dnstxt موضوع[] قائمة سجلات TXT لنظام أسماء النطاقات لكل مجال للتحقق من صحة ما إذا لم يتم إصدار الشهادة بعد.
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها.
الانتهاء خيط تاريخ إنتهاء الصلاحية.
ملف خيط إنه اسم ملف الشهادة ، المعرف الفريد.
المصدر خيط سلطة معتمدة توقيع الشهادة.
الحالة خيط حالة الشهادة.صالح، الشهادة صالحة.على وشك الانتهاء، الشهادة على وشك الانتهاء.انتهت، الشهادة منتهية الصلاحية.لم يصدر، الشهادة معلقة ليتم إصدارها.غير معروف، الشهادة غير صالحة.
نوع خيط شهادة LE.
البدل خيط صحيح، الشهادة لمجالات أحرف البدل. زائف، الشهادة لمجالات غير أحرف البدل.

كائن dnstxt

الحقل النوع الوصف
نطاق خيط اسم النطاق
TXT خيط يجب أن يتم التحقق من صحة سجل DNS TXT LetsEncrypt. سيكون سجل TXT لنظام أسماء النطاقات متاحًا بواسطة _acme-Challen.domain.

قم بتعيين إجراء في Let's Encrypt Wildcard Certificate

قم بتعيين إجراء في Let's Encrypt Wildcard Certificate

طلب مثال:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com/actions
zcli certificate-le-wildcard renew *.example.domain.com

POST /certificates/letsencryptz-wildcard/<domain>/actions

قم بتطبيق إجراء على شهادة Let's Encrypt ، راجع جدول معاملات الطلب للإجراءات.

طلب المعلمات

الحقل النوع الوصف مطلوب:
الإجراءات خيط الإجراء للتنفيذ ، الاحتمالات هي: تجديد، سيتم تجديد الشهادة ؛ تجربه بالعربي سيتم التحقق من سجلات dns txt عبر استعلام نظام أسماء النطاقات.
تجديد القوة خيط (فقط لإجراء "تجديد") صحيح، إجبار الشهادة على التجديد حتى لم تنته صلاحيتها ، زائف، سيتم تجديد الشهادة إذا كان من المقرر تجديدها (أقل من 30 يومًا على انتهاء الصلاحية).
إعادة تشغيل خيط (فقط لإجراء "تجديد") صحيح، سيتم إعادة تشغيل جميع المزارع التي تستخدم الشهادة. زائف، لن يتم إعادة تشغيل أي مزارع تستخدم الشهادة.
DNS خيط (لإجراء "الاختبار" فقط) يجب استخدام خادم Dns لاختبار سجل TXT لنظام أسماء النطاقات _acme-Challen.domain.

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

{
   "description" : "Let's Encrypt wildcard certificate actions",
   "message" : "The action renew has been performed in Let's Encrypt certificate *.test1.wildcard.test.zevenet.io.",
   "params" : {
      "action" : "renew",
      "status" : "valid"
   }
}

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

الحقل النوع الوصف
params موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
عمل خيط تاريخ الإنشاء.
الحالة خيط حالة الشهادة.صالح، الشهادة صالحة.على وشك الانتهاء، الشهادة على وشك الانتهاء.انتهت، الشهادة منتهية الصلاحية.لم يصدر، الشهادة معلقة ليتم إصدارها.غير معروف، الشهادة غير صالحة.
dnstxt موضوع[] (فقط لإجراء "الاختبار") قائمة سجلات TXT لنظام أسماء النطاقات لكل مجال ونتائج استعلام DNS الخاصة بهم عبر خادم DNS.

كائن dnstxt

الحقل النوع الوصف
DNS خيط خادم DNS المطلوب استخدامه. تعني كلمة "فارغ" استخدام ما تم تكوينه في النظام.
نطاق خيط اسم النطاق
مورد هدف يجب فحص مورد DNS.
الحالة خيط نتيجة فحص DNS TXT Record عبر خادم DNS. إلى أسفل إذا كان DNS TXT إعادة

الحبل لم يتم العثور على خادم DNS. up إذا تم العثور على سجل DNS TXT.

كائن المورد

الحقل النوع الوصف
rname خيط اسم مورد DNS. دعونا تشفير يتطلب _acme- التحدي
نوع خيط نوع سجل DNS. دعونا تشفير يتطلب TXT
rdata خيط قيمة سجل DNS.

احذف حرف بدل لنقوم بتشفير الشهادة

احذف حرف بدل لنقوم بتشفير الشهادة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com
zcli certificate-le-wildcard delete *.example.domain.com

DELETE /certificates/letsencryptz-wildcard/<domain>

احذف شهادة Let's Encrypt wildcard حسب المجال.

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

{
   "description" : "Delete Let's Encrypt wildcard certificate",
   "message" : "Let's Encrypt wildcard Certificate example.domain.com has been deleted.",
   "success" : "true"
}

Let'sEncrypt SSL بدون شهادات البدل

Let'sEncrypt no wildcard شهادات شهادات صالحة فقط لنطاقات بدل.

قم بإنشاء شهادة Let'sEncrypt No Wildcard جديدة

أنشئ شهادة Let's Encrypt No Wildcard الجديدة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"lefarm","domains":["test.zevenet.com"],"test":"true","wildcard":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le create -wildcard false 

POST /certificates/letsencryptz

قم بإنشاء شهادة Let's Encrypt wildcard جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم المزرعة الذي تم تكوين الخدمة المؤقتة "Let's Encryptz" فيه. صحيح إذا لم يتم إرسال param vip.
كبار الشخصيات خيط IP للنظام ، حيث تم تكوين مزرعة مؤقتة "Let's Encryptz". صحيح إذا لم يتم إرسال param farmname.
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها. صحيح
البدل خيط صحيح، الشهادة لمجالات أحرف البدل. زائف، الشهادة لمجالات غير أحرف البدل. صحيح
تجربه بالعربي خيط صحيح، يتم إصدار الشهادة بواسطة LetsEncrypt Staging Server. زائف، يتم إصدار الشهادة عن طريق LetsEncrypt Server وستكون صالحة لبيئة الإنتاج. صحيح

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

{
   "description" : "Create Let's Encrypt certificate",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:05:30 2021 GMT",
      "domains" : [
         "test.zevenet.io"
      ],
      "expiration" : "Aug 29 11:05:30 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   }
}

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

الحقل النوع الوصف
params موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
CN خيط اسم المجال الشائع.
خلق خيط تاريخ الإنشاء.
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها.
الانتهاء خيط تاريخ إنتهاء الصلاحية.
ملف خيط إنه اسم ملف الشهادة ، المعرف الفريد.
المصدر خيط سلطة معتمدة توقيع الشهادة.
الحالة خيط حالة الشهادة.صالح، الشهادة صالحة.على وشك الانتهاء، الشهادة على وشك الانتهاء.انتهت، الشهادة منتهية الصلاحية.لم يصدر، الشهادة معلقة ليتم إصدارها.غير معروف، الشهادة غير صالحة.
نوع خيط شهادة LE.
البدل خيط صحيح، الشهادة لمجالات أحرف البدل. زائف، الشهادة لمجالات غير أحرف البدل.

قم بتعيين إجراء في Let's Encrypt no Wildcard Certificate

قم بتعيين إجراء في شهادة Let's Encrypt No Wildcard

طلب مثال:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","vip":"192.168.101.44","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com/actions
zcli certificate-le renew example.domain.com ( not implemented )

POST /certificates/letsencryptz/<domain>/actions

عيِّن إجراءً في شهادة Let's Encrypt no wildcard ، راجع جدول معلمات الطلب للإجراءات.

طلب المعلمات

الحقل النوع الوصف مطلوب:
عمل خيط الإجراء المطلوب تنفيذه: الاحتمالات هي: تجديدسيتم تجديد الشهادة.
farmname خيط اسم المزرعة الذي تم تكوين خدمة مؤقتة "Let's Encryptz" فيه لتجديد الشهادة. صحيح إذا لم يتم إرسال param vip.
كبار الشخصيات خيط IP للنظام ، حيث تم تكوين مزرعة مؤقتة "Let's Encryptz" لتجديد الشهادة. صحيح إذا لم يتم إرسال param farmname.
تجديد القوة خيط صحيح، إجبار الشهادة على التجديد حتى لم تنته صلاحيتها ، زائف، سيتم تجديد الشهادة إذا كان من المقرر تجديدها (أقل من 30 يومًا على انتهاء الصلاحية).
إعادة تشغيل خيط صحيح، سيتم إعادة تشغيل جميع المزارع التي تستخدم الشهادة. زائف، لن يتم إعادة تشغيل أي مزارع تستخدم الشهادة.

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

{
   "description" : "Let's Encrypt certificate actions",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:35:08 2021 GMT",
      "domains" : [
         "test.zevenet.com"
      ],
      "expiration" : "Aug 29 11:35:08 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   },
   "warning" : "The following farms were been restarted: testl7farm"
}

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

إذا تم إعادة تشغيل المزارع ، فإن تحذير سيصفها الحقل.

الحقل النوع الوصف
params موضوع[ ] قائمة كائنات الشهادة.

كائن الشهادة

الحقل النوع الوصف
CN خيط اسم المجال الشائع.
خلق خيط تاريخ الإنشاء.
المجالات خيط[] قائمة المجالات التي تكون الشهادة صالحة لها.
الانتهاء خيط تاريخ إنتهاء الصلاحية.
ملف خيط إنه اسم ملف الشهادة ، المعرف الفريد.
المصدر خيط سلطة معتمدة توقيع الشهادة.
الحالة خيط حالة الشهادة.صالح، الشهادة صالحة.على وشك الانتهاء، الشهادة على وشك الانتهاء.انتهت، الشهادة منتهية الصلاحية.لم يصدر، الشهادة معلقة ليتم إصدارها.غير معروف، الشهادة غير صالحة.
نوع خيط شهادة LE.
البدل خيط صحيح، الشهادة لمجالات أحرف البدل. زائف، الشهادة لمجالات غير أحرف البدل.

احذف أي حرف بدل ، فلنقم بتشفير الشهادة

احذف أي حرف بدل ، فلنقم بتشفير الشهادة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com
zcli certificate-le delete example.domain.com

DELETE /certificates/letsencryptz/<domain>

احذف شهادة Let's Encrypt حسب المجال.

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

{
   "description" : "Delete Let's Encrypt certificate",
   "message" : "Let's Encrypt Certificate example.domain.com has been deleted.",
   "success" : "true"
}

المزارع

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

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

قائمة ملخص المزارع

قائمة المزارع ملخص

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/modules/summary

GET /farms/modules/summary

سرد ملخص مع المزارع في النظام ، مجمعة حسب الوحدة النمطية.

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

{
   "description" : "Farm Modules summary",
   "params" : {
      "dslb" : [],
      "gslb" : [
         {
            "name" : "dnsServ",
            "profile" : "gslb",
            "services" : []
         }
      ],
      "lslb" : [
         {
            "name" : "CatalogueWeb",
            "profile" : "http",
            "services" : [
               "technology",
               "food"
            ]
         },
         {
            "name" : "shopApp",
            "profile" : "http",
            "services" : [
               "provider",
               "clients"
            ]
         },
         {
            "name" : "VirtualApps",
            "profile" : "l4xnat"
         }
      ]
   }
}

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

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

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

الحقل النوع الوصف
farmname خيط اسم مزرعة وصفي. يتم استخدامه كمعرف فريد للمزارع.
البيانات الشخصية خيط نوع الملف الشخصي ، القيم المتاحة في الملف الشخصي هي: HTTP, HTTPS or l4xnat لوحدة LSLB ، gslb لوحدة GLSB و وصلة البيانات لوحدة DSLB
خدمة خيط[] إنه اسم قائمة الخدمات التي تحتويها المزرعة. هذا الحقل سيكون متاحا في مزارع من النوع HTTP, HTTPSو gslb.

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

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

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm list

GET /farms

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

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

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

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

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

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

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

حذف مزرعة

حذف مزرعة

طلب مثال:

curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm delete 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/v4.0/zapi.cgi/farms/FarmTCP/actions
zcli farm stop FarmTCP

PUT /farms/<farmname>/actions

تطبيق إجراء على مزرعة ، راجع جدول معلمات الطلب للإجراءات.

طلب المعلمات

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

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

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

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

إذا لم تكن هناك مشكلات في التكوين ، فسوف تُرجع ZAPI الإجراء المطلوب.

مزارع HTTP

ملف تعريف HTTP هو موازنة تحميل 7 لطبقة متقدمة (أو مراقب تسليم التطبيقات) مع خصائص خاصة بالوكالة. يوفر ملف التعريف هذا بعض الميزات مثل موازنة تحميل HTTPS مع تسريع إلغاء تحميل 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/v4.0/zapi.cgi/farms/httpFarm
zcli farm get httpFarm

GET /farms/<farmname>

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

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

{
   "description" : "List farm httpFarm",
   "ipds" : {
      "blacklists" : [
         {
            "name" : "outside",
            "status" : "down"
         }
      ],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ],
      "waf" : [
         {
            "name" : "XSSi",
            "status" : "down"
         },
         {
            "name" : "SQLi",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "addheader" : [
         {
            "header" : "load-balancer: true",
            "id" : 0
         }
      ],
      "addresponseheader" : [
         {
            "header" : "Session: 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",
      "errorWAF"  : "The request was rejected by the server.",
      "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",
      "removeresponseheader" : [
         {
            "id" : 0,
            "pattern" : "Host"
         }
      ],
      "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" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
      {
         "backends" : [
            {
               "alias" : "http-server",
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null,
               "priority" : 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" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
   ]
}

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

ستكون الاستجابة كائن JSON بالتنسيق أدناه.

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

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

كائن IPDS:

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

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

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

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

الحقل النوع الوصف
addheader موضوع[] وهي قائمة بالكائنات ذات الرؤوس لإضافتها إلى طلب العميل.
addresponseheader (من 4.0.1) موضوع[] وهي قائمة بالكائنات ذات الرؤوس لإضافتها إلى استجابة الخلفية.
certlist موضوع[] فقط إذا كان المستمع HTTPS. يتم استخدام قائمة الشهادات من قبل المزرعة ، لديهم بتنسيق PEM ، يُسمح بإضافة أكثر من شهادة PEM إلى المزرعة نفسها لدعم SNI. يمكن استخدام أي شهادة في مخزن الشهادات هنا.
cipherc خيط فقط في https المستمع. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها من خلال اتصال طبقة المقابس الآمنة ، وهي عبارة عن سلسلة بنفس التنسيق كما في أصفار OpenSSL. هذه السمة تستخدم فقط عندما الأصفار الحقل له قيمة "الأمن الجمركي".
الأصفار خيط فقط إذا كان المستمع 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 مسموحًا به.
خطأ WAF خيط رسالة مخصصة للرد عندما يرفض WAF طلبًا (من 4.0.2).
error414 خيط رسالة مخصصة للاستجابة برمز خطأ 414 HTTP.
error500 خيط رسالة مخصصة للاستجابة برمز خطأ 500 HTTP.
error501 خيط رسالة مخصصة للاستجابة برمز خطأ 501 HTTP.
error503 خيط رسالة مخصصة للاستجابة برمز خطأ 503 HTTP.
headremove موضوع[] إنها قائمة التعبيرات العادية لإزالة الرؤوس من طلبات العميل. لن تصل الرؤوس التي تمت إزالتها إلى الواجهة الخلفية.
httpverb خيط يشير هذا الحقل إلى العمليات التي سيتم السماح بها لطلبات عميل HTTP. القيم المتاحة هي: standardHTTP، طلبات HTTP المقبولة GET ، POST ، HEAD. extendedHTTP، قبلت طلبات HTTP السابقة بالإضافة إلى PUT ، DELETE. خيارات HTTP (من 4.0.1) ، أضف فعل OPTIONS إلى الأفعال السابقة. 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. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
رأس المزيل (من 4.0.1) موضوع[] وهي قائمة بالتعبيرات العادية لإزالة الرؤوس من استجابة الخلفية. لن تصل الرؤوس التي تمت إزالتها إلى العميل.
reqtimeout رقم الهاتف إلى متى ستنتظر المزرعة طلب العميل في ثوانٍ.
restimeout رقم الهاتف إلى متى ستنتظر المزرعة استجابة من الخلفيات في ثوانٍ.
resurrectime رقم الهاتف فترة الخروج من الخادم الحقيقي الساقط ، بعد هذه الفترة يتحقق توازن التحميل إذا كان الخادم الحقيقي على قيد الحياة ، في ثوانٍ.
rewritelocation موضوع[] إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، مفعل معاق، المعطل أو تمكين الخلفيات تتم مقارنة فقط عنوان الخلفية. من 4.0.2 الخيارات الجديدة المتاحة: تمكين المسار و تمكين الخلفية المسار. يتم تطبيق المسار إذا قام التوجيه RewriteUrl بتعديل عنوان URL الخاص بالطلب. تفرض هذه العلامة على التراجع عن تحويل عنوان URL الذي قام به RewriteUrl.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. 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.
اتصال مثبت (من الإصدار 4.0.2) رقم الهاتف حدد ما إذا كنا نريد تثبيت جميع الاتصالات ، (الافتراضي: 0 ، غير مثبت). إذا تم تعيين Pinnedconnection على 1 ، فإن zproxy يعيد توجيه جميع البيانات مباشرة دون تحليل أو تحرير.
سياسة التوجيه (من الإصدار 4.0.2) خيط حدد سياسة التوجيه. يتم ترجيح جميع الخوارزميات باستخدام جميع الأوزان المحددة في كل خلفية. هناك أربعة خيارات: ROUND_ROBIN استخدام خوارزمية round robin كسياسة توجيه (الافتراضي). LEAST_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات تم إنشاؤها باستخدام مجموعة الأوزان كنسبة مئوية. وقت الاستجابة حدد الخلفية ذات أقل وقت استجابة باستخدام الأوزان التي تم تعيينها كنسبة. PENDING_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات معلقة باستخدام نسبة الأوزان المحددة.
إعادة كتابة عنوان URL (من الإصدار 4.0.2) موضوع[] يتحقق من نمط ما للحصول على سلاسل من URL واستبدالها. يمكن إضافة عدة توجيهات RewriteUrl. سيتم تطبيق كل منهم بالتسلسل على عنوان URL الوارد ما لم يتم تعيين العلم الأخير الذي سينهي مرحلة إعادة كتابة عنوان url.

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

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

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

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

طلب مثال:

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newHTTPfarm -profile http -vip 192.168.100.23 -vport 80

POST /farms

قم بإنشاء مزرعة HTTP جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم مزرعة وصفي. يتم استخدامه كمعرف فريد. صحيح
البيانات الشخصية خيط ملف تعريف المزرعة التي تم إنشاؤها. لمزارع HTTP هو HTTP. صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث سيتم تشغيل الخدمة الافتراضية. يجب تكوين IP المشار إليه في النظام و UP صحيح
vport رقم الهاتف ميناء المزرعة ، حيث ستستمع الخدمة الافتراضية. يجب ألا يكون نفس المنفذ الظاهري و IP الظاهري قيد الاستخدام من قبل مزرعة أخرى. صحيح
نسخة من (من 4.0.1) خيط تتوقع هذه المعلمة اسم مزرعة موجودة. إذا تم إرسال هذه المعلمة ، يتم نسخ المزرعة من المزرعة المحددة فيها. ال farmname, كبار الشخصيات و vport سيتم استبدال القيم.

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

{
   "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", "errorWAF":"Message error WAF",
"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/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -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 -errorcode414 'Message error 414' -logs true

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. خيارات HTTP (من 4.0.1) ، أضف فعل OPTIONS إلى الأفعال السابقة. 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 سيتم معالجة الرأس.
خطأ WAF خيط خطأ رسالة شخصية WAF (من الإصدار 4.0.2).
error414 خيط خطأ في رسالة شخصية 414.
error500 خيط خطأ في رسالة شخصية 500.
error501 خيط خطأ في رسالة شخصية 501.
error503 خيط خطأ في رسالة شخصية 503.
مستمع خيط يحدد المستمع كيف ستقوم المزرعة باللعب مع الطلبات الواردة من العملاء. الخيارات هي: HTTP لبروتوكول غير آمن أو HTTPS للبروتوكول المؤمن.
الجذوع خيط المزرعة بتسجيل أثر اتصالات HTTP. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
الأصفار خيط فقط في المستمع مع قيمة HTTPS. تستخدم لإنشاء قائمة من الأصفار المقبولة بواسطة اتصالات SSL لتصلب اتصال SSL. الخيارات هي: من جميع، سيتم قبول جميع الأصفار. حماية عالية، سيتم قبول الأصفار للأمن العالي فقط ؛ customsecurity، فقط الأصفار تحميلها cipherc سيتم قبول المجال أو ssloffloading، فإنه يؤول مهمة تشفير للعملية ، يعتمد هذا التشفير على المعالج.
cipherc خيط فقط في https المستمع. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها من خلال اتصال طبقة المقابس الآمنة ، وهي عبارة عن سلسلة بنفس التنسيق كما في أصفار OpenSSL. هذه السمة تستخدم فقط عندما الأصفار الحقل له قيمة "الأمن الجمركي".
newfarmname خيط اسم المزرعة الجديد. يجب إيقاف المزرعة.
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية.
كبار الشخصيات خيط IP للمزرعة ، حيث يتم الاستماع الخدمة الافتراضية ، يجب تكوين IP هذا وما يصل في النظام.
اسم الشهادة خيط تم تكوين شهادة Https

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

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

أضف رأسًا مخصصًا إلى الطلب

أضف رأسًا مخصصًا إلى الطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

POST /farms/<farmname>/addheader

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

طلب المعلمات

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

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

{
   "description" : "Add addheader directive.",
   "message" : "Added a new item to the addheader list",
   "status" : "needed restart",
   "success" : "true"
}

قم بتعديل إضافة رأس مخصص إلى قاعدة الطلب

قم بتعديل إضافة رأس مخصص إلى قاعدة الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/id
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

PUT /farms/<farmname>/addheader/<id>

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

طلب المعلمات

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

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

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}

حذف رأس مخصص من الطلب

حذف رأس مخصص من الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/0
zcli farm-add-request-header remove MyHttpFarm 0

DELETE /farms/<farmname>/addheader/<index>

مؤشر هو فهرس مجموعة Addheader للحذف.

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

{
   "description" : "Delete addheader directive.",
   "message" : "The addheader 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 '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

POST /farms/<farmname>/headremove

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Add headremove directive.",
   "message" : "Added a new item to the headremove list",
   "status" : "needed restart",
   "success" : "true"
}

تعديل إزالة الرؤوس من قاعدة الطلب

تعديل إزالة الرؤوس من قاعدة الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/id
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

PUT /farms/<farmname>/headremove/<id>

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Modify an headremove directive.",
   "message" : "Modified an item from the headremove list",
   "success" : "true"
}

حذف قاعدة لإزالة الرؤوس من الطلب

حذف قاعدة لإزالة الرؤوس من الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/0
zcli farm-remove-request-header remove MyHttpFarm 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 '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/addresponseheader

ستضيف المزرعة رأس استجابة الخلفية.

طلب المعلمات

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

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

{
   "description" : "Add a header to the backend repsonse.",
   "message" : "Added a new header to the backend response",
   "status" : "needed restart",
   "success" : "true"
}

قم بتعديل إضافة رأس مخصص إلى قاعدة الاستجابة

قم بتعديل إضافة رأس مخصص إلى قاعدة الاستجابة

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/id
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

ستضيف المزرعة رأس استجابة الخلفية.

طلب المعلمات

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

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

{
   "description" : "Modify an addresponseheader directive.",
   "message" : "Modified an item from the addresponseheader list",
   "success" : "true"
}

حذف رأس مخصص من الاستجابة

حذف رأس مخصص من الاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/0
zcli farm-add-response-header remove torta 0

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/addresponseheader/<index>

مؤشر هو فهرس صفيف addresponseheader المطلوب حذفه.

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

{
   "description" : "Delete a header previously added to the backend response.",
   "message" : "The header 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 '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/removeresponseheader

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Remove a header from the backend response.",
   "message" : "Added a patter to remove reponse headers",
   "status" : "needed restart",
   "success" : "true"
}

قم بتعديل قاعدة إزالة الرؤوس من الاستجابة

قم بتعديل قاعدة إزالة الرؤوس من الاستجابة

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/id
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/removeresponseheader/<id>

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Modify a remove response header directive.",
   "message" : "Modified an item from the removeresponseheader list",
   "success" : "true"
}

حذف قاعدة لإزالة الرأس من الاستجابة

حذف قاعدة لإزالة الرأس من الاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/0
zcli farm-remove-response-header remove torta 0

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/removeresponseheader/<index>

مؤشر هو فهرس صفيف رأس المزيل المراد حذفه.

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

{
   "description" : "Delete a pattern to remove response headers.",
   "message" : "The pattern 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 '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/replacerequestheader

أضف قواعد لإعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

تعديل إعادة كتابة الرؤوس من قاعدة الطلب

تعديل إعادة كتابة الرؤوس من قاعدة الطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/replacerequestheader/<id>

أضف قواعد لإعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

احذف قاعدة لإعادة كتابة الرؤوس من الطلب

احذف قاعدة لإعادة كتابة الرؤوس من الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/0
zcli farm-replace-request-header remove MyHttpFarm 0

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/replacerequestheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 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 '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id/actions
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/replacerequestheader/<id>/actions

انقل رأس ReplaceRequest.

طلب المعلمات

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

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

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

أضف قاعدة لإعادة كتابة الرؤوس من الاستجابة

أضف قاعدة لإعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/replaceresponseheader

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

قم بتعديل قاعدة إعادة كتابة الرؤوس من الاستجابة

قم بتعديل قاعدة إعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/replaceresponseheader/<id>

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

احذف قاعدة لإعادة كتابة الرؤوس من الاستجابة

احذف قاعدة لإعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/0
zcli farm-replace-response-header remove MyHttpFarm 0

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/replaceresponseheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 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 '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/replaceresponseheader/<id>/actions

انقل رأس ReplaceRequest.

طلب المعلمات

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

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

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

أضف شهادة

أضف شهادة

طلب مثال:

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

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 POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarm/certificates/certif.pem/actions
zcli farm-certificate move newfarm zertif.pem -position 0

POST /farms/<farmname>/certificates/<file>/actions

و URI file المعلمة هي اسم ملف الشهادة الذي سيتم نقله.

تسمح هذه الميزة بنقل الشهادات لتغيير الترتيب الذي سيتم التحقق منه.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ان يرتفع المركز عدد صحيح هذا هو الموضع الذي ستحصل عليه الشهادة في تكوين المزرعة عند معالجة مكالمة ZAPI صحيح

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

{
    "description" : "Move service",
    "params" : {
        "position" : 0
    },
    "status" : "needed restart",
    "info" : "There\'re changes that need to be applied, stop and start farm to apply them!",
    "message" : "certif.pem was moved successfully."
}

حذف شهادة

حذف شهادة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
zcli farm-certificate remove MyHttpFarm 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/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists
zcli farm-blacklist add httpFarm -name china

POST /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>

قم بتطبيق القائمة السوداء أو DoS أو RBL أو WAF على المزرعة.

طلب المعلمات

الحقل النوع الوصف
الاسم خيط اسم قاعدة 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 POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2

POST /farms/<farmname>/ipds/<waf|blacklists>/<name>/actions

قواعد IPDS للنقل متاحة فقط لقواعد WAF والقائمة السوداء. في هذا النوع من القواعد مهم الترتيب الذي سيتم التحقق منه.

يوفر name معلمة URI هي اسم مجموعة القواعد التي سيتم نقلها.

طلب المعلمات

الحقل النوع الوصف مطلوب:
ان يرتفع المركز عدد صحيح إنه الموضع الذي ستشغله قاعدة IPDS في تكوين المزرعة عندما تتم معالجة مكالمة ZAPI صحيح

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

{
    "message" : "The rule was moved properly to the position 2.",
    "description" : "Move a rule in the set test_waf_ori"
}

قم بإزالة قاعدة IPDS

قم بإزالة قاعدة IPDS

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists/china
zcli farm-blacklist remove httpFarm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>/<name>

قم بإزالة قائمة سوداء أو DoS أو RBL أو WAF من مزرعة معينة باستخدام مؤشرها الاسم.

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

{
   "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/v4.0/zapi.cgi/farms/cookiefarm/services/serv
zcli farm get cookiefarm -filter services

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,
            "priority" : null,
            "connection_limit" : null
         },
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null,
            "priority" : null,
            "connection_limit" : 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" : "",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN",
      "replacerequestheader" : [],
      "replaceresponseheader" : [],
      "addrequestheader" : [],
      "addresponseheader" : [],
      "removerequestheader" : [],
      "removeresponseheader" : [],
      "rewriteurl" : [],
      "sessions" : []
   }
}

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

ستكون الاستجابة كائن 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.
اتصال مثبت (من الإصدار 4.0.2) رقم الهاتف حدد ما إذا كنا نريد تثبيت جميع الاتصالات ، (الافتراضي: 0 ، غير مثبت). إذا تم تعيين Pinnedconnection على 1 ، فإن zproxy يعيد توجيه جميع البيانات مباشرة دون تحليل أو تحرير.
سياسة التوجيه (من الإصدار 4.0.2) خيط حدد سياسة التوجيه. يتم ترجيح جميع الخوارزميات باستخدام جميع الأوزان المحددة في كل خلفية. هناك أربعة خيارات: ROUND_ROBIN استخدام خوارزمية round robin كسياسة توجيه (تقصيرر). LEAST_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات تم إنشاؤها باستخدام مجموعة الأوزان كنسبة مئوية. وقت الاستجابة حدد الخلفية ذات أقل وقت استجابة باستخدام الأوزان التي تم تعيينها كنسبة. PENDING_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات معلقة باستخدام نسبة الأوزان المحددة.
الاستبدالمن الإصدار 4.0.2) موضوع[] صفيف من القواعد لاستبدال رأس في الطلب. في حالة تطابق العديد من التعبير العادي في الرأس ، فسيتم تطبيق أول واحد فقط. التوجيه replaceHeader في الخدمات له الأولوية على المستمع.
استبدال رأس الاستجابة (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لاستبدال رأس استجابة. في حالة تطابق العديد من التعبير العادي في الرأس ، فسيتم تطبيق أول واحد فقط. التوجيه replaceHeader في الخدمات له الأولوية على المستمع.
العنوان الإضافي (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لإضافة العنوان المحدد إلى الطلب الذي تم تمريره إلى العملاء. تمت إضافة الرأس حرفيا.
addresponseheader (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لإضافة الرأس المحدد إلى الاستجابة التي تم تمريرها إلى العملاء. تمت إضافة الرأس حرفيا.
رئيس الاسترداد (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لإزالة رؤوس معينة من الطلب الخارج ، لا يتم إرسال الرأس المرسل بواسطة الواجهة الخلفية إلى العميل.
رأس المزيل (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لإزالة رؤوس معينة من الاستجابة الخارجة ، لا يتم إرسال الرأس المرسل بواسطة الواجهة الخلفية إلى العميل.
إعادة كتابة عنوان URL (من الإصدار 4.0.2) موضوع[] صفيف من القواعد لتغيير رؤوس الموقع والمحتوى في الردود لإظهار المضيف الظاهري الذي تم إرساله في الطلب.
الجلسات (من الإصدار 4.0.2) موضوع[] قائمة الجلسات الثابتة والديناميكية التي تم إنشاؤها لخدمة المزرعة هذه.

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

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

replaceRequestHeader و replaceResponseHeader كائنات لخدمات مزرعة HTTP:

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

addRequestHeader وكائن addResponseHeader لخدمات مزرعة HTTP:

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

removeRequestHeader وكائن removeResponseHeader لخدمات مزرعة HTTP:

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

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

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

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

الحقل النوع الوصف
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "IP" الجلسة يجب أن يكون IPv4 أو IPv6 ، مثل 192.168.42.65 ؛
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا لم تكن الجلسة من النوع الثابت.

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

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

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
zcli farm-service add FarmHTTP -id newserv

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","pinnedconnection":0,"routingpolicy":"ROUND_ROBIN"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -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 -pinnedconnection 0 -routingpolicy ROUND_ROBIN

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 إلى الخلفيات.
اتصال مثبت (من الإصدار 4.0.2) رقم الهاتف حدد ما إذا كنا نريد تثبيت جميع الاتصالات ، (الافتراضي: 0 ، غير مثبت). إذا تم تعيين Pinnedconnection على 1 ، فإن zproxy يعيد توجيه جميع البيانات مباشرة دون تحليل أو تحرير.
سياسة التوجيه (من الإصدار 4.0.2) خيط حدد سياسة التوجيه. يتم ترجيح جميع الخوارزميات باستخدام جميع الأوزان المحددة في كل خلفية. هناك أربعة خيارات: ROUND_ROBIN استخدام خوارزمية round robin كسياسة توجيه (الافتراضي). LEAST_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات تم إنشاؤها باستخدام مجموعة الأوزان كنسبة مئوية. وقت الاستجابة حدد الخلفية ذات أقل وقت استجابة باستخدام الأوزان التي تم تعيينها كنسبة. PENDING_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات معلقة باستخدام نسبة الأوزان المحددة.
إعادة تحديد الموقع (من الإصدار 4.0.2) خيط إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، مفعل معاق، المعطل أو تمكين الخلفيات تتم مقارنة فقط عنوان الواجهة الخلفية. الخيارات الأخرى المتاحة: تمكين المسار و تمكين الخلفية المسار. يتم تطبيق المسار إذا قام التوجيه RewriteUrl بتعديل عنوان URL الخاص بالطلب. تفرض هذه العلامة على التراجع عن تحويل عنوان URL الذي قام به RewriteUrl.

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

{
   "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",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN"
   },
   "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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/fg
zcli farm-service-farmguardian add FarmHTTP service1 -name check_tcp-cut_conns

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/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove FarmHTTP service1 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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/actions
zcli farm-service move FarmHTTP service1 -position 0

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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1
zcli farm-service remove FarmHTTP 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"
}

أضف قاعدة لإعادة كتابة الرؤوس من الطلب

أضف قاعدة لإعادة كتابة الرؤوس من الطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/service/<servicename>/replacerequestheader

أضف قواعد لإعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header"
}

تعديل إعادة كتابة الرؤوس من قاعدة الطلب

تعديل إعادة كتابة الرؤوس من قاعدة الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

تعديل قاعدة إعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}
تعديل إعادة كتابة الرؤوس من قاعدة الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

تعديل قاعدة إعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}

احذف قاعدة لإعادة كتابة الرؤوس من الطلب

احذف قاعدة لإعادة كتابة الرؤوس من الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/Index
zcli farm-service-replacerequestheader remove MyHttpFarm MyService Index

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replacerequestheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

أضف قاعدة لإعادة كتابة الرؤوس من الاستجابة

أضف قاعدة لإعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/service/<servicename>/replaceresponseheader

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

نقل إعادة كتابة الرؤوس من قاعدة الطلب

نقل إعادة كتابة الرؤوس من قاعدة الطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/services/<service>/replacerequestheader/<id>/actions

انقل رأس ReplaceRequest.

طلب المعلمات

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

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

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

قم بتعديل قاعدة إعادة كتابة الرؤوس من الاستجابة

قم بتعديل قاعدة إعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/service/<servicename>/replaceresponseheader/<id>

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح
مباراة خيط قيمة Regex لتتناسب مع ما نريد استبداله صحيح
يحل محل خيط القيمة لاستبدال التطابقات صحيح

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

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

احذف قاعدة لإعادة كتابة الرؤوس من الاستجابة

احذف قاعدة لإعادة كتابة الرؤوس من الاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/Index
zcli farm-service-replaceresponseheader remove MyHttpFarm MyService Index

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replaceresponseheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header <index> was deleted successfully"
}

نقل إعادة كتابة الرؤوس من قاعدة الاستجابة

نقل إعادة كتابة الرؤوس من قاعدة الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/services/<service>/replaceresponseheader/<id>/actions

انقل رأس ReplaceRequest.

طلب المعلمات

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

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

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

أضف قاعدة لإضافة رأس إلى الطلب

أضف قاعدة لإضافة رأس للطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader
farm-service-addrequestheader add farm1 -header "header: value"

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/addrequestheader

أضف قواعد لإعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح

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

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

قم بتعديل إضافة رأس إلى قاعدة الطلب

قم بتعديل إضافة رأس إلى قاعدة الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/id
farm-service-addrequestheader add farm1 -header "header: value"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/addrequestheader/<id>

أضف قواعد لإعادة كتابة الرؤوس من الطلب.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح

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

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

احذف قاعدة لإضافة رأس إلى الطلب

احذف قاعدة لإضافة رأس إلى الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/Index
zcli farm-service-addrequestheader remove MyHttpFarm MyService Index

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "message": "The add request header <index> has been deleted successfully"
}

أضف قاعدة لإضافة رأس للاستجابة

أضف قاعدة لإضافة رأس للاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader
zcli farm-service-addresponseheader add farm1 -header "header: value"

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/addresponseheader

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح

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

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

قم بتعديل إضافة رأس إلى قاعدة الاستجابة

قم بتعديل إضافة رأس إلى قاعدة الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/id
zcli farm-service-addresponseheader add farm1 -header "header: value"

هذه المكالمة متاحة من الإصدار 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

أضف قواعد لإعادة كتابة الرؤوس من الاستجابة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
رأس خيط Regex مع اسم الرأس المراد إعادة كتابته صحيح

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

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}


احذف قاعدة لإضافة رأس للاستجابة

احذف قاعدة لإضافة رأس للاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/Index
zcli farm-service-addresponseheader remove MyHttpFarm MyService Index

هذه المكالمة متاحة من الإصدار 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

مؤشر هو فهرس مصفوفة الاستبدال المراد حذفها.

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

{
   "message": "The add response header 0 has been deleted successfully"
}

أضف قاعدة لإزالة الرؤوس من الطلب

أضف قاعدة لإزالة الرؤوس من الطلب

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removerequestheader

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "message": "Added a new remove request header"
}

تعديل القاعدة لإزالة الرؤوس من الطلب

تعديل القاعدة لإزالة الرؤوس من الطلب

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/id
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removerequestheader/<id>

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

حذف قاعدة لإزالة الرؤوس من الطلب

حذف قاعدة لإزالة الرؤوس من الطلب

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removerequestheader/<index>

مؤشر هو فهرس مصفوفة removerquestheader المراد حذفها.

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

{
   "message": "The remove request header <index> has been deleted successfully"
}


أضف قاعدة لإزالة الرؤوس من الاستجابة

أضف قاعدة لإزالة الرؤوس من الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removeresponseheader

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "message": "Added a new remove response header"
}

تعديل إزالة الرؤوس من قاعدة الاستجابة

تعديل إزالة الرؤوس من قاعدة الاستجابة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/id
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removeresponseheader/<id>

أزل بعض الرؤوس من الطلبات الواردة. ستتم إزالة جميع تكرارات العنوان المحدد المطابق.

طلب المعلمات

الحقل النوع الوصف مطلوب:
النمط خيط وهي سلسلة مع regexp للبحث عنها في طلبات العميل. إذا تطابقت بعض العناوين في النمط ، فستتم إزالة العنوان صحيح

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

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

احذف قاعدة لإزالة الرؤوس من الاستجابة

احذف قاعدة لإزالة الرؤوس من الاستجابة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removeresponseheader/<index>

مؤشر هو فهرس صفيف رأس المزيل المراد حذفه.

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

{
   "message": "The remove request header <index> has been deleted successfully"
}


أضف قاعدة لعمليات التحقق وأعد كتابة الأنماط من URL

أضف قاعدة لعمليات التحقق وأعد كتابة الأنماط من URL

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

POST /farms/<farmname>/service/<servicename>/rewriteurl

من الإصدار 4.0.2. يتحقق من نمط ما للحصول على سلاسل من URL واستبدالها.

طلب المعلمات

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

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

{
   "message": "Added a new rewriteurl"
}

تعديل قاعدة الشيكات وإعادة كتابة الأنماط من URL

تعديل قاعدة الشيكات وإعادة كتابة الأنماط من URL

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

PUT /farms/<farmname>/service/<servicename>/rewriteurl/<id>

من الإصدار 4.0.2. يتحقق من نمط ما للحصول على سلاسل من URL واستبدالها.

طلب المعلمات

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

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

{
   "description" : "Modify a RewriteUrl.",
   "message" : "Modify a new rewrite url",
   "success" : "true"
}

احذف قاعدة لفحص الأنماط وإعادة كتابتها من عنوان URL

احذف قاعدة لفحص الأنماط وإعادة كتابتها من عنوان URL

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/Index
zcli arm-service-rewriteurl remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/rewriteurl/<index>

من الإصدار 4.0.2. مؤشر هو فهرس المصفوفة المعاد كتابتها المراد حذفها.

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

{
   "message": "The rewriteurl <index> has been deleted successfully"
}


انقل عمليات التحقق وأعد كتابة الأنماط من قاعدة URL

انقل عمليات التحقق وأعد كتابة الأنماط من قاعدة URL

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

هذه المكالمة متاحة من الإصدار 4.0.2

POST /farms/<farmname>/services/<service>/rewriteurl/<id>/actions

انقل رأس ReplaceRequest.

طلب المعلمات

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

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

{
   "description" : "Move a rewriteurl directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

قائمة الجلسات

قائمة الجلسات

طلب مثال:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session list farm1 service0

GET /farms/<farmname>/services/<servicename>/sessions

من الإصدار 4.0.2. احصل على قائمة الجلسات في المزرعة: الخدمة. الملكية متاحة فقط لوكيل الجيل الجديد zproxy.

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

{
   "description" : "Get farm sessions",
   "params": [
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": null,
         "type": "static"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

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

يقوم هذا الطلب بإرجاع قائمة بكائن الجلسات ، ويحتوي كل كائن جلسة على المفاتيح التالية:

الحقل النوع الوصف
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "IP" الجلسة يجب أن يكون IPv4 أو IPv6 ، مثل 192.168.42.65 ؛
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا لم تكن الجلسة من النوع الثابت.

أضف جلسة

أضف جلسة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session add farm1 service0 -backend 0 -session 10.0.0.2

POST /farms/<farmname>/services/<servicename>/sessions

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

طلب المعلمات

الحقل النوع الوصف
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "IP" ، الجلسة يجب أن يكون IPv4 أو IPv6 ، مثل 192.168.42.65 ؛

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

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "id" : "0",
      "session" : "10.0.0.1",
      "ttl" : null,
      "type" : "static"
   }
}

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

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

الحقل النوع الوصف
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو 'IPالجلسة يجب أن يكون IPv4 أو IPv6 ، مثل 192.168.42.65.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا كانت الجلسة من النوع الثابت.
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.

إزالة جلسة

إزالة جلسة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions/10.0.0.1
zcli farm-service-session remove farm1 service0 10.0.0.1

DELETE /farms/<farmname>/services/<servicename>/sessions/<session>

يحذف جلسة ثابتة.

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

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

HTTP - خدمات - الخلفيات

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

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

طلب مثال:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
zcli farm get httpfarm

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,
         "priority" : null,
         "connection_limit" : null
      },
      {
         "alias" : null,
         "id" : 1,
         "ip" : "192.168.102.245",
         "port" : 80,
         "status" : "up",
         "timeout" : 22,
         "weight" : 2,
         "priority" : null,
         "connection_limit": null
      }
   ]
}

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

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

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

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

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

طلب مثال:

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,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2 -connection_limit 10

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

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

طلب المعلمات

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

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

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 0,
      "ip" : "192.168.102.244",
      "port" : 80,
      "timeout" : 2,
      "weight" : 2,
      "priority" : 1,
      "connection_limit" : 10
   },
   "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,"weight":1,"priority":1,"connection_limit":10}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1 -connection_limit 10

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

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

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

طلب المعلمات

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

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

{
   "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,
      "priority" : 4,
      "connection_limit" : 10
   },
   "status" : "needed restart",
   "warning" : "Backends with high priority value (4) will not be used."
}

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

سيكون الرد 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/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
zcli farm-service-backend maintenance httpfarm newsrv 0 -mode cut

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/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
zcli farm-service-backend remove newfarmHTTP service1 4

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

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

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

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

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

مزارع L4xNAT

تسمح مزرعة ملف تعريف L4xNAT بإنشاء مزارع موازنة التحميل التي تعمل في طبقة 4 من نموذج OSI ، مع أداء عالٍ للغاية واتصالات متزامنة أكثر بكثير من مراكز موازن التحميل في طبقة 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/v4.0/zapi.cgi/farms/l4farm
zcli farm get l4farm

GET /farms/<farmname>

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

جسم الرد:

{
   "backends" : [
      {
         "alias" : null,
         "max_conns" : 0,
         "id" : 0,
         "ip" : "192.168.55.40",
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "alias" : "server-1",
         "id" : 1,
         "max_conns" : 500,
         "ip" : "192.168.55.41",
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "ipds" : {
      "blacklists" : [
            {
              "status" : "down",
              "name" : "blacklist"
            }
      ],
      "dos" : [
         {
             "name" : "newlimitconns",
             "status" : "down"
         }
      ],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "algorithm" : "weight",
      "farmguardian" : "check_tcp-cut_conns",
      "listener" : "l4xnat",
      "logs" : "false",
      "nattype" : "nat",
      "persistence" : "ip",
      "protocol" : "tcp",
      "status" : "down",
      "ttl" : 120,
      "vip" : "192.168.100.241",
      "vport" : "88",
      "sessions": []
   }
}

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

ستكون الاستجابة كائن JSON بالتنسيق أدناه.

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

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

كائن IPDS:

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

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

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

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

الحقل النوع الوصف
خوارزمية خيط نوع جدولة موازنة التحميل المستخدم لإرسال حركة المرور بين المؤخرة. الخيارات هي: leastconn توجيه الاتصال دائمًا بخادم الاتصال الأقل ؛ وزن إيفاد خطي اتصال اعتمادا على وزن الخلفية. roundrobin يقوم بالاختيار المتسلسل بين مستودع الواجهة الخلفية ، سيتلقى كل واجهة خلفية نفس عدد الطلبات ؛ hash_srcip أرصدة الحزم التي تتطابق مع نفس IP المصدر لنفس الخلفية ؛ hash_srcip_srcport أرصدة الحزم التي تطابق نفس IP المصدر والمنفذ إلى نفس الخلفية ؛ symhash حزم الموازنة التي تتطابق مع نفس مصدر IP والمنفذ والمنفذ والمنفذ الوجهة ، بحيث يمكن أن تتوقف عن الاتصال في كلا الاتجاهين (أثناء الداخل والخارج).
مستمع خيط يحدد المستمع كيف ستلعب المزرعة بطلبات العملاء. المعلومات لا يمكن تعديله.
الجذوع خيط معلومات حزمة سجلات المزرعة لطبقة النقل ، فهي لا تتوفر معلومات طبقة التطبيق. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
nattype خيط كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات يُطلق عليه أيضًا وضع sNAT ، يستجيب الواجهة الخلفية لموازن التحميل لإرسال الرد إلى العميل ؛ DNAT سوف تستجيب الواجهة الخلفية مباشرة للعميل ، يجب تكوين موازن التحميل كبوابة في خادم الواجهة الخلفية ؛ في DSR وضع (إرجاع الخادم المباشر) الذي يتصل به العميل إلى VIP ، ثم يغير موازن التحميل عنوان MAC الوجهة الخاص به لعنوان MAC الخلفي (يجب أن يكون الخادم على نفس وسيط الارتباط مثل موازن التحميل) ؛ عديمي الجنسية DNAT. في stateless_dnat عنوان وجهة تبديل موازن التحميل لعنوان الواجهة الخلفية وإعادة توجيهه إلى الواجهة الخلفية كما يفعل DNAT ، لكنه لا يدير أي نوع من معلومات الاتصال.
إصرار خيط تقوم هذه المعلمة بإعادة توجيه الطلب الوارد إلى نفس الواجهة الخلفية في وضع الثبات المختار. الخيارات هي: "" تعمل القيمة الفارغة على تعطيل الاستمرارية ، وسيتم موازنة كل حزمة واردة بين المؤخرة ؛ ip or srcip، المصدر IP ، سوف يعين نفس الخلفية لكل اتصال وارد اعتمادا على عنوان IP المصدر فقط ؛ ميناء، سيتم تعيين منفذ المصدر ، نفس الخلفية لكل اتصال وارد اعتمادا على منفذ المصدر فقط. srcmac، مصدر MAC ، باستخدام هذا الخيار ، ستقوم المزرعة بتعيين نفس الخلفية لكل اتصال وارد اعتمادًا على عنوان MAC لطبقة الوصلة للحزمة ؛ srcip_srcport، المصدر IP ومصدر المصدر ، سوف يعين نفس الخلفية لكل اتصال وارد اعتمادا على حد سواء ، مصدر IP والمصدر المصدر ؛ srcip_dstport، مصدر IP وميناء الوجهة ، سيعين نفس الخلفية لكل اتصال وارد اعتمادا على كل من ، مصدر IP والمنفذ الوجهة.
بروتوكول خيط البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيحمل ملف التعريف توازن أي بروتوكول L4 ؛ برنامج التعاون الفني سيقوم موازن التحميل فقط بموازنة بروتوكول TCP L4 ، وأيضًا بالنسبة إلى TCP ، من الممكن تعيين مرة واحدة من البروتوكولات التالية من أجل تحليل رؤوسها واستخدامها للتوزيع بشكل صحيح: بروتوكول نقل الملفات, IRC, PPTP، أو عاقل; UDP سيوازن موازن التحميل فقط بروتوكول UDP L4 ، وأيضًا لـ UDP ، من الممكن تعيين مرة واحدة من البروتوكولات التالية من أجل تحليل رؤوسها واستخدامها لتوزيعها بشكل صحيح: رشفة, المبسط, أماندا, NETBIOS-NS، أو تجميعيه; SCTP، موازن التحميل فقط سيوازن بروتوكول SCTP L4. إذا h323 تم اختيار ، سوف المزرعة الاستماع TCP و UDP طلبات وتحليل رؤوسها لتحقيق التوازن بين الخلفية.
الحالة خيط حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح.
TTL رقم الهاتف تشير قيمة الحقل إلى عدد الثواني التي يتم فيها تعيين الثبات بين مصدر العميل والواجهة الخلفية بالثواني. إصرار يجب تكوين
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث الخدمة الافتراضية هي الاستماع. يمكن تحديد منفذ فريد ، ويمكن تحديد منفذ النطاق مع فاصل : ويمكن تحديد العديد من المنافذ مع فاصل ,.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.
الجلسات (من الإصدار 4.0.2) موضوع[] قائمة الجلسات الثابتة والديناميكية التي تم إنشاؤها لهذه المزرعة.

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

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

كائن الجلسة لمزارع L4xNAT:

الحقل النوع الوصف
زبون رقم الهاتف هو معرف العميل.
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "ماك" ، الجلسة يجب أن يكون MAC ، على سبيل المثال 02: 8e: 69: 38: 12: 8e ؛ إذا إصرار هو "ip" أو "srcip" ، الجلسة يجب أن يكون IPv4 أو IPv6 ، على سبيل المثال 192.168.42.65 ؛ إذا إصرار هو "المنفذ" ، الجلسة يجب أن يكون منفذًا صالحًا ، مثل 5445 ؛ إذا إصرار هو "srcip_srcport" أو "srcip_dstport" ؛ الجلسة يجب أن تكون سلسلة مع IP ومنفذ مرتبط بنطاق سفلي ''، على سبيل المثال 122.36.54.280.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا كانت الجلسة من النوع الثابت.
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.

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

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

طلب مثال:

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newl4farm -vip 192.168.100.241 -vport 88 -profile l4xnat

POST /farms

قم بإنشاء مزرعة L4xNAT جديدة.

طلب المعلمات

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

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

{
   "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/v4.0/zapi.cgi/farms/newfarml4
zcli farm set newfarml4 -algorithm weight -newfarmname l4farm -protocol tcp -nattype nat -ttl 125 -vip 178.62.126.152 -vport 81 -logs true

PUT /farms/<farmname>

تعديل تكوين مزرعة L4xNAT.

طلب المعلمات

الحقل النوع الوصف
newfarmname خيط اسم المزرعة الجديد. يجب إيقاف المزرعة.
الجذوع خيط معلومات حزمة سجلات المزرعة لطبقة النقل ، فهي لا تتوفر معلومات طبقة التطبيق. إذا كانت هذه المعلمة لها القيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، يتم تعطيل السجلات.
TTL رقم الهاتف تشير قيمة الحقل هذه إلى عدد الثواني التي يتم تعيين استمرارها بين مصدر العميل والخلفية ، بالثواني. يجب تكوين المثابرة.
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية.
vport خيط ميناء المزرعة ، حيث الخدمة الافتراضية هي الاستماع. يمكن تحديد منفذ فريد ، ويمكن تحديد منفذ النطاق مع فاصل : ويمكن تحديد العديد من المنافذ مع فاصل ,.
إصرار خيط تقوم هذه المعلمة بإعادة توجيه الطلب الوارد إلى نفس الواجهة الخلفية في وضع الثبات المختار. الخيارات هي: "" تعمل القيمة الفارغة على تعطيل الاستمرارية ، وسيتم موازنة كل حزمة واردة بين المؤخرة ؛ ip or srcip، المصدر IP ، سوف يعين نفس الخلفية لكل اتصال وارد اعتمادا على عنوان IP المصدر فقط ؛ ميناء، سيتم تعيين منفذ المصدر ، نفس الخلفية لكل اتصال وارد اعتمادا على منفذ المصدر فقط. srcmac، مصدر MAC ، باستخدام هذا الخيار ، ستقوم المزرعة بتعيين نفس الخلفية لكل اتصال وارد اعتمادًا على عنوان MAC لطبقة الوصلة للحزمة ؛ srcip_srcport، المصدر IP ومصدر المصدر ، سوف يعين نفس الخلفية لكل اتصال وارد اعتمادا على حد سواء ، مصدر IP والمصدر المصدر ؛ srcip_dstport، مصدر IP وميناء الوجهة ، سيعين نفس الخلفية لكل اتصال وارد اعتمادا على كل من ، مصدر IP والمنفذ الوجهة.
nattype خيط كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات يُطلق عليه أيضًا وضع sNAT ، يستجيب الواجهة الخلفية لموازن التحميل لإرسال الرد إلى العميل ؛ DNAT سوف تستجيب الواجهة الخلفية مباشرة للعميل ، يجب تكوين موازن التحميل كبوابة في خادم الواجهة الخلفية ؛ في DSR وضع (إرجاع الخادم المباشر) الذي يتصل به العميل إلى VIP ، ثم يغير موازن التحميل عنوان MAC الوجهة الخاص به لعنوان MAC الخلفي (يجب أن يكون الخادم على نفس وسيط الارتباط مثل موازن التحميل) ؛ عديمي الجنسية DNAT. في stateless_dnat عنوان وجهة تبديل موازن التحميل لعنوان الواجهة الخلفية وإعادة توجيهه إلى الواجهة الخلفية كما يفعل DNAT ، لكنه لا يدير أي نوع من معلومات الاتصال.
خوارزمية خيط نوع جدولة موازنة التحميل المستخدم لإرسال حركة المرور بين المؤخرة. الخيارات هي: leastconn توجيه الاتصال دائمًا بخادم الاتصال الأقل ؛ وزن إيفاد خطي اتصال اعتمادا على وزن الخلفية. roundrobin يقوم بالاختيار المتسلسل بين مستودع الواجهة الخلفية ، سيتلقى كل واجهة خلفية نفس عدد الطلبات ؛ hash_srcip أرصدة الحزم التي تتطابق مع نفس IP المصدر لنفس الخلفية ؛ hash_srcip_srcport أرصدة الحزم التي تطابق نفس IP المصدر والمنفذ إلى نفس الخلفية ؛ symhash حزم الموازنة التي تتطابق مع نفس مصدر IP والمنفذ والمنفذ والمنفذ الوجهة ، بحيث يمكن أن تتوقف عن الاتصال في كلا الاتجاهين (أثناء الداخل والخارج).
بروتوكول خيط البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيحمل ملف التعريف توازن أي بروتوكول L4 ؛ برنامج التعاون الفني سيقوم موازن التحميل فقط بموازنة بروتوكول TCP L4 ، وأيضًا بالنسبة إلى TCP ، من الممكن تعيين مرة واحدة من البروتوكولات التالية من أجل تحليل رؤوسها واستخدامها للتوزيع بشكل صحيح: بروتوكول نقل الملفات, IRC, PPTP، أو عاقل; UDP سيوازن موازن التحميل فقط بروتوكول UDP L4 ، وأيضًا لـ UDP ، من الممكن تعيين مرة واحدة من البروتوكولات التالية من أجل تحليل رؤوسها واستخدامها لتوزيعها بشكل صحيح: رشفة, المبسط, أماندا, NETBIOS-NS، أو تجميعيه; SCTP، موازن التحميل فقط سيوازن بروتوكول SCTP L4. إذا h323 تم اختيار ، سوف المزرعة الاستماع TCP و UDP طلبات وتحليل رؤوسها لتحقيق التوازن بين الخلفية.

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

{
   "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/v4.0/zapi.cgi/farms/l4Farm/fg
zcli farm-service-farmguardian add l4Farm default_service -name check_tcp-cut_conns

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/v4.0/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove l4Farm default_service 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"
}

أضف POST /farms/<farmname>/sessions

أضف DELETE /farms/<farmname>/sessions/<session>

قائمة الجلسات

قائمة الجلسات

طلب مثال:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session list farm1

GET /farms/<farmname>/sessions

احصل على قائمة الجلسات في المزرعة.

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

{
   "description" : "Get farm sessions",
   "params": [
      {
         "client": 0,
         "id": "0",
         "session": "10.0.0.2_56",
         "ttl": null,
         "type": "static"
      },
      {
         "client": 1,
         "id": "0",
         "session": "10.0.0.2_54936",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "client": 2,
         "id": "0",
         "session": "10.0.0.2_54968",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

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

يعرض هذا الطلب قائمة بكائنات الجلسات ، ويحتوي كل كائن جلسة على المفاتيح التالية:

الحقل النوع الوصف
زبون رقم الهاتف هو معرف العميل.
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "ماك" ، الجلسة يجب أن يكون MAC ، على سبيل المثال 02: 8e: 69: 38: 12: 8e ؛ إذا إصرار هو "ip" أو "srcip" ، الجلسة يجب أن يكون IPv4 أو IPv6 ، على سبيل المثال 192.168.42.65 ؛ إذا إصرار هو "المنفذ" ، الجلسة يجب أن يكون منفذًا صالحًا ، مثل 5445 ؛ إذا إصرار هو "srcip_srcport" أو "srcip_dstport" ؛ الجلسة يجب أن تكون سلسلة مع IP ومنفذ مرتبط بنطاق سفلي ''، على سبيل المثال 122.36.54.280.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا كانت الجلسة من النوع الثابت.
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.

أضف جلسة

أضف جلسة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2_56","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session add farm1 -id 0 -session 10.0.0.2_56

POST /farms/<farmname>/sessions

يخلق جلسة ثابتة مع خلفية. اتصال الإدخال الذي يتطابق مع الجلسة ستتم إعادة توجيهه دائمًا إلى الواجهة الخلفية.

طلب المعلمات

الحقل النوع الوصف
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "ماك" ، الجلسة يجب أن يكون MAC ، على سبيل المثال 02: 8e: 69: 38: 12: 8e ؛ إذا إصرار هو "ip" أو "srcip" ، الجلسة يجب أن يكون IPv4 أو IPv6 ، على سبيل المثال 192.168.42.65 ؛ إذا إصرار هو "المنفذ" ، الجلسة يجب أن يكون منفذًا صالحًا ، مثل 5445 ؛ إذا إصرار هو "srcip_srcport" أو "srcip_dstport" ؛ الجلسة يجب أن تكون سلسلة مع IP ومنفذ مرتبط بنطاق سفلي ''، على سبيل المثال 122.36.54.280.

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

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "client" : 1,
      "id" : "0",
      "session" : "10.0.0.1_56",
      "ttl" : null,
      "type" : "static"
   }
}

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

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

الحقل النوع الوصف
زبون رقم الهاتف هو معرف العميل.
id رقم الهاتف معرف الخلفية التي ستتلقى الاتصال.
الجلسة خيط هو معرف الجلسة أو الاتصال ، وتعتمد قيمته على إصرار معلمة المزرعة. إذا إصرار هو "ماك" ، الجلسة يجب أن يكون MAC ، على سبيل المثال 02: 8e: 69: 38: 12: 8e ؛ إذا إصرار هو "ip" أو "srcip" ، الجلسة يجب أن يكون IPv4 أو IPv6 ، على سبيل المثال 192.168.42.65 ؛ إذا إصرار هو "المنفذ" ، الجلسة يجب أن يكون منفذًا صالحًا ، مثل 5445 ؛ إذا إصرار هو "srcip_srcport" أو "srcip_dstport" ؛ الجلسة يجب أن تكون سلسلة مع IP ومنفذ مرتبط بنطاق سفلي ''، على سبيل المثال 122.36.54.280.
TTL خيط هو عبارة عن سلسلة مع وقت الجلسة تنتهي صلاحيتها. ال TTL ستكون القيمة فارغة إذا كانت الجلسة من النوع الثابت.
نوع خيط هناك نوعان من الجلسات: ديناميكي هو اتصال يقوم بتحميل دبابيس الموازن مع الواجهة الخلفية باستخدام خوارزمية موازنة تحميل المزرعة ؛ ساكن هو اتصال يقوم مسؤول موازن التحميل بتوصيله بخلفية. لن يتم إعادة توجيه الجلسات الثابتة إلى خلفية أخرى إذا كانت النسخة المدعومة غير قابلة للوصول.

إزالة جلسة

إزالة جلسة

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56

DELETE /farms/<farmname>/sessions/<session>

يحذف جلسة ثابتة.

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

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
   "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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists
zcli farm-blacklist add l4Farm -name china

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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists/china
zcli farm-blacklist remove l4Farm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>

قم بإزالة القائمة السوداء أو DoS أو RBL من وحدة IPDS من مزرعة معينة باستخدام مؤشرها الاسم.

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

{
   "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/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm get l4farm

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/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm-service-backend add l4farm default_service -ip 192.168.5.100 -port 8080 -max_conns 400

POST /farms/<farmname>/backends

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

طلب المعلمات

الحقل النوع الوصف مطلوب:
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. صحيح
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
max_conns رقم الهاتف إنه الحد الأقصى لعدد الاتصالات المتزامنة للواجهة الخلفية. إذا كان هذا الحقل يحتوي على القيمة 0 ، فإن الواجهة الخلفية لم تقم بتكوين أي حد للاتصال.
الأولوية رقم الهاتف إنها قيمة الأولوية للخادم الحقيقي الحالي. ستكون الخلفية ذات قيمة أولوية أقل جاهزة لتلقي الاتصالات من قبل الآخرين ذوي الأولوية الأعلى. القيمة الافتراضية فارغة ، قيمة أولوية 1 يستخدم. القيم المحتملة من 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/v4.0/zapi.cgi/farms/l4farm/backends/2
zcli farm-service-backend set l4farm default_service 2 -ip 192.168.5.40 -port 8080 -max_conns 220 -priority 4 -weight 7

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

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

طلب المعلمات

الحقل النوع الوصف
ip خيط IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية.
ميناء رقم الهاتف ميناء Backend حيث تستمع الخدمة الحقيقية. يتم قبول القيمة الفارغة وسوف تستخدم نفس التكوين من المنفذ (المنافذ) الافتراضية.
max_conns رقم الهاتف إنه الحد الأقصى لعدد الاتصالات المتزامنة للواجهة الخلفية. إذا كان هذا الحقل يحتوي على القيمة 0 ، فإن الواجهة الخلفية لم تقم بتكوين أي حد للاتصال.
الأولوية رقم الهاتف إنها قيمة الأولوية للخادم الحقيقي الحالي. ستكون الخلفية ذات قيمة أولوية أقل جاهزة لتلقي الاتصالات من قبل الآخرين ذوي الأولوية الأعلى. القيمة الافتراضية فارغة ، قيمة أولوية 1 يستخدم. القيم المحتملة من 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/v4.0/zapi.cgi/farms/l4farm/backends/1/maintenance
zcli farm-service-backend maintenance l4farm default_service 1 -mode cut

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/v4.0/zapi.cgi/farms/l4farm/backends/4
zcli farm-service-backend remove l4farm default_service 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/v4.0/zapi.cgi/farms/gslbfarm
zcli farm get 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، والتي سوف توازن الاتصالات بين جميع الوصلات الخلفية ، أو 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/v4.0/zapi.cgi/farms
zcli farm create -farmname gslbfarm -vip 192.168.100.241 -vport 53 -profile gslb

POST /farms

قم بإنشاء مزرعة GSLB جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط يستخدم اسم المزرعة كمعرف فريد للمزارع. صحيح
البيانات الشخصية خيط الملف الشخصي للمزرعة المنشأة. لمزارع GSLB هو gslb. صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية. صحيح
vport رقم الهاتف ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. صحيح
نسخة من (من 4.0.1) خيط تتوقع هذه المعلمة اسم مزرعة موجودة. إذا تم إرسال هذه المعلمة ، يتم نسخ المزرعة من المزرعة المحددة فيها. ال farmname, كبار الشخصيات و 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/v4.0/zapi.cgi/farms/gslbfarm
zcli farm set gslbfarm -newfarmname gslbnewname -vip 192.168.100.155 -vport 60

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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists
zcli farm farm-blacklist add gslbFarm -name china

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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
zcli farm-blacklist remove gslbFarm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>

قم بإزالة القائمة السوداء أو DoS أو RBL من مزرعة معينة باستخدام معرفها الاسم.

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

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
   "success" : "true"
}

GSLB - الخدمات

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

الخدمات المتاحة هي:

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

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

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

الحقل النوع الوصف
الخلفيات موضوع[] الخلفيات المحددة في الخدمة.
farmguardian خيط إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى.
id خيط اسم الخدمة الذي يستخدم كمعرف فريد.
خوارزمية خيط نوع من خوارزمية موازنة التحميل المستخدمة في الخدمة. الخيارات هي: roundrobin، والتي سوف توازن الاتصالات بين جميع الوصلات الخلفية ، أو 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/v4.0/zapi.cgi/farms/gslbfarm/services
zcli farm-service add gslbfarm -id service1 -algorithm roundrobin

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/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service set  gslbfarm service1 -deftcpport 53

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/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg
zcli farm-service-farmguardian add gslbfarm service1 -name dns-request

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/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
zcli farm-service-farmguardian remove gslbfarm service1 dns-request

DELETE /farms/<farmname>/fg/<name>

قم بإزالة FarmGuardian من خدمة GSLB.

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

{
   "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/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service remove gslbfarm 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/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm get gslbfarm

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/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm-service-backend add gslbfarm service1 -ip 192.135.10.2

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/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/1
zcli farm-service-backend set gslbfarm service1 1 -ip 192.168.2.30

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/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/3
zcli farm-service-backend remove gslbfarm service1 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.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones
zcli farm-zone add gslbfarm -id global.com

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/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com
zcli farm-zone set gslbfarm global.com -defnamesv ns3

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/v4.0/zapi.cgi/farms/gslbfarm/zones/dom.com
zcli farm-zone remove gslbfarm 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 ويتم إرجاع الاسم فقط. الاستخدام الأكثر شيوعًا هو تنفيذ عمليات البحث العكسي عن DNS.
  10. NAPTR. مؤشر مرجع التسمية ، يسمح بإعادة كتابة أسماء النطاقات على أساس التعبير العادي والتي يمكن استخدامها بعد ذلك كمعرّفات URI ، أو المزيد من أسماء النطاقات إلى عمليات البحث ، إلخ.

قائمة الموارد

قائمة الموارد

طلب مثال:

curl  -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource list gslbfarm global.com

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/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource add gslbfarm global.com -rname resource2 -rdata 192.168.0.9 -ttl 10 -type A

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/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
zcli farm-zone-resource set gslbfarm global.com 1 -rname resource2 -rdata 192.168.200.30 -type A

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/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
zcli farm-zone-resource remove gslbfarm global.com 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 أو DSLB (Datalink Service Load Balancing) بإنشاء مزرعة قائمة على المسارات حيث تكون الواجهات الخلفية عبارة عن أجهزة توجيه أو بوابات للوصلة الصاعدة. هذا النوع من ملف تعريف المزرعة جاهز لمشاركة العديد من عمليات الوصول إلى جهاز توجيه WAN للوصلة الصاعدة باستخدام موازن التحميل كجهاز إرسال متعدد القنوات للوصلة الصاعدة (مدخل واحد والعديد من مخرجات خط التوجيه). لذلك ، يمكن استخدام مزارع ارتباط البيانات كروابط اتصال عالية متاحة بالإضافة إلى ذلك يمكن استخدامها لزيادة عرض النطاق الترددي الذي ينضم إلى مقدار النطاق الترددي بين الروابط الخلفية لأجهزة التوجيه.

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

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

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm get 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 من الخلفية ، حيث يتم الاستماع الخدمة الحقيقية.
الواجهة خيط إنها واجهة الشبكة المحلية حيث يتم توصيل الخلفية.
الأولوية رقم الهاتف إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. سيتم استخدامه عندما خوارزمية تم تكوين الحقل كأولوية والأفضلية المنخفضة لها الأفضلية
الحالة خيط حالة الخلفية. القيم المحتملة هي: 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/v4.0/zapi.cgi/farms
zcli farm create -profile datalink -farmname dlink -vip 192.168.100.241

POST /farms

قم بإنشاء مزرعة datalink جديدة.

طلب المعلمات

الحقل النوع الوصف مطلوب:
farmname خيط اسم المزرعة ، معرف فريد. صحيح
البيانات الشخصية خيط ملف تعريف المزرعة التي تم إنشاؤها. لإنشاء مزرعة من نوع datalink ، المفتاح هو وصلة البيانات صحيح
كبار الشخصيات خيط IP للمزرعة ، حيث تستمع الخدمة الافتراضية. صحيح
نسخة من (من 4.0.1) خيط تتوقع هذه المعلمة اسم مزرعة موجودة. إذا تم إرسال هذه المعلمة ، يتم نسخ المزرعة من المزرعة المحددة فيها. ال farmname و كبار الشخصيات سيتم استبدال القيم.

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

{
   "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/v4.0/zapi.cgi/farms/dlink
zcli farm set dlink -newfarmname dlink2 -vip 192.168.100.199 -algorithm weight

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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists
zcli farm-blacklist add dlink2 -name china

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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists/china
zcli farm-blacklist remove dlink -name china

DELETE /farms/<farmname>/ipds/<blacklists>/<name>

إزالة قاعدة القائمة السوداء لوحدة IPDS من مزرعة معينة باستخدام مؤشرها الاسم.

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

{
   "description" : "Delete a rule from a farm",
   "message" : "Blacklist rule china was removed successful from the farm dlink2.",
   "success" : "true"
}

Datalink - الخلفية

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

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

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

طلب مثال:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm get dlink

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/v4.0/zapi.cgi/farms/dlink/backends
zcli farm-service-backend add dlink default_service -ip 192.168.100.10 -interface eth0 -priority 2 -weight 2

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/v4.0/zapi.cgi/farms/datalink/backends/2
zcli farm-service-backend set datalink default_service 2 -ip 192.168.102.50 -interface eth0 -weight 1 -priority 1

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/v4.0/zapi.cgi/farms/dlink/backends/4
zcli farm-service-backend remove dlink default_service 4

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

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

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

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

شبكة

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

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

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

شبكة محلية ظاهرية: أو بطاقة LAN الظاهرية هي نوع من واجهة الشبكة التي توفر خدمات تجزئة الشبكة. يمكن إنشاء أكثر من شبكة محلية ظاهرية واحدة من خلال واجهة nic.

الرابطة: يُطلق عليها أيضًا بائعون آخرون واجهات جذع ، يمكن إنشاء هذا النوع من nic مع أكثر من واجهة nic. يدعم Zevenet أنواع 7 المختلفة من واجهات الترابط.

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

قائمة جميع الواجهات

قائمة جميع الواجهات

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network list

GET /interfaces

الحصول على قائمة من واجهات في النظام مع التكوين الخاصة بهم.

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

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "bond2",
         "netmask" : "",
         "status" : "down",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "eth2",
         "netmask" : "",
         "status" : "up",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "is_slave" : "true"
      }
   ]
}

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

ستكون الاستجابة كائن JSON مع صفيف كائنات واجهة.

كائن الواجهة:

الحقل النوع الوصف
الاسم المستعار خيط ومن نيك لمساعدة على تحديد واجهة. الاسم المستعار
ip خيط IP للواجهة. يجب أن يكون عنوان IP في نفس جزء الشبكة الذي توجد به الواجهة الأصل في واجهة افتراضية.
has_vlan خيط صحيح، الواجهة هي الأصل لواجهة VLAN ؛ أو زائف، لم تحصل الواجهة على أي واجهة VLAN إلحاق بها. هذا الحقل هو فقط لواجهات NIC.
قناع الشبكة خيط قناع الشبكة للواجهة. لا يمكن تعديل هذه القيمة في الواجهات الافتراضية ، فهي موروثة من الواجهة الأصلية.
بوابة خيط بوابة الواجهة. لا يمكن تعديل هذه القيمة في الواجهات الافتراضية ، فهي موروثة من الواجهة الأصلية.
لجنة الهدنة العسكرية خيط ماك من واجهة. يتم توارث هذه القيمة من أول NIC التابع في واجهات الترابط. في الواجهات الظاهرية و VLAN ، يتم توارثها من واجهة الأصل.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن أن تتلقى الواجهة الحزم.
نوع خيط نوع مختلف من واجهات: NIC, شبكة محلية ظاهرية, واقعي or رباط.
is_slave خيط متوفر فقط في واجهات NIC ، صحيح، الواجهة هي جزء من واجهة الترابط ، زائف الواجهة ليست جزءًا من واجهة الربط.
DHCP خيط تمكن خدمة DHCP من الحصول على تكوين الشبكة للواجهة من خادم DHCP. تقبل هذه المعلمة: صحيحلتمكين الخدمة ، سيتم حظر تكوين الواجهة أثناء تمكين خدمة DHCP ؛ زائف لإيقاف الخدمة ، ستفقد الواجهة كل تكوين شبكتها.

استرداد العبارة الافتراضية

استرداد العبارة الافتراضية

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 get

GET /interfaces/gateway/<ip_version>

العبّارة الافتراضية هي العقدة التي ترسل كل حركة مرور الوجهة التي لا يمكن الوصول إليها محليًا من أي واجهة في موازن التحميل.

الحصول على معلمات واجهة البوابة الافتراضية.

قام النظام بتكوين مدخلين ، مرة واحدة لتوجيه IPv4 والآخر لتوجيه IPv6. يتوقع URI إصدار IP ipv4 or ipv6.

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

{
   "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/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 set -interface eth0 -address 192.168.100.5

PUT /interfaces/gateway/<ip_version>

قم بتعديل تكوين واجهة البوابة.

يتوقع URI إصدار IP المستخدم في حقل العنوان. القيم المحتملة هي ipv4 و ipv6.

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

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

طلب المعلمات

الحقل النوع الوصف
العنوان خيط هذا هو IP للبوابة.
الواجهة خيط اسم الواجهة للبوابة.

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

DELETE /interfaces/gateway/<ip_version>

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

يتوقع URI إصدار IP واحد من العبّارة الافتراضية لحذفها. القيم المحتملة هي ipv4 و ipv6.

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

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

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 delete

رسالة الرد

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

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

{
   "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/v4.0/zapi.cgi/interfaces/nic
zcli network-nic list

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

{
   "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",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

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

ستكون الاستجابة كائن JSON مع صفيف من كائنات واجهة NIC.

كائن واجهة NIC:

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

استرداد واجهة NIC

استرداد واجهة NIC

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic get 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",
      "dhcp" : "false",
      "status" : "up"
   }
}

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

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

تعديل واجهة 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/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic set eth0 -ip 192.168.100.102 -netmask 255.255.255.0 -gateway 192.168.100.5

PUT /interfaces/nic/<name>

قم بتعديل معلمات واجهة NIC. الاسم هو معرف فريد للواجهة.

طلب المعلمات

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

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

{
   "description" : "Configure NIC interface",
   "params" : {
      "alias" : null,
      "dhcp" : "false",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "4a:4f:3c:d7:dd:70",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "down"
}

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

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

حذف تكوين NIC

حذف تكوين NIC

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
zcli network-nic unset 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/v4.0/zapi.cgi/interfaces/nic/eth1/actions
zcli network-nic stop eth1

POST /interfaces/nic/<name>/actions

تطبيق إجراء على واجهة NIC. تتيح هذه المكالمة تمكين أو تعطيل واجهة شبكة.

الاسم هو معرف فريد للواجهة.

طلب المعلمات

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

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

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

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

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

شبكة - واجهات VLAN

تسمح واجهة VLAN بتشغيل واجهة NIC أو الربط في شبكة أخرى ، وبالتالي فإن تكوين الشبكة (IP, بوابةو قناع الشبكة) يجب أن يكون في قطعة شبكة مختلفة. ترث واجهة VLAN عنوان MAC من الواجهة الأصلية.

مجال واجهات VLAN الاسم سيظهر مع حرف "." الذي سيتم استخدامه لإنشاء علامة معرف لواجهة VLAN.

قائمة واجهات VLAN

قائمة واجهات VLAN

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan list 

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",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

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

ستكون الاستجابة كائن JSON مع صفيف كائنات واجهة VLAN.

معلمات VLAN هي:

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

استرداد واجهة VLAN

استرداد واجهة VLAN

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan get eth0.1

GET /interfaces/vlan/<name>

الحصول على جميع المعلمات من واجهة الشبكة المحلية الظاهرية. الاسم هو معرف فريد للواجهة.

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

{
   "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",
      "dhcp" : "false",
      "status" : "up"
   }
}

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

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

إنشاء واجهة 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","mac":"52:98:19:6a:c9:18","dhcp":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan create -name eth0.1 -ip 192.168.120.120 -netmask 255.255.255.0 -gateway 192.168.120.1 -mac 52:98:19:61:c9:18 -dhcp false

POST /interfaces/vlan

قم بإنشاء واجهة VLAN من NIC أو واجهة الربط. ستقوم واجهة VLAN الجديدة بمشاركة MAC ، على الرغم من أن معلمات الشبكة التالية يجب أن تكون مختلفة: ip، ويمكن تغيير ما يلي: بوابة, قناع الشبكة.

طلب المعلمات

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

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

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : "52:98:19:6a:c9:18",
      "name" : "eth0.1",
      "dhcp" : "false",
      "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","mac":"96:23:25:8b:d4:af"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan set eth0.1 -ip 192.168.131.151 -netmask 255.255.255.0 -gateway 192.168.131.1 -mac 96:23:25:8b:d4:af

PUT /interfaces/vlan/<name>

قم بتعديل معلمات واجهة VLAN. الاسم هو معرف فريد للواجهة.

طلب المعلمات

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

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

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0",
      "mac" : "96:23:25:8b:d4:af",
      "dhcp" : "false",
      "force" : "true"
   }
}

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

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

حذف واجهة VLAN

حذف واجهة VLAN

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan delete 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/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
zcli network-vlan stop eth0.1

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/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual list

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/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual get eth0:vip1

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/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual create -name eth0:virtiface -ip 192.168.100.41

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/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual set eth0:virtiface -ip 192.168.131.155

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/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual delete 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/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
zcli network-virtual stop eth0:virtiface

POST /interfaces/virtual/<name>/actions

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

الاسم هو معرف فريد للواجهة.

طلب المعلمات

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

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

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

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

ستكون الاستجابة عبارة عن 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/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding list

GET /interfaces/bonding

الحصول على التكوين حول جميع واجهات الترابط في النظام.

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

{
   "description" : "List bonding interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "mode" : "broadcast",
         "name" : "bond2",
         "netmask" : "",
         "dhcp" : "false",
         "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",
         "dhcp" : "false",
         "netmask" : "255.255.255.0",
         "slaves" : [
            {
               "name" : "eth3"
            },
            {
               "name" : "eth4"
            }
         ],
         "status" : "up"
      }
   ]
}

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

ستكون الاستجابة كائن JSON مع صفيف كائن واجهة الترابط.

معلمات الترابط هي:

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

العبيد وجوه:

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

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

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

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding get 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",
      "dhcp" : "false",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "up"
   }
}

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

ستكون الاستجابة كائن JSON مع كائن واجهة ربط.

معلمات الترابط هي:

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

عبد موضوع:

الحقل النوع الوصف
الاسم خيط الاسم هو معرف فريد لواجهة 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/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding create -slave eth3,eth2 -name bondiface -mode balance-rr

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

الحقل النوع الوصف
لجنة الهدنة العسكرية خيط معرف طبقة الربط الفريد. انها لجنة الهدنة العسكرية من أول عبد واجهة NIC.
الاسم خيط اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة.
الحالة خيط القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم.
السلافية موضوع[] واجهات NIC التي تنشئ واجهة الترابط.
طريقة خيط هذا هو وضع العمل لواجهة الترابط. الخيارات هي: ميزان ص ص، سياسة 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","mac":"86:2f:0e:9a:30:14"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding set bondiface -ip 192.168.100.121 -netmask 255.255.255.0 -gateway 192.168.100.1 -mac 86:2f:0e:9a:30:14 

PUT /interfaces/bonding/<name>

تعديل معلمات واجهة الترابط. الاسم هو معرف فريد للواجهة.

طلب المعلمات

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

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

{
   "description" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0",
      "mac" : "86:2f:0e:9a:30:14",
      "dhcp" : "false",
      "force" : "true"
   }
}

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

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

حذف تكوين الترابط

حذف تكوين الترابط

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding delete 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/v4.0/zapi.cgi/interfaces/bonding/bondiface/actions
zcli network-bond start bondiface

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/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves
zcli network-bonding-slave add bondiface -name eth4

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/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
zcli network-bonding-slave remove bondiface 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"
}

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

يستخدم هذا النوع من الواجهة واجهة افتراضية محددة ويخفي حركة مرور البيانات الصادرة NIC, الرابطة or VLAN واجهة مع طفل واقعي جهة تعامل. يتم استخدام هذه الواجهة لسلوك فشل الحالة في ملفات تعريف l4xnat إذا تم تكوين كتلة.

قائمة العائمة واجهات

قائمة العائمة واجهات

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating
zcli network-floating list

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/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating get eth0

GET /interfaces/floating/<name>

يظهر ما إذا كان للواجهة IP عائم مكون. إذا كان يحتوي على تكوين واحد ، فسيتم عرضه هنا.

الاسم هو معرّف الواجهة الفريد الذي يمكن أن يكون من النوع nic أو الربط أو VLAN.

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

{
   "description" : "Show floating interface",
   "params" : {
      "alias" : null,
      "floating_alias" : null,
      "floating_ip" : "192.168.100.41",
      "interface" : "eth0",
      "interface_virtual" : "eth0:virtiface"
   }
}

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

الحقل النوع الوصف
الاسم المستعار خيط ومن نيك لمساعدة على تحديد واجهة. الاسم المستعار
floating_alias خيط هذا هو الاسم المستعار للواجهة الافتراضية.
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/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating set eth0 -floating_ip 192.168.100.199

PUT /interfaces/floating/<name>

تكوين IP عائم ل NIC أو الرابطة أو VLAN.

الاسم هو معرّف الواجهة الفريد الذي يمكن أن يكون من النوع nic أو الربط أو 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/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating delete eth0

DELETE /interfaces/floating/<name>

قم بإزالة تكوين IP العائم في واجهة.

الاسم هو معرّف الواجهة الفريد الذي يمكن أن يكون من النوع nic أو الربط أو VLAN.

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

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

الشبكة - الأسماء المستعارة

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

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

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

الأسماء المستعارة هي معلومات مرئية فقط ، ولا تحل محل عنوان IP الخلفي أو اسم الواجهة في طلب ZAPI.

قائمة الأسماء المستعارة

قائمة الأسماء المستعارة

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/backends
zcli network-alias-backend list

GET /aliases/<backends|interfaces>

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

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

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

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

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

قم بإنشاء اسم مستعار

قم بإنشاء اسم مستعار

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"eth0","alias":"management"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces
zcli network-alias-interface set eth0 -alias management

POST /aliases/<backends|interfaces>

نوع الواجهة الخلفية أو واجهات الكائن التي ستتلقى الاسم المستعار.

طلب المعلمات

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

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

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

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

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

تعديل الاسم المستعار

تعديل الاسم المستعار

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"gateway"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zcli network-alias-interface set eth0 -alias gateway

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/v4.0/zapi.cgi/aliases/interfaces/eth0
zli network-alias-interface delete eth0

DELETE /aliases/<backends|interfaces>/<id>

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

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

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

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

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

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

الشبكة - التوجيه

هذه الوحدة متاحة من الإصدار 4.0.1 من zapi.

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

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

قائمة بقواعد التوجيه

قائمة بقواعد التوجيه

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule list

GET /routing/rules

سرد قواعد التوجيه لموازنة التحميل. تُستخدم قواعد التوجيه للحصول على جدول الواجهة بناءً على عنوان IP لحزمة المصدر

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

{
    "description" : "List routing rules",
    "params" : [
        {
            "id" : 1024,
            "not" : "true",
            "from" : "10.10.10.0/24",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "local",
            "type" : "system",
            "id" : 0,
            "priority" : 0,
            "from" : "all"
        },
        {
            "id" : 0,
            "priority" : 31000,
            "from" : "10.3.0.0/24",
            "table" : "205",
            "type" : "system"
        },
        {
            "type" : "system",
            "table" : "table_eth1",
            "priority" : 31000,
            "from" : "4.4.4.0/24",
            "id" : 0
        },
        {
            "type" : "system",
            "table" : "main",
            "priority" : 32766,
            "from" : "all",
            "id" : 0
        }
    ]
}

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

سيكون الرد عبارة عن قائمة JSON مع جميع قواعد التوجيه في النظام. كل قاعدة هي كائن بالمعلمات التالية:

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

إنشاء قاعدة التوجيه

إنشاء قاعدة التوجيه

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","not":"true","priority":"30000","from":"192.168.0.0/16"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule -table table_eth1 -not true -priority 30000 -from 192.168.0.0/16

POST /routing/rules

إنشاء قاعدة توجيه.

طلب المعلمات

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

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

{
    "description" : "Create a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "from" : "192.168.0.0/16",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "table_eth0",
            "type" : "system",
            "id" : 0,
            "priority" : 32765,
            "from" : "192.168.100.0/24"
        },
        {
            "from" : "all",
            "priority" : 32766,
            "id" : 0,
            "type" : "system",
            "table" : "main"
        },
        {
            "id" : 0,
            "priority" : 32767,
            "from" : "all",
            "table" : "default",
            "type" : "system"
        }
    ]
}

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

سيكون الرد عبارة عن كائن JSON مع جميع قواعد المسارات في النظام. كل مسار هو كائن له المعلمات:

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

تعديل قاعدة التوجيه

تعديل قاعدة التوجيه

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","from":"10.10.10.0/24","priority":"30000","not":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule set 1024 -table table_eth1 -from 10.10.10.0/24 -priority 30000 -not false

PUT /routing/rules/<id>

قم بتعديل معلمات قاعدة التوجيه.

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

قواعد نوع المستخدم هي الفريدة التي يمكن تعديلها

طلب المعلمات

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

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

{
    "description" : "Modify a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "priority" : 30000,
            "from" : "10.10.10.0/24",
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "id" : 0,
            "from" : "4.4.4.0/24",
            "priority" : 31000,
            "table" : "table_eth1",
            "type" : "system"
        },
        {
            "table" : "table_eth2",
            "type" : "system",
            "id" : 0,
            "from" : "5.5.5.0/24",
            "priority" : 31000
        },
        {
            "type" : "system",
            "table" : "table_eth0",
            "from" : "192.168.100.0/24",
            "priority" : 32765,
            "id" : 0
        },
    ]
}

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

سيكون الرد عبارة عن كائن JSON مع جميع قواعد المسارات في النظام. كل مسار هو كائن له المعلمات:

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

حذف قاعدة التوجيه

حذف قاعدة التوجيه

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule remove 1024

DELETE /routing/rules/<id>

حذف قاعدة التوجيه.

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

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

{
    "message" : "The routing rule '1024' has been deleted successfully.",
    "description" : "Delete the routing rule '1024'"
}

سرد جداول التوجيه

سرد جداول التوجيه

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables
zcli network-routing-table list

GET /routing/tables

سرد جداول التوجيه التي يديرها موازن التحميل.

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

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

{
  "description" : "List routing tables",
  "params" : [
                "main",
                "table_eth0",
                "table_eth1",
                "table_eth2",
                "table_eth3"
              ]
}

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

سيكون الرد كائن JSON مع params المفتاح الذي يحتوي على قائمة بالجداول الموجودة في النظام.

سرد مسارات الجدول

قائمة بقواعد التوجيه

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2
zcli network-routing-table get table_eth2

GET /routing/tables/<table>

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

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

{
    "description" : "Get the routing table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "priority" : 10,
          "raw" : "5.5.5.0/24 dev eth2 scope link src 5.5.5.5 initcwnd 10 initrwnd 10  table table_eth2",
          "interface" : "eth2",
          "source" : "5.5.5.5",
          "type" : "system",
          "to" : "5.5.5.0/24",
          "via" : ""
        },
        {
          "via" : "",
          "to" : "192.168.100.0/24",
          "interface" : "eth0",
          "type" : "system",
          "source" : "192.168.100.241",
          "raw" : "192.168.100.0/24 dev eth0 scope link src 192.168.100.241 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10
        }
    ]
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params وقائمة بالطرق التي تحتوي على الجدول.

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

إنشاء إدخال توجيه

إنشاء إدخال توجيه

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"source":"4.4.4.4","via":"4.4.4.45","interface":"eth1","priority":2,"to":"84.1.21.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes
zcli network-routing-table add table_eth2 -source 4.4.4.4 -via 4.4.4.45 -interface eth1 -priority 2 -to 84.1.21.5

POST /routing/tables/<table>/routes

إنشاء طريق لواجهة.

يوفر جدول معلمة URI هي جدول الواجهة حيث سيتم إضافة المسار.

طلب المعلمات

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

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

{
    "description" : "Create a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "source" : "",
          "type" : "system",
          "interface" : "eth2",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2",
          "source" : "4.4.4.4",
          "type" : "system",
          "interface" : "eth1",
          "to" : "4.4.4.0/24",
          "via" : ""
        },
    ]
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params وقائمة بالطرق التي تحتوي على الجدول.

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

تعديل إدخال مسار

تعديل إدخال مسار

طلب مثال:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"priority":2,"source":"4.4.4.4","interface":"eth1","to":"71.71.71.0/24","via":"4.4.4.45"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table -id 1024 -priority 2 -source 4.4.4.4 -interface eth1 -to 71.71.71.0/24 -via 4.4.4.45

PUT /routing/tables/<table>/routes/<id>

تعديل معلمات إدخال المسار.

يوفر جدول معلمة URI هي جدول واجهة المسار الذي سيتم تعديله. ال id معلمة URI هي المعرف الفريد للمسار الذي سيتم تعديله.

طلب المعلمات

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

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

{
    "description" : "Modify a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "71.71.71.0/24",
          "via" : "4.4.4.45",
          "raw" : "71.71.71.0/24 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "priority" : 2,
          "id" : 1024,
          "type" : "user",
          "source" : "4.4.4.4",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "interface" : "eth2",
          "source" : "",
          "type" : "system",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "via" : "",
          "to" : "4.4.4.0/24",
          "interface" : "eth1",
          "source" : "4.4.4.4",
          "type" : "system",
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2"
        },
    ]
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params وقائمة بالطرق التي تحتوي على الجدول.

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

حذف إدخال مسار

حذف إدخال مسار

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table remove table_eth2 1024

DELETE /routing/tables/<table>/routes/<id>

حذف مسار جدول واجهة.

يوفر جدول معلمة URI هي جدول الواجهة الذي سيتم حذف المسار منه. ال id معلمة URI هي المعرف الفريد للمسار الذي سيتم حذفه.

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

{
    "description" : "Delete the routing entry '1024' from the table 'table_eth2'",
    "message" : "The routing rule '1024' has been deleted successfully."
}

قائمة الواجهات غير المُدارة في جدول

قائمة الواجهات غير المدارة في جدول

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged get table_eth1

GET /routing/tables/<table>/unmanaged

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

جدول هو جدول التوجيه للواجهة الواردة.

قم بسرد الواجهات وما إذا كان يمكن استخدامها لمرور حركة المرور.

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

{
    "params" : [
      {
         "unmanaged" : "false",
         "interface" : "eth3"
      },
      {
         "unmanaged" : "false",
         "interface" : "eth0"
      }
    ],
    "description" : "Get the list of interfaces that cannot manage traffic when traffic incoming through the table 'table_eth1'"
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params يحتوي على قائمة كائنات بالمعلمات التالية.

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

أضف واجهة إلى قائمة ملفات

إلغاء إدارة الواجهة

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged add table_eth1 interface eth0

POST /routing/tables/<table>/unmanaged

تعطيل واجهة لحركة المرور الصادرة.

يوفر جدول معلمة URI هي اسم جدول التوجيه الذي لا يمكن الوصول إلى المسار منه. إذا جدول له قيمة "*"(علامة النجمة) ، فإن الواجهة لن يمكن الوصول إليها من أي جدول.

طلب المعلمات

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

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

{
    "description" : "Do not route traffic through an interface for the table 'table_eth1'",
    "message" : "The interface 'eth2' is not accesible from the table 'table_eth1'"
}

قم بإزالة واجهة من قائمة ملفات

إدارة جدول التوجيه

طلب مثال:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged/eth2
zcli network-routing-table-unmanaged remove table_eth1 eth2

DELETE /routing/tables/<table>/unmanaged/<interface>

السماح للواجهة ستكون مرئية من جدول واجهة آخر

يوفر جدول معلمة URI هي جدول الواجهة الذي يتم تعديله. إذا جدول له قيمة "*"(علامة النجمة) ، فإن الواجهة ستدار من جميع الجداول. ال الواجهة معلمة URI هي الواجهة التي سيتم السماح بها لـ جدول الجدول.

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

{
    "description" : "Enable an interface as possible route path from the table 'table_eth1'",
    "message" : "The interface 'eth2' is now accesible from the table 'table_eth1'"
}

رصد - FarmGuardian

يستخدم FarmGuardian لدولة رصد متقدمة من الخلفية. عندما يتم اكتشاف مشكلة بواسطة FarmGuardian يعطل تلقائيا الخادم الحقيقي وسيتم وضع علامة على القائمة السوداء.

قائمة FarmGuardians

قائمة FarmGuardians

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian list

GET /monitoring/fg

قائمة FarmGuardians. تظهر القوالب و 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",
         "backend_alias" : "false"
      },
      {
         "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",
         "backend_alias" : "true"
      },
      {
         "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",
         "backend_alias" : "false"
      }
   ]
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف موجز للشيك.
المزارع خيط[ ] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تطبيقه على أي مزرعة. القوالب مفيدة لإنشاء FarmGuardian جديد.
backali_alias (من 4.0.1) خيط إذا كانت هذه المعلمة لها القيمة زائف، سيكون مضيف الواجهة الخلفية IP. سيتم استخدام الاسم المستعار للواجهة الخلفية كمضيف إذا كانت هذه المعلمة لها القيمة صحيح، يجب تحديد الاسم المستعار ويجب أن يكون موازن التحميل قادراً على حله.

استرجع FarmGuardian

استرجع FarmGuardian

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
zcli farmguardian get 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" : 10,
      "log" : "false",
      "name" : "check_tcp",
      "template" : "true",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف موجز للشيك.
المزارع خيط[ ] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات. هذا هو الوقت منذ اختبار آخر خلفية في القائمة حتى يتم اختبار الواجهة الخلفية الأولى مرة أخرى.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تعديله. القوالب مفيدة لإنشاء FarmGuardian جديدة أو تنطبق مباشرة على المزارع.
backali_alias (من 4.0.1) خيط إذا كانت هذه المعلمة لها القيمة زائف، سيكون مضيف الواجهة الخلفية IP. سيتم استخدام الاسم المستعار للواجهة الخلفية كمضيف إذا كانت هذه المعلمة لها القيمة صحيح، يجب تحديد الاسم المستعار ويجب أن يكون موازن التحميل قادراً على حله.
نفذ الوقت (من 4.0.2) رقم الهاتف مهلة كل خلفية. بعد هذا الوقت أثناء اختبار الواجهة الخلفية ، سيتم اعتباره مرفوضًا. بشكل افتراضي ، المهلة تساوي الفاصل الزمني.

إنشاء FarmGuardian

إنشاء FarmGuardian

طلب مثال:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "copy_from":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian create -name check_tcp-cut_conns -copy_from check_tcp

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",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف موجز للشيك.
المزارع خيط[ ] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات. هذا هو الوقت منذ اختبار آخر خلفية في القائمة حتى يتم اختبار الواجهة الخلفية الأولى مرة أخرى.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تعديله. القوالب مفيدة لإنشاء FarmGuardian جديدة أو تنطبق مباشرة على المزارع.
backali_alias (من 4.0.1) خيط إذا كانت هذه المعلمة لها القيمة زائف، سيكون مضيف الواجهة الخلفية IP. سيتم استخدام الاسم المستعار للواجهة الخلفية كمضيف إذا كانت هذه المعلمة لها القيمة صحيح، يجب تحديد الاسم المستعار ويجب أن يكون موازن التحميل قادراً على حله.
نفذ الوقت (من 4.0.2) رقم الهاتف مهلة كل خلفية. بعد هذا الوقت أثناء اختبار الواجهة الخلفية ، سيتم اعتباره مرفوضًا. بشكل افتراضي ، المهلة تساوي الفاصل الزمني.

تعديل 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/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian set custom-tcp -interval 7 -log true -description 'TCP check to the port 80' -command 'check_tcp -p 80 -H HOST' -cut_conns false

PUT /monitoring/fg/<name>

تعديل FarmGuardian.

معامل URI الاسم هو معرف فريد FarmGuardian.

طلب المعلمات

ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:

الحقل النوع الوصف مطلوب:
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف موجز للشيك.
الفاصلة رقم الهاتف الوقت بين الشيكات. هذا هو الوقت منذ اختبار آخر خلفية في القائمة حتى يتم اختبار الواجهة الخلفية الأولى مرة أخرى.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
القوة خيط إذا كانت مزرعة قيد التشغيل تستخدم FarmGuardian ، فلن تتمكن من تعديل FarmGuardian. بعد ذلك ، إذا تم إرسال هذه المعلمة بالقيمة صحيح، سيتم إجبار FarmGuardian على اتخاذ التكوين الجديد.
backali_alias (من 4.0.1) خيط إذا كانت هذه المعلمة لها القيمة زائف، سيكون مضيف الواجهة الخلفية IP. سيتم استخدام الاسم المستعار للواجهة الخلفية كمضيف إذا كانت هذه المعلمة لها القيمة صحيح، يجب تحديد الاسم المستعار ويجب أن يكون موازن التحميل قادراً على حله.
نفذ الوقت (من 4.0.2) رقم الهاتف مهلة كل خلفية. بعد هذا الوقت أثناء اختبار الواجهة الخلفية ، سيتم اعتباره مرفوضًا. بشكل افتراضي ، المهلة تساوي الفاصل الزمني.

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

{
   "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",
      "backend_alias" : "false",
      "timeout" : 7
   }
}

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

ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:

الحقل النوع الوصف
أمر خيط القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec.
cut_conns خيط القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
وصف خيط وصف موجز للشيك.
المزارع خيط[ ] المزارع حيث يتم تطبيق FarmGuardian.
الفاصلة رقم الهاتف الوقت بين الشيكات. هذا هو الوقت منذ اختبار آخر خلفية في القائمة حتى يتم اختبار الواجهة الخلفية الأولى مرة أخرى.
سجل خيط القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة.
الاسم خيط معرف فريد.
قالب خيط إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تطبيقه على أي مزرعة. القوالب مفيدة لإنشاء FarmGuardian جديد.
backali_alias (من 4.0.1) خيط إذا كانت هذه المعلمة لها القيمة زائف، سيكون مضيف الواجهة الخلفية IP. سيتم استخدام الاسم المستعار للواجهة الخلفية كمضيف إذا كانت هذه المعلمة لها القيمة صحيح، يجب تحديد الاسم المستعار ويجب أن يكون موازن التحميل قادراً على حله.
نفذ الوقت (من 4.0.2) رقم الهاتف مهلة كل خلفية. بعد هذا الوقت أثناء اختبار الواجهة الخلفية ، سيتم اعتباره مرفوضًا. بشكل افتراضي ، المهلة تساوي الفاصل الزمني.

احذف FarmGuardian

احذف FarmGuardian

طلب مثال:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian delete 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/v4.0/zapi.cgi/stats
zcli statistics-system get

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 رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل انقطاع الأجهزة.
رحلة جميلة رقم الهاتف أولوية جدولة وحدة المعالجة المركزية.
softirq رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل انقطاع البرمجيات.
SYS رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل النظام.
استعمال رقم الهاتف إجمالي وحدة المعالجة المركزية المستخدمة.
المستخدم رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل المستخدم.

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

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

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

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

كائن الشبكة:

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

عرض إحصائيات الشبكة

عرض إحصائيات الشبكة

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network
zcli statistic-network get

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 خيط إجمالي حركة الإدخال بالميغابايت.
الواجهة خيط اسم الواجهة.
خارج خيط إجمالي حركة الإخراج بالميغابايت.

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

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

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network/interfaces
zcli statistics-network get

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/v4.0/zapi.cgi/stats/system/memory
zcli statistics-system get -filter 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/v4.0/zapi.cgi/stats/system/load
zcli statistics-system get -filter 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/v4.0/zapi.cgi/stats/system/cpu
zcli statistics-system get -filter 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 رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل انقطاع الأجهزة.
رحلة جميلة رقم الهاتف أولوية جدولة وحدة المعالجة المركزية.
softirq رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل انقطاع البرمجيات.
SYS رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل النظام.
استعمال رقم الهاتف إجمالي وحدة المعالجة المركزية المستخدمة.
المستخدم رقم الهاتف وحدة المعالجة المركزية المستخدمة من قبل المستخدم.
تاريخ خيط تاريخ النظام.
اسم المضيف خيط اسم المضيف.

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

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

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/connections
zcli statistics-network-connections get

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/v4.0/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/v4.0/zapi.cgi/stats/farms
statistics-farm list

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/v4.0/zapi.cgi/stats/farms/farmname
zcli statistic-farm list

GET /stats/farms/<farmname>

يُظهر حالة المزرعة الحالية وحالة الواجهة الخلفية والاتصالات. سوف تستجيب كل مزرعة بكائن مختلف ، حسب ملف التعريف.

مثال الاستجابة لمزرعة 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"
         "backend_ip" : "192.168.0.168"
         "backend_port" : 80
         "service" : "srv1",
         "session" : "192.168.0.186",
         "ttl" : "1m28s0ms"
      }
   ],
   "total_sessions" : 1
}

معلمات الاستجابة في مزارع HTTP

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

كائن الخلفية

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

كائن الجلسة

الحقل النوع الوصف
زبون خيط معرف فريد للعميل.
id خيط الخلفية المعرف الفريد المخصص للعميل.
خدمة خيط معرف فريد للخدمة يتم تعيينه للعميل.
الجلسة خيط معرف جلسة فريدة. هذه القيمة تعتمد على نوع الثبات.
TTL خيط من الإصدار 4.0.2. الوقت المتبقي حتى انتهاء الجلسة
backend_ip خيط من الإصدار 4.0.2. الواجهة الخلفية IP المخصصة للعميل.
backend_port خيط من الإصدار 4.0.2. تم تعيين منفذ الواجهة الخلفية للعميل.

مثال للاستجابة لمزرعة 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 رقم الهاتف كان حجم المخزن المؤقت DNS الموسع المحدد للعميل صغيرًا جدًا بالنسبة للبيانات المطلوبة.
recvfail رقم الهاتف عدد أخطاء UDP ، حيث أشار نظام التشغيل إلى حدوث شيء سيء عند استلامه.
reqs رقم الهاتف إجمالي عدد طلبات UDP التي تتم معالجتها بواسطة الخادم.
sendfail رقم الهاتف عدد أخطاء UDP ، حيث أشار نظام التشغيل إلى حدوث أمر سيء عند الإرسال.
tc رقم الهاتف الردود التي تم اقتطاعها مع مجموعة TC bit.

كائن موسع

الحقل النوع الوصف
badvers رقم الهاتف طلب يحتوي على EDNS OPT-RR مع إصدار غير معتمد.
إسقاط رقم الهاتف الطلبات المسقطة للتنسيق غير الصحيح.
edns رقم الهاتف يحتوي الطلب على EDNS OPT-RR.
edns_clientsub رقم الهاتف مجموعة فرعية من طلبات edns التي حددت خيار edns_client_subnet.
formerr رقم الهاتف تم تنسيق الطلب بشكل سيء ولكنه كان عاقلًا بدرجة كافية بحيث أرسلنا ردًا مع rcode FORMERR.
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" : [
      {
     "client": 0,
         "id" : 5,
         "backend_ip" : "192.168.5.100",
         "backend_port" : "8080",
         "session" : "192.168.5.100",
         "ttl" : "1m51s564ms",
         "type" : "dynamic"
      }
   ],
   "total_sessions" : 1

}

معلمات الاستجابة في مزارع L4xNAT

ستكون الاستجابة JSON مع الكائن الخلفيات و دورات:

كائن خلفي:

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

كائن الجلسة:

الحقل النوع الوصف
زبون رقم الهاتف المعرف الأمني ​​للجلسة.
id رقم الهاتف معرف فريد الخلفية حيث يتم تعيين العميل.
الجلسة خيط معرف فريد للجلسة. هو IP العميل.
نوع خيط القيم هي: ثابت أو ديناميكي. ثابت إذا تم إجراء الجلسة يدويًا وديناميكيًا إذا تم إجراء الجلسة تلقائيًا.
TTL خيط من الإصدار 4.0.2. الوقت المتبقي حتى انتهاء الجلسة
backend_ip خيط من الإصدار 4.0.2. IP الخلفية المخصصة للعميل.
backend_port رقم الهاتف من الإصدار 4.0.2. تم تعيين منفذ الواجهة الخلفية للعميل.

إحصائيات مزارع Datalink غير متوفرة في الواقع.

إظهار حالة الوحدة

إظهار حالة الوحدة

طلب مثال:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/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
      }
   }
}

معلمات الاستج