Zevenet API v4.0 Reference
ZAPI (Zevenet Application Programming Interface) هي أداة لمسؤول النظام للتحكم في أداء موازن التحميل Zevenet.
من الضروري تنشيط المستخدم zapi من واجهة الويب قبل استخدامه ، نظام / المستخدمين.
بمجرد إنشاء مستخدم zapi ، من الممكن إرسال طلب إلى عنوان URL ، https: // (zevenet_server): 444 / zapi / v4.0 / zapi.cgi / (URI_path) ، حيث zevenet_server هو IP حيث تستمع خدمة HTTP.
URI_path يحدد الكائن أو الإجراء المطلوب التصرف. سيتم تعريف سلوكه ومعلماته داخل كل قسم قسم التثقيف.
الأفعال المستخدمة في هذا API سوف يكون الحصول على, سأعين, ضع or حذف. يحتاج طلب PUT أو POST دائمًا إلى معلمة تقريبًا على الرغم من أن هذا لا يحتاج إلى أي معلمة مطلوبة.
الشهادات
يدعم Zevenet cetificates بتنسيق PEM لاستخدامها مع مزارع HTTP 444 / zapi / v4.0 / zapi.cgi مع مستمع HTTPS. إذا كنت ترغب في معرفة المزيد عن كيفية إنشاء شهادات pem ، يرجى زيارة المقالة التالية: شهادات جنرال في شكل بيم
قائمة جميع الشهادات
قائمة جميع الشهادات
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates
GET /certificates
قم بإدراج جميع شهادات CSR و PEM في مخزن الشهادات ، ويمكن استخدام هذه الشهادات مع مزارع HTTPS.
ستكون الاستجابة كائن JSON مع ضبط مفتاح على params. ستكون قيمة هذا صفيفًا من كائنات الشهادة ، يحتوي كل منها على سمات المفتاح أدناه.
مثال على الاستجابة:
{
"description" : "List all certificates",
"params" : [
{
"CN" : "Zen Load Balancer",
"creation" : "Jan 12 14:49:03 2011 GMT",
"expiration" : "Jan 9 14:49:03 2021 GMT",
"file" : "zencert.pem",
"issuer" : "Zen Load Balancer",
"type" : "Certificate"
}
]
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| params | موضوع[ ] | قائمة كائنات الشهادة. |
كائن الشهادة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| CN | خيط | اسم المجال الشائع. |
| خلق | خيط | تاريخ الإنشاء. |
| الانتهاء | خيط | تاريخ إنتهاء الصلاحية. |
| ملف | خيط | اسم الملف للشهادة ، المعرف الفريد. |
| المصدر | خيط | سلطة معتمدة توقيع الشهادة. |
| نوع | خيط | المسؤولية الاجتماعية للشركات أو الشهادة. |
تحميل الشهادة
تحميل الشهادة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
GET /certificates/<file>
قم بتنزيل شهادة مثبتة في مخزن الشهادات ، واستخدم اسم الملف في طلب التعرف عليه.
ستتضمن الاستجابة الرؤوس المبينة أدناه بمعلومات حول الملف. سيكون نص الاستجابة محتوى الملف.
رؤوس الاستجابة:
HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359
حذف شهادة
حذف شهادة
طلب مثال:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
DELETE /certificates/<file>
حذف شهادة حسب اسم الملف في مخزن الشهادات.
مثال على الاستجابة:
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
قم بإنشاء شهادة CSR
قم بإنشاء شهادة CSR
طلب مثال:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates
POST /certificates
إنشاء طلب توقيع شهادة (ملف CSR).
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| الاسم | خيط | اسم معرف الشهادة. | صحيح |
| FQDN | خيط | اسم المجال المؤهل بالكامل لخادم 444 / zapi / v4.0 / zapi.cgi. | صحيح |
| قسم الدواء | خيط | تقسيم مؤسسة 444 / zapi / v4.0 / zapi.cgi التي تتعامل مع الشهادة. | صحيح |
| منظمة | خيط | الاسم القانوني للمنظمة 444 / zapi / v4.0 / zapi.cgi. | صحيح |
| مكان | خيط | المدينة التي تقع فيها منظمة 444 / zapi / v4.0 / zapi.cgi. | صحيح |
| حالة | خيط | الولاية / المنطقة حيث تقع مؤسسة 444 / zapi / v4.0 / zapi.cgi. | صحيح |
| البلد | خيط | رمز ISO المكون من حرفين للبلد الذي توجد به مؤسسة 444 / zapi / v4.0 / zapi.cgi. | صحيح |
| بريد | خيط | عنوان البريد الإلكتروني المستخدم للاتصال بـ 444 / zapi / v4.0 / zapi.cgi organization. | صحيح |
مثال على الاستجابة:
{
"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
POST /certificates/<file>
تحميل شهادة PEM لمزارع HTTP المزودة بمستمع HTTPS.
يتطلب المعلمة --tcp-nodelayو --data-binary لتحميل الملف في الوضع الثنائي.
طلب معرفات URI
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| ملف | خيط | اسم ملف الشهادة المراد تحميله وحفظه في مخزن الشهادات. | صحيح |
مثال على الاستجابة:
{
"description" : "Upload PEM certificate",
"message" : "Certificate uploaded",
"success" : "true"
}
قائمة الأصفار
قائمة الأصفار
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ciphers
GET /ciphers
أدرج الأصفار المتاحة التي يمكن لمزرعة HTTPS استخدامها.
ستكون الاستجابة كائن JSON مع ضبط مفتاح على params. ستكون قيمة هذا صفيفًا من كائنات الشهادة ، يحتوي كل منها على سمات المفتاح أدناه.
مثال على الاستجابة:
{
"description" : "Get the ciphers available",
"params" : [
{
"ciphers" : "all",
"description" : "All"
},
{
"ciphers" : "highsecurity",
"description" : "High security"
},
{
"ciphers" : "customsecurity",
"description" : "Custom security"
}
]
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| params | موضوع[ ] | قائمة كائنات الشهادة. |
كائن الشهادة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الأصفار | خيط | يتم استخدامه كمعرف فريد. |
| وصف | خيط | اسم مألوف. |
شهادات 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. |
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 و Datalink Load Balancer أو وحدة DSLB.
تعمل جميع الوحدات مع مفهوم فارم بروفيل ، والملف الشخصي للمزرعة هو مجموعة من المعلمات جاهزة للقيام بعمل معين مع حركة مرور الشبكة ، من المهم أن نفهم ما هو قادر على القيام بكل ملف تعريف مزرعة من أجل الحصول على أفضل النتائج من Zevenet ADC.
- LSLB: هذه الوحدة قادرة على العمل مع HTTP و l4xnat مزارع الشخصي. يعمل على عكس وكيل الويب أو جهاز التوجيه
- DSLB: هذه الوحدة قادرة على العمل مع وصلة البيانات الملف الشخصي المزرعة. يعمل كبوابة.
قائمة جميع المزارع
قائمة جميع المزارع
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
GET /farms
قائمة جميع المزارع المتاحة
ستكون الاستجابة كائن JSON مع ضبط مفتاح على params. ستكون قيمة هذا مجموعة من كائنات استئناف المجال ، كل منها يحتوي على سمات المفتاح أدناه.
كائن المزرعة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| farmname | خيط | اسم وصفي مزرعة. يتم استخدامه كتعريف فريد. |
| البيانات الشخصية | خيط | نوع الملف الشخصي ، القيم المتاحة في الملف الشخصي هي: HTTP, HTTPS or l4xnat وحدة LSLB و وصلة البيانات لوحدة DSLB |
| الحالة | خيط | حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح. |
| كبار الشخصيات | خيط | عنوان IP ظاهري حيث تتلقى المزرعة حركة المرور |
| vport | خيط | المنفذ الافتراضي حيث تستقبل المزرعة حركة المرور ، والقيم المتاحة للمنفذ هي: رقم منفذ لـ http [s] و l4xnat ، أو مجموعة من المنافذ مفصولة بعلامة "،" أو نطاق منفذ مفصول بـ ":" لملفات تعريف l4xnat ، في l4xnat كلا الفاصل يمكن استخدام القيم ("،" و ":") في نفس الحقل. |
مثال على الاستجابة:
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
حذف مزرعة
حذف مزرعة
طلب مثال:
curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
DELETE /farms/<farmname>
حذف مزرعة من خلال معرف المزرعة الخاص به.
مثال على الاستجابة:
{
"description" : "Delete farm FarmHTTP",
"message" : "The Farm FarmHTTP has been deleted.",
"success" : "true"
}
تعيين عمل في مزرعة
تعيين عمل في مزرعة
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmTCP/actions
PUT /farms/<farmname>/actions
تطبيق إجراء على مزرعة ، راجع جدول معلمات الطلب للإجراءات.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| عمل | خيط | حدد الإجراء المطلوب. الإجراءات هي: توقف، سيتم إيقاف المزرعة. بدايةسوف تبدأ المزرعة و إعادة تشغيل، سيتم إيقاف المزرعة وبدأت تلقائيا. |
مثال على الاستجابة:
{
"description" : "Set a new action in FarmHTTP",
"params" : [
{
"action" : "stop"
}
]
}
معلمات الاستجابة
إذا لم تكن هناك مشكلات في التهيئة ، فسيعرض zapi الإجراء المطلوب.
مزارع HTTP
ملف تعريف HTTP هو موازنة تحميل متقدمة من الطبقة 7 (أو وحدة تحكم تسليم التطبيق) بخصائص خاصة للوكيل. يقدم ملف التعريف هذا بعض الميزات مثل موازنة تحميل HTTPS للطبقة 7. تم تخصيص ملف التعريف هذا لخدمات الويب (بما في ذلك خوادم تطبيقات الويب) وجميع بروتوكولات التطبيقات القائمة على بروتوكولات 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
GET /farms/<farmname>
عرض جميع التهيئة حول مزرعة معينة.
مثال على الاستجابة:
{
"description" : "List farm httpFarm",
"params" : {
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"addheader" : [
{
"header" : "load-balancer: true",
"id" : 0
}
],
"addresponseheader" : [
{
"header" : "Session: true",
"id" : 0
}
],
"headremove" : [
{
"id" : 0,
"pattern" : "^client"
}
],
"removeresponseheader" : [
{
"id" : 0,
"pattern" : "Host"
}
],
"ignore_100_continue" : "true",
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"httpverb" : "MSRPCext",
"listener" : "https",
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"farmguardian" : "check_tcp",
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"redirect" : "http://192.168.101.254/index.html",
"redirecttype" : "default",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"farmguardian" : null,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON بالتنسيق أدناه.
كائن المزرعة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| params | هدف | معلمات التكوين الزراعي. |
| الخدمات | موضوع[] | صفيف مع جميع الخدمات التي تم إنشاؤها في هذه المزرعة وتكوينها. |
كائن المعلمات لمزارع HTTP:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| certlist | موضوع[] | فقط في ملف https. الشهادة التي تم تفعيلها في المزرعة ، بصيغة بيم ، يُسمح لها بإضافة شهادة بيم واحدة فقط إلى نفس المزرعة. مطلوب المستمع مع قيمة HTTPS. يمكن استخدام أي شهادة Pem في مخزن الشهادات هنا. |
| cipherc | خيط | فقط في المستمع https. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها بواسطة اتصال SSL ، وهي سلسلة بنفس التنسيق كما هو الحال في الأصفار OpenSSL. يستخدم هذا السهم فقط عندما الأصفار المجال لديه قيمة sutomsecurity. |
| الأصفار | خيط | فقط في المستمع مع قيمة HTTPS. تستخدم لإنشاء قائمة من الأصفار المقبولة بواسطة اتصالات SSL لتصلب اتصال SSL. الخيارات هي: من جميع، سيتم قبول جميع الأصفار. حماية عالية، سيتم قبول الأصفار للأمن العالي فقط ؛ أو customsecurity، فقط الأصفار تحميلها cipherc المجال سيتم قبوله. |
| contimeout | رقم الهاتف | إلى متى ستنتظر المزرعة اتصال TCP إلى الواجهة الخلفية في ثوانٍ. |
| disable_sslv2 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح غير مسموح بالاتصالات التي تستخدم بروتوكول أمان SSL مع الإصدار 2 ؛ أو زائف إذا كان البروتوكول SSLv2 مسموحًا به. |
| disable_sslv3 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح غير مسموح بالاتصالات التي تستخدم بروتوكول أمان SSL مع الإصدار 3 ؛ أو زائف إذا كان البروتوكول SSLv3 مسموحًا به. |
| disable_tlsv1 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1 ؛ أو زائف إذا كان البروتوكول TLSv1 مسموحًا به. |
| disable_tlsv1_1 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1.1 ؛ أو زائف إذا كان البروتوكول TLSv1.1 مسموحًا به. |
| disable_tlsv1_2 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1.2 ؛ أو زائف إذا كان البروتوكول TLSv1.2 مسموحًا به. |
| error414 | خيط | رسالة مخصصة للاستجابة لرمز خطأ HTTP 414. |
| error500 | خيط | رسالة مخصصة للاستجابة لرمز خطأ HTTP 500. |
| error501 | خيط | رسالة مخصصة للاستجابة لرمز خطأ HTTP 501. |
| error503 | خيط | رسالة مخصصة للاستجابة لرمز خطأ HTTP 503. |
| httpverb | خيط | يشير هذا الحقل إلى العمليات التي سيتم السماح بها لطلبات عميل HTTP. القيم المتاحة هي: standardHTTP، قبول طلبات http GET ، POST ، HEAD. extendedHTTPقبول طلبات http السابقة بالإضافة إلى PUT و DELETE. standardWebDAV، قبول طلبات http السابقة بالإضافة إلى LOCK ، UNLOCK ، PROPFIND ، PROPPATCH ، SEARCH ، MKCOL ، MOVE ، COPY ، OPTIONS ، TRACE ، MKACTIVITY ، CHECKOUT ، MERGE ، REPORT ، MSextWebDAV قبول طلبات http السابقة بالإضافة إلى الاشتراك أو إلغاء الاشتراك أو الإخطار أو BPROPFIND أو BPROPPATCH أو POLL أو BMOVE أو BCOPY أو BDELETE أو CONNECT أو MSRPCextقبول طلبات http السابقة بالإضافة إلى RPC_IN_DATA ، RPC_OUT_DATA. لاحظ أن تلك القيم تحسس حالة الأحرف. |
| مستمع | خيط | يحدد المستمع كيف ستقوم المزرعة باللعب مع الطلبات الواردة من العملاء. الخيارات هي: HTTP لبروتوكول غير آمن أو HTTPS للبروتوكول المؤمن. |
| reqtimeout | رقم الهاتف | إلى متى ستنتظر المزرعة طلب العميل في ثوانٍ. |
| restimeout | رقم الهاتف | إلى متى ستنتظر المزرعة استجابة من الخلفيات في ثوانٍ. |
| resurrectime | رقم الهاتف | فترة الخروج من الخادم الحقيقي الساقط ، بعد هذه الفترة يتحقق توازن التحميل إذا كان الخادم الحقيقي على قيد الحياة ، في ثوانٍ. |
| rewritelocation | خيط | إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، نشط معاقأو غير نشط أو تمكين الخلفيات تتم مقارنة فقط عنوان الخلفية. |
| الحالة | خيط | حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح. |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث تستمع الخدمة الافتراضية. |
| vport | رقم الهاتف | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. |
سجلات | سلسلة | المزرعة تسجل تتبع اتصالات HTTP. إذا كانت هذه المعلمة لها قيمة صحيحيتم تمكين السجلات؛ إذا كان لديه قيمة زائف، السجلات معطلة. ignore_100_continue | سلسلة | إذا كان هذا الحقل يحتوي على القيمة صحيحة ، فسيتم تجاهل 100 متابعة رأس HTTP ؛ إذا كانت القيمة خاطئة ، فستتم معالجة رأس المتابعة 100 (من الإصدار 4.0.2). addheader | كائن [] | هي قائمة كائنات مع رؤوس لإضافتها إلى طلب العميل (من الإصدار 4.0.2). addresponseheader | كائن [] | إنها قائمة كائنات تحتوي على رؤوس لإضافتها إلى استجابة الواجهة الخلفية (من الإصدار 4.0.2). إزالة الرأس | كائن [] | إنها قائمة من التعبيرات العادية لإزالة الرؤوس من طلبات العميل. لن تصل الرؤوس التي تمت إزالتها إلى الواجهة الخلفية (من الإصدار 4.0.2). مزيل | كائن [] | إنها قائمة بالتعبيرات العادية لإزالة الرؤوس من استجابة الخلفية. الرؤوس التي تمت إزالتها لن تصل إلى العميل (من الإصدار 4.0.2). اتصال مثبت (من الإصدار 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.
كائن الشهادة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ملف | خيط | اسم الشهادة ، مراجع للشهادة في مخزن الشهادات. |
| id | رقم الهاتف | معرف الشهادة. |
كائن الخدمات لمزارع HTTP:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الخلفيات | موضوع[] | الخلفيات المحددة في الخدمة. |
| farmguardian | خيط | إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى. |
| httpsb | خيط | تشير هذه المعلمة إلى المزرعة إلى أن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات. |
| id | خيط | اسم الخدمة ، لا يمكن تعديله بمجرد إنشاء الخدمة. |
| leastresp | خيط | تمكن أقل طريقة موازنة المستجيب. صحيح بشكل فاحش يتحقق الملف الشخصي الذي تستغرقه الخلفية وقتا أقل للرد من أجل إرسال المزيد من الاتصالات لهذا ، زائف الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد. |
| إصرار | خيط | تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، أساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM يتم إجراء جلسة المثابرة في قاعدة قيمة في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس. |
| إعادة توجيه | خيط | ويتصرف كخلفية خاصة ، حيث يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا. إذا تم تكوين إعادة التوجيه ، فلن تتم إعادة توجيه الطلب إلى الواجهة الخلفية ، فسيتم رد "إعادة التوجيه" إلى العميل بدلاً من ذلك. |
| redirecttype | خيط | كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته مع الخيار الافتراضي. إذا إعادة توجيه لم يتم تكوين الحقل ، سيكون هذا الحقل عبارة عن سلسلة فارغة. |
| معرف جلسة العمل | خيط | هو متوافرة إذا إصرار الحقل هو URL أو COOKIE أو HEADER ، سيتم البحث في قيمة المعلمة من قبل المزرعة في رأس http وسيتم إدارة جلسة عمل العميل. |
| TTL | رقم الهاتف | فقط مع استمرار. تشير هذه القيمة إلى أقصى مدة للحياة لجلسة عمل غير نشطة (الحد الأقصى لعمر الجلسة) في ثوانٍ. |
| urlp | خيط | يسمح بتحديد خدمة ويب فيما يتعلق بعنوان URL الذي يطلبه العميل من خلال نمط محدد لعنوان URL والذي سيتم فحصه بناءًا. ويدعم التعبير العادي PCRE. |
| عشقتك | خيط | وهي تحدد الشرط الذي يحدده اسم النطاق من خلال نفس IP الظاهري والمنفذ المحدد بواسطة مجموعة HTTP. ويدعم التعبير العادي PCRE. |
كائن الخلفية لمزارع HTTP:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف الخلفية داخل الخدمة المعينة. |
| ip | خيط | عنوان IP الخاص بـ Backend حيث يتم تشغيل الخدمة الحقيقية. |
| ميناء | رقم الهاتف | منفذ Backend حيث يتم تشغيل الخدمة الحقيقية. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
| مهلة | رقم الهاتف | إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. إذا كان النظام الفارغ سيستخدم المعلمة العمومية Backend timeout. |
| وزن | رقم الهاتف | إنها قيمة الوزن للخادم الحقيقي الحالي ، وستتلقى الواجهة الخلفية ذات القيمة الأعلى للوزن مزيدًا من الاتصالات. القيمة الافتراضية خالية ، وليس وزنًا خاصًا مستخدمًا لهذه الخلفية. القيم المحتملة من 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
POST /farms
قم بإنشاء مزرعة HTTP جديدة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| farmname | خيط | اسم وصفي مزرعة. يتم استخدامه كمعرف فريد. | صحيح |
| البيانات الشخصية | خيط | الملف الشخصي للمزرعة المنشأة. لمزارع http هو HTTP. | صحيح |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث سيتم تشغيل الخدمة الافتراضية. يجب تكوين IP المشار إليه في النظام و UP | صحيح |
| vport | رقم الهاتف | ميناء المزرعة ، حيث ستستمع الخدمة الافتراضية. يجب ألا يكون المنفذ الظاهري ذاته وعنوان IP الظاهري قيد الاستخدام بواسطة مزرعة أخرى. | صحيح |
مثال على الاستجابة:
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"farmname" : "newHTTPfarm",
"profile" : "http",
"vip" : "192.168.100.23",
"vport" : 80
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
تعديل مزرعة
تعديل مزرعة
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
PUT /farms/<farmname>
قم بتعديل المعلمات العمومية لمزرعة HTTP محددة.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| contimeout | رقم الهاتف | كم من الوقت ستنتظر المزرعة للاتصال بالخلفية في ثوانٍ. |
| restimeout | رقم الهاتف | إلى متى ستنتظر المزرعة استجابة من الخلفيات في ثوانٍ. |
| resurrectime | رقم الهاتف | هذه القيمة بالثواني هي فترة إخراج الواجهة الخلفية وتدقيقها إذا كانت على قيد الحياة. |
| reqtimeout | رقم الهاتف | إلى متى ستنتظر المزرعة طلب العميل في ثوانٍ. |
| disable_sslv2 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح غير مسموح بالاتصالات التي تستخدم بروتوكول أمان SSL مع الإصدار 2 ؛ أو زائف إذا كان البروتوكول SSLv2 مسموحًا به. |
| disable_sslv3 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح غير مسموح بالاتصالات التي تستخدم بروتوكول أمان SSL مع الإصدار 3 ؛ أو زائف إذا كان البروتوكول SSLv3 مسموحًا به. |
| disable_tlsv1 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1 ؛ أو زائف إذا كان البروتوكول TLSv1 مسموحًا به. |
| disable_tlsv1_1 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1.1 ؛ أو زائف إذا كان البروتوكول TLSv1.1 مسموحًا به. |
| disable_tlsv1_2 | خيط | فقط في المستمع https. إذا كان هذا المجال لديه القيمة صحيح لا يُسمح بالاتصالات التي تستخدم بروتوكول أمان TLS مع الإصدار 1.2 ؛ أو زائف إذا كان |
| rewritelocation | خيط | إذا تم تمكينه ، فسيتم فرض المزرعة على تعديل الموقع: وموقع المحتوى: رؤوس في استجابات للعملاء الذين لديهم مضيف ظاهري. الخيارات هي: تمكين، نشط معاقأو غير نشط أو تمكين الخلفيات تتم مقارنة فقط عنوان الخلفية. |
| httpverb | خيط | يشير هذا الحقل إلى العمليات التي سيتم السماح بها لطلبات عميل HTTP. القيم المتاحة هي: standardHTTP، قبول طلبات http GET ، POST ، HEAD. extendedHTTPقبول طلبات http السابقة بالإضافة إلى PUT و DELETE. standardWebDAV، قبول طلبات http السابقة بالإضافة إلى LOCK ، UNLOCK ، PROPFIND ، PROPPATCH ، SEARCH ، MKCOL ، MOVE ، COPY ، OPTIONS ، TRACE ، MKACTIVITY ، CHECKOUT ، MERGE ، REPORT ، MSextWebDAV قبول طلبات http السابقة بالإضافة إلى الاشتراك أو إلغاء الاشتراك أو الإخطار أو BPROPFIND أو BPROPPATCH أو POLL أو BMOVE أو BCOPY أو BDELETE أو CONNECT أو MSRPCextقبول طلبات http السابقة بالإضافة إلى RPC_IN_DATA ، RPC_OUT_DATA. لاحظ أن تلك القيم تحسس حالة الأحرف. |
| error414 | خيط | خطأ في رسالة شخصية 414. |
| error500 | خيط | خطأ في رسالة شخصية 500. |
| error501 | خيط | خطأ في رسالة شخصية 501. |
| error503 | خيط | خطأ في رسالة شخصية 503. |
| مستمع | خيط | يحدد المستمع كيف ستقوم المزرعة باللعب مع الطلبات الواردة من العملاء. الخيارات هي: HTTP لبروتوكول غير آمن أو HTTPS للبروتوكول المؤمن. |
| الأصفار | خيط | فقط في المستمع مع قيمة HTTPS. تستخدم لإنشاء قائمة من الأصفار المقبولة بواسطة اتصالات SSL لتصلب اتصال SSL. الخيارات هي: من جميع، سيتم قبول جميع الأصفار. حماية عالية، سيتم قبول الأصفار للأمن العالي فقط ؛ أو customsecurity، فقط الأصفار تحميلها cipherc المجال سيتم قبوله. |
| cipherc | خيط | فقط في المستمع https. هذه هي القائمة المخصصة المسموح بها من الأصفار التي سيتم قبولها بواسطة اتصال SSL ، وهي سلسلة بنفس التنسيق كما هو الحال في الأصفار OpenSSL. يستخدم هذا السهم فقط عندما الأصفار المجال لديه قيمة sutomsecurity. |
| newfarmname | خيط | اسم المزرعة الجديد. يجب إيقاف المزرعة. |
| vport | رقم الهاتف | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث يتم الاستماع الخدمة الافتراضية ، يجب تكوين IP هذا وما يصل في النظام. |
مثال على الاستجابة:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
"ciphers" : "customsecurity",
"contimeout" : 22,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Message error 414",
"error500" : "Message error 500",
"error501" : "Message error 501",
"error503" : "Message error 503",
"httpverb" : "standardHTTP",
"listener" : "https",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
أضف شهادة
أضف شهادة
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"file":"example.pem"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/certificates
POST /farms/<farmname>/certificates
قم بتغيير شهادة PEM لمزرعة HTTP باستخدام وحدة إصغاء HTTPS. يجب تحميل الشهادة المستخدمة بالفعل في النظام ، انظر الشهادات> قائمة بجميع الشهادات للحصول على قائمة الشهادات المتاحة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| ملف | خيط | اسم الملف الشهادة ، سابقا يجب تحميل الشهادة في النظام. | صحيح |
مثال على الاستجابة:
{
"description" : "Add certificate",
"message" : "The certificate example.pem has been added to the farm httpFarm, you need restart the farm to apply",
"success" : "true",
"status": "needed restart"
}
أضف رأسًا مخصصًا إلى الطلب
أضف رأسًا مخصصًا إلى الطلب
طلب مثال:
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"
هذه المكالمة متاحة من الإصدار 4.0.2
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"
هذه المكالمة متاحة من الإصدار 4.0.2
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
هذه المكالمة متاحة من الإصدار 4.0.2
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:"
هذه المكالمة متاحة من الإصدار 4.0.2
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:"
هذه المكالمة متاحة من الإصدار 4.0.2
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
هذه المكالمة متاحة من الإصدار 4.0.2
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"
}
}
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
GET /farms/<farmname>/services/<id>
عرض كل التهيئة حول خدمة معينة.
مثال على الاستجابة:
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null,
"connection_limit" : null
},
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"connection_limit" : null
}
],
"farmguardian" : "check_tcp-cut_conns",
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN",
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON بالتنسيق أدناه.
كائن الخدمات لمزارع HTTP:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الخلفيات | موضوع[] | الخلفيات المحددة في الخدمة. |
| farmguardian | خيط | إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى. |
| httpsb | خيط | تشير هذه المعلمة إلى المزرعة إلى أن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات. |
| id | خيط | اسم الخدمة ، لا يمكن تعديله بمجرد إنشاء الخدمة. |
| leastresp | خيط | تمكن أقل طريقة موازنة المستجيب. صحيح بشكل فاحش يتحقق الملف الشخصي الذي تستغرقه الخلفية وقتا أقل للرد من أجل إرسال المزيد من الاتصالات لهذا ، زائف الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد. |
| إصرار | خيط | تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، أساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM يتم إجراء جلسة المثابرة في قاعدة قيمة في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس. |
| إعادة توجيه | خيط | ويتصرف كخلفية خاصة ، حيث يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا. إذا تم تكوين إعادة التوجيه ، فلن تتم إعادة توجيه الطلب إلى الواجهة الخلفية ، فسيتم رد "إعادة التوجيه" إلى العميل بدلاً من ذلك. |
| redirecttype | خيط | كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته مع الخيار الافتراضي. إذا إعادة توجيه لم يتم تكوين الحقل ، سيكون هذا الحقل عبارة عن سلسلة فارغة. |
| معرف جلسة العمل | خيط | هو متوافرة إذا إصرار الحقل هو URL أو COOKIE أو HEADER ، سيتم البحث في قيمة المعلمة من قبل المزرعة في رأس http وسيتم إدارة جلسة عمل العميل. |
| 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 حدد الواجهة الخلفية مع أقل توصيلات معلقة باستخدام نسبة الأوزان المحددة. |
كائن الخلفية لمزارع HTTP:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف الخلفية داخل الخدمة المعينة. |
| ip | خيط | عنوان IP الخاص بـ Backend حيث يتم تشغيل الخدمة الحقيقية. |
| ميناء | رقم الهاتف | منفذ Backend حيث يتم تشغيل الخدمة الحقيقية. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
| مهلة | رقم الهاتف | إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. إذا كان النظام الفارغ سيستخدم المعلمة العمومية Backend timeout. |
| وزن | رقم الهاتف | إنها قيمة الوزن للخادم الحقيقي الحالي ، وستتلقى الواجهة الخلفية ذات القيمة الأعلى للوزن مزيدًا من الاتصالات. القيمة الافتراضية خالية ، وليس وزنًا خاصًا مستخدمًا لهذه الخلفية. القيم المحتملة من 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 '{"id":"newserv"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
POST /farms/<farmname>/services
قم بإنشاء خدمة في ملف تعريف HTTP معين. تحتاج المزرعة إلى إجراء إعادة تشغيل لتطبيق هذا التغيير.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| id | خيط | اسم الخدمة الذي يتم استخدامه كمعرّف فريد. لا يُسمح إلا بالقيم الأبجدية الرقمية. | صحيح |
مثال على الاستجابة:
{
"description" : "New service newserv",
"params" : {
"id" : "newserv"
},
"status" : "needed restart"
}
تعديل الخدمة
تعديل الخدمة
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL",
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid",
"leastresp":"true","httpsb":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
PUT /farms/<farmname>/services/<id>
قم بتعديل معلمات إحدى الخدمات في ملف تعريف HTTP. id هو معرف الخدمة الفريد الذي سيتم تعديله.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| عشقتك | خيط | يحدد الشرط الذي يحدده اسم النطاق من خلال نفس IP الظاهري والمنفذ المحدد بواسطة مجموعة ملف تعريف HTTP. ويدعم التعبير العادي PCRE. |
| urlp | خيط | يسمح بتحديد خدمة ويب فيما يتعلق بعنوان URL الذي يطلبه العميل من خلال نمط محدد لعنوان URL والذي سيتم فحصه بناءًا. ويدعم التعبير العادي PCRE. |
| إعادة توجيه | خيط | يعمل كخلفية خاصة ، يتم الرد على طلب العميل عن طريق إعادة التوجيه إلى عنوان URL جديد تلقائيًا. |
| redirecttype | خيط | كيف سيتم تنفيذ إعادة التوجيه ، وهما خياران: الافتراضي، يتم أخذ عنوان url كمضيف مطلق ومسار لإعادة التوجيه إلى ، ألحق، سيتم إلحاق المسار طلب الأصلي أو URI المضيف والمسار الذي حددته في إعادة توجيه حقل. سينطبق هذا السلوك فقط إذا إعادة توجيه ليست قيمة فارغة. |
| إصرار | خيط | تحدد هذه المعلمة كيف ستقوم خدمة HTTP بإدارة جلسة عمل العميل. الخيارات هي: "" سلسلة فارغة ، يتم اتخاذ أي إجراء ، IP تتم جلسة المثابرة في قاعدة IP العميل ، أساسي تتم جلسة المثابرة في الأساس من رؤوس BASIC ، URL يتم إجراء جلسة المثابرة في قاعدة حقل في URI ، PARM تتم جلسة المثابرة على أساس قيمة مفصولة بعلامة "؛" في نهاية URI ، كوكي يتم إجراء جلسة المثابرة في أساس اسم ملف تعريف الارتباط ، يجب إنشاء ملف تعريف الارتباط هذا بواسطة الخلفية ، و HEADER، تتم جلسة المثابرة في قاعدة اسم رأس. |
| TTL | رقم الهاتف | فقط مع استمرار. أقصى وقت للحياة لجلسة عمل غير نشطة (الحد الأقصى لعمر الجلسة) في ثوانٍ. |
| معرف جلسة العمل | خيط | هو متوافرة إذا إصرار الميدان هو URL, كوكي or HEADER، سيتم البحث في قيمة المعلمة بواسطة ملف التعريف في رأس http وسيدير جلسة عمل العميل. |
| leastresp | خيط | تمكن أقل طريقة موازنة المستجيب. صحيحبشكل فاحش ، يتحقق الملف الشخصي من الخلفية التي تستغرق وقتًا أقل للرد من أجل إرسال المزيد من الاتصالات إلى هذا الشخص ، زائف، الملف الشخصي لا يتحقق من الخلفية التي تستغرق وقتًا أقل للرد. |
| httpsb | خيط | يشير إلى المزرعة بأن خوادم الواجهة الخلفية المحددة في الخدمة الحالية تستخدم لغة HTTPS ومن ثم سيتم تشفير البيانات قبل إرسالها. صحيح، يرسل الملف الشخصي حركة المرور في بروتوكول HTTPS إلى الخلفيات ، زائف، يرسل الملف الشخصي حركة المرور في بروتوكول HTTP إلى الخلفيات. |
| اتصال مثبت (من الإصدار 4.0.2) | رقم الهاتف | حدد ما إذا كنا نريد تثبيت جميع الاتصالات ، (الافتراضي: 0 ، غير مثبت). إذا تم تعيين Pinnedconnection على 1 ، فإن zproxy يعيد توجيه جميع البيانات مباشرة دون تحليل أو تحرير. |
| سياسة التوجيه (من الإصدار 4.0.2) | خيط | حدد سياسة التوجيه. يتم ترجيح جميع الخوارزميات باستخدام جميع الأوزان المحددة في كل خلفية. هناك أربعة خيارات: ROUND_ROBIN استخدام خوارزمية round robin كسياسة توجيه (تقصيرر). LEAST_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات تم إنشاؤها باستخدام مجموعة الأوزان كنسبة مئوية. وقت الاستجابة حدد الخلفية ذات أقل وقت استجابة باستخدام الأوزان التي تم تعيينها كنسبة. PENDING_CONNECTIONS حدد الواجهة الخلفية مع أقل توصيلات معلقة باستخدام نسبة الأوزان المحددة. |
مثال على الاستجابة:
{
"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" : [],
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirecttype" : "default",
"sessionid" : "sid",
"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
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
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 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
DELETE /farms/<farmname>/services/<id>
حذف خدمة معينة من ملف تعريف http. id هو معرف الخدمة الفريد الذي سيتم حذفه.
مثال على الاستجابة:
{
"description" : "Delete service service1 in farm FarmHTTP",
"message" : "The service service1 in farm FarmHTTP has been deleted.",
"success" : "true",
"status": "needed restart"
}
HTTP - خدمات - الخلفيات
قائمة الخلفية
قائمة الخلفية
طلب مثال:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
الحصول على قائمة الخلفية في الخدمة. id هو معرف الخدمة الفريد.
مثال على الاستجابة:
{
"description" : "List service backends",
"params" : [
{
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1,
"connection_limit" : null
},
{
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2,
"connection_limit" : null
}
]
}
معلمات الاستجابة
تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف فريد للواجهة الخلفية في الخدمة. يتم إنشاء هذا المعرف من قبل النظام. |
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. |
| ميناء | رقم الهاتف | ميناء Backend حيث تستمع الخدمة الحقيقية. |
| مهلة | رقم الهاتف | إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. |
| وزن | رقم الهاتف | إنها قيمة الوزن للواجهة الخلفية الحالية. القيم المحتملة من 1 إلى 9. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
| 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}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
POST /farms/<farmname>/services/<id>/backends
إنشاء خلفية جديدة في ملف تعريف HTTP محدد. id هو معرف الخدمة الفريد.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. | صحيح |
| ميناء | رقم الهاتف | ميناء Backend حيث تستمع الخدمة الحقيقية. | صحيح |
| مهلة | رقم الهاتف | إنها المهلة الخلفية للاستجابة لطلب معين. | |
| وزن | رقم الهاتف | إنها قيمة الوزن للواجهة الخلفية الحالية. القيم المحتملة من 1 إلى 9. |
مثال على الاستجابة:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 0,
"ip" : "192.168.102.244",
"port" : 80,
"timeout" : 2,
"weight" : 2,
"connection_limit" : null
},
"status" : "needed restart"
}
معلمات الاستجابة
سيكون الرد json مع المعلمات المطلوبة المحدثة و الحالة المجال مع هناك حاجة لإعادة التشغيل قيمة إذا كان يجب إعادة تشغيل المزرعة. يجب اتخاذ إجراء إعادة التشغيل لتطبيق التغييرات.
تعديل الخلفية
تعديل الخلفية
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.0.10","port":88,"timeout":12,"service":"sev2", "weight":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/services/<id>/backends/<id>
قم بتعديل معلمات الخلفية في خدمة ملف تعريف HTTP.
الاسم الأول id هو معرف الخدمة الفريد ، التالي id هو معرف فريد الخلفية.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. |
| ميناء | رقم الهاتف | ميناء Backend حيث تستمع الخدمة الحقيقية. |
| مهلة | رقم الهاتف | إنها المهلة الخلفية للاستجابة لطلب معين ، في ثوان. |
| وزن | رقم الهاتف | إنها قيمة الوزن للواجهة الخلفية الحالية. القيم المحتملة من 1 إلى 9. |
مثال على الاستجابة:
{
"description" : "Modify service backend",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.0.10",
"port" : 88,
"timeout" : 12,
"weight" : 1,
"connection_limit" : null
},
"status" : "needed restart"
}
معلمات الاستجابة
سيكون الرد json مع المعلمات المطلوبة المحدثة و الحالة المجال مع هناك حاجة لإعادة التشغيل قيمة إذا كان يجب إعادة تشغيل المزرعة. يجب اتخاذ إجراء إعادة التشغيل لتطبيق التغييرات.
الخلفية في الصيانة
الخلفية في الصيانة
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance","mode":"cut"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance
قم بتعيين إجراء معين في الخلفية لمزرعة HTTP ، يتم وصف الإجراءات المتاحة أدناه.
الاسم الأول id هو معرف الخدمة الفريد ، التالي id هو معرف فريد الخلفية.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| عمل | خيط | حدد الإجراء المطلوب. الإجراءات هي: up الخلفية جاهزة لاستقبال طلبات العميل ، صيانة الخلفية ليست جاهزة لتلقي طلبات العميل ، وهذا الإجراء مفيد لإيقاف خادم الواجهة الخلفية دون التأثير على العملاء. | |
| طريقة | خيط | اختر وضع الصيانة. الخيارات المتاحة هي: استنزاف، لا تقبل الواجهة الخلفية اتصالات جديدة ، لكنها ستستمر في التعامل مع الاتصالات الحالية ؛ أو قطع، سيتم إغلاق الاتصالات الحالية. | إذا لم يتم تحديد هذا الحقل ، فسيكون الوضع الافتراضي استنزاف. |
مثال على الاستجابة:
{
"description" : "Set service backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
حذف الخلفية
حذف الخلفية
طلب مثال:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
DELETE /farms/<farmname>/services/<id>/backends/<id>
احذف خلفية معينة في خدمة ملف تعريف HTTP.
الاسم الأول id هو معرف الخدمة الفريد ، التالي id هو معرف فريد الخلفية.
مثال على الاستجابة:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
مزارع L4xNAT
تسمح مجموعة الملف الشخصي L4xNAT بإنشاء مزرعة L4 بأداء عالٍ جدًا وتوصيلات أكثر تواصلاً من نوى موازن الحمل في طبقة 7 مثل ملفات تعريف مزرعة HTTP. يعوق تحسين أداء طبقة 4 معالجة المحتوى المتقدم التي يمكن أن تديرها ملفات تعريف طبقة 7.
بالإضافة إلى ذلك ، يمكن لمزارع L4xNAT ربط مجموعة من المنافذ ، وليس منفذًا افتراضيًا واحدًا فقط كما هو مستخدم مع ملفات تعريف الطبقة 7 الأخرى. لكي تتمكن من تحديد مجموعة من المنافذ الافتراضية أو منفذ افتراضي معين في مزارع L4xNAT ، من الضروري تحديد نوع البروتوكول. في حالة أخرى ، ستستمع المزرعة على جميع المنافذ من IP الظاهري (يشار إليه بالحرف "*"). بمجرد تحديد بروتوكول TCP أو UDP ، سيكون متاحًا لتحديد منفذ ، أو عدة منافذ بين "،" ، وتتراوح المنافذ بين ":" أو جميع المنافذ التي تحتوي على "*". سيكون الجمع بينهم جميعًا صالحًا أيضًا.
استرجاع المزرعة بالاسم
استرجاع المزرعة بالاسم
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm
GET /farms/<farmname>
عرض جميع التهيئة حول مزرعة معينة.
جسم الرد:
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.55.40",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.55.41",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"params" : {
"algorithm" : "weight",
"farmguardian" : "check_tcp",
"listener" : "l4xnat",
"nattype" : "nat",
"protocol" : "tcp",
"status" : "down",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON بالتنسيق أدناه.
كائن المزرعة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| params | هدف | معلمات التكوين الزراعي. |
| الخلفيات | موضوع[] | جميع الخوادم الحقيقية التي تم إنشاؤها في هذه المزرعة وتكوينها. |
كائن معلمات لمزارع L4xNAT:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| خوارزمية | خيط | نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: وزن اتصال خطي الإرسال حسب الوزن ، مصدر تجزئة Hash لكل مصدر IP ومصدر المصدر ، مصدر بسيط تجزئة تجزئة لكل عنوان IP فقط ، متماثل هاش تجزئة جولة ذهابا وإيابا لكل IP والميناء. |
| مستمع | خيط | يحدد المستمع كيف ستلعب المزرعة بطلبات العملاء. المعلومات لا يمكن تعديله. |
| nattype | خيط | كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات تسمى أيضًا وضع sNAT ، تستجيب الواجهة الخلفية لموازن التحميل من أجل إرسال الاستجابة إلى العميل ، DNAT الخلفية سوف تستجيب مباشرة إلى العميل ، يجب أن يتم تكوين موازن التحميل كبوابة في الخادم الخلفي ، DSR عودة الملقم المباشر ، موازن التحميل تغيير mac الوجهة ثم ينتقل الرد مباشرة إلى العميل. |
| بروتوكول | خيط | البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيقوم الملف الشخصي بتحميل التوازن لأي بروتوكول L4 ، برنامج التعاون الفني موازن التحميل سوف يوازن فقط بروتوكول TCP L4 ، UDP موازن التحميل سوف يوازن فقط بروتوكول UDP L4 ، رشفة سوف توازن موازن التحميل فقط بروتوكول SIP أو بروتوكول VoIP L7 ، بروتوكول نقل الملفات موازن التحميل سوف يوازن بروتوكول FTP L7 فقط ، المبسط موازن التحميل سوف يوازن فقط بروتوكول TFTP L7 ، SCTP موازن التحميل سوف يوازن فقط بروتوكول SCTP L4 ، أماندا موازن الحمل سيوازن فقط بروتوكول AMANDA L7 ، h323 سوف موازن الحمل موازنة فقط بروتوكول H323 L7 ، IRC موازن التحميل سوف يوازن فقط بروتوكول IRC L7 ، NETBIOS-NS سوف موازن تحميل توازن فقط بروتوكول NETBIOS-NS. |
| الحالة | خيط | حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح. |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث تستمع الخدمة الافتراضية. |
| vport | خيط | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. يمكن أن يكون المنفذ الفريد محددًا ، يمكن تعيين منفذ مجموعة باستخدام فاصل : وعدة منافذ يمكن أن تكون محددة مع فاصل ,. |
| farmguardian | خيط | إنه اسم FarmGuardian الذي يتحقق من حالة الواجهة الخلفية. سيتم تشغيل FarmGuardian في حين أن المزرعة في حالة أعلى. |
الكائن الخلفي للمزارع L4xNAT:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف لتعريف الواجهة الخلفية في المزرعة. |
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
| الأولوية | رقم الهاتف | إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 1 هي الأكثر أولوية و 9 هي الأقل أولوية. |
| وزن | رقم الهاتف | إنها قيمة الوزن للخادم الحقيقي الحالي. الخلفية ذات الوزن الأكبر ستتلقى المزيد من الوصلات. القيم المحتملة من 1 إلى 9. |
إنشاء مزرعة جديدة
إنشاء مزرعة جديدة
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
POST /farms
قم بإنشاء مزرعة L4xNAT جديدة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| farmname | خيط | اسم المزرعة ، معرف فريد. | صحيح |
| البيانات الشخصية | خيط | الملف الشخصي للمزرعة المنشأة. للمزارع L4xNAT هو l4xnatرسالة معلومات لا يمكن تغيير هذه القيمة | صحيح |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث تستمع الخدمة الافتراضية. | صحيح |
| vport | خيط | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. تسمح مزارع L4xNAT بفصل المنفذ المتعدد عن بعضها البعض , أو منفذ النطاق مفصولة :. | صحيح |
مثال على الاستجابة:
{
"description" : "Creating farm 'newl4farm'",
"params" : {
"farmname" : "newl4farm",
"interface" : "eth0",
"profile" : "l4xnat",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
تعديل مزرعة
تعديل مزرعة
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"algorithm":"weight","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","vip":"178.62.126.152","vport":"81"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
PUT /farms/<farmname>
قم بتعديل تكوين مزرعة L4xNAT.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| newfarmname | خيط | اسم المزرعة الجديد. يجب إيقاف المزرعة. |
| خوارزمية | خيط | نوع من خوارزمية موازنة الحمل المستخدمة في المزرعة. الخيارات هي: وزن اتصال خطي الإرسال حسب الوزن ، مصدر تجزئة Hash لكل مصدر IP ومصدر المصدر ، مصدر بسيط تجزئة تجزئة لكل عنوان IP فقط ، متماثل هاش تجزئة جولة ذهابا وإيابا لكل IP والميناء. |
| nattype | خيط | كيف ستعمل حزمة موازن الحمل 4 core. الخيارات هي: نات تسمى أيضًا وضع sNAT ، تستجيب الواجهة الخلفية لموازن التحميل من أجل إرسال الاستجابة إلى العميل ، DNAT الخلفية سوف تستجيب مباشرة إلى العميل ، يجب أن يتم تكوين موازن التحميل كبوابة في الخادم الخلفي ، DSR عودة الملقم المباشر ، موازن التحميل تغيير mac الوجهة ثم ينتقل الرد مباشرة إلى العميل. |
| بروتوكول | خيط | البروتوكول لتكون متوازنة في طبقة 4. الخيارات هي: من جميع سيقوم الملف الشخصي بتحميل التوازن لأي بروتوكول L4 ، برنامج التعاون الفني موازن التحميل سوف يوازن فقط بروتوكول TCP L4 ، UDP موازن التحميل سوف يوازن فقط بروتوكول UDP L4 ، رشفة سوف توازن موازن التحميل فقط بروتوكول SIP أو بروتوكول VoIP L7 ، بروتوكول نقل الملفات موازن التحميل سوف يوازن بروتوكول FTP L7 فقط ، المبسط موازن التحميل سوف يوازن فقط بروتوكول TFTP L7 ، SCTP موازن التحميل سوف يوازن فقط بروتوكول SCTP L4 ، أماندا موازن الحمل سيوازن فقط بروتوكول AMANDA L7 ، h323 سوف موازن الحمل موازنة فقط بروتوكول H323 L7 ، IRC موازن التحميل سوف يوازن فقط بروتوكول IRC L7 ، NETBIOS-NS سوف يوازن موازن التحميل بروتوكول NETBIOS-NS فقط ، PPTP سوف يوازن موازن التحميل بروتوكول H323 L7 فقط. |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث تستمع الخدمة الافتراضية. |
| vport | خيط | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. يمكن أن يكون المنفذ الفريد محددًا ، يمكن تعيين منفذ مجموعة باستخدام فاصل : وعدة منافذ يمكن أن تكون محددة مع فاصل ,. |
مثال على الاستجابة:
{
"description" : "Modify farm l4farm",
"params" : {
"algorithm" : "weight",
"nattype" : "nat",
"newfarmname" : "l4farm",
"protocol" : "tcp",
"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
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
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"
}
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
GET /farms/<farmname>/backends
الحصول على قائمة الخلفية في الخدمة.
مثال على الاستجابة:
{
"description" : "List backends",
"params" : [
{
"id" : 0,
"ip" : "192.5.1.1",
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.5.1.3",
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
معلمات الاستجابة
تقوم هذه المكالمة بإرجاع مصفوفة الكائن الخلفي مع المعلمات الداعمة.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف لتعريف الواجهة الخلفية في المزرعة. |
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
| الأولوية | رقم الهاتف | إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 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"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
POST /farms/<farmname>/backends
إنشاء الخلفية الجديدة في مزرعة L4xNAT معينة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. | صحيح |
| الأولوية | رقم الهاتف | إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 1 هي الأكثر أولوية و 9 هي الأقل أولوية. | |
| وزن | رقم الهاتف | إنها قيمة الوزن للخادم الحقيقي الحالي. الخلفية ذات الوزن الأكبر ستتلقى المزيد من الوصلات. القيم المحتملة من 1 إلى 9. |
مثال على الاستجابة:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"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","priority":4,"weight":7}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
PUT /farms/<farmname>/backends/<id>
تعديل معلمات الخلفية في خدمة L4xNAT Farm. id هو معرف فريد الخلفية.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP الخاص بـ Backend حيث تستمع الخدمة الحقيقية. |
| الأولوية | رقم الهاتف | إنها القيمة ذات الأولوية للخادم الحقيقي الحالي. دائمًا ما تكون الاتصالات أكثر البرامج المتاحة حيث تكون 1 هي الأكثر أولوية و 9 هي الأقل أولوية. |
| وزن | رقم الهاتف | إنها قيمة الوزن للخادم الحقيقي الحالي. الخلفية ذات الوزن الأكبر ستتلقى المزيد من الوصلات. القيم المحتملة من 1 إلى 9. |
مثال على الاستجابة:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"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
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
DELETE /farms/<farmname>/backends/<id>
حذف الخلفية المعطاة في خدمة مزرعة L4xNAT.
id هو معرف فريد الخلفية.
مثال على الاستجابة:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
شبكة
Zevenet يمكن أن تعمل مع أنواع مختلفة من واجهات الشبكة.
في هذا القسم ، يمكنك سرد وإنشاء وتكوين وحذف وتعيين إجراء في NIC و VLAN والواجهات الظاهرية.
NIC: أو بطاقة واجهة الشبكة ، هو مكون أجهزة الكمبيوتر ونوع tis من الواجهة هو الأساس للنوع التالي من الواجهات التي يمكن تعريفها وإدارتها في Zevenet.
شبكة محلية ظاهرية: أو بطاقة lan الظاهرية هي واجهة أو واجهة شبكة اتصال توفر خدمات تجزئة الشبكة. يمكن إنشاء أكثر من vlan من خلال واجهة nic.
واقعي: يمكن إنشاء هذا النوع من الواجهة عبر أي نوع من واجهة وصف أعلاه. يجب استخدام هذا النوع من الواجهة للمزارع ويتطلب تعريف الواجهة الظاهرية في نفس الشبكة الفرعية عن الأصل.
قائمة جميع الواجهات
قائمة جميع الواجهات
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
GET /interfaces
الحصول على قائمة من واجهات في النظام مع التكوين الخاصة بهم.
مثال على الاستجابة:
{
"description" : "List interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
},
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "down",
"type" : "vlan"
},
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "virtual"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
}
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع صفيف كائنات واجهة.
كائن الواجهة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. يجب أن يكون IP في نفس مقطع الشبكة من واجهة الأصل في الواجهة الافتراضية. |
| has_vlan | خيط | صحيح، الواجهة هي أصل واجهة VLAN ؛ أو زائف، لم تحصل الواجهة على أي واجهة VLAN إلحاق بها. هذا الحقل هو فقط لواجهات NIC. |
| قناع الشبكة | خيط | قناع الشبكة للواجهة. لا يمكن تعديل هذه القيمة في واجهات ظاهرية ، بل يتم توريثها من inteface الأصل. |
| بوابة | خيط | بوابة الواجهة. لا يمكن تعديل هذه القيمة في واجهات ظاهرية ، بل يتم توريثها من inteface الأصل. |
| لجنة الهدنة العسكرية | خيط | ماك من واجهة. هذه القيمة موروثة من واجهة الأصل. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. |
| الحالة | خيط | القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم. |
| نوع | خيط | نوع مختلف من واجهات: NIC, شبكة محلية ظاهرية or واقعي. |
استرداد العبارة الافتراضية
استرداد العبارة الافتراضية
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
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
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
رسالة الرد
إذا كانت البوابة هي disconfigure من نفس مقطع الشبكة ، ستظهر هذه الرسالة ، وإلا سوف يفقد الاتصال.
مثال على الاستجابة:
{
"description" : "Remove default gateway",
"message" : "The default gateway has been deleted successfully",
"params" : {
"address" : null,
"interface" : null
}
}
شبكة - واجهات NIC
واجهات NIC هي الواجهات المادية المتصلة بموازنة التحميل Zevenet الخاصة بك.
يتعرف النظام على الواجهات الجديدة تلقائيًا بمجرد توصيلها.
باستخدام واجهات NIC كآباء ، يمكن إنشاء نوع آخر من الواجهات ذات الخصائص المختلفة. الواجهات المتاحة هي: VLAN و واقعي.
قائمة واجهات NIC
GET /interfaces/nic
الحصول على جميع المعلمات من واجهات NIC.
قائمة واجهات NIC
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
مثال على الاستجابة:
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"is_slave" : "false",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع صفيف من كائنات واجهة NIC.
كائن واجهة NIC:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. |
| has_vlan | خيط | صحيح، الواجهة هي أصل واجهة VLAN ؛ أو زائف، لم تحصل الواجهة على أي واجهة VLAN إلحاق بها. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم إلى مقطع شبكة مختلف. |
| لجنة الهدنة العسكرية | خيط | طبقة فريدة من نوعها indentifier. إنه غير قابل للتعديل. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة. |
| الحالة | خيط | القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم. |
استرداد واجهة NIC
استرداد واجهة NIC
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
GET /interfaces/nic/<name>
الحصول على جميع المعلمات من واجهة NIC. الاسم هو معرف فريد للواجهة.
مثال على الاستجابة:
{
"description" : "Show NIC interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم إلى مقطع شبكة مختلف. |
| لجنة الهدنة العسكرية | خيط | طبقة فريدة من نوعها indentifier. إنه غير قابل للتعديل. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد للواجهة. |
| الحالة | خيط | القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم. |
| نوع | خيط | نوع مختلف من واجهات: NIC, شبكة محلية ظاهرية or واقعي. يتم تعريف كل واحد في القائمة الفرعية لشبكة الاتصال الخاصة بهم. |
تعديل واجهة 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
PUT /interfaces/nic/<name>
قم بتعديل معلمات واجهة NIC. الاسم هو معرف فريد للواجهة.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. |
| القوة | خيط | إذا كانت المزرعة تستخدم الواجهة ، فلن تتمكن من تعديل الواجهة. بعد ذلك ، إذا تم إرسال هذه المعلمة بالقيمة صحيح، ستضطر واجهة لاتخاذ التكوين الجديد وسيتم تشغيل جميع المزارع تستخدم واجهة. |
مثال على الاستجابة:
{
"description" : "Configure nic interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"netmask" : "255.255.255.0",
"force" : "true"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
حذف تكوين NIC
حذف تكوين NIC
طلب مثال:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
DELETE /interfaces/nic/<name>
احذف التكوين لواجهة NIC. بعد هذا الإجراء ، ستكون الواجهة غير مجدية ، وتكون جاهزة للتهيئة مرة أخرى. الاسم هو معرف فريد للواجهة.
مثال على الاستجابة:
{
"description" : "Delete nic interface",
"message" : "The configuration for the network interface eth3 has been deleted.",
"success" : "true"
}
تعيين إجراء واجهة NIC
تعيين إجراء واجهة NIC
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1/actions
POST /interfaces/nic/<name>/actions
تطبيق إجراء على واجهة NIC. تتيح هذه المكالمة تمكين أو تعطيل واجهة شبكة.
الاسم هو معرف فريد للواجهة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| عمل | خيط | الإجراء المطلوب تطبيقه على الواجهة. القيم المتاحة هي: upتمكين الواجهة وتحضيرها لاستخدامها ؛ إلى أسفل، تعطيل واجهة لعدم تلقي أو عدم إرسال الحزم. | صحيح |
مثال على الاستجابة:
{
"description" : "Action on nic interface",
"params" : {
"action" : "up"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
شبكة - واجهات VLAN
تتيح واجهة VLAN واجهة NIC تعمل في شبكة أخرى ، لذلك فإن IP, بوابة و قناع الشبكة يمكن أن تكون الحقول مختلفة عن الواجهة الأصلية. ترث واجهة VLAN عنوان MAC من واجهتها الرئيسية.
مجال واجهات VLAN الاسم سيظهر مع حرف "." الذي سيتم استخدامه لإنشاء علامة معرف لواجهة vlan.
قائمة واجهات VLAN
قائمة واجهات VLAN
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
GET /interfaces/vlan
الحصول على جميع المعلمات من واجهات VLAN.
مثال على الاستجابة:
{
"description" : "List VLAN interfaces",
"interfaces" : [
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع صفيف كائنات واجهة VLAN.
معلمات VLAN هي:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. يمكن أن يكون مختلفًا عن inteface IP. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. |
| لجنة الهدنة العسكرية | خيط | ماك من واجهة. هذه القيمة موروثة من الواجهة الأصلية. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من اسم الواجهة الأصل ، وهو حرف النقطة "." ورقم لواجهة شبكة vlan أو علامة vlan. |
| أصل | خيط | هو واجهة المستخدم لإنشاء هذا واحد. |
| الحالة | خيط | القيم يمكن أن يكون up واجهة يمكن تلقي الحزم ، إلى أسفل واجهة لا يمكن تلقي الحزم. |
استرداد واجهة 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
GET /interfaces/vlan/<name>
الحصول على جميع المعلمات من واجهة VLAN. الاسم هو معرف فريد للواجهة.
مثال على الاستجابة:
{
"description" : "Show VLAN interface",
"interface" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. |
| لجنة الهدنة العسكرية | خيط | ماك من واجهة. هذه القيمة موروثة من الواجهة الأصلية. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من اسم واجهة أصل ، وهو حرف النقطة "." ورقم لواجهة شبكة vlan. |
| الحالة | خيط | القيم يمكن أن يكون up واجهة يمكن تلقي الحزم ، إلى أسفل واجهة لا يمكن تلقي الحزم. |
إنشاء واجهة VLAN
إنشاء واجهة VLAN
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1", "name":"eth0.1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
POST /interfaces/vlan
قم بإنشاء واجهة VLAN من واجهة NIC. ستقوم واجهة VLAN الجديدة بمشاركة MAC ، على الرغم من أن معلمات الشبكة التالية يجب أن تكون مختلفة: ip، ويمكن تغيير ما يلي: بوابة, قناع الشبكة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| ip | خيط | IP من الواجهة. يجب أن يكون مختلفًا عن inteface IP. | صحيح |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. | صحيح |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. | صحيح |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من اسم واجهة أصل ، وهو حرف النقطة "." ورقم لواجهة شبكة vlan. | صحيح |
مثال على الاستجابة:
{
"description" : "Add a vlan interface",
"params" : {
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : null,
"name" : "eth0.1",
"netmask" : "255.255.255.0"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
تعديل واجهة VLAN
تعديل واجهة VLAN
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
PUT /interfaces/vlan/<name>
قم بتعديل معلمات واجهة VLAN. الاسم هو معرف فريد للواجهة.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. يمكن أن يكون مختلفًا عن inteface IP. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. |
| القوة | خيط | إذا كانت المزرعة تستخدم الواجهة ، فلن تتمكن من تعديل الواجهة. بعد ذلك ، إذا تم إرسال هذه المعلمة بالقيمة صحيح، ستضطر واجهة لاتخاذ التكوين الجديد وسيتم تشغيل جميع المزارع تستخدم واجهة. |
مثال على الاستجابة:
{
"description" : "Modify VLAN interface",
"params" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"netmask" : "255.255.255.0",
"force" : "true",
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
حذف واجهة VLAN
حذف واجهة VLAN
طلب مثال:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
DELETE /interfaces/vlan/<name>
حذف واجهة VLAN. الاسم هو معرف فريد للواجهة.
مثال على الاستجابة:
{
"description" : "Delete VLAN interface",
"message" : "The VLAN interface eth0.1 has been deleted.",
"success" : "true"
}
تعيين إجراء واجهة VLAN
تعيين إجراء واجهة VLAN
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
POST /interfaces/vlan/<name>/actions
قم بتطبيق إجراء على واجهة VLAN. تتيح هذه المكالمة تمكين أو تعطيل واجهة شبكة.
الاسم هو الاسم الفريد للاسم.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| عمل | خيط | الإجراء المطلوب تطبيقه على الواجهة. القيم المتاحة هي: upتمكين الواجهة وتحضيرها لاستخدامها ؛ إلى أسفل، تعطيل واجهة لعدم تلقي أو عدم إرسال الحزم. | صحيح |
مثال على الاستجابة:
{
"description" : "Action on vlan interface",
"params" : {
"action" : "down"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
الشبكة - واجهات افتراضية
تسمح واجهات الشبكة للمستخدمين بواجهة شبكة أخرى في نفس مقطع الشبكة عن الأصل ، لذلك ترث الواجهات الظاهرية دائمًا تكوين الشبكة من أصلها. ستكون المعلمة مختلفة ip. يمكن إنشاء واجهة افتراضية من NIC أو VLAN. سيظهر إنشاء واجهة افتراضية جديدة حقلاً بعلامة النقطتين ":" التي سيتم استخدامها لإنشاء تعريف للواجهة الظاهرية.
قائمة واجهات الظاهري
قائمة واجهات الظاهري
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
GET /interfaces/virtual
الحصول على جميع المعلمات من واجهات الظاهري.
مثال على الاستجابة:
{
"description" : "List virtual interfaces",
"interfaces" : [
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. يجب أن يكون عنوان IP في نفس مقطع الشبكة عن واجهة الأصل. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. يرث من واجهة الأصل. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. يرث من واجهة الأصل. |
| لجنة الهدنة العسكرية | خيط | ماك من واجهة. يرث من واجهة الأصل. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من واجهة رئيسية ، حرف النقطتين ":" واسم واجهة الشبكة الافتراضية ، يُسمح باستخدام الأحرف الأبجدية الرقمية. |
| أصل | خيط | هو واجهة المستخدم لإنشاء هذا واحد. |
| الحالة | خيط | القيم يمكن أن يكون up، يمكن للواجهة تلقي الحزم ؛ إلى أسفل، لا يمكن للواجهة تلقي الحزم. |
استرداد واجهة افتراضية
استرداد واجهة افتراضية
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
GET /interfaces/virtual/<name>
الحصول على جميع المعلمات من واجهة افتراضية. الاسم هو معرف فريد للواجهة.
مثال على الاستجابة:
{
"description" : "Show virtual interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"status" : "down"
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ip | خيط | IP من الواجهة. يجب أن يكون عنوان IP في نفس مقطع الشبكة عن واجهة الأصل. |
| قناع الشبكة | خيط | حدد جزء الشبكة حيث تعمل الواجهة. يرث من واجهة الأصل. |
| بوابة | خيط | IP يستخدم لإرسال الحزم من مقطع شبكة مختلف. يرث من واجهة الأصل. |
| لجنة الهدنة العسكرية | خيط | ماك من واجهة. يرث من واجهة الأصل. |
| الاسم | خيط | اسم الواجهة. يتم استخدامه كمعرف فريد. هذا الاسم عبارة عن سلسلة مكونة من واجهة رئيسية ، وحرف النقطتين ":" وسلسلة أبجدية رقمية لواجهة الشبكة الافتراضية. |
| أصل | خيط | هو واجهة المستخدم لإنشاء هذا واحد. |
| الحالة | خيط | القيم يمكن أن يكون 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
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
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
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
POST /interfaces/virtual/<name>/actions
تطبيق إجراء على واجهة افتراضية. تتيح هذه المكالمة تمكين أو تعطيل واجهة شبكة.
الاسم هو معرف فريد للواجهة.
طلب المعلمات
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| عمل | خيط | الإجراء المطلوب تطبيقه على الواجهة. القيم المتاحة هي: upتمكين الواجهة وتحضيرها لاستخدامها ؛ إلى أسفل، تعطيل واجهة لعدم تلقي أو عدم إرسال الحزم. | صحيح |
مثال على الاستجابة:
{
"description" : "Action on virtual interface",
"params" : {
"action" : "down"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
رصد - 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
GET /monitoring/fg
قائمة FarmGuardians. تظهر القوالب و availabe FarmGuardians في القائمة.
مثال على الاستجابة:
{
"description" : "List farm guardian checks and templates",
"params" : [
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true"
},
{
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [
"web_service",
"my_welcome_web"
],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false"
},
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أمر | خيط | القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec. |
| cut_conns | خيط | القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| وصف | خيط | وصف صغير حول الشيك. |
| المزارع | خيط[] | المزارع حيث يتم تطبيق FarmGuardian. |
| الفاصلة | رقم الهاتف | الوقت بين الشيكات. |
| سجل | خيط | القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| الاسم | خيط | معرف فريد. |
| قالب | خيط | إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تطبيقه على أي مزرعة. القوالب مفيدة لإنشاء FarmGuardian جديد. |
استرجع FarmGuardian
استرجع FarmGuardian
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
GET /monitoring/fg/<name>
إظهار تكوين FarmGuardian.
معامل URI الاسم هو معرف فريد FarmGuardian.
مثال على الاستجابة:
{
"description" : "Retrive the farm guardian check_tcp",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أمر | خيط | القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec. |
| cut_conns | خيط | القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| وصف | خيط | وصف صغير حول الشيك. |
| المزارع | خيط[] | المزارع حيث يتم تطبيق FarmGuardian. |
| الفاصلة | رقم الهاتف | الوقت بين الشيكات. |
| سجل | خيط | القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| الاسم | خيط | معرف فريد. |
| قالب | خيط | إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تعديله. القوالب مفيدة لإنشاء FarmGuardian جديدة أو تنطبق مباشرة على المزارع. |
إنشاء FarmGuardian
إنشاء FarmGuardian
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "parent":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
POST /monitoring/fg
قم بإنشاء FarmGuardian جديد.
طلب المعلمات
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| الاسم | خيط | معرف فريد. | صحيح |
| أصل | خيط | هذا هو FarmGuardian تستخدم كقالب لإنشاء FarmGuardian الجديد. إذا لم يتم إرسال هذا الحقل ، فسيتم إنشاء FarmGuardian الجديد فارغًا. |
مثال على الاستجابة:
{
"description" : "Create a farm guardian check_tcp-cut_conns",
"message" : "The farm guardian check_tcp-cut_conns has been created successfully",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أمر | خيط | القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec. |
| cut_conns | خيط | القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| وصف | خيط | وصف صغير حول الشيك. |
| المزارع | خيط[] | المزارع حيث يتم تطبيق FarmGuardian. |
| الفاصلة | رقم الهاتف | الوقت بين الشيكات. |
| سجل | خيط | القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| الاسم | خيط | معرف فريد. |
| قالب | خيط | إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تعديله. القوالب مفيدة لإنشاء FarmGuardian جديدة أو تنطبق مباشرة على المزارع. |
تعديل FarmGuardian
تعديل FarmGuardian
طلب مثال:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
PUT /monitoring/fg/<name>
تعديل FarmGuardian.
معامل URI الاسم هو معرف فريد FarmGuardian.
طلب المعلمات
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| أمر | خيط | القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec. | |
| cut_conns | خيط | القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. | |
| وصف | خيط | وصف صغير حول الشيك. | |
| الفاصلة | رقم الهاتف | الوقت بين الشيكات. | |
| سجل | خيط | القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. | |
| القوة | خيط | إذا كانت مزرعة قيد التشغيل تستخدم FarmGuardian ، فلن تتمكن من تعديل FarmGuardian. بعد ذلك ، إذا تم إرسال هذه المعلمة بالقيمة صحيح، سيتم إجبار FarmGuardian على اتخاذ التكوين الجديد. |
مثال على الاستجابة:
{
"description" : "Modify farm guardian custom-tcp",
"message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
"params" : {
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON باستخدام المفتاح params والتنسيق أدناه:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أمر | خيط | القيادة للتحقق من حالة الخدمة في الخلفية. هذه الأوامر المتاحة في مسار libexec. |
| cut_conns | خيط | القيم المحتملة هي: صحيح، FarmGuardian يقطع الاتصالات الحالية عندما لا تتوفر الخلفية. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| وصف | خيط | وصف صغير حول الشيك. |
| المزارع | خيط[] | المزارع حيث يتم تطبيق FarmGuardian. |
| الفاصلة | رقم الهاتف | الوقت بين الشيكات. |
| سجل | خيط | القيم المحتملة هي: صحيح، سيقوم FarmGuardian بتسجيل كل شيك. أو زائفإذا كانت الخلفية غير متوفرة ، سيتم تعطيلها ولكن تستمر الجلسات على قيد الحياة. |
| الاسم | خيط | معرف فريد. |
| قالب | خيط | إذا كان FarmGuardian عبارة عن قالب ، فلن يتم تطبيقه على أي مزرعة. القوالب مفيدة لإنشاء FarmGuardian جديد. |
احذف FarmGuardian
احذف FarmGuardian
طلب مثال:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
DELETE /monitoring/fg/<name>
حذف FarmGuardian.
معامل URI الاسم هو معرف فريد FarmGuardian.
مثال على الاستجابة:
{
"description" : "Delete the farm guardian custom-tcp",
"message" : "custom-tcp has been deleted successful.",
"success" : "true"
}
الرصد - الاحصائيات
عرض معلومات حول النظام والمزارع. ستكون هذه المعلومات مفيدة لمراقبة حالة موازن التحميل Zevenet.
إظهار إحصائيات النظام
إظهار إحصائيات النظام
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats
GET /stats
احصل على إحصائيات النظام العالمي.
مثال على الاستجابة:
{
"description" : "System stats",
"params" : {
"cpu" : {
"cores" : 2,
"idle" : 94.42,
"iowait" : 0,
"irq" : 0,
"nice" : 0,
"softirq" : 0,
"sys" : 2.54,
"usage" : 5.58,
"user" : 3.05
},
"date" : "Fri Jan 27 11:40:32 2017",
"hostname" : "api3",
"load" : {
"Last_1" : 1.17,
"Last_15" : 0.36,
"Last_5" : 0.6
},
"memory" : {
"Buffers" : 21.68,
"Cached" : 147.95,
"MemFree" : 348.06,
"MemTotal" : 2005.01,
"MemUsed" : 1656.95,
"SwapCached" : 2.67,
"SwapFree" : 614.38,
"SwapTotal" : 672,
"SwapUsed" : 57.62
},
"network" : {
"eth0 in in" : 2702.29,
"eth0 out out" : 50701.95,
"eth0.2 in in" : 0,
"eth0.2 out out" : 0,
"eth1 in in" : 234.72,
"eth1 out out" : 0,
"eth2 in in" : 234.72,
"eth2 out out" : 0,
"eth3 in in" : 0,
"eth3 out out" : 0,
"eth4 in in" : 436.89,
"eth4 out out" : 4300.38,
"eth4.6 in in" : 0,
"eth4.6 out out" : 0,
"eth5 in in" : 301.39,
"eth5 out out" : 0,
"eth5.5 in in" : 0,
"eth5.5 out out" : 0,
"eth6 in in" : 77.42,
"eth6 out out" : 0
}
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| وحدة المعالجة المركزية | هدف | إحصائيات وحدة المعالجة المركزية. |
| تاريخ | خيط | تاريخ النظام. |
| اسم المضيف | خيط | اسم المضيف. |
| تحميل | هدف | إحصائيات الحمولة الأساسية. |
| ذاكرة | هدف | إحصائيات الذاكرة المستخدمة. |
| شبكة | هدف | إحصائيات حركة مرور الشبكة. |
كائن وحدة المعالجة المركزية:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| النوى | رقم الهاتف | عدد النوى في المعالج. |
| الخمول | رقم الهاتف | وحدة المعالجة المركزية لا تستخدم من قبل أي برنامج. |
| iowait | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل عملية الإدخال أو الإخراج. |
| IRQ | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل الأجهزة interrrupcions. |
| رحلة جميلة | رقم الهاتف | أولوية جدولة وحدة المعالجة المركزية. |
| softirq | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل البرامج interrrupcions. |
| SYS | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل النظام. |
| استعمال | رقم الهاتف | إجمالي وحدة المعالجة المركزية المستخدمة. |
| المستخدم | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل المستخدم. |
تحميل الكائن:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| Last_1 | رقم الهاتف | تحميل نظام التحميل في اللحظة الأخيرة. |
| Last_5 | رقم الهاتف | تحميل نظام porgesage قبل خمس دقائق. |
| Last_15 | رقم الهاتف | تحميل نظام porgesage قبل خمس عشرة دقيقة. |
كائن الذاكرة.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| مخازن | رقم الهاتف | إنها الذاكرة المستخدمة من قبل المخازن المؤقتة. يشار إلى هذا المبلغ في ميغابايت. |
| مؤقتا | رقم الهاتف | إنه إجمالي الذاكرة المخزنة مؤقتًا من قبل النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemFree | رقم الهاتف | إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemTotal | رقم الهاتف | إنها ذاكرة ذاكرة الوصول العشوائي الكاملة على النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemUsed | رقم الهاتف | إنها الذاكرة المستخدمة من قبل النظام. يشار إلى هذا المبلغ في ميغابايت. |
| SwapCached | رقم الهاتف | انها ذاكرة التخزين المؤقت الإجمالية محفوظة. |
| SwapFree | رقم الهاتف | إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت. |
| SwapTotal | رقم الهاتف | انها الذاكرة المبادلة الإجمالية محفوظة. |
| SwapUsed | رقم الهاتف | إنها الذاكرة المستخدمة من قبل النظام ، على الأنظمة المثلى يجب أن تكون 0. |
كائن الشبكة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| في | رقم الهاتف | حركة المرور لهذا الواجهة. |
| اخرج | رقم الهاتف | حركة الإخراج لهذا الواجهة. |
عرض إحصائيات الشبكة
عرض إحصائيات الشبكة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network
GET /stats/system/network
الحصول على ملخص إجمالي حركة مرور الإدخال والإخراج من خلال واجهة شبكة.
مثال على الاستجابة:
{
"description" : "Network interfaces usage",
"params" : {
"date" : "Fri Jan 27 11:58:05 2017",
"hostname" : "api3",
"interfaces" : [
{
"in" : "77.42",
"interface" : "eth6",
"out" : "0.00"
},
{
"in" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
}
]
}
}
معلمات الاستجابة
سيكون الرد JSON مع مفتاح params قيمتها عبارة عن كائن بمفاتيح المتابعة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| تاريخ | خيط | تاريخ النظام. |
| اسم المضيف | خيط | اسم المضيف. |
| واجهات | موضوع[] | إحصائيات حركة مرور الشبكة. |
كائن واجهات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| in | خيط | إجمالي حركة الإدخال بالميغابايت. |
| الواجهة | خيط | اسم الواجهة. |
| خارج | خيط | مجموع الانتاج trafficin ميغابايت. |
عرض إحصائيات الواجهات
عرض إحصائيات الواجهات
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network/interfaces
GET /stats/system/network/interfaces
الحصول على ملخص لكل واجهة الشبكة.
مثال على الاستجابة:
{
"description" : "Interfaces info",
"params" : {
"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 التي ترث من هذه الواجهة. |
إظهار إحصائيات الذاكرة
إظهار إحصائيات الذاكرة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/memory
GET /stats/system/memory
الحصول على ملخص ذاكرة النظام.
مثال على الاستجابة:
{
"description" : "Memory usage",
"params" : {
"Buffers" : 1.01,
"Cached" : 42.47,
"MemFree" : 880.11,
"MemTotal" : 2005.01,
"MemUsed" : 1124.91,
"SwapCached" : 8.27,
"SwapFree" : 565.15,
"SwapTotal" : 672,
"SwapUsed" : 106.84,
"date" : "Fri Jan 27 12:27:11 2017",
"hostname" : "api3"
}
}
معلمات الاستجابة
سيكون الرد JSON مع مفتاح params قيمتها هي كائن ذاكرة.
مكبر الصوت : يدعم، مع دعم ميكروفون مدمج لمنع الضوضاء موضوع.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| مخازن | رقم الهاتف | إنها الذاكرة المستخدمة من قبل المخازن المؤقتة. يشار إلى هذا المبلغ في ميغابايت. |
| مؤقتا | رقم الهاتف | إنه إجمالي الذاكرة المخزنة مؤقتًا من قبل النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemFree | رقم الهاتف | إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemTotal | رقم الهاتف | إنها ذاكرة ذاكرة الوصول العشوائي الكاملة على النظام. يشار إلى هذا المبلغ في ميغابايت. |
| MemUsed | رقم الهاتف | إنها الذاكرة المستخدمة من قبل النظام. يشار إلى هذا المبلغ في ميغابايت. |
| SwapCached | رقم الهاتف | انها ذاكرة التخزين المؤقت الإجمالية محفوظة. |
| SwapFree | رقم الهاتف | إنه إجمالي الذاكرة الحرة التي لا يتم تخزينها مؤقتًا بواسطة النظام. يشار إلى هذا المبلغ في ميغابايت. |
| SwapTotal | رقم الهاتف | انها الذاكرة المبادلة الإجمالية محفوظة. |
| SwapUsed | رقم الهاتف | إنها الذاكرة المستخدمة من قبل النظام ، على الأنظمة المثلى يجب أن تكون 0. |
| تاريخ | خيط | تاريخ النظام. |
| اسم المضيف | خيط | اسم المضيف. |
إظهار إحصائيات التحميل
إظهار إحصائيات التحميل
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/load
GET /stats/system/load
احصل على ملخص تحميل نظام CPU.
مثال على الاستجابة:
{
"description" : "System load",
"params" : {
"Last_1" : 0.66,
"Last_15" : 0.39,
"Last_5" : 0.49,
"date" : "Fri Jan 27 13:15:01 2017",
"hostname" : "api3"
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| Last_1 | رقم الهاتف | تحميل نظام استخدام الماضي. |
| Last_5 | رقم الهاتف | استخدام نظام التحميل لآخر خمس دقائق. |
| Last_15 | رقم الهاتف | استخدام نظام التحميل لآخر خمس عشرة دقيقة. |
| تاريخ | خيط | تاريخ النظام. |
| اسم المضيف | خيط | اسم المضيف. |
إظهار إحصائيات وحدة المعالجة المركزية
إظهار إحصائيات وحدة المعالجة المركزية
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/cpu
GET /stats/system/cpu
مثال على الاستجابة:
{
"description" : "System CPU usage",
"params" : {
"cores" : 2,
"date" : "Fri Jan 27 13:30:52 2017",
"hostname" : "api3",
"idle" : 94.9,
"iowait" : 0,
"irq" : 0,
"nice" : 0,
"softirq" : 0,
"sys" : 3.06,
"usage" : 5.1,
"user" : 2.04
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| النوى | رقم الهاتف | عدد النوى في المعالج. |
| الخمول | رقم الهاتف | وحدة المعالجة المركزية لا تستخدم من قبل أي برنامج. |
| iowait | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل عملية الإدخال أو الإخراج. |
| IRQ | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل الأجهزة interrrupcions. |
| رحلة جميلة | رقم الهاتف | أولوية جدولة وحدة المعالجة المركزية. |
| softirq | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل البرامج interrrupcions. |
| SYS | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل النظام. |
| استعمال | رقم الهاتف | إجمالي وحدة المعالجة المركزية المستخدمة. |
| المستخدم | رقم الهاتف | وحدة المعالجة المركزية المستخدمة من قبل المستخدم. |
| تاريخ | خيط | تاريخ النظام. |
| اسم المضيف | خيط | اسم المضيف. |
إظهار إحصائيات الاتصالات
إظهار إحصائيات الاتصالات
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/connections
GET /stats/system/connections
احصل على إجمالي الاتصالات الحالية في النظام. يقوم العداد بجمع أي نوع من الاتصالات المتعقبة: ASSURED ، ESTABLISHED ، SYN_SENT ، TIME_WAIT ، LISTEN ...
مثال على الاستجابة:
{
"description" : "System connections",
"params" : {
"connections" : 324
}
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| علاقات | رقم الهاتف | مجموع الاتصالات المتعقبة في الواقع. |
عرض عدد من المزارع
عرض عدد من المزارع
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/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
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"
}
]
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أنشئ | رقم الهاتف | مجموع عدد الاتصالات الحالية. |
| farmname | خيط | اسم المزرعة ، معرف فريد. |
| ريثما | رقم الهاتف | عدد الاتصالات المعلقة. |
| البيانات الشخصية | خيط | نوع المزرعة. القيم المحتملة هي: وصلة البيانات, l4xnat, HTTP or HTTPS. يتم تعريف كل ملف تعريف في قسمه. |
| الحالة | خيط | حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. 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
GET /stats/farms/<farmname>
يعرض حالة المزرعة الحالية وحالة backs الخاصة بهم والاتصالات. سوف تستجيب كل مزرعة مع كائن مختلف ، اعتمادا على ملف التعريف.
مثال الاستجابة لمزرعة HTTP:
{
"backends" : [
{
"established" : 0,
"id" : 0,
"ip" : "192.168.0.168",
"pending" : 0,
"port" : 80,
"service" : "srv1",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"client" : "0",
"id" : "0",
"service" : "srv1",
"session" : "192.168.0.186"
}
]
}
معلمات الاستجابة في مزارع HTTP
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الخلفيات | موضوع[] | عرض معلومات حول الخلفيات. |
| دورات | موضوع[] | عرض معلومات حول الجلسات. |
كائن الخلفية
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أنشئ | رقم الهاتف | العدد الإجمالي للاتصالات القائمة. |
| id | رقم الهاتف | معرف فريد الخلفية. |
| ip | خيط | IP حيث تستمع الخدمة الحقيقية. |
| ريثما | رقم الهاتف | عدد الاتصالات المعلقة. |
| ميناء | رقم الهاتف | الميناء حيث تستمع الخدمة الحقيقية. |
| العملاء | خيط | اسم الخدمة المستخدم كمعرّف فريد. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
كائن الجلسة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| زبون | خيط | معرف فريد للعميل. |
| id | خيط | الخلفية المعرف الفريد المخصص للعميل. |
| العملاء | خيط | معرف فريد للخدمة يتم تعيينه للعميل. |
| الجلسة | خيط | معرف فريد للجلسة. هذه القيمة تعتمد على نوع المثابرة. |
مثال استجابة لمزرعة L4xNAT:
{
"backends" : [
{
"established" : 5,
"id" : 1,
"ip" : "192.168.5.40",
"pending" : 0,
"port" : "8080",
"status" : "maintenance"
},
{
"established" : null,
"id" : 3,
"ip" : "192.5.1.1",
"pending" : 0,
"port" : "787",
"status" : "down"
},
{
"established" : 1,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"id" : 5,
"session" : "192.168.5.100"
}
]
}
معلمات الاستجابة في مزارع L4xNAT
ستكون الاستجابة JSON مع الكائن الخلفيات و دورات:
كائن خلفي:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أنشئ | رقم الهاتف | مجموع عدد الاتصالات الحالية. |
| id | رقم الهاتف | معرف فريد الخلفية. |
| ip | خيط | IP حيث تستمع الخدمة الحقيقية. |
| ريثما | رقم الهاتف | عدد الاتصالات المعلقة. |
| ميناء | رقم الهاتف | الميناء حيث تستمع الخدمة الحقيقية. |
| الحالة | خيط | حالة الخلفية. القيم المحتملة هي: up، والمزرعة تعمل ، والخلفية جاهزة لاستقبال الاتصالات ؛ إلى أسفليتم تشغيل المزرعة واكتشفت الخدمة أن الواجهة الخلفية لا تعمل ؛ صيانة، تم وضع علامة على الواجهة الخلفية على أنها غير جاهزة لتلقي الاتصالات من قبل المسؤول ، وهذا الخيار مفيد لمهام صيانة الواجهة الخلفية ؛ غير محدد، لم يتم التحقق من حالة الخلفية. |
كائن الجلسة:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| id | رقم الهاتف | معرف فريد الخلفية حيث يتم تعيين العميل. |
| الجلسة | خيط | معرف فريد للجلسة. هو IP العميل. |
معلمات الاستجابة في مزارع وصلة البيانات
إحصائيات مزارع Datalink غير متوفرة في الواقع.
إظهار حالة الوحدة
إظهار حالة الوحدة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/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
},
"lslb" : {
"critical" : 0,
"down" : 2,
"problem" : 0,
"total" : 4,
"up" : 2
}
}
}
معلمات الاستجابة
سيكون الرد JSON مع ثلاثة مفاتيح: dslb و lslb.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| حرج | رقم الهاتف | عدد المزارع في حالة حرجة. المزرعة حرجة عندما تكون في وضع التشغيل ولا يمكن الوصول إلى جميع الخلفيات (أسفل أو صيانة). |
| إلى أسفل | رقم الهاتف | عدد المزارع المتوقفة. يتم إيقاف المزارع من قبل مسؤول النظام. |
| مشكلة | رقم الهاتف | عدد المزارع في حالة المشكلة. تعتبر المزرعة مشكلة عندما تكون في وضع التشغيل وتكون الخلفية تقريبًا في حالة منخفضة. |
| مجموع | رقم الهاتف | عدد المزارع الكلية. |
| up | رقم الهاتف | عدد المزارع الجارية. هنا يتم عرض maintenanced وتحتاج إلى إعادة تشغيل حالة المزرعة. |
إظهار إحصائيات الوحدة
إظهار إحصائيات الوحدة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/modules/lslb
GET /stats/farms/modules/<module>
إظهار إحصائيات المزارع لوحدة نمطية محددة.
القيم المتاحة لل وحدة المعلمة هي: lslb or dslb.
مثال على الاستجابة:
{
"description" : "List lslb farms stats",
"farms" : [
{
"established" : 0,
"farmname" : "newfarm",
"pending" : 0,
"profile" : "http",
"status" : "up",
"vip" : "192.168.100.199",
"vport" : "40"
},
{
"established" : 0,
"farmname" : "nwl4farm",
"pending" : 0,
"profile" : "l4xnat",
"status" : "down",
"vip" : "192.168.100.241",
"vport" : "88"
},
{
"established" : 0,
"farmname" : "l4farm",
"pending" : 0,
"profile" : "l4xnat",
"status" : "up",
"vip" : "192.168.100.102",
"vport" : "70"
}
]
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع معلومات حول المزارع في الوحدة النمطية.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أنشئ | رقم الهاتف | مجموع عدد الاتصالات الحالية. |
| farmname | خيط | اسم مزرعة ، معرف فريد للمزارع. |
| ريثما | رقم الهاتف | عدد الاتصالات المعلقة. |
| البيانات الشخصية | خيط | نوع المزرعة. القيم المحتملة هي: وصلة البيانات, l4xnat, HTTP or HTTPS. يتم تعريف كل ملف تعريف في القسم نفسه. |
| الحالة | خيط | حالة المزرعة. قيم الحالة المتاحة هي: إلى أسفلالمزرعة لا تعمل. هناك حاجة لإعادة التشغيل، المزرعة متروك لكنها في انتظار إجراء إعادة التشغيل ؛ حرج، والمزرعة متروك وجميع الخلفيات غير قابلة للوصول أو الصيانة ؛ مشكلة، والمزرعة مترامية ، وهناك بعض الخلفية لا يمكن الوصول إليها ، ولكن تقترب من الخلفية صيانة، والمزرعة متروك وهناك الخلفية في حالة ، ولكن تقريبا الخلفية في وضع الصيانة. up، المزرعة متروك وجميع الخلفيات تعمل بنجاح. |
| كبار الشخصيات | خيط | IP للمزرعة ، حيث تستمع الخدمة الافتراضية. |
| vport | خيط | ميناء المزرعة ، حيث تستمع الخدمة الافتراضية. |
الرصد - الرسوم البيانية
هذا القسم هو مفيد لmonitorize النظام موازن التحميل الداخلي للكشف عن المشاكل من خلال المعلمات من استخدام وحدة المعالجة المركزية والذاكرة المبادلة ذاكرة رام، كل واجهات ارتباط بشبكة تكوين، وتحميل وتخزين على القرص الثابت.
أيضا ، سوف تكون قادرا على الوصول إلى التاريخ الأسبوعية ، mothly والسنوية.
يتم استيفاء الرسوم البيانية مع المعلومات بتنسيق base64.
قائمة الرسوم البيانية المتاحة
قائمة الرسوم البيانية المتاحة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs
GET /graphs
إظهار كائن بكل الرسومات البيانية المتوفرة في النظام. ويبين الطلب المحتمل الذي يمكن تقديمه.
مثال على الاستجابة:
{
"description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
"farms" : [
"l4farm",
"newfarm",
"nwl4farm",
"httpweb"
],
"interfaces" : [
"eth0.1",
"eth2",
"eth1",
"eth3",
"eth0"
],
"system" : [
"cpu",
"load",
"ram",
"swap",
{
"disk" : [
"root/",
"root/boot",
"root/usr/local/zenloadbalancer/config",
"root/var/log"
]
}
]
}
معلمات الاستجابة
سوف يكون الجواب JSON ثلاثة أنواع من الرسوم البيانية ، المزارع, واجهات و نظام.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| المزارع | خيط[] | قائمة الرسوم البيانية الزراعية المتاحة. |
| واجهات | خيط[] | قائمة الرسوم البيانية المتاحة |
| نظام | موضوع[] | قائمة الرسوم البيانية نظام availables النظام. يحتوي المصفوفة على كائن مع صفيف والذي يشير إلى نقاط تحميل القرص. |
كائن النظام:
يحتوي كائن النظام على قائمة مصفوفة مرتبطة بالنظام ، وكائن قرص بالتنسيق التالي.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| أسطوانة | خيط[] | قيم هذه المجموعة كلها موجودة نقاط جبل في النظام ، كل واحد لديه الرسوم البيانية المتاحة. |
عرض الرسوم البيانية
عرض الرسوم البيانية
طلب مثال للمزرعة:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb
طلب مثال للواجهة:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3
طلب مثال للقرص:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/system/disk/root/boot
GET /graphs/<graph>
القيم المتاحة لـ رسم بياني هي:
| القيمة | وصف المنتج |
|---|---|
farms/<farmname> |
farmnameوالمعرّف الفريد للمزرعة. |
interfaces/<interface> |
الواجهةواجهة معرف فريد. |
system/<system> |
نظاموالرسوم البيانية الممكنة للنظام هي: وحدة المعالجة المركزية, تحميل, ذاكرة الوصول العشوائي or مقايضة. |
system/disk/<mount point> |
نقطة جبل، هي قيمة أسطوانة تم إرجاعه بواسطة استدعاء "GET / الرسوم البيانية". |
مثال على الاستجابة:
{
"description" : "Get cpu graphs",
"graphs" : [
{
"frequency" : "daily",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "weekly",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "monthly",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "yearly",
"graph" : "PNG IN BASE 64"
}
]
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| تردد | خيط | الفترة الزمنية المستخدمة لإنشاء الرسم البياني. القيم المحتملة هي: يوميا, أسبوعي, شهريا or سنويا. |
| الرسوم البيانية | خيط | الرسم البياني بتنسيق 64 الأساسي. |
عرض الرسم البياني التردد
عرض الرسم البياني التردد
طلب مثال للمزرعة:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb/daily
طلب مثال للواجهة:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3/monthly
طلب مثال للقرص:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/system/disk/root/boot/yearly
GET /graphs/<graph>/<frequency>
القيم المتاحة لـ رسم بياني هي:
| القيمة | وصف المنتج |
|---|---|
farms/<farmname> |
farmnameوالمعرّف الفريد للمزرعة. |
interfaces/<interface> |
الواجهةواجهة معرف فريد. |
system/<system> |
نظاموالرسوم البيانية الممكنة للنظام هي: وحدة المعالجة المركزية, تحميل, ذاكرة الوصول العشوائي or مقايضة. |
system/disk/<mount point> |
نقطة جبل، هي قيمة أسطوانة تم إرجاعه بواسطة استدعاء "GET / الرسوم البيانية". |
القيم المتاحة لـ تردد هي:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| تردد | خيط | الفترة الزمنية المستخدمة لإنشاء الرسم البياني. القيم المحتملة هي: يوميا, أسبوعي, شهريا or سنويا. |
مثال على الاستجابة:
{
"description" : "Get farm graphs",
"graph" : "PNG IN BASE 64"
}
معلمات الاستجابة
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الرسوم البيانية | خيط | الرسم البياني بتنسيق 64 الأساسي. |
System
توفر لك خيارات النظام إمكانية تخصيص الخدمات التي يتم تشغيلها في الموازن والمعلمات العالمية.
عرض الإصدار
عرض الإصدار
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/version
GET /system/version
إظهار informacion حول إصدار المنتج.
مثال على الاستجابة:
{
"description" : "Get version",
"params" : {
"appliance_version" : "ZVA 4100, hypervisor: xen",
"hostname" : "DEV5",
"kernel_version" : "3.16.7-ckt20",
"system_date" : "Thu Feb 2 10:34:27 2017",
"zevenet_version" : "5.0"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع المعلمات أدناه.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| appliance_version | خيط | نسخة الطلب. اعرض أيضًا hypervisor إذا كان جهاز ظاهري. |
| اسم المضيف | خيط | اسم المضيف. |
| إصدار النواة | خيط | إصدار Linux kernel. |
| تاريخ النظام | خيط | تاريخ النظام. |
| zevenet_version | خيط | نسخة Zevenet. |
عرض DNS
عرض DNS
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/dns
GET /system/dns
إظهار تكوين خدمة DNS.
مثال على الاستجابة:
{
"description" : "Get dns",
"params" : {
"primary" : "8.8.8.8",
"secondary" : null
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع المعلمات أدناه.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ابتدائي | خيط | DNS الأساسي تكوينها في النظام. |
| ثانوي | خيط | DNS الثانوية تكوينها في النظام. |
تعديل DNS
تعديل DNS
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/dns
POST /system/dns
قم بتعديل تكوين خدمة DNS.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| ابتدائي | خيط | DNS الأساسي تكوينها في النظام. |
| ثانوي | خيط | DNS الثانوية تكوينها في النظام. |
مثال على الاستجابة:
{
"description" : "Post dns",
"params" : {
"primary" : "8.8.4.4",
"secondary" : "8.8.8.8"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
إظهار SNMP
إظهار SNMP
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/snmp
GET /system/snmp
إظهار تكوين خدمة SNMP.
مثال على الاستجابة:
{
"description" : "Get snmp",
"params" : {
"community" : "public",
"ip" : "*",
"port" : "161",
"scope" : "0.0.0.0/0",
"status" : "false"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع المعلمات أدناه.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| مجتمع | خيط | اسم المجتمع. قراءة المجتمع فقط المستخدمة. |
| ip | خيط | واجهة IP حيث تعمل خدمة SNMP. يمكنك الحفاظ على أمان جميع الواجهات باستخدام حرف *. |
| ميناء | خيط | المنفذ حيث يتم تشغيل خدمة SNMP. |
| نطاق | خيط | IP أو الشبكة الفرعية مع الوصول (IP / بت). تسمح عناوين IP للعميل المسموح بها بخدمة SNMPD ، في حالة ما إذا كنت تريد السماح بالدخول إلى عنوان IP واحد فقط ، فيرجى استخدام بت "/ 32". |
| الحالة | خيط | حالة خدمة SNMP. القيم المحتملة هي: صحيح، الخدمة قيد التشغيل؛ أو زائف، يتم إيقاف الخدمة. |
تعديل SNMP
تعديل SNMP
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/snmp
POST /system/snmp
قم بتعديل تكوين خدمة SNMP.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| مجتمع | خيط | اسم المجتمع. قراءة المجتمع فقط المستخدمة. |
| ip | خيط | واجهة IP حيث تعمل خدمة SNMP. يمكنك الحفاظ على أمان جميع الواجهات باستخدام حرف *. |
| ميناء | خيط | المنفذ حيث يتم تشغيل خدمة SNMP. |
| نطاق | خيط | IP أو الشبكة الفرعية مع الوصول (IP / بت). تسمح عناوين IP للعميل المسموح بها بخدمة SNMPD ، في حالة ما إذا كنت تريد السماح بالدخول إلى عنوان IP واحد فقط ، فيرجى استخدام بت "/ 32". |
| الحالة | خيط | حالة خدمة SNMP. القيم المحتملة هي: صحيح، الخدمة قيد التشغيل؛ أو زائف، يتم إيقاف الخدمة. |
مثال على الاستجابة:
{
"description" : "Post snmp",
"params" : {
"community" : "public",
"ip" : "192.168.100.241",
"port" : "170",
"scope" : "0.0.0.0/0",
"status" : "true"
}
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
استرجاع الرخصة
استرجاع الرخصة
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/license/txt
GET /system/license/<format>
إظهار ترخيص Zevenet في تنسيق. المتاح شكل القيم هي أتش تي أم أل or TXT.
عرض NTP
عرض NTP
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/ntp
GET /system/ntp
إظهار تكوين خدمة NTP.
مثال على الاستجابة:
{
"description" : "Get ntp",
"params" : {
"server" : "pool.ntp.org"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع المعلمات أدناه.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الخادم | خيط | الخادم حيث يقوم عميل NTP بالطلبات. |
تعديل NTP
تعديل NTP
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"server":"pool.ntp.org"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/ntp
POST /system/ntp
قم بتعديل تهيئة خدمة NTP.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الخادم | خيط | الخادم حيث يقوم عميل NTP بالطلبات. |
مثال على الاستجابة:
{
"description" : "Post ntp",
"params" : "pool.ntp.org"
}
معلمات الاستجابة
سيكون الرد json مع تحديث كل القيم المطلوبة. انظر مثال الاستجابة لمزيد من المعلومات.
تحميل الدعم
تحميل الدعم
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/supportsave > supportsave.tar.gz
GET /system/supportsave
احصل على صورة حالة النظام مع جميع التكوينات وعملية التشغيل في النظام. هذا supportave من الضروري العثور على القضايا أو المساعدة في الدعم.
استرداد المستخدم الحالي
استرداد المستخدم الحالي
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/users
GET /system/users
إظهار معلومات حول المستخدم الحالي. المستخدم الحالي هو الحصول على المستخدم من ZAPI_KEY أو المستخدم بتسجيل الدخول بواسطة webgui
مثال على الاستجابة:
{
"description" : "Retrieve the user root",
"params" : {
"user" : "root",
"zapi_permissions" : "true"
}
}
معلمات الاستجابة
ستكون الاستجابة كائن JSON مع صفيف من المعلمات أدناه.
| الحقل | النوع | وصف المنتج |
|---|---|---|
| المستخدم | خيط | هو مالك المستخدم ZAPI_KEY. يمكن أن يكون المستخدم الافتراضي الجذر. |
| zapi_permissions | خيط | إذا كانت القيمة صحيح، يمكن للمستخدم استخدام Zevenet api باستخدام zapikey الخاص بالمستخدم ؛ أو إذا كانت القيمة زائف، قام المستخدم بتعطيل لاستخدام zapi. |
تعديل المستخدم الحالي
تعديل المستخدم الحالي
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"password":"CDe0c3ck","newpassword":"v2mfcvv2","zapi_permissions":"false","zapikey":"vCeH60mQFf2MgH5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/users
POST /system/users
تعديل تكوين المستخدم الحالي. المستخدم الحالي هو الحصول على المستخدم من ZAPI_KEY أو المستخدم بتسجيل الدخول بواسطة webgui.
معلمات الطلب:
| الحقل | النوع | وصف المنتج | مطلوب: |
|---|---|---|---|
| zapikey | خيط | يمكن لكل مستخدم الحصول على zapikey. باستخدام هذا zapikey ، يمكن للمستخدم القيام بعمل من خلال zapikey بأذونات دور المستخدم. | |
| zapi_permissions | خيط | القيم المحتملة هي: صحيحلتمكين الوصول إلى موازن التحميل عبر zapi؛ أو زائف، لعدم السماح بالوصول من خلال zapi. | |
| كلمة السر الجديدة | خيط | كلمة مرور مستخدم جديدة للوصول من خلال واجهة المستخدم الرسومية على شبكة الإنترنت. | |
| كلمه السر | خيط | كلمة مرور المستخدم الحالية. | مطلوب عند كلمة السر الجديدة أرسل. |
مثال على الاستجابة:
{
"description" : "Modify the user Shadi",
"message" : "Settings was changed successful."
}
قائمة ملفات السجل
قائمة ملفات السجل
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs
GET /system/logs
قائمة ملفات السجل المتاحة.
مثال على الاستجابة:
{
"description" : "Get logs",
"params" : [
{
"date" : "Mon Jan 30 06:25:02 2017",
"file" : "syslog.4.gz"
},
{
"date" : "Tue Jan 31 06:25:03 2017",
"file" : "syslog.3.gz"
},
{
"date" : "Wed Feb 1 06:25:04 2017",
"file" : "syslog.2.gz"
},
{
"date" : "Thu Feb 2 06:25:03 2017",
"file" : "syslog.1"
},
{
"date" : "Sun Jan 29 06:25:03 2017",
"file" : "syslog.5.gz"
},
{
"date" : "Fri Feb 3 04:28:56 2017",
"file" : "syslog"
}
]
}
معلمات الاستجابة
ستكون الاستجابة JSON مع صفيف من ملف السجل. معلمات كل كائن هي:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| تاريخ | خيط | تاريخ آخر تعديل للملف. |
| ملف | خيط | اسم ملف ملفات السجل. يتم استخدامه كمعرف فريد للسجل. |
إظهار خطوط ملفات السجل
إظهار خطوط ملفات السجل
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs/kern.log/lines/2
GET /system/logs/<file>/lines/<lines>
سرد عدد من أسطر ملف السجل. URI param ملف هو ملف السجل من القراءة. خطوط هو عدد الخطوط المراد إظهارها من النهائي.
مثال على الاستجابة:
{
"description" : "Show a log file",
"log" : [
"Aug 28 09:44:00 maq2 kernel: [258451.740173] Netfilter messages via NETLINK v0.30.\n",
"Aug 28 09:44:00 maq2 kernel: [258451.775666] ctnetlink v0.93: registering with nfnetlink.\n"
]
}
معلمات الاستجابة
ستكون الاستجابة JSON مع صفيف من ملف السجل. المفتاح هو السجل وقيمته هي مصفوفة مع عدد الخطوط المطلوبة.
قم بتنزيل ملف سجل
قم بتنزيل ملفات السجل
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
قم بتنزيل ملف سجل ملفات السجلات المتاحة المدرجة أثناء طلب GET.
ملف هو معرف فريد لملف السجل.
النظام - النسخ الاحتياطية
مع خيار النسخ الاحتياطي يمكنك حفظ تكوين النظام الحالي وتنزيله.
في هذا القسم ، ستتمكن من إنشاء ملفات النسخ الاحتياطي واستعادتها وتحميلها وتنزيلها.
قائمة النسخ الاحتياطية
قائمة النسخ الاحتياطية
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup
GET /system/backup
مثال على الاستجابة:
{
"description" : "Get backups",
"params" : [
{
"date" : "Fri Feb 3 06:01:04 2017",
"name" : "newbackup"
},
{
"date" : "Fri Feb 3 05:50:48 2017",
"name" : "firstConf"
}
]
}
معلمات الاستجابة
ستكون الاستجابة JSON مع مجموعة من النسخ الاحتياطية. المعلمات لكل عنصر الصفيف هي:
| الحقل | النوع | وصف المنتج |
|---|---|---|
| تاريخ | خيط | تاريخ آخر تعديل. |
| الاسم | خيط | هو اسم الملف المستخدم كمعرّف فريد. امتداد الملف هو .tar.gz. |
إنشاء نسخة احتياطية
إنشاء نسخة احتياطية
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"firstConf"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup
POST /system/backup
قم بإنشاء نسخة احتياطية لتكوين النظام للتهيئة الحالية.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| الاسم | خيط | هو اسم الملف المستخدم كمعرّف فريد. امتداد الملف هو .tar.gz. |
مثال على الاستجابة:
{
"description" : "Create a backups",
"message" : "Backup firstConf was created successful.",
"params" : "firstConf"
}
قم بتنزيل نسخة احتياطية
قم بتنزيل نسخة احتياطية
طلب مثال:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz
ملف النسخ الاحتياطي بتنسيق TAR GZ.
GET /system/backup/<name>
قم بتنزيل نسخة احتياطية لتكوين النظام. الاسم هو المعرف الفريد للنسخ الاحتياطي.
تحميل نسخة احتياطية
تحميل نسخة احتياطية
طلب مثال:
curl -k -X PUT -H 'Content-Type: text/plain'
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/newbackup
PUT /system/backup/<name>
تحميل نسخة احتياطية محلية مخزنة إلى Zevenet. الاسم هو المعرف الفريد للنسخ الاحتياطي الذي سيتم تخزينه في Zevenet.
طلب المعلمات
من الضروري استخدام –data-binary لتحميل نسخة احتياطية.
مثال على الاستجابة:
{
"description" : "Upload a backup",
"message" : "Backup newbackup was created successful.",
"params" : "newbackup"
}
حذف نسخة احتياطية
حذف نسخة احتياطية
طلب مثال:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf
DELETE /system/backup/<name>
حذف ملف نسخة احتياطية من نظام Zevenet. الاسم هو المعرف الفريد للنسخ الاحتياطي.
مثال على الاستجابة:
{
"description" : "Delete backup firstConf'",
"message" : "The list firstConf has been deleted successful.",
"success" : "true"
}
تطبيق نسخة احتياطية
تطبيق نسخة احتياطية
طلب مثال:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"apply"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf/actions
POST /system/backup/<name>/actions
استعادة التكوين من ملف النسخ الاحتياطي. الاسم هو المعرف الفريد للنسخ الاحتياطي.
طلب المعلمات
| الحقل | النوع | وصف المنتج |
|---|---|---|
| عمل | خيط | لاستعادة تكوين النسخ الاحتياطي ، يجب أن تكون القيمة تطبيق. |
مثال على الاستجابة:
{
"description" : "Apply a backup to the system",
"params" : {
"action" : "apply"
}
}