Referensi Zevenet API v3
ZAPI (Zevenet Application Programming Interface) adalah alat bagi administrator sistem untuk mengendalikan penyeimbang beban Zevenet.
Sangat penting untuk mengaktifkan pengguna zapi dari antarmuka web sebelum menggunakannya, Sistem / Pengguna.
Setelah pengguna zapi dibuat, ada kemungkinan mengirim permintaan ke URL, https: //zevenet_server: 444 / zapi / v3 / zapi.cgi /URI_path.
zevenet_server
adalah IP tempat layanan HTTP mendengarkan.
URI_path
mendefinisikan objek atau tindakan untuk bertindak. Perilaku dan parameternya akan ditentukan dalam setiap bagian dokumentasi.
Kata kerja yang digunakan dalam API ini adalah DAPATKAN, POST, PUT or DELETE. Permintaan PUT atau POST selalu membutuhkan hampir satu parameter meskipun ini tidak memerlukan parameter yang diperlukan.
sertifikat
Zevenet mendukung sertifikat dalam format PEM untuk menggunakannya dengan HTTP farms Anda dengan pendengar HTTPS. Jika Anda ingin mempelajari lebih lanjut tentang cara membuat sertifikat pem, silakan kunjungi artikel berikut: Hasilkan SERTIFIKAT DALAM FORMAT PEM
Daftar semua Sertifikat
Daftar semua Sertifikat
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates
GET /certificates
Sebutkan semua sertifikat CSR dan PEM di toko sertifikat, sertifikat itu dapat digunakan dengan kebun HTTPS.
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek sertifikat, yang masing-masing berisi atribut kunci di bawah ini.
Contoh respons:
{
"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"
}
]
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
Bidang | Tipe | Deskripsi |
---|---|---|
CN | Tali | Nama umum domain. |
penciptaan | Tali | Tanggal pembuatan. |
kedaluwarsa | Tali | Tanggal kadaluarsa. |
fillet | Tali | Nama file sertifikat, ID unik. |
penerbit | Tali | Otoritas Bersertifikat menandatangani sertifikat. |
mengetik | Tali | CSR atau Sertifikat. |
Unduh Sertifikat
Unduh Sertifikat
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/example.pem
GET /certificates/<file>
Unduh sertifikat yang dipasang di toko sertifikat, gunakan nama file dalam permintaan untuk mengidentifikasinya.
Respons akan mencakup tajuk yang ditunjukkan di bawah ini dengan informasi tentang file. Tubuh respons akan menjadi konten file.
Header respons:
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
Tampilkan detail Sertifikat
Tampilkan detail Sertifikat
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/example.pem/info
GET /certificates/<file>/info
Tampilkan semua informasi yang termasuk dalam sertifikat yang diberikan di toko sertifikat, termasuk tanda tangan, diperlukan nama file untuk membuat referensi.
Contoh respons:
Certificate:
Data:
Version: 3 (0x2)
Serial Number: 14346016480403539444 (0xc71749fb005a45f4)
Signature Algorithm: sha1WithRSAEncryption
Issuer: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
Validity
Not Before: Jan 12 14:49:03 2011 GMT
Not After : Jan 9 14:49:03 2021 GMT
Subject: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
Subject Public Key Info:
Public Key Algorithm: rsaEncryption
Public-Key: (1024 bit)
Modulus:
...
Tampilkan detail Sertifikat aktivasi
Tampilkan detail Sertifikat aktivasi
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/activation
GET /certificates/activation
Tampilkan semua informasi yang termasuk dalam sertifikat aktivasi, termasuk tanda tangan, sertifikat ini disimpan di toko sertifikat. Jika sertifikat aktivasi dihapus maka produk akan dinonaktifkan.
Hapus Sertifikat
Hapus Sertifikat
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/example.pem
DELETE /certificates/<file>
Hapus sertifikat dengan nama file di toko sertifikat.
Contoh respons:
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
Hapus Sertifikat aktivasi
Hapus Sertifikat aktivasi
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/activation
DELETE /certificates/activation
Hapus sertifikat aktivasi yang dipasang di toko sertifikat. Jika sertifikat ini dihapus maka Load Balancer dinonaktifkan.
Contoh respons:
{
"description" : "Delete activation certificate",
"message" : "The activation certificate has been deleted",
"success" : "true"
}
Buat sertifikat CSR
Buat sertifikat CSR
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates
POST /certificates
Buat Permintaan Penandatanganan Sertifikat (file CSR).
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama | Tali | Nama ID sertifikat. | benar |
fqdn | Tali | Nama domain yang sepenuhnya memenuhi syarat dari server Anda. | benar |
divisi | Tali | Divisi organisasi Anda yang menangani sertifikat. | benar |
organisasi | Tali | Nama resmi organisasi Anda. | benar |
lokalitas | Tali | Kota tempat organisasi Anda berada. | benar |
negara | Tali | Negara bagian / wilayah tempat organisasi Anda berada. | benar |
negara | Tali | Kode ISO dua huruf untuk negara tempat organisasi Anda berada. | benar |
surat | Tali | Alamat email yang digunakan untuk menghubungi organisasi Anda. | benar |
Contoh respons:
{
"description" : "Create CSR",
"message" : "Certificate NewCSR created",
"success" : "true"
}
Unggah Sertifikat
Unggah Sertifikat
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/example.pem
POST /certificates/<file>
Unggah sertifikat PEM untuk pertanian HTTP dengan pendengar HTTPS.
Membutuhkan parameter --tcp-nodelay
, dan --data-binary
untuk mengunggah file dalam mode biner.
Minta parameter URI
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
fillet | Tali | Nama file sertifikat untuk diunggah dan disimpan di toko sertifikat. | benar |
Contoh respons:
{
"description" : "Upload PEM certificate",
"message" : "Certificate uploaded",
"success" : "true"
}
Unggah Sertifikat aktivasi
Unggah Sertifikat aktivasi
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/path/to/example.pem
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/activation
POST /certificates/activation
Unggah sertifikat aktivasi dengan format PEM, sertifikat ini diperlukan untuk mengaktifkan semua fungsi. Sertifikat ini disimpan di toko sertifikat, jika sertifikat aktivasi ada di toko sertifikat maka sertifikat sebelumnya ditimpa.
Contoh respons:
{
"description" : "Upload activation certificate",
"message" : "Activation certificate uploaded",
"success" : "true"
}
Pertanian
Zevenet dapat mengatur lalu lintas dengan tiga cara yang berbeda, masing-masing cara dikelola oleh modul yang berbeda, penyeimbang beban layanan lokal atau modul LSLB, modul Global Service Load Balancer atau GSLB dan modul Datalink Service Load Balancer atau modul DSLB.
Semua modul bekerja dengan konsep Profil tambak, profil tambak adalah sekelompok parameter yang siap untuk melakukan tindakan khusus dengan lalu lintas jaringan, penting untuk memahami apa yang dapat dilakukan setiap profil tambak untuk mendapatkan hasil terbaik dari Zevenet ADC.
- LSLB: Modul ini dapat bekerja dengan http dan l4xnat peternakan profil. Ini berfungsi sebagai proxy atau router membalikkan web
- GSLB: Modul ini dapat bekerja dengan gslb pertanian profil. Ini berfungsi sebagai Domain Name Server
- DSLB: Modul ini dapat bekerja dengan datalink pertanian profil. Ini berfungsi sebagai gateway.
Daftar semua peternakan
Daftar semua peternakan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms
GET /farms
Daftar semua peternakan yang tersedia
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek resume pertanian, yang masing-masing berisi atribut kunci di bawah ini.
Obyek Pertanian
Bidang | Tipe | Deskripsi |
---|---|---|
nama pertanian | Tali | Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik. |
profil | Tali | Jenis profil, nilai-nilai profil yang tersedia adalah: http, https or l4xnat untuk modul LSLB, gslb untuk modul GLSB dan datalink untuk modul DSLB |
status | Tali | Status tambak, nilai status yang tersedia adalah: up, pertanian sedang berjalan atau turun, pertanian dihentikan |
vip | Tali | IP virtual tempat peternakan menerima lalu lintas |
olahraga | Tali | Port Virtual tempat tambak menerima lalu lintas, nilai port yang tersedia adalah: nomor port untuk profil http [s], l4xnat dan gslb, sekelompok port yang dipisahkan oleh "," atau rentang port yang dipisahkan oleh ":" untuk profil l4xnat, di l4xnat kedua nilai pemisah ("," dan ":") dapat digunakan di bidang yang sama. |
Contoh respons:
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
Hapus sebuah Peternakan
Hapus sebuah Peternakan
Contoh permintaan:
curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP
DELETE /farms/<farmname>
Hapus sebuah peternakan melalui pengidentifikasi nama peternakannya.
Contoh respons:
{
"description" : "Delete farm FarmHTTP",
"message" : "The Farm FarmHTTP has been deleted.",
"success" : "true"
}
Tetapkan tindakan di Peternakan
Tetapkan tindakan di Peternakan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/FarmTCP/actions
PUT /farms/<farmname>/actions
Terapkan tindakan ke tambak, lihat tabel Parameter permintaan untuk tindakan.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Atur aksi yang diinginkan. Tindakannya adalah: berhenti, pertanian akan dihentikan. awal, pertanian akan dimulai dan Restart, tambak akan dihentikan dan mulai secara otomatis. |
Contoh respons:
{
"description" : "Set a new action in FarmHTTP",
"params" : [
{
"action" : "stop"
}
]
}
Parameter respons
Jika tidak ada masalah dalam konfigurasi maka zapi akan mengembalikan tindakan yang diminta.
Pertanian HTTP
Profil HTTP adalah penyeimbangan beban lapisan 7 tingkat lanjut (atau Pengendali Pengiriman Aplikasi) dengan properti khusus proxy. Profil ini menawarkan beberapa fitur seperti HTTPS layer 7 load balancing yang dikombinasikan dengan akselerasi offload SSL. Profil ini disarankan untuk layanan web (termasuk server aplikasi web) dan semua protokol aplikasi berdasarkan protokol HTTP dan HTTPS seperti WebDav, RDP melalui HTTP, ICA melalui HTTP, dll. Untuk mengonfigurasi profil tambak ini, alamat IP virtual, dan port TCP virtual akan diperlukan.
Ambil pertanian dengan nama
Ambil pertanian dengan nama
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Contoh respons:
{
"description" : "List farm httpFarm",
"ipds" : {
"blacklists" : [
"rem"
],
"dos" : []
},
"params" : {
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"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" : "down",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "tcp_check",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan format di bawah ini.
Objek Pertanian:
Bidang | Tipe | Deskripsi |
---|---|---|
ipds | obyek | Daftar aturan IPDS yang diterapkan pada tambak ini. |
params | obyek | Parameter konfigurasi tambak. |
layanan | Obyek[] | Array dengan semua layanan yang dibuat di tambak ini dan konfigurasinya. |
Objek IPDS:
Bidang | Tipe | Deskripsi |
---|---|---|
daftar hitam | Tali[] | Aturan daftar hitam diterapkan ke tambak. |
dos | Tali[] | Aturan DoS diterapkan ke tambak. |
Objek parameter untuk HTTP farms:
Bidang | Tipe | Deskripsi |
---|---|---|
daftar sertifikat | Obyek[] | Hanya di profil https. Daftar sertifikat diaktifkan di tambak, dalam format pem, diizinkan untuk menambahkan lebih dari satu sertifikat pem ke tambak yang sama untuk dukungan SNI. diperlukan pendengar dengan nilai https. Sertifikat apa pun di toko sertifikat dapat digunakan di sini. |
sandi | Tali | Hanya di pendengar https. Ini adalah daftar sandi yang diizinkan yang disesuaikan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti dalam sandi OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai keamanan sutom. |
cipher | Tali | Hanya di pendengar dengan nilai https. Digunakan untuk membuat daftar sandi yang diterima oleh koneksi SSL untuk mengeraskan koneksi SSL. Opsinya adalah: semua, semua kode sandi akan diterima, keamanan tinggi, hanya sandi untuk keamanan tinggi yang akan diterima, atau keamanan bea cukai, hanya cipher yang dimuat sandi bidang akan diterima. |
contimeout | Jumlah | Berapa lama peternakan akan menunggu koneksi TCP ke backend dalam hitungan detik. |
error414 | Tali | Pesan yang dipersonalisasi untuk merespons dengan kode kesalahan HTTP 414. |
error500 | Tali | Pesan yang dipersonalisasi untuk merespons dengan kode kesalahan HTTP 500. |
error501 | Tali | Pesan yang dipersonalisasi untuk merespons dengan kode kesalahan HTTP 501. |
error503 | Tali | Pesan yang dipersonalisasi untuk merespons dengan kode kesalahan HTTP 503. |
httpverb | Tali | Bidang ini menunjukkan operasi yang akan diizinkan untuk permintaan klien HTTP. nilai yang tersedia adalah: standardHTTP, permintaan http yang tidak diterima GET, POST, HEAD. extendedHTTP, menerima permintaan http sebelumnya ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, LAPORAN, MSextWebDAV menerima permintaan http sebelumnya plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahwa nilai-nilai tersebut peka terhadap huruf besar-kecil. |
pendengar | Tali | Seorang pendengar mendefinisikan bagaimana tambak akan bermain dengan permintaan dari klien. Opsinya adalah: http untuk protokol yang tidak diamankan atau https untuk protokol aman. |
reqtimeout | Jumlah | Berapa lama kebun akan menunggu permintaan klien dalam hitungan detik. |
istirahat | Jumlah | Berapa lama peternakan akan menunggu jawaban dari backend dalam hitungan detik. |
kebangkitan kembali | Jumlah | Periode untuk keluar dari server nyata yang jatuh, setelah periode ini penyeimbang beban memeriksa apakah server sebenarnya masih hidup, dalam hitungan detik. |
penempatan ulang | Tali | Jika diaktifkan, tambak dipaksa untuk mengubah Lokasi: dan konten-lokasi: header dalam menanggapi klien dengan host virtual. Opsinya adalah: diaktifkan, diaktifkan cacat, tidak aktif atau diaktifkan-backend hanya alamat backend yang dibandingkan. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up, pertanian sedang berjalan; turun, peternakan dihentikan atau diperlukan restart, tambak perlu dimulai kembali agar perubahan terbaru berlaku. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Jumlah | Port of the farm, tempat layanan virtual mendengarkan. |
Objek Sertifikat:
Bidang | Tipe | Deskripsi |
---|---|---|
fillet | Tali | Nama sertifikat, referensi ke sertifikat di toko sertifikat. |
id | Jumlah | ID Sertifikat, Urutan dalam daftar, yang pertama akan digunakan secara default jika header host virtual tidak cocok dengan bidang CN di sertifikat. Digunakan untuk SNI. |
Objek layanan untuk HTTP farms:
Bidang | Tipe | Deskripsi |
---|---|---|
backends | Obyek[] | Backends didefinisikan dalam layanan. |
cookiedomain | Tali | Penyisipan cookie akan dieksekusi jika domain cocok dengan konten cookie. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookie dimasukkan | Tali | Ini memungkinkan penyisipan cookie untuk sesi tempel backend. Opsinya adalah benar, profil akan mencari cookie yang diberikan di bidang nama masak, jika tidak ada maka cookie ini akan ditambahkan, palsu, bukan tindakan yang diambil. |
nama masak | Tali | Nama cookie (ID sesi) akan digunakan untuk mengidentifikasi proses tempel ke backend. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookiepath | Tali | Itu mengelola nilai jalur cookie untuk cookie yang diberikan. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookiettl | Jumlah | Ini adalah waktu maksimum untuk cookie, dalam hitungan detik. Memungkinkan cookie dimasukkan bidang wajib diisi. |
difabel | Tali | Aktifkan penggunaan wali pertanian. benar wali pertanian diaktifkan dan memeriksa status backends, palsu penjaga pertanian dinonaktifkan dan tidak memeriksa status backends. Dalam profil HTTP, check_tcp dijalankan secara default meskipun wali pertanian dinonaktifkan. |
fglog | Tali | Aktifkan penggunaan log di wali pertanian. benar diaktifkan, palsu, dinonaktifkan. difabel Dibutuhkan. |
fgscript | Tali | Perintah yang akan digunakan penjaga pertanian untuk memeriksa kesehatan backend. benar diaktifkan, palsu, dinonaktifkan. difabel Dibutuhkan. |
fgtimecheck | Jumlah | penjaga pertanian akan memeriksa setiap detik 'pemeriksaan jadwal' status kesehatan backend. difabel Dibutuhkan. |
httpsb | Tali | Parameter ini menunjukkan kepada tambak bahwa server backend yang ditentukan dalam layanan saat ini menggunakan bahasa HTTPS dan kemudian data akan dienkripsi sebelum dikirim. benar, profil mengirimkan lalu lintas dalam protokol HTTPS ke backends, palsu, profil mengirimkan lalu lintas dalam protokol HTTP ke backends. |
id | Tali | Nama layanan, tidak dapat diubah setelah layanan dibuat. |
setidaknya respons | Tali | Ini memungkinkan metode balancing yang paling tidak berespon. benar seringnya profil memeriksa backend mana yang mengambil lebih sedikit waktu untuk merespons untuk mengirim lebih banyak koneksi ke yang ini, palsu profile tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons. |
ketekunan | Tali | Parameter ini menentukan bagaimana layanan HTTP akan mengelola sesi klien. Opsinya adalah: "" string kosong, tidak ada tindakan yang diambil, IP sesi ketekunan dilakukan di dasar IP klien, DASAR sesi ketekunan dilakukan di dasar header BASIC, URL sesi ketekunan dilakukan di dasar bidang di URI, PARM sesi ketekunan dilakukan berdasarkan nilai pada akhir URI, COOKIE sesi ketekunan dilakukan berdasarkan nama cookie, cookie ini harus dibuat oleh backend, dan HEADER, sesi ketekunan dilakukan berdasarkan nama Header. |
redirect | Tali | Berperilaku sebagai backend khusus, karena permintaan klien dijawab dengan mengarahkan ulang ke URL baru secara otomatis. Jika redirect dikonfigurasi maka permintaan tidak akan diteruskan ke backend, sebaliknya Redirect akan ditanggapi ke klien. |
redirecttype | Tali | Bagaimana pengalihan akan dilakukan, dua opsi: kegagalan, url diambil sebagai host mutlak dan jalur untuk mengarahkan ulang ke, menambahkan, jalur permintaan awal atau URI akan ditambahkan ke host dan jalur yang Anda tentukan dengan opsi default. Jika redirect bidang tidak dikonfigurasikan, bidang ini akan menjadi string kosong. |
sessionid | Tali | Ini tersedia jika ketekunan bidang adalah URL, COOKIE atau HEADER, nilai parameter akan dicari oleh tambak di header http dan akan mengelola sesi klien. |
Ttl | Jumlah | Hanya dengan kegigihan. Nilai ini menunjukkan waktu hidup maksimum untuk sesi klien tidak aktif (usia sesi maks) dalam detik. |
urlp | Tali | Memungkinkan untuk menentukan layanan web mengenai URL yang diminta klien melalui pola URL tertentu yang akan diperiksa secara sintaksis. Ekspresi reguler PCRE didukung. |
vhost | Tali | Ini menentukan kondisi yang ditentukan oleh nama domain melalui IP virtual dan port yang sama yang ditentukan oleh HTTP farm. Ekspresi reguler PCRE didukung. |
Objek backend untuk pertanian HTTP:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi backend di dalam layanan yang diberikan. |
ip | Tali | IP backend tempat layanan sebenarnya berjalan. |
pelabuhan | Jumlah | Port backend tempat layanan sebenarnya berjalan. |
status | Tali | Status backend. Nilainya bisa: up backend siap menerima koneksi, pemeliharaan backend ditandai sebagai tidak siap untuk menerima koneksi, opsi ini berguna untuk tugas pemeliharaan backend. |
batas waktu | Jumlah | Ini batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik. Jika sistem nol akan menggunakan batas waktu parameter global Backends. |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini, backend dengan nilai bobot lebih tinggi akan menerima lebih banyak koneksi. Nilai default null, bukan bobot khusus yang digunakan untuk backend ini. |
Buat Pertanian baru
Buat Pertanian baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"newHTTPfarm", "profile":"http", "vip":"192.168.100.23",
"vport":80}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms
POST /farms
Buat ladang HTTP baru.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama pertanian | Tali | Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik. | benar |
profil | Tali | Profil Peternakan yang dibuat. Untuk peternakan http adalah http. | benar |
vip | Tali | IP pertanian, tempat layanan virtual akan dijalankan. IP yang ditunjukkan harus dikonfigurasikan dalam sistem dan UP | benar |
olahraga | Jumlah | Port of the farm, tempat layanan virtual akan mendengarkan. Port virtual dan IP virtual yang sama tidak boleh digunakan oleh farm lain. | benar |
Contoh respons:
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"interface" : "eth0.2",
"farmname" : "newHTTPfarm",
"profile" : "http",
"vip" : "192.168.100.23",
"vport" : 80
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Pertanian
Ubah Pertanian
Contoh permintaan:
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",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP
PUT /farms/<farmname>
Ubah parameter global untuk tambak HTTP yang diberikan.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
contimeout | Jumlah | Berapa lama peternakan akan menunggu koneksi ke backend dalam hitungan detik. |
istirahat | Jumlah | Berapa lama peternakan akan menunggu jawaban dari backend dalam hitungan detik. |
kebangkitan kembali | Jumlah | Nilai ini dalam hitungan detik adalah periode untuk mengeluarkan backend yang masuk daftar hitam dan memeriksa apakah masih hidup. |
reqtimeout | Jumlah | Berapa lama kebun akan menunggu permintaan klien dalam hitungan detik. |
penempatan ulang | Tali | Jika diaktifkan, tambak dipaksa untuk mengubah Lokasi: dan konten-lokasi: header dalam menanggapi klien dengan host virtual. Opsinya adalah: diaktifkan, diaktifkan cacat, tidak aktif atau diaktifkan-backend hanya alamat backend yang dibandingkan. |
httpverb | Tali | Bidang ini menunjukkan operasi yang akan diizinkan untuk permintaan klien HTTP. nilai yang tersedia adalah: standardHTTP, permintaan http yang tidak diterima GET, POST, HEAD. extendedHTTP, menerima permintaan http sebelumnya ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, LAPORAN, MSextWebDAV menerima permintaan http sebelumnya plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahwa nilai-nilai tersebut peka terhadap huruf besar-kecil. |
error414 | Tali | Kesalahan pesan yang dipersonalisasi 414. |
error500 | Tali | Kesalahan pesan yang dipersonalisasi 500. |
error501 | Tali | Kesalahan pesan yang dipersonalisasi 501. |
error503 | Tali | Kesalahan pesan yang dipersonalisasi 503. |
pendengar | Tali | Seorang pendengar mendefinisikan bagaimana tambak akan bermain dengan permintaan dari klien. Opsinya adalah: http untuk protokol yang tidak diamankan atau https untuk protokol aman. |
cipher | Tali | Hanya di pendengar https. Bidang ini digunakan untuk membuat daftar sandi yang diterima oleh koneksi SSL untuk mengeraskan koneksi SSL. Opsinya adalah: semua, semua kode sandi akan diterima, keamanan tinggi, hanya sandi untuk keamanan tinggi yang akan diterima, atau keamanan bea cukai, hanya cipher yang dimuat sandi bidang akan diterima. |
sandi | Tali | Hanya di pendengar https. Ini adalah daftar sandi yang diizinkan yang disesuaikan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti dalam sandi OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai keamanan sutom. |
newfarmname | Tali | Nama Peternakan baru. Pertanian harus dihentikan. |
olahraga | Jumlah | Port of the farm, tempat layanan virtual mendengarkan. |
vip | Tali | IP dari farm, di mana layanan virtual mendengarkan, IP ini harus dikonfigurasi dan di sistem. |
Contoh respons:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
"ciphers" : "customsecurity",
"contimeout" : 22,
"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
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan Sertifikat
Tambahkan Sertifikat
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"file":"example.pem"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm/certificates
POST /farms/<farmname>/certificates
Sertakan Sertifikat PEM yang tersedia ke daftar SNI atau certlist
array dari HTTP farm dengan pendengar HTTPS. Sertifikat yang digunakan harus sudah diunggah dalam sistem, lihat Sertifikat> Daftar semua Sertifikat untuk daftar sertifikat yang tersedia.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
fillet | Tali | nama file sertifikat, sebelumnya sertifikat harus diunggah dalam sistem. | benar |
Contoh respons:
{
"description" : "Add certificate",
"message" : "The certificate example.pem has been added to the SNI list of farm httpFarm, you need restart the farm to apply",
"success" : "true",
"status": "needed restart"
}
Hapus Sertifikat
Hapus Sertifikat
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
DELETE /farms/<farmname>/certificates/<file>
Hapus sertifikat dengan nama file yang dipilih dari daftar sertifikat di HTTP farm dengan pendengar HTTPS. Sertifikat tidak akan dihapus dari toko sertifikat.
Contoh respons:
{
"description" : "Delete farm certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true",
"status": "needed restart"
}
Tambahkan aturan IPDS
Tambahkan aturan IPDS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists>
Terapkan daftar hitam atau aturan DoS ke tambak.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama aturan IPDS digunakan sebagai pengidentifikasi unik. |
Contoh respons:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm httpFarm.",
"success" : "true"
}
Hapus aturan IPDS
Hapus aturan IPDS
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists>/<name>
Hapus daftar hitam atau aturan DoS dari tambak yang diberikan menggunakan idenficatornya nama.
Contoh respons:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm httpFarm.",
"success" : "true"
}
HTTP - Layanan
Layanan dalam tambak profil HTTP menyediakan metode alih konten untuk memberikan beberapa layanan web dengan properti berbeda, backend, atau bahkan metode kegigihan, melalui beberapa kondisi deterministik yang digunakan oleh inti tambak untuk mencocokkan layanan yang benar untuk setiap permintaan klien. Definisi layanan ini akan digunakan oleh tambak untuk menentukan server backend yang dapat memberikan respons kepada klien.
Di dalam objek layanan ada dua jenis nilai: terkait layanan dan terkait petani.
Farmguardian digunakan untuk memantau keadaan backend dan sepenuhnya dipersonalisasi untuk skrip Anda sendiri untuk layanan saat ini. Ketika masalah terdeteksi oleh petani, secara otomatis menonaktifkan server sebenarnya dan akan ditandai sebagai daftar hitam.
Untuk deskripsi lengkap tentang objek Layanan di tambak HTTP, lihat HTTP Farms> Ambil farm berdasarkan nama> Objek Table Services untuk farm HTTP
Buat Layanan baru
Buat Layanan baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/services
POST /farms/<farmname>/services
Buat layanan di Farm profil HTTP yang diberikan. Kebun membutuhkan tindakan mulai ulang untuk menerapkan perubahan ini.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
id | Tali | Nama layanan yang digunakan sebagai pengidentifikasi unik. Hanya nilai alfanumerik yang diizinkan. | benar |
Contoh respons:
{
"description" : "New service newserv",
"params" : {
"id" : "newserv"
},
"status" : "needed restart"
}
Ubah Layanan
Ubah Layanan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL",
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","leastresp":"true",
"httpsb":"true"}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/services/sev2
PUT /farms/<farmname>/services/<id>
Ubah parameter layanan dalam profil HTTP. id adalah pengidentifikasi unik layanan yang akan dimodifikasi.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
vhost | Tali | Menentukan kondisi yang ditentukan oleh nama domain melalui IP dan port virtual yang sama yang ditentukan oleh farm profil HTTP. Ekspresi reguler PCRE didukung. |
urlp | Tali | Memungkinkan untuk menentukan layanan web mengenai URL yang diminta klien melalui pola URL tertentu yang akan diperiksa secara sintaksis. Ekspresi reguler PCRE didukung. |
redirect | Tali | Ini berfungsi sebagai backend khusus, permintaan klien dijawab dengan mengarahkan ulang ke URL baru secara otomatis. |
redirecttype | Tali | Bagaimana pengalihan akan dilakukan, dua opsi: kegagalan, url diambil sebagai host mutlak dan jalur untuk mengarahkan ulang ke, menambahkan, jalur permintaan awal atau URI akan ditambahkan ke host dan jalur yang Anda tentukan redirect bidang. Perilaku ini hanya akan berlaku jika redirect bukan nilai kosong. |
cookie dimasukkan | Tali | Ini memungkinkan penyisipan cookie untuk sesi tempel backend. Opsinya adalah benar, profil akan mencari cookie yang diberikan di bidang nama masak, jika tidak ada maka cookie ini akan ditambahkan, palsu, cookie penyisipan dinonaktifkan. |
nama masak | Tali | Nama cookie (ID sesi) akan digunakan untuk mengidentifikasi proses tempel ke backend. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookiedomain | Tali | Penyisipan cookie akan dieksekusi jika domain cocok dengan konten cookie. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookiepath | Tali | Ini mengelola nilai jalur cookie untuk cookie tertentu, jika URI dalam permintaan klien atau respons backend tidak cocok dengan cookiepath, maka metode persistensi penyisipan cookie tidak diterapkan. Memungkinkan cookie dimasukkan bidang wajib diisi. |
cookiettl | Jumlah | Ini adalah waktu maksimum untuk cookie, dalam hitungan detik. Memungkinkan cookie dimasukkan bidang wajib diisi. |
ketekunan | Tali | Parameter ini menentukan bagaimana layanan HTTP akan mengelola sesi klien. Opsinya adalah: "" string kosong, tidak ada tindakan yang diambil, IP sesi ketekunan dilakukan di dasar IP klien, DASAR sesi ketekunan dilakukan di dasar header BASIC, URL sesi ketekunan dilakukan di dasar bidang di URI, PARM sesi persistensi dilakukan dalam basis nilai yang dipisahkan oleh ";" di akhir URI, COOKIE sesi ketekunan dilakukan berdasarkan nama cookie, cookie ini harus dibuat oleh backend, dan HEADER, sesi ketekunan dilakukan berdasarkan nama Header. |
Ttl | Jumlah | Hanya dengan kegigihan. Waktu maksimum kehidupan untuk sesi klien tidak aktif (usia sesi maks) dalam detik. |
sessionid | Tali | Ini tersedia jika ketekunan bidang adalah URL, COOKIE or HEADER, nilai parameter akan dicari oleh profil di header http dan akan mengelola sesi klien. |
setidaknya respons | Tali | Ini memungkinkan metode balancing yang paling tidak berespon. benar, sering kali profil memeriksa backend yang membutuhkan waktu lebih sedikit untuk merespons agar dapat mengirim lebih banyak koneksi ke ini, palsu, profil tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons. |
httpsb | Tali | Ini menunjukkan kepada farm bahwa server backend yang didefinisikan dalam layanan saat ini menggunakan bahasa HTTPS dan kemudian data akan dienkripsi sebelum dikirim. benar, profil mengirimkan lalu lintas dalam protokol HTTPS ke backends, palsu, profil mengirimkan lalu lintas dalam protokol HTTP ke backends. |
Contoh respons:
{
"description" : "Modify service newsrv in farm newHTTPfarm",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"params" : {
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirecttype" : "default",
"sessionid" : "sid",
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com"
},
"status" : "needed restart"
}
Parameter Respon
Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.
Ubah wali pertanian
Ubah wali pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"check_tcp","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/fg
Farmguardian digunakan untuk memantau keadaan backend dan sepenuhnya dipersonalisasi untuk skrip Anda sendiri untuk layanan saat ini. Ketika masalah terdeteksi oleh petani, secara otomatis menonaktifkan server sebenarnya dan akan ditandai sebagai daftar hitam.
PUT /farms/<farmname>/fg
Ubah parameter penjaga pertanian di profil HTTP yang diberikan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
fgtimecheck | Jumlah | Penjaga pertanian akan memeriksa status kesehatan backend setiap detik 'pemeriksaan jadwal'. | |
fgscript | Tali | Perintah yang dijalankan penjaga pertanian untuk memeriksa status kesehatan backend | |
difabel | Tali | Ini memungkinkan wali pertanian dalam layanan yang ditunjukkan. benar wali pertanian akan digunakan untuk memeriksa status backends, palsu wali pertanian akan dinonaktifkan | |
fglog | Tali | Aktifkan penggunaan log di wali pertanian. benar wali pertanian akan mencatat tindakan apa pun, palsu wali pertanian tidak akan mencatat tindakan apa pun, disarankan untuk mengaktifkan fglog hanya untuk pemecahan masalah. | |
layanan | Tali | Nama layanan digunakan sebagai pengidentifikasi unik. | benar |
Contoh respons:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "checktcp",
"fgtimecheck" : 5,
"service" : "service1"
}
}
Pindahkan layanan
Pindahkan layanan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/services/service1/actions
POST /farms/<farmname>/services/<id>/actions
Tindakan ini memindahkan layanan yang diberikan Naik atau Turun dalam Daftar Layanan, opsi ini berguna jika diperlukan untuk mengubah urutan prioritas, perhatikan bahwa layanan dievaluasi dalam urutan yang sama yang ditampilkan. tindakan ini memulai kembali pertanian secara otomatis.
id adalah pengidentifikasi unik layanan yang akan dimodifikasi.
Parameter Permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
posisi | Jumlah | Posisi di mana akan menjadi layanan. Posisi pertama memiliki indeks 0. | benar |
Contoh respons:
{
"description" : "Move service",
"message" : "service1 was moved successful.",
"params" : {
"position" : 0
}
}
Hapus Layanan
Hapus Layanan
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/services/service1
DELETE /farms/<farmname>/services/<id>
Hapus layanan yang diberikan dari profil http. id adalah pengidentifikasi unik layanan yang akan dihapus.
Contoh respons:
{
"description" : "Delete service service1 in farm FarmHTTP",
"message" : "The service service1 in farm FarmHTTP has been deleted.",
"success" : "true",
"status": "needed restart"
}
HTTP - Layanan - Backends
Daftar backend
Daftar backend
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/httpfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.
Contoh respons:
{
"description" : "List service backends",
"params" : [
{
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2
}
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | pengidentifikasi unik untuk backend dalam layanan. Pengidentifikasi ini dihasilkan oleh sistem. |
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. |
batas waktu | Jumlah | Ini batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik. |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. |
status | Tali | Status backend. Nilainya bisa: up backend siap menerima koneksi, pemeliharaan backend ditandai sebagai tidak siap untuk menerima koneksi, opsi ini berguna untuk tugas pemeliharaan backend. |
Buat Backend baru
Buat Backend baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/httpfarm/services/newsrv/backends
POST /farms/<farmname>/services/<id>/backends
Buat Backend baru di profil HTTP yang diberikan. id adalah pengidentifikasi unik layanan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. | benar |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. | benar |
batas waktu | Jumlah | Ini batas waktu backend untuk menanggapi permintaan tertentu. | |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. |
Contoh respons:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 0,
"ip" : "192.168.102.244",
"port" : 80,
"timeout" : 2,
"weight" : 2
},
"status" : "needed restart"
}
Parameter Respon
Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai jika tambak harus dimulai kembali. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.
Ubah Backend
Ubah Backend
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.0.10","port":88,"timeout":12,"service":"sev2", "weight":1}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/service/<id>/backends/<id>
Ubah parameter backend dalam layanan profil HTTP.
Pertama id adalah pengidentifikasi unik layanan, selanjutnya id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. |
batas waktu | Jumlah | Ini batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik. |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. |
Contoh respons:
{
"description" : "Modify service backend",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.0.10",
"port" : 88,
"timeout" : 12,
"weight" : 1
},
"status" : "needed restart"
}
Parameter Respon
Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai jika tambak harus dimulai kembali. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.
Backend dalam pemeliharaan
Backend dalam pemeliharaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance
Atur tindakan yang diberikan di backend dari HTTP farm, tindakan yang tersedia dijelaskan di bawah ini.
Pertama id adalah pengidentifikasi unik layanan, selanjutnya id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Atur aksi yang diinginkan. Tindakannya adalah: up backend siap menerima permintaan klien, pemeliharaan backend tidak siap untuk menerima permintaan klien, tindakan ini berguna untuk menghentikan server backend tanpa mempengaruhi klien. |
Contoh respons:
{
"description" : "Set service backend status",
"params" : {
"action" : "maintenance"
}
}
Hapus backend
Hapus backend
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
DELETE /farms/<farmname>/services/<id>/backends/<id>
Hapus backend yang diberikan dalam layanan profil HTTP.
Pertama id adalah pengidentifikasi unik layanan, selanjutnya id adalah pengidentifikasi unik backend.
Contoh respons:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
L4xNAT Peternakan
L4xNAT farm farm memungkinkan untuk membuat farm L4 dengan kinerja yang sangat tinggi dan koneksi lebih banyak bersamaan dari core load balancer di layer 7 seperti profil farm HTTP. Peningkatan kinerja lapisan 4 itu menangkal penanganan konten lanjutan yang dapat dikelola oleh profil lapisan 7.
Selain itu, tambak L4xNAT dapat mengikat berbagai port, tidak hanya satu port virtual seperti yang digunakan dengan profil layer 7 lainnya. Agar dapat memilih kisaran port virtual atau port virtual spesifik di L4xNAT farms, wajib untuk memilih jenis protokol. Dalam kasus lain, tambak akan mendengarkan semua port dari IP virtual (ditandai dengan karakter ''). Setelah protokol TCP atau UDP dipilih, akan tersedia untuk menentukan port, beberapa port antara ',', port berkisar antara ':' atau semua port dengan '' Kombinasi semuanya akan berlaku juga.
Ambil pertanian dengan nama
Ambil pertanian dengan nama
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4farm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Respon BODY:
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.55.40",
"port" : "88",
"priority" : 2,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.55.41",
"port" : "88",
"priority" : 3,
"status" : "up",
"weight" : 2
}
],
"description" : "List farm l4farm",
"ipds" : {
"blacklists" : [],
"dos" : []
},
"params" : {
"algorithm" : "weight",
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"listener" : "l4xnat",
"nattype" : "nat",
"persistence" : "",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan format di bawah ini.
Objek Pertanian:
Bidang | Tipe | Deskripsi |
---|---|---|
ipds | obyek | Daftar aturan IPDS yang diterapkan pada tambak ini. |
params | obyek | Parameter konfigurasi tambak. |
backends | Obyek[] | Semua server nyata dibuat di peternakan ini dan konfigurasinya. |
Objek IPDS:
Bidang | Tipe | Deskripsi |
---|---|---|
daftar hitam | Tali[] | Aturan daftar hitam diterapkan ke peternakan. |
dos | Tali[] | Aturan DoS diterapkan ke tambak. |
Objek parameter untuk peternakan L4xNAT:
Bidang | Tipe | Deskripsi |
---|---|---|
algoritma | Tali | Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: lessconn koneksi selalu ke server koneksi yang paling sedikit, berat koneksi linear pengiriman berat, prio koneksi selalu ke yang paling prio tersedia. |
pendengar | Tali | Seorang pendengar menjelaskan bagaimana pertanian akan bermain dengan permintaan dari klien. bidang informasional, tidak dapat diubah. |
nattype | Tali | Bagaimana lapisan penyeimbang inti 4 beroperasi. Opsinya adalah: nat juga disebut mode sNAT, backend merespons ke load balancer untuk mengirim respons ke klien, dnat backend akan merespons langsung ke klien, load balancer harus dikonfigurasi sebagai gateway di server backend. |
ketekunan | Tali | Alamat ip yang sama akan terhubung ke server yang sama. Opsinya adalah: "" nilai kosong, kegigihan dinonaktifkan, ip kegigihan diaktifkan melalui, IP asal digunakan seperti ID unik dalam sesi. |
protokol | Tali | Protokol harus seimbang pada layer 4. Opsinya adalah: semua profil akan memuat saldo protokol L4 apa pun, tcp penyeimbang beban hanya akan menyeimbangkan protokol TCP L4, udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, menyesap penyeimbang beban hanya akan menyeimbangkan protokol SIP atau VoIP L7, ftp penyeimbang beban hanya akan menyeimbangkan protokol FTP L7, tftp penyeimbang beban hanya akan menyeimbangkan protokol TFTP L7. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up tambak berjalan dan menangkap lalu lintas, turun pertanian turun dan tidak menangkap lalu lintas apa pun. |
Ttl | Jumlah | Nilai bidang ini menunjukkan jumlah detik yang persistensi antara sumber klien dan backend ditugaskan, dalam detik. Kegigihan harus dikonfigurasikan. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. Port unik dapat ditentukan, port jangkauan dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,. |
difabel | Tali | Memungkinkan penggunaan wali pertanian. benar penjaga pertanian diaktifkan, palsu wali pertanian dinonaktifkan. |
fglog | Tali | Memungkinkan penggunaan log di wali pertanian. difabel harus diaktifkan. |
fgscript | Tali | Perintah yang akan diperiksa oleh penjaga pertanian. Perintah-perintah yang tersedia berada di libexec path. difabel harus diaktifkan. |
fgtimecheck | Jumlah | Petugas pertanian akan memeriksa setiap detik 'pemeriksaan jadwal'. difabel harus diaktifkan. |
Objek backend untuk tambak L4xNAT:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | ID untuk mengidentifikasi backend di tambak. |
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual. |
status | Tali | Status backend. Nilainya bisa: up backend siap menerima koneksi, pemeliharaan backend tidak siap untuk menerima koneksi. |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas. |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. |
Buat Pertanian baru
Buat Pertanian baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms
POST /farms
Buat peternakan L4xNAT baru.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama pertanian | Tali | Nama pertanian, pengidentifikasi unik. | benar |
profil | Tali | Profil Peternakan yang dibuat. Untuk peternakan L4xNAT adalah l4xnat, pesan informasi, nilai ini tidak dapat diubah | benar |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. | benar |
olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. L4xNAT farm memungkinkan multiport dipisahkan oleh , atau rentang port dipisahkan oleh :. | benar |
Contoh respons:
{
"description" : "Creating farm 'newl4farm'",
"params" : {
"farmname" : "newl4farm",
"interface" : "eth0",
"profile" : "l4xnat",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Pertanian
Ubah Pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"algorithm":"weight","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/newfarml4
PUT /farms/<farmname>
Ubah konfigurasi tambak L4xNAT.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
newfarmname | Tali | Nama Peternakan baru. Pertanian harus dihentikan. |
algoritma | Tali | Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: lessconn koneksi selalu ke server koneksi yang paling sedikit, berat koneksi linear pengiriman berat, prio koneksi selalu ke yang paling prio tersedia. |
pendengar | Tali | Seorang pendengar menjelaskan bagaimana pertanian akan bermain dengan permintaan dari klien. bidang informasional, tidak dapat diubah. |
nattype | Tali | Bagaimana lapisan penyeimbang inti 4 beroperasi. Opsinya adalah: nat juga disebut mode sNAT, backend merespons ke load balancer untuk mengirim respons ke klien, dnat backend akan merespons langsung ke klien, load balancer harus dikonfigurasi sebagai gateway di server backend. |
ketekunan | Tali | Alamat ip yang sama akan terhubung ke server yang sama. Opsinya adalah: "" nilai kosong, kegigihan dinonaktifkan, ip kegigihan diaktifkan melalui, IP asal digunakan seperti ID unik dalam sesi. |
protokol | Tali | Protokol harus seimbang pada layer 4. Opsinya adalah: semua profil akan memuat saldo protokol L4 apa pun, tcp penyeimbang beban hanya akan menyeimbangkan protokol TCP L4, udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, menyesap penyeimbang beban hanya akan menyeimbangkan protokol SIP atau VoIP L7, ftp penyeimbang beban hanya akan menyeimbangkan protokol FTP L7, tftp penyeimbang beban hanya akan menyeimbangkan protokol TFTP L7. |
Ttl | Jumlah | Nilai bidang ini menunjukkan jumlah detik yang persistensi antara sumber klien dan backend ditugaskan, dalam detik. Kegigihan harus dikonfigurasikan. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. Port unik dapat ditentukan, port jangkauan dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,. |
Contoh respons:
{
"description" : "Modify farm l4farm",
"params" : {
"algorithm" : "weight",
"nattype" : "nat",
"newfarmname" : "l4farm",
"persistence" : "",
"protocol" : "tcp",
"ttl" : 125,
"vip" : "178.62.126.152",
"vport" : "81"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah wali pertanian
Ubah wali pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"Command of Farm Guardian","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4farm/fg
Farmguardian digunakan untuk memantau keadaan backend dan sepenuhnya dipersonalisasi untuk skrip Anda sendiri untuk layanan saat ini. Ketika masalah terdeteksi oleh petani, secara otomatis menonaktifkan server sebenarnya dan akan ditandai sebagai daftar hitam.
PUT /farms/<farmname>/fg
Ubah parameter penjaga pertanian dalam layanan L4xNAT.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
difabel | Tali | Memungkinkan penggunaan wali pertanian. benar penjaga pertanian diaktifkan, palsu wali pertanian dinonaktifkan. |
fglog | Tali | Memungkinkan penggunaan log di wali pertanian. difabel harus diaktifkan. |
fgscript | Tali | Perintah yang akan diperiksa oleh penjaga pertanian. Perintah-perintah yang tersedia berada di libexec path. difabel harus diaktifkan. |
fgtimecheck | Jumlah | Petugas pertanian akan memeriksa setiap detik 'pemeriksaan jadwal'. difabel harus diaktifkan. |
Contoh respons:
{
"description" : "Modify farm guardian",
"message" : "Success, some parameters have been changed in farm guardian in farm l4farm.",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "check_tcp",
"fgtimecheck" : 5
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan aturan IPDS
Tambahkan aturan IPDS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4Farm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists>
Terapkan aturan daftar hitam atau DoS ke tambak.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama aturan IPDS digunakan sebagai pengidentifikasi unik. |
Contoh respons:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm l4Farm.",
"success" : "true"
}
Hapus aturan IPDS
Hapus aturan IPDS
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4Farm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists>/<name>
Hapus daftar hitam atau aturan DoS modul IPDS dari peternakan yang diberikan menggunakan idenficator-nya nama.
Contoh respons:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm l4Farm.",
"success" : "true"
}
L4xNAT - Backends
Daftar backend
Daftar backend
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/l4farm/backends
GET /farms/<farmname>/backends
Dapatkan daftar backend dalam suatu layanan.
Contoh respons:
{
"description" : "List backends",
"params" : [
{
"id" : 0,
"ip" : "192.5.1.1",
"max_conns" : 400,
"port" : 787,
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.5.1.3",
"max_conns" : 200,
"port" : 787,
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | ID untuk mengidentifikasi backend di tambak. |
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual. |
status | Tali | Status backend. Nilainya bisa: up backend siap menerima koneksi, pemeliharaan backend tidak siap untuk menerima koneksi. |
max_conns | Jumlah | Ini jumlah maksimum koneksi serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun. |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas. |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. |
Buat Backend baru
Buat Backend baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/l4farm/backends
POST /farms/<farmname>/backends
Buat Backend baru di L4xNAT Farm yang diberikan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. | benar |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual. | |
max_conns | Jumlah | Ini jumlah maksimum koneksi serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun. | |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas. Nilai default adalah 1. | |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. Nilai defaultnya adalah 1. |
Contoh respons:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"port" : 8080,
"max_conns" : 400,
"priority" : null,
"weight" : null
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Backend
Ubah Backend
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.40","port":8080,"max_conns":220,"priority":4,"weight":7}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/l4farm/backends/2
PUT /farms/<farmname>/backends/<id>
Ubah parameter backend dalam layanan L4xNAT Farm. id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual. |
max_conns | Jumlah | Ini jumlah maksimum koneksi serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun. |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas. |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. |
Contoh respons:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"port" : 8080,
"max_conns" : 220,
"priority" : 4,
"weight" : 7
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Backend dalam pemeliharaan
Backend dalam pemeliharaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/l4farm/backends/1/maintenance
PUT /farms/<farmname>/backends/<id>/maintenance
Tetapkan tindakan yang diberikan di backend dari L4xNAT farm. id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Atur aksi yang diinginkan. Tindakannya adalah: up backend siap menerima permintaan klien, pemeliharaan backend tidak siap untuk menerima permintaan klien, tindakan ini berguna untuk menghentikan server backend tanpa mempengaruhi klien. |
Contoh respons:
{
"description" : "Set backend status",
"params" : {
"action" : "maintenance"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus backend
Hapus backend
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/l4farm/backends/4
DELETE /farms/<farmname>/backends/<id>
Hapus backend yang diberikan dalam layanan L4xNAT Farm.
id adalah pengidentifikasi unik backend.
Contoh respons:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
Pertanian GSLB
Penyeimbangan Beban Layanan Global, yang biasa disebut GSLB, memungkinkan untuk membuat layanan penyeimbangan beban berdasarkan arsitektur hierarki layanan DNS. Peternakan semacam ini menyediakan DNS otoritatif khusus dengan algoritma load balancing dan deteksi status layanan pada lapisan aplikasi DNS.
Ambil pertanian dengan nama
Ambil pertanian dengan nama
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Contoh respons:
{
"description" : "List farm gslbfarm",
"ipds" : {
"blacklists" : [],
"dos" : []
},
"params" : {
"status" : "needed restart",
"vip" : "192.168.100.155",
"vport" : 60
},
"services" : [
{
"algorithm" : "roundrobin",
"backends" : [
{
"id" : 1,
"ip" : "127.0.0.1"
},
{
"id" : 2,
"ip" : "192.168.55.40"
},
{
"id" : 4,
"ip" : "192.135.10.2"
}
],
"deftcpport" : 53,
"fgenabled" : "true",
"fgscript" : "check_tcp",
"fgtimecheck" : 5,
"id" : "service1"
},
{
"algorithm" : "prio",
"backends" : [
{
"id" : 1,
"ip" : "127.0.0.1"
},
{
"id" : 2,
"ip" : "127.0.0.1"
}
],
"deftcpport" : 80,
"fgenabled" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"id" : "prioServ"
}
],
"zones" : [
{
"defnamesv" : "ns3",
"id" : "global.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns3",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns3",
"ttl" : null,
"type" : "A"
},
{
"id" : 3,
"rdata" : "resource2",
"rname" : "ns2",
"ttl" : null,
"type" : "NS"
},
{
"id" : 4,
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
}
]
},
{
"defnamesv" : "ns1",
"id" : "DOM.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns1",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns1",
"ttl" : null,
"type" : "A"
}
]
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan format di bawah ini.
Objek Pertanian:
Bidang | Tipe | Deskripsi |
---|---|---|
ipds | obyek | Daftar aturan IPDS yang diterapkan pada tambak ini. |
params | obyek | Parameter konfigurasi tambak. |
layanan | Obyek[] | Array dengan semua layanan yang dibuat di tambak ini dan konfigurasinya. |
zona | Obyek[] | Array dengan semua zona yang dibuat di tambak ini dan konfigurasinya. |
Objek IPDS:
Bidang | Tipe | Deskripsi |
---|---|---|
daftar hitam | Tali[] | Daftar hitam diterapkan ke pertanian. |
dos | Tali[] | Aturan DoS diterapkan ke tambak. |
Objek parameter untuk peternakan GSLB:
Bidang | Tipe | Deskripsi |
---|---|---|
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Jumlah | Port of the farm, tempat layanan virtual mendengarkan. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up, pertanian sedang berjalan; turun, peternakan dihentikan atau diperlukan restart, tambak perlu dimulai kembali agar perubahan terbaru berlaku. |
Objek layanan untuk pertanian GSLB:
Bidang | Tipe | Deskripsi |
---|---|---|
backends | Obyek[] | Backends didefinisikan dalam layanan. |
difabel | Tali | Aktifkan penggunaan wali pertanian. benar wali pertanian diaktifkan dan memeriksa status backends, palsu penjaga pertanian dinonaktifkan dan tidak memeriksa status backends. Dalam profil GSLB pemeriksaan tcp dijalankan secara default bahkan jika wali pertanian dinonaktifkan. |
fgscript | Tali | Perintah yang akan digunakan penjaga pertanian untuk memeriksa kesehatan backend. benar diaktifkan, palsu, dinonaktifkan. difabel Dibutuhkan. |
fgtimecheck | Jumlah | Penjaga pertanian akan memeriksa setiap detik 'pemeriksaan jadwal' status kesehatan backend. difabel Dibutuhkan. |
id | Tali | Nama layanan yang digunakan sebagai pengidentifikasi unik. |
algoritma | Tali | Jenis algoritma load balancing yang digunakan dalam layanan. Opsinya adalah: roundrobin, yang akan menyeimbangkan koneksi di antara semua backend, atau prio yang akan mengirim semua koneksi ke backend pertama yang tersedia. |
deftcpport | Jumlah | Pemeriksaan kesehatan port TCP default. Ini adalah pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup. Nilai kosong dinonaktifkan. |
Objek backend untuk pertanian GSLB:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk backend dalam layanan. Pengidentifikasi ini dihasilkan oleh sistem. |
ip | Tali | IP backend tempat layanan sebenarnya mendengarkan. |
Objek zona:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Nama zona digunakan seperti penanda unik. |
defnamesv | Tali | Ini akan menjadi server nama root titik masuk yang akan tersedia sebagai catatan DNS Start of Authority (SOA). |
sumber daya | Obyek[] | Sumber didefinisikan dalam zona. |
Objek sumber daya:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk sumber daya di zona. |
rname | Tali | Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata. |
Ttl | Jumlah | Nilai Time to Live (opsional) untuk catatan saat ini yang diperlukan untuk menentukan lama waktu di mana nama saat ini akan di-cache. |
mengetik | Tali | Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian. |
rdata | Tali | Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. |
Buat Pertanian baru
Buat Pertanian baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms
POST /farms
Buat peternakan GSLB baru.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama pertanian | Tali | Nama tambak, pengidentifikasi unik untuk tambak. | benar |
profil | Tali | Profil Peternakan yang dibuat. Untuk peternakan GSLB adalah gslb. | benar |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. | benar |
olahraga | Jumlah | Port of the farm, tempat layanan virtual mendengarkan. | benar |
Contoh respons:
{
"description" : "Creating farm 'gslbfarm'",
"params" : {
"farmname" : "gslbfarm",
"interface" : "eth0",
"profile" : "gslb",
"vip" : "192.168.100.241",
"vport" : 53
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Pertanian
Ubah Pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"gslbnewname","vip":"192.168.100.155","vport":60}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm
PUT /farms/<farmname>
Ubah konfigurasi tambak GSLB.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
newfarmname | Tali | Nama Peternakan baru. Pertanian harus dihentikan untuk melakukan perubahan ini. |
olahraga | Jumlah | Port of the farm, tempat layanan virtual mendengarkan. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
Contoh respons:
{
"description" : "Modify farm gslbnewname",
"params" : {
"newfarmname" : "gslbnewname",
"vip" : "192.168.100.155",
"vport" : 60
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan aturan IPDS
Tambahkan aturan IPDS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbFarm/ipds/blacklists
POST /farms/<farmname>/ipds/<dos|blacklists>
Terapkan daftar hitam atau aturan DoS ke tambak.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama aturan IPDS digunakan sebagai pengidentifikasi unik. |
Contoh respons:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
"success" : "true"
}
Hapus aturan IPDS
Hapus aturan IPDS
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
DELETE /farms/<farmname>/ipds/<dos|blacklists>/<name>
Hapus daftar hitam atau aturan DoS dari tambak yang diberikan menggunakan idenficatornya nama.
Contoh respons:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
"success" : "true"
}
GSLB - Layanan
Layanan GSLB mewakili sekelompok server nyata dan algoritma terkait yang akan digunakan untuk mereka. Untuk membuat layanan baru, Anda harus menetapkan nama identifikasi yang valid dan algoritma yang diinginkan untuk digunakan.
Layanan yang tersedia adalah:
Round Robin: pembagian yang sama. Keseimbangan lalu lintas yang sama ke semua server nyata yang aktif. Untuk setiap koneksi yang masuk, penyeimbang menetapkan server real robin putaran berikutnya untuk mengirimkan permintaan.
Prioritas: koneksi selalu ke yang paling prio tersedia. Seimbangkan semua koneksi ke server prioritas tertinggi yang sama. Jika server ini tidak aktif, koneksi akan beralih ke server tertinggi berikutnya. Dengan algoritma ini, Anda dapat membangun layanan klaster Pasive Aktif dengan beberapa server nyata.
Objek layanan untuk peternakan GSLB
Bidang | Tipe | Deskripsi |
---|---|---|
backends | Obyek[] | Backends didefinisikan dalam layanan. |
difabel | Tali | Aktifkan penggunaan wali pertanian. benar wali pertanian diaktifkan dan memeriksa status backends, palsu penjaga pertanian dinonaktifkan dan tidak memeriksa status backends. Dalam profil GSLB pemeriksaan tcp dijalankan secara default bahkan jika wali pertanian dinonaktifkan. |
fgscript | Tali | Perintah yang akan digunakan penjaga pertanian untuk memeriksa kesehatan backend. benar diaktifkan, palsu, dinonaktifkan. difabel Dibutuhkan. |
fgtimecheck | Jumlah | Penjaga pertanian akan memeriksa setiap detik 'pemeriksaan jadwal' status kesehatan backend. difabel Dibutuhkan. |
id | Tali | Nama layanan yang digunakan sebagai pengidentifikasi unik. |
algoritma | Tali | Jenis algoritma load balancing yang digunakan dalam layanan. Opsinya adalah: roundrobin, yang akan menyeimbangkan koneksi di antara semua backend, atau prio yang akan mengirim semua koneksi ke backend pertama yang tersedia. |
deftcpport | Tali | Pemeriksaan kesehatan port TCP default. Ini adalah pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup. Nilai kosong dinonaktifkan. |
Buat Layanan baru
Buat Layanan baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"service1","algorithm":"roundrobin"}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services
POST /farms/<farmname>/services
Buat layanan di Ladang GSLB yang diberikan. Kebun harus dimulai kembali untuk menerapkan perubahan ini.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
id | Tali | Nama layanan yang digunakan sebagai pengidentifikasi unik. | benar |
algoritma | Tali | Jenis algoritma load balancing yang digunakan dalam layanan. Opsinya adalah: roundrobin, yang akan menyeimbangkan koneksi di antara semua backend, atau prio yang akan mengirim semua koneksi ke backend pertama yang tersedia. | benar |
Contoh respons:
{
"description" : "New service service1",
"params" : {
"algorithm" : "roundrobin",
"id" : "service1"
},
"status" : "needed restart"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Layanan
Ubah Layanan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"deftcpport":53}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1
PUT /farms/<farmname>/services/<id>
Ubah parameter layanan di Ladang GSLB. id adalah pengidentifikasi unik layanan yang akan dimodifikasi.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
deftcpport | Jumlah | Ini adalah pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup. |
Contoh respons:
{
"description" : "Modify service service1 in farm gslbfarm",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"params" : {
"deftcpport" : 53
},
"status" : "needed restart"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah wali pertanian
Ubah wali pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":"5","fgscript":"check_tcp","fgenabled":"true",
"service":"service1"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/fg
Farmguardian digunakan untuk memantau keadaan backend dan sepenuhnya dipersonalisasi untuk skrip Anda sendiri untuk layanan saat ini. Ketika masalah terdeteksi oleh petani, secara otomatis menonaktifkan server sebenarnya dan akan ditandai sebagai daftar hitam.
PUT /farms/<farmname>/fg
Ubah parameter penjaga pertanian di layanan GSLB.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
difabel | Tali | Aktifkan penggunaan wali pertanian. benar wali pertanian diaktifkan dan memeriksa status backends, palsu penjaga pertanian dinonaktifkan dan tidak memeriksa status backends. Dalam profil GSLB pemeriksaan tcp dijalankan secara default bahkan jika dinonaktifkan diaktifkan. | |
fgscript | Tali | Perintah yang akan digunakan penjaga pertanian untuk memeriksa kesehatan backend. benar diaktifkan, palsu, dinonaktifkan. | benar jika difabel diaktifkan. |
fgtimecheck | Jumlah | Penjaga pertanian akan memeriksa setiap detik 'pemeriksaan jadwal' status kesehatan backend. difabel Dibutuhkan. | |
layanan | Tali | Pengidentifikasi layanan, id, yang akan diubah wali pertanian. | benar |
Contoh respons:
{
"description" : "Modify farm guardian",
"message" : "Success, some parameters have been changed in farm guardian in farm gslbfarm.",
"params" : {
"fgenabled" : "true",
"fgscript" : "check_tcp",
"fgtimecheck" : 5
},
"status" : "needed restart"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus Layanan
Hapus Layanan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1
DELETE /farms/<farmname>/services/<id>
Hapus layanan yang diberikan dari Peternakan GSLB. id adalah pengidentifikasi unik layanan yang akan dihapus.
Contoh respons:
{
"description" : "Delete service service1 in farm gslbfarm",
"message" : "The service service1 in farm gslbfarm has been deleted.",
"success" : "true",
"status": "needed restart"
}
GSLB - Layanan - Backends
Bagian ini akan mengelola daftar layanan nyata yang terkait dengan layanan.
Daftar backend
Daftar backend
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.
Contoh respons:
{
"description" : "List service backends",
"params" : [
{
"id" : 1,
"ip" : "127.0.0.1"
},
{
"id" : 2,
"ip" : "192.168.55.40"
}
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk backend dalam layanan. Pengidentifikasi ini dihasilkan oleh sistem. |
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. |
Buat Backend baru
Buat Backend baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.135.10.2"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends
POST /farms/<farmname>/services/<id>/backends
Buat Backend baru di layanan yang diberikan di GSLB Farm. id adalah pengidentifikasi unik layanan di mana backend akan ditambahkan.
Layanan prioritas memiliki backend 2 sebagai maximun, host aktif dan host pasif.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. | benar |
Contoh respons:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 4,
"ip" : "192.135.10.2"
},
"status" : "needed restart"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Backend
Ubah Backend
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.2.30"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends/1
PUT /farms/<farmname>/services/<id>/backends/<id>
Ubah parameter backend dalam layanan Farm GSLB.
Catatan di PUT
di atas itu dulu id adalah pengidentifikasi unik layanan dan selanjutnya id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. |
Contoh respons:
{
"description" : "Modify service backend",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.2.30"
},
"status" : "needed restart"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus backend
Hapus backend
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends/3
DELETE /farms/<farmname>/services/<servicename>/backends/<id>
Hapus backend yang diberikan dalam layanan Ladang GSLB
Contoh respons:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
GSLB - Zona
Bagian zona GSLB akan menjelaskan nama domain DNS, subdomain, alias, dll., Yang akan diperlukan untuk menghasilkan zona DNS lengkap dengan tambahan catatan penyeimbangan menggunakan layanan yang ditentukan.
Buat zona
Buat zona
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"global.conf"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones
POST /farms/<farmname>/zones
Buat zona DNS.
Parameter Permintaan
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
id | Jumlah | Nama zona digunakan seperti penanda unik. | benar |
Contoh respons:
{
"description" : "New zone global.com",
"params" : {
"id" : "global.com"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah zona
Ubah zona
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"defnamesv":"ns3"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com
PUT /farms/<farmname>/zones/<id>
Ubah parameter suatu zona. id adalah pengidentifikasi unik zona yang akan dimodifikasi.
Parameter Permintaan
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
defnamesv | Tali | Ini akan menjadi server nama root titik masuk yang akan tersedia sebagai catatan DNS Start of Authority (SOA). |
Contoh respons:
{
"description" : "Modify zone global.com in farm gslbfarm",
"params" : {
"defnamesv" : "ns3"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus Zona
Hapus Zona
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/dom.com
DELETE /farms/<farmname>/zones/<id>
Hapus zona yang ditentukan dari Ladang GSLB.
Contoh respons:
{
"description" : "Delete zone dom.com in farm gslbfarm.",
"message" : "The zone dom.com in farm gslbfarm has been deleted.",
"success" : "true"
}
GSLB - Zona - Sumber Daya
Sumber daya yang didefinisikan sebagai layanan DNS menyelesaikan permintaan. Sumber daya DNS yang mungkin dalam saldo beban Zevenet adalah:
- NS. Nama jenis catatan Server, itu mendelegasikan zona DNS untuk menggunakan server nama otoritatif yang diberikan.
- A. Catatan jenis alamat, ia mengembalikan alamat IPv4 dari sebuah host.
- CNAME. Jenis catatan nama kanonik, itu mewakili alias dari nama yang diberikan.
- DYNA. Catatan tipe alamat dinamis, ini mengembalikan alamat dinamis yang ditentukan oleh layanan GSLB yang sudah dibuat dalam konfigurasi tambak sesuai dengan algoritma yang dipilih untuk layanan tersebut.
- AAAA. Catatan jenis alamat, ia mengembalikan alamat IPv6 dari sebuah host.
- MX. Catatan jenis pertukaran surat, memetakan nama domain ke daftar agen transfer pesan untuk domain itu.
- SRV. Catatan jenis pelacak layanan, Catatan lokasi layanan umum, digunakan untuk protokol yang lebih baru daripada membuat catatan khusus protokol seperti MX.
- TXT. Catatan jenis teks, digunakan untuk menyimpan informasi berbasis teks apa pun yang dapat diambil saat diperlukan. Kami paling sering melihat data TXT yang digunakan untuk menyimpan data SPF dan memverifikasi kepemilikan domain.
- PTR. Catatan pointer, penunjuk ke nama kanonik. Tidak seperti CNAME, pemrosesan DNS berhenti dan hanya namanya yang dikembalikan. Penggunaan yang paling umum adalah untuk menerapkan pencarian DNS terbalik.
- NAPTR. Penamaan Otoritas Pointer, Mengizinkan penulisan ulang nama domain berdasarkan ekspresi reguler yang kemudian dapat digunakan sebagai URI, nama domain selanjutnya untuk pencarian, dll.
Daftar sumber daya
Daftar sumber daya
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources
GET /farms/<farmname>/zones/<id>/resources
Dapatkan daftar sumber daya di zona. id adalah pengidentifikasi unik zona.
Contoh respons:
{
"description" : "List zone resources",
"params" : [
{
"id" : 0,
"rdata" : "ns3",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns3",
"ttl" : null,
"type" : "A"
},
{
"id" : 2,
"rdata" : "192.168.0.9",
"rname" : "resource2",
"ttl" : 10,
"type" : "A"
},
{
"id" : 3,
"rdata" : "resource2",
"rname" : "ns2",
"ttl" : null,
"type" : "NS"
}
]
}
Parameter Respon
Panggilan ini mengembalikan array objek sumber daya dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk sumber daya di zona. |
rname | Tali | Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata. |
Ttl | Jumlah | Nilai Time to Live (opsional) untuk catatan saat ini yang diperlukan untuk menentukan lama waktu di mana nama saat ini akan di-cache. |
mengetik | Tali | Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian. |
rdata | Tali | Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. |
Buat sumber daya baru
Buat sumber daya baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.0.9", "ttl":10, "type":"A" }'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources
POST /farms/<farmname>/zones/<id>/resources
Buat sumber daya baru di zona tertentu di Lahan GSLB. id adalah pengidentifikasi unik zona yang akan dimodifikasi di mana sumber daya akan ditambahkan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
rname | Tali | Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata. | benar |
Ttl | Jumlah | Nilai Time to Live untuk catatan saat ini. Ini adalah jumlah maksimal perangkat router yang dapat diminta hingga mati. Berguna adalah bahwa paket tidak diinput dalam loop net. | |
mengetik | Tali | Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian. | benar |
rdata | Tali | Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. Jika DYNA dipilih dalam mengetik maka nilai rdata harus salah satu yang dikonfigurasi layanan di zona ini. | benar |
Contoh respons:
{
"description" : "New zone resource",
"message" : "Resource added",
"params" : {
"rdata" : "192.168.0.9",
"rname" : "resource2",
"ttl" : 10,
"type" : "A",
"zone" : "global.com"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah sumber daya
Ubah sumber daya
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.200.30","ttl":null, "type":"A" }'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
PUT /farms/<farmname>/zones/<id>/resources/<id>
Ubah parameter sumber daya di zona Ladang GSLB.
Pertama id adalah pengidentifikasi unik zona, selanjutnya id adalah pengidentifikasi unik sumber daya.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
rname | Tali | Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata. |
Ttl | Jumlah | Nilai Time to Live (opsional) untuk catatan saat ini yang diperlukan untuk menentukan lama waktu di mana nama saat ini akan di-cache. |
mengetik | Tali | Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian. |
rdata | Tali | Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. Jika mengetik dimuat dengan nilai DYNA kemudian rdata harus dimuat dengan yang tersedia layanan nama |
Contoh respons:
{
"description" : "Modify zone resource",
"message" : "Resource modified",
"params" : {
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
},
"success" : "true"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus sumber daya
Hapus sumber daya
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
DELETE /farms/<farmname>/zones/<id>/resources/<id>
Hapus sumber daya yang diberikan di zona Lahan GSLB
Perhatikan bahwa dalam DELETE
URI di atas yang pertama id adalah pengidentifikasi unik zona dan berikutnya id adalah pengidentifikasi unik sumber daya.
Contoh respons:
{
"description" : "Delete zone resource",
"message" : "Resource removed",
"success" : "true"
}
Peternakan Datalink
Profil datalink farm memungkinkan untuk membuat farm berbasis rute di mana backend adalah router uplink atau gateway. Profil pertanian semacam ini siap untuk membagikan beberapa akses router WAN uplink menggunakan penyeimbang beban sebagai multipleksor saluran uplink (input 1 dan beberapa output garis router). Oleh karena itu, tambak datalink dapat digunakan sebagai tautan komunikasi yang tersedia tinggi dan juga dapat digunakan sebagai peningkatan bandwidth yang menghubungkan jumlah bandwidth antara tautan backend router.
Ambil pertanian dengan nama
Ambil pertanian dengan nama
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/dlink
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak.
Contoh respons:
{
"backends" : [
{
"id" : 0,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
},
{
"id" : 1,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"weight" : 1
}
],
"description" : "List farm dlink",
"params" : {
"algorithm" : "weight",
"status" : "down",
"vip" : "192.168.100.199"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan format di bawah ini.
Objek Pertanian:
Bidang | Tipe | Deskripsi |
---|---|---|
params | obyek | Parameter konfigurasi tambak. |
backends | Obyek[] | Server nyata dibuat di tambak ini dan konfigurasinya. |
Objek parameter untuk peternakan datalink:
Bidang | Tipe | Deskripsi |
---|---|---|
algoritma | Tali | Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: berat, penyeimbang mendistribusikan di antara semua backend yang tersedia memberikan backend charge lebih banyak dengan atribusi berat lebih tinggi atau prio, yang mengirim semua koneksi ke backend dengan nilai minor prioritas. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up, tambak sedang berjalan, atau turun, pertanian dihentikan. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
Objek backend untuk peternakan datalink:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk backend di tambak. |
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. |
antarmuka | Tali | Ini adalah antarmuka jaringan lokal tempat backend terhubung. |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Ini akan digunakan kapan algoritma bidang adalah konfigurasi karena prio dan prioritas yang lebih rendah akan memiliki preferensi |
berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Ini akan digunakan saat algoritma bidang adalah konfigurasi sebagai bobot. |
Buat Pertanian baru
Buat Pertanian baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms
POST /farms
Buat peternakan datalink baru.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama pertanian | Tali | Nama pertanian, pengidentifikasi unik. | benar |
profil | Tali | Profil Peternakan yang dibuat. Untuk peternakan datalink adalah datalink | benar |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. | benar |
Contoh respons:
{
"description" : "Creating farm 'dlink'",
"params" : {
"farmname" : "dlink",
"interface" : "eth0",
"profile" : "datalink",
"vip" : "192.168.100.241"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Pertanian
Ubah Pertanian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/dlink
PUT /farms/<farmname>
Ubah konfigurasi pertanian datalink.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
newfarmname | Tali | Nama pertanian baru. Pertanian harus dihentikan. |
algoritma | Tali | Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: berat, penyeimbang mendistribusikan di antara semua backend yang tersedia memberikan backend charge lebih banyak dengan atribusi berat lebih tinggi atau prio, yang mengirim semua koneksi ke backend dengan nilai minor prioritas. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
Contoh respons:
{
"description" : "Modify farm dlink",
"params" : {
"algorithm" : "weight",
"vip" : "192.168.100.199",
"newfarmname" : "dlink2"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Datalink - Backends
Backends di peternakan datalink adalah gateway melalui routing layanan. Layanan ini akan multiplexor di antara gateway ini, dan beberapa di antaranya tidak tersedia, layanan menggunakan yang lain.
Daftar backend
Daftar backend
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/dlink/backends
GET /farms/<farmname>/backends
Dapatkan daftar backend dalam suatu layanan.
Contoh respons:
[
{
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
},
{
"id" : 7,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"weight" : 1
}
]
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Pengidentifikasi unik untuk backend di tambak. Pengidentifikasi ini dihasilkan oleh sistem. |
antarmuka | Tali | Ini adalah antarmuka jaringan lokal tempat backend terhubung. |
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. |
prioritas | Jumlah | Ini adalah nilai prioritas untuk backend saat ini. Ini akan digunakan kapan algoritma bidang adalah konfigurasi karena prio dan prioritas yang lebih rendah akan memiliki preferensi. |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. Ini akan digunakan saat algoritma bidang adalah konfigurasi sebagai bobot. |
Buat Backend baru
Buat Backend baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/dlink/backends
POST /farms/<farmname>/backends
Buat Backend baru di Farm datalink yang diberikan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. | benar |
antarmuka | Tali | Ini adalah antarmuka jaringan lokal tempat backend terhubung. | benar |
prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Ini akan digunakan kapan algoritma bidang adalah konfigurasi karena prio dan prioritas yang lebih rendah akan memiliki preferensi. Nilai default adalah 1. | |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. Ini akan digunakan saat algoritma bidang adalah konfigurasi sebagai bobot. Nilai default adalah 1. |
Contoh respons:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah Backend
Ubah Backend
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"timeout":1}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/datalink/backends/2
PUT /farms/<farmname>/backends/<id>
Ubah parameter backend dalam layanan Farm datalink. id adalah pengidentifikasi unik backend.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
Tali | ip | IP backend, tempat layanan sebenarnya mendengarkan. |
antarmuka | Tali | Ini adalah antarmuka jaringan lokal tempat backend terhubung. |
batas waktu | Jumlah | Ini batas waktu backend untuk menanggapi permintaan tertentu. |
berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. |
Contoh respons:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"interface" : "eth0",
"ip" : "192.168.102.50",
"timeout" : 1,
"weight" : 1
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus backend
Hapus backend
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/dlink/backends/4
DELETE /farms/<farmname>/backends/<id>
Hapus backend yang diberikan dalam layanan Farm datalink. id adalah pengidentifikasi unik backend.
Contoh respons:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
jaringan
Zevenet dapat bekerja dengan berbagai jenis antarmuka jaringan.
Di bagian ini Anda dapat membuat daftar, membuat, mengonfigurasi, menghapus, dan mengatur tindakan dalam antarmuka NIC, VLAN, virtual, dan bonding.
nic: atau kartu antarmuka jaringan, ini adalah komponen perangkat keras komputer dan jenis antarmuka ini adalah dasar untuk jenis antarmuka berikut yang dapat didefinisikan dan dikelola di Zevenet.
vlan: atau kartu lan virtual adalah jenis atau antarmuka jaringan yang menyediakan layanan segmentasi jaringan. Lebih dari satu vlan dapat dibuat melalui antarmuka nic. ikatan: Disebut juga oleh vendor lain sebagai antarmuka trunk, jenis nic ini dapat dibuat dengan lebih dari satu antarmuka nic. Zevenet mendukung 7 berbagai jenis antarmuka ikatan.
maya: Jenis antarmuka ini dapat dibuat di atas jenis antarmuka apa pun yang dijelaskan di atas. Jenis antarmuka ini harus digunakan untuk Farms dan diperlukan bahwa antarmuka virtual didefinisikan dalam subnet yang sama dari induknya.
Daftar semua antarmuka
Daftar semua antarmuka
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic
GET /interfaces
Dapatkan daftar antarmuka dalam sistem dengan konfigurasinya.
Contoh respons:
{
"description" : "List interfaces",
"interfaces" : [
{
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "bond2",
"netmask" : "",
"status" : "down",
"type" : "bond"
},
{
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "bond"
},
{
"gateway" : "192.168.100.5",
"ip" : "192.168.100.241",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic",
"is_slave" : "false"
},
{
"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",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"status" : "down",
"type" : "virtual"
},
{
"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",
"type" : "nic",
"is_slave" : "false"
},
{
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "eth2",
"netmask" : "",
"status" : "up",
"type" : "nic",
"is_slave" : "true"
},
{
"gateway" : "",
"ip" : "",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"status" : "up",
"type" : "nic",
"is_slave" : "true"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka.
Objek antarmuka:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk di antarmuka virtual. |
netmask | Tali | Netmask antarmuka. Nilai ini tidak dapat dimodifikasi dalam antarmuka virtual, itu diwarisi dari induk inteface. |
pintu gerbang | Tali | Gerbang antarmuka. Nilai ini tidak dapat dimodifikasi dalam antarmuka virtual, itu diwarisi dari induk inteface. |
mac | Tali | MAC dari antarmuka. Nilai ini diwarisi dari slave NIC pertama di antarmuka ikatan. Dalam antarmuka virtual dan VLAN itu diwarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
mengetik | Tali | Berbagai jenis antarmuka adalah: nic, vlan, maya or ikatan. |
is_slave | Tali | Hanya tersedia di antarmuka NIC, benar, antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan. |
Ambil gateway default
Ambil gateway default
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/interfaces/gateway
GET /interfaces/gateway
Gateway default adalah simpul yang mengirim semua lalu lintas tujuan yang tidak dapat dijangkau secara lokal dari antarmuka apa pun di penyeimbang beban.
Dapatkan parameter antarmuka gateway default.
Contoh respons:
{
"description" : "Default gateway",
"params" : {
"address" : "192.168.100.5",
"interface" : "eth0"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
alamat | Tali | Ini adalah IP gateway. |
antarmuka | Tali | Nama antarmuka untuk gateway. |
Ubah gateway default
Ubah gateway default
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth0","address":"192.168.100.5"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces
PUT /interfaces/gateway
Ubah konfigurasi antarmuka gateway.
Contoh respons:
{
"description" : "Modify default gateway",
"message" : "The default gateway has been changed successfully",
"success" : "true"
}
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
alamat | Tali | Ini adalah IP gateway. |
antarmuka | Tali | Nama antarmuka untuk gateway. |
Hapus konfigurasi gateway
DELETE /interfaces/gateway
Hapus konfigurasi konfigurasi gateway default.
peringatan: jika gateway tidak dikonfigurasi, Zevenet tidak akan dapat dijangkau dari segmen jaringan eksternal.
Hapus konfigurasi gateway
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/gateway
Pesan tanggapan
Jika gateway dikonfigurasi dari segmen jaringan yang sama, pesan ini akan muncul, jika tidak koneksi akan hilang.
Contoh respons:
{
"description" : "Remove default gateway",
"message" : "The default gateway has been deleted successfully",
"params" : {
"address" : null,
"interface" : null
}
}
Jaringan - antarmuka NIC
Antarmuka NIC adalah antarmuka fisik yang terhubung ke penyeimbang beban Zevenet Anda.
Sistem mengenali antarmuka baru secara otomatis setelah terhubung.
Menggunakan antarmuka NIC sebagai orangtua, jenis antarmuka lain dengan karakteristik berbeda dapat dibuat. Antarmuka yang tersedia adalah: VLAN,maya dan ikatan.
Daftar antarmuka NIC
GET /interfaces/nic
Dapatkan semua parameter antarmuka NIC.
Daftar antarmuka NIC
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic
Contoh respons:
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"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",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
},
{
"gateway" : "",
"ip" : "",
"is_slave" : "false",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"status" : "down"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka NIC.
Objek antarmuka NIC:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket ke segmen jaringan yang berbeda. |
mac | Tali | Tautan indentifier unik layer. Itu tidak dapat dimodifikasi. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
is_slave | Tali | benar antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan. |
Ambil antarmuka NIC
Ambil antarmuka NIC
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic/eth1
GET /interfaces/nic/<name>
Dapatkan semua parameter antarmuka NIC. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show NIC interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket ke segmen jaringan yang berbeda. |
mac | Tali | Tautan indentifier unik layer. Itu tidak dapat dimodifikasi. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
mengetik | Tali | Berbagai jenis antarmuka adalah: nic, vlan, maya or ikatan. Masing-masing didefinisikan dalam submenu jaringan mereka. |
is_slave | Tali | benar antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan. |
Ubah antarmuka NIC
Ubah antarmuka NIC
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.102","netmask":"255.255.255.0","gateway":"192.168.100.5"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic/eth1
PUT /interfaces/nic/<name>
Ubah parameter antarmuka NIC. nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
Contoh respons:
{
"description" : "Configure nic interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"netmask" : "255.255.255.0"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus konfigurasi NIC
Hapus konfigurasi NIC
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic/eth3
DELETE /interfaces/nic/<name>
Hapus konfigurasi untuk antarmuka NIC. Setelah tindakan ini, antarmuka akan menjadi tidak berguna, dan siap untuk dikonfigurasikan lagi. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Delete nic interface",
"message" : "The configuration for the network interface eth3 has been deleted.",
"success" : "true"
}
Tetapkan tindakan antarmuka NIC
Tetapkan tindakan antarmuka NIC
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/nic/eth1/actions
POST /interfaces/nic/<name>/actions
Terapkan tindakan ke antarmuka NIC. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.
nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket. | benar |
Contoh respons:
{
"description" : "Action on nic interface",
"params" : {
"action" : "up"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Jaringan - Ikatan antarmuka
Antarmuka pengikatan Linux atau juga disebut oleh vendor lain sebagai Trunk menyediakan metode untuk menggabungkan beberapa antarmuka jaringan menjadi satu antarmuka logis "terikat". Perilaku antarmuka terikat tergantung pada mode, Zevenet Load Balancer mendukung metode berikut:
Kebijakan round-robin: Mengirimkan paket secara berurutan dari budak pertama yang tersedia hingga yang terakhir. Mode ini menyediakan penyeimbangan muatan dan toleransi kesalahan.
Kebijakan pencadangan aktif: Hanya satu budak di ikatan yang aktif. Seorang budak yang berbeda menjadi aktif jika, dan hanya jika, budak yang aktif gagal. Alamat MAC ikatan terlihat secara eksternal hanya pada satu port (adaptor jaringan) untuk menghindari membingungkan sakelar. Mode ini memberikan toleransi kesalahan. Opsi utama memengaruhi perilaku mode ini.
Kebijakan XOR: Mengirimkan berdasarkan alamat MAC sumber XOR'd dengan alamat MAC tujuan. Ini memilih budak yang sama untuk setiap alamat MAC tujuan. Mode ini menyediakan penyeimbangan muatan dan toleransi kesalahan.
Kebijakan penyiaran: Mengirimkan semua yang ada di semua antarmuka slave. Mode ini memberikan toleransi kesalahan.
IEEE 802.3ad LACP: Membuat grup agregasi yang berbagi kecepatan dan pengaturan dupleks yang sama. Memanfaatkan semua budak dalam agregator aktif sesuai dengan spesifikasi 802.3ad.
Pra-syarat:
Dukungan antarmuka jaringan pada driver dasar untuk mendapatkan kecepatan dan dupleks dari setiap slave.
Sakelar yang mendukung agregasi tautan Dinamis IEEE 802.3ad. Sebagian besar sakelar akan memerlukan beberapa jenis konfigurasi untuk mengaktifkan mode 802.3ad.
Penyeimbangan beban pengiriman adaptif: Ikatan saluran yang tidak memerlukan dukungan sakelar khusus. Lalu lintas keluar didistribusikan sesuai dengan beban saat ini (dihitung relatif terhadap kecepatan) pada setiap budak. Lalu lintas masuk diterima oleh budak saat ini. Jika budak penerima gagal, budak lain mengambil alih alamat MAC dari budak penerima yang gagal.
Prasyarat:
Dukungan pangkalan driver untuk mengambil kecepatan setiap budak.
Penyeimbangan beban adaptif: Termasuk penyeimbangan beban pengiriman adaptif plus penyeimbangan muatan terima untuk lalu lintas IPV4, dan tidak memerlukan dukungan sakelar khusus. Penyeimbangan muatan terima dicapai dengan negosiasi ARP. Pengandar ikatan memotong ARP Balasan yang dikirim oleh sistem lokal pada jalan keluar dan menimpa alamat perangkat keras sumber dengan alamat perangkat keras yang unik dari salah satu budak dalam ikatan sehingga rekan yang berbeda menggunakan alamat perangkat keras yang berbeda untuk server.
Daftar antarmuka ikatan
Daftar antarmuka ikatan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding
GET /interfaces/bonding
Dapatkan konfigurasi tentang semua antarmuka ikatan dalam sistem.
Contoh respons:
{
"description" : "List bonding interfaces",
"interfaces" : [
{
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"mode" : "broadcast",
"name" : "bond2",
"netmask" : "",
"slaves" : [
{
"name" : "eth2"
}
],
"status" : "down"
},
{
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth4"
}
],
"status" : "up"
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array objek antarmuka ikatan.
Parameter ikatan adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
mac | Tali | Tautan indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
budak | Obyek[] | Anggota antarmuka NIC dari antarmuka ikatan. |
mode | Tali | Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan di bagian Jaringan - Ikatan antarmuka. |
Objek budak:
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama adalah pengidentifikasi unik antarmuka dari budak NIC. |
Ambil antarmuka Bonding
Ambil antarmuka Bonding
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface
GET /interfaces/bonding/<name>
Dapatkan semua parameter antarmuka. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show bonding interface",
"interface" : {
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
}
],
"status" : "up"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan objek antarmuka ikatan.
Parameter ikatan adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
mac | Tali | Tautan indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
budak | Obyek[] | Anggota antarmuka NIC dari antarmuka ikatan. |
mode | Tali | Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat. |
Budak obyek:
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama adalah pengidentifikasi unik antarmuka dari budak NIC. |
Buat antarmuka Bonding
Buat antarmuka Bonding
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"slaves":["eth3","eth2"],"name":"bondiface","mode":"balance-rr"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding
POST /interfaces/bonding
Buat antarmuka ikatan bergabung dengan antarmuka NIC.
Alamat MAC ikatan akan diambil dari antarmuka NIC pertamanya. Mode ikatan tidak dapat diubah setelah antarmuka ikatan dibuat, tetapi antarmuka anggota dapat ditambahkan atau dihapus di antarmuka ikatan sesuai kebutuhan. Antarmuka NIC akan dikunci jika merupakan bagian dari antarmuka ikatan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. | benar |
budak | Tali[] | Semua antarmuka NIC yang membangun ikatan. Diperlukan parameter NIC nama. | benar |
mode | Tali | Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat. | benar |
Contoh respons:
{
"description" : "Add a bond interface",
"params" : {
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
}
],
"status" : "down"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan ikatan parameter yang dikonfigurasi.
Bidang | Tipe | Deskripsi |
---|---|---|
mac | Tali | Tautan indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
budak | Obyek[] | Antarmuka NIC yang membangun ikatan ikatan. |
mode | Tali | Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat. |
Budak obyek:
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama adalah pengidentifikasi unik antarmuka dari budak NIC. |
Ubah antarmuka ikatan
Ubah antarmuka ikatan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.121","netmask":"255.255.255.0","gateway":"192.168.100.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface
PUT /interfaces/bonding/<name>
Ubah parameter antarmuka ikatan. nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
Contoh respons:
{
"description" : "Modify bond address",
"params" : {
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"netmask" : "255.255.255.0"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus konfigurasi Bonding
Hapus konfigurasi Bonding
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface
DELETE /interfaces/bonding/<name>
Hapus konfigurasi antarmuka ikatan. Parameter konfigurasi adalah: pintu gerbang, ip dan netmask.
nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Delete bonding network configuration",
"message" : "The configuration for the bonding interface bondiface has been deleted.",
"success" : "true"
}
Tetapkan tindakan antarmuka Bonding
Tetapkan tindakan antarmuka Bonding
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"up"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/actions
POST /interfaces/bonding/<name>/actions
Menerapkan tindakan ke antarmuka ikatan. Panggilan ini memungkinkan untuk menghapus antarmuka ikatan dan mengaktifkan atau menonaktifkannya.
Diperlukan untuk menghapus antarmuka ikatan menggunakan menghancurkan tindakan jika Anda ingin membuka kunci antarmuka NIC yang digunakan dalam ikatan Driver ikatan kemudian akan mengembalikan alamat MAC yang dimiliki oleh anggota antarmuka sebelum mereka ditambahkan ke antarmuka ikatan.
nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up aktifkan antarmuka dan persiapkan untuk digunakan, turun nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket, menghancurkan hapus ikatan dan kembalikan antarmuka NIC slave. | benar |
Contoh respons:
{
"description" : "Action on bond interface",
"params" : {
"action" : "up"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan antarmuka budak ikatan
Tambahkan antarmuka budak ikatan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"eth4"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/slaves
POST /interfaces/bonding/<name>/slaves
Tambahkan antarmuka NIC sebagai budak ke antarmuka ikatan yang ada.
nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama | Tali | Antarmuka NIC nama untuk menambah antarmuka ikatan. | benar |
Contoh respons:
{
"description" : "Add a slave to a bond interface",
"params" : {
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
},
{
"name" : "eth4"
}
],
"status" : "up"
}
}
Parameter respons
Respons akan berupa json dengan nilai konfigurasi yang diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus antarmuka budak Bonding
Hapus antarmuka budak Bonding
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
DELETE /interfaces/bonding/<name>/slaves/<name>
Hapus antarmuka slave NIC dari antarmuka bonding. Bonding interface harus memiliki hampir satu antarmuka slave NIC.
Pertama nama adalah DELETE
panggilan adalah pengidentifikasi unik nama ikatan, selanjutnya nama dalam DELETE
panggilan adalah pengidentifikasi unik nama antarmuka NIC.
Contoh respons:
{
"description" : "Remove bonding slave interface",
"message" : "The bonding slave interface eth2 has been removed.",
"success" : "true"
}
Jaringan - antarmuka VLAN
Antarmuka VLAN memungkinkan NIC atau antarmuka ikatan bekerja di jaringan lain, jadi IP, pintu gerbang dan netmask bidang bisa berbeda dari antarmuka induk. Antarmuka VLAN mewarisi alamat MAC dari antarmuka induknya.
Bidang antarmuka VLAN nama akan muncul dengan karakter titik “.” yang akan digunakan untuk membuat tag pengenal untuk antarmuka vlan.
Daftar antarmuka VLAN
Daftar antarmuka VLAN
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan
GET /interfaces/vlan
Dapatkan semua parameter antarmuka VLAN.
Contoh respons:
{
"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"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka VLAN.
Parameter VLAN adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. Ini bisa berbeda dengan inteface IP induk. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
mac | Tali | MAC dari antarmuka. Nilai ini diwarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan atau tag vlan. |
induk | Tali | Ini adalah Antarmuka yang digunakan untuk membuat yang ini. |
status | Tali | Nilai bisa up antarmuka dapat menerima paket, turun antarmuka tidak dapat menerima paket. |
Ambil antarmuka VLAN
Ambil antarmuka VLAN
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan/eth0.1
GET /interfaces/vlan/<name>
Dapatkan semua parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"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"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
mac | Tali | MAC dari antarmuka. Nilai ini diwarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan. |
status | Tali | Nilai bisa up antarmuka dapat menerima paket, turun antarmuka tidak dapat menerima paket. |
Buat antarmuka VLAN
Buat antarmuka VLAN
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1", "name":"eth0.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan
POST /interfaces/vlan
Buat antarmuka VLAN dari antarmuka NIC atau ikatan. Antarmuka VLAN baru akan membagikan MAC, meskipun parameter jaringan berikut harus berbeda: ip, dan berikut ini dapat berubah: pintu gerbang, netmask.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP antarmuka. Itu harus berbeda dengan inteface IP induk. | benar |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. | benar |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. | benar |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan. | benar |
Contoh respons:
{
"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"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah antarmuka VLAN
Ubah antarmuka VLAN
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan/eth0.1
PUT /interfaces/vlan/<name>
Ubah parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. Ini bisa berbeda dengan inteface IP induk. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
Contoh respons:
{
"description" : "Modify VLAN interface",
"params" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"netmask" : "255.255.255.0"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus antarmuka VLAN
Hapus antarmuka VLAN
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan/eth0.1
DELETE /interfaces/vlan/<name>
Hapus antarmuka VLAN. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Delete VLAN interface",
"message" : "The VLAN interface eth0.1 has been deleted.",
"success" : "true"
}
Tetapkan tindakan antarmuka VLAN
Tetapkan tindakan antarmuka VLAN
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/vlan/eth0.1/actions
POST /interfaces/vlan/<name>/actions
Terapkan tindakan ke antarmuka VLAN. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.
nama adalah nama pengidentifikasi unik.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket. | benar |
Contoh respons:
{
"description" : "Action on vlan interface",
"params" : {
"action" : "down"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Jaringan - Antarmuka virtual
Antarmuka jaringan memungkinkan pengguna untuk memiliki antarmuka jaringan lain di segmen jaringan yang sama dari induknya, sehingga antarmuka virtual selalu mewarisi konfigurasi jaringan dari induknya. Parameter yang berbeda adalah ip. Antarmuka virtual dapat dibuat dari NIC, bonding atau VLAN. Membuat antarmuka virtual baru akan muncul bidang dengan karakter ":" titik dua yang akan digunakan untuk membuat identifikasi untuk antarmuka virtual.
Daftar antarmuka virtual
Daftar antarmuka virtual
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual
GET /interfaces/virtual
Dapatkan semua parameter antarmuka virtual.
Contoh respons:
{
"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"
}
]
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk. |
mac | Tali | MAC dari antarmuka. Ini mewarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":" dan nama untuk antarmuka jaringan virtual, karakter alfanumerik diperbolehkan. |
induk | Tali | Ini adalah Antarmuka yang digunakan untuk membuat yang ini. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
Ambil antarmuka virtual
Ambil antarmuka virtual
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual/eth0:virtiface
GET /interfaces/virtual/<name>
Dapatkan semua parameter antarmuka virtual. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"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"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk. |
mac | Tali | MAC dari antarmuka. Ini mewarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":", dan string alfanumerik untuk antarmuka jaringan virtual. |
induk | Tali | Ini adalah Antarmuka yang digunakan untuk membuat yang ini. |
status | Tali | Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket. |
Buat antarmuka virtual
Buat antarmuka virtual
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.41", "name":"eth0:virtiface"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual
POST /interfaces/virtual
Buat antarmuka virtual.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk. | benar |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":", dan string alfanumerik untuk antarmuka jaringan virtual. | benar |
Contoh respons:
{
"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"
}
}
Parameter respons
Responsnya akan menjadi json dengan konfigurasi antarmuka. Lihat contoh respons untuk informasi lebih lanjut.
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk. |
netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk. |
pintu gerbang | Tali | IP digunakan untuk mengirim paket ke segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk. |
mac | Tali | MAC dari antarmuka. Ini mewarisi dari antarmuka induk. |
nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":" dan string alpahnumerik untuk antarmuka jaringan virtual. |
Ubah antarmuka virtual
Ubah antarmuka virtual
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual/eth0:virtiface
PUT /interfaces/virtual/<name>
Ubah parameter antarmuka virtual. nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk. |
Contoh respons:
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus antarmuka virtual
Hapus antarmuka virtual
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual/eth0:virtiface
DELETE /interfaces/virtual/<name>
Hapus antarmuka virtual. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Delete virtual interface",
"message" : "The virtual interface eth0:virtiface has been deleted.",
"success" : "true"
}
Tetapkan tindakan antarmuka virtual
Tetapkan tindakan antarmuka virtual
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
POST /interfaces/virtual/<name>/actions
Terapkan tindakan ke antarmuka virtual. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.
nama adalah pengenal unik antarmuka.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket. | benar |
Contoh respons:
{
"description" : "Action on virtual interface",
"params" : {
"action" : "down"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Jaringan - Antarmuka apung
Jenis antarmuka ini menggunakan antarmuka virtual yang ditentukan dan menutupi lalu lintas keluar a nic, ikatan or VLAN antarmuka dengan seorang anak maya antarmuka. Antarmuka ini digunakan untuk perilaku failover stateful di l4xnat profil jika cluster dikonfigurasi.
Daftar antarmuka Mengambang
Daftar antarmuka Mengambang
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/floating
GET /interfaces/floating
Tampilkan semua availables atau antarmuka yang dikonfigurasi di mana IP mengambang telah dibuat.
Contoh respons:
{
"description" : "List floating interfaces",
"params" : [
{
"floating_ip" : null,
"interface" : "bondiface"
},
{
"floating_ip" : "192.168.100.199",
"interface" : "eth0"
},
{
"floating_ip" : null,
"interface" : "eth0.1"
},
{
"floating_ip" : null,
"interface" : "eth1"
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array objek antarmuka mengambang:
Mengambang obyek:
Bidang | Tipe | Deskripsi |
---|---|---|
floating_ip | Tali | IP Apung digunakan di antarmuka. floating_ip harus ada sebagai anak antarmuka virtual dari antarmuka. |
antarmuka | Tali | Antarmuka ditutupi oleh IP mengambang. |
Ambil antarmuka Mengambang
Ambil antarmuka Mengambang
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/floating/eth0
GET /interfaces/floating/<name>
Ditampilkan jika antarmuka memiliki IP mengambang yang dikonfigurasi. Jika sudah dikonfigurasi, akan ditampilkan di sini.
nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.
Contoh respons:
{
"description" : "Show floating interface",
"params" : {
"floating_ip" : "192.168.100.199",
"interface" : "eth0"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
floating_ip | Tali | IP Apung digunakan di antarmuka. floating_ip harus ada sebagai anak antarmuka virtual dari antarmuka. |
antarmuka | Tali | Antarmuka ditutupi oleh IP mengambang. |
Ubah antarmuka Mengambang
Ubah antarmuka Mengambang
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"floating_ip":"192.168.100.199"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/floating/eth0
PUT /interfaces/floating/<name>
Konfigurasikan IP mengambang untuk antarmuka NIC, bonding atau VLAN.
nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
floating_ip | Tali | IP Apung digunakan di antarmuka. floating_ip harus ada sebagai anak antarmuka virtual dari antarmuka. | benar |
Contoh respons:
{
"description" : "Modify floating interface",
"message" : "Floating interface modification done",
"success" : "true"
}
Hapus konfigurasi Floating
Hapus konfigurasi Floating
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/floating/eth0
DELETE /interfaces/floating/<name>
Hapus konfigurasi IP mengambang dalam sebuah antarmuka.
nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.
Contoh respons:
{
"description" : "Remove floating interface",
"message" : "The floating interface has been removed.",
"success" : "true"
}
Pemantauan - Statistik
Tampilkan informasi tentang sistem dan pertanian. Informasi ini akan berguna untuk memantau status penyeimbang beban Zevenet.
Tampilkan statistik sistem
Tampilkan statistik sistem
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats
GET /stats
Dapatkan statistik sistem global.
Contoh respons:
{
"description" : "System stats",
"params" : {
"cpu" : {
"cores" : 2,
"idle" : 94.42,
"iowait" : 0,
"irq" : 0,
"nice" : 0,
"softirq" : 0,
"sys" : 2.54,
"usage" : 5.58,
"user" : 3.05
},
"date" : "Fri Jan 27 11:40:32 2017",
"hostname" : "api3",
"load" : {
"Last_1" : 1.17,
"Last_15" : 0.36,
"Last_5" : 0.6
},
"memory" : {
"Buffers" : 21.68,
"Cached" : 147.95,
"MemFree" : 348.06,
"MemTotal" : 2005.01,
"MemUsed" : 1656.95,
"SwapCached" : 2.67,
"SwapFree" : 614.38,
"SwapTotal" : 672,
"SwapUsed" : 57.62
},
"network" : {
"bond0 in in" : 234.72,
"bond0 out out" : 0,
"bond0.10 in in" : 0,
"bond0.10 out out" : 0,
"bond1 in in" : 234.72,
"bond1 out out" : 0,
"bond3 in in" : 815.69,
"bond3 out out" : 4300.38,
"eth0 in in" : 2702.29,
"eth0 out out" : 50701.95,
"eth0.2 in in" : 0,
"eth0.2 out out" : 0,
"eth1 in in" : 234.72,
"eth1 out out" : 0,
"eth2 in in" : 234.72,
"eth2 out out" : 0,
"eth3 in in" : 0,
"eth3 out out" : 0,
"eth4 in in" : 436.89,
"eth4 out out" : 4300.38,
"eth4.6 in in" : 0,
"eth4.6 out out" : 0,
"eth5 in in" : 301.39,
"eth5 out out" : 0,
"eth5.5 in in" : 0,
"eth5.5 out out" : 0,
"eth6 in in" : 77.42,
"eth6 out out" : 0
}
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
cpu | obyek | Statistik CPU. |
tanggal | Tali | Tanggal sistem. |
hostname | Tali | Nama tuan rumah. |
memuat | obyek | Statistik beban inti. |
ingatan | obyek | Statistik memori yang digunakan. |
jaringan | obyek | Statistik lalu lintas jaringan. |
Objek CPU:
Bidang | Tipe | Deskripsi |
---|---|---|
warna | Jumlah | Jumlah inti dalam prosesor. |
siaga | Jumlah | CPU tidak digunakan oleh program apa pun. |
iowait | Jumlah | CPU digunakan oleh proses input atau output. |
irq | Jumlah | CPU digunakan oleh gangguan perangkat keras. |
bagus | Jumlah | Prioritas penjadwalan CPU. |
softirq | Jumlah | CPU digunakan oleh gangguan perangkat lunak. |
sys | Jumlah | CPU digunakan oleh sistem. |
pemakaian | Jumlah | Total CPU yang digunakan. |
pemakai | Jumlah | CPU digunakan oleh pengguna. |
Memuat objek:
Bidang | Tipe | Deskripsi |
---|---|---|
Last_1 | Jumlah | Muat sistem persentase pada menit terakhir. |
Last_5 | Jumlah | Muat sistem persentase lima menit yang lalu. |
Last_15 | Jumlah | Muat sistem persentase lima belas menit yang lalu. |
Objek memori.
Bidang | Tipe | Deskripsi |
---|---|---|
Buffer | Jumlah | Ini memori yang digunakan oleh buffer. Jumlah ini ditunjukkan dalam Mb. |
Dalam cache | Jumlah | Ini adalah total memori yang di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
MemFree | Jumlah | Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
MemTotal | Jumlah | Ini total memori ram pada sistem. Jumlah ini ditunjukkan dalam Mb. |
MemUsed | Jumlah | Ini memori yang digunakan oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
SwapCached | Jumlah | Ini adalah total memori cache yang dipesan. |
SwapFree | Jumlah | Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
SwapTotal | Jumlah | Ini memori swap total yang dicadangkan. |
Ditukar | Jumlah | Ini swap memori yang digunakan oleh sistem, pada sistem yang optimal harus 0. |
Objek jaringan:
Bidang | Tipe | Deskripsi |
---|---|---|
di dalam | Jumlah | Input traffic untuk ini antarmuka. |
keluar keluar | Jumlah | Output traffic untuk ini antarmuka. |
Tampilkan statistik jaringan
Tampilkan statistik jaringan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/network
GET /stats/system/network
Dapatkan ringkasan total lalu lintas input dan output melalui antarmuka jaringan.
Contoh respons:
{
"description" : "Network interfaces usage",
"params" : {
"date" : "Fri Jan 27 11:58:05 2017",
"hostname" : "api3",
"interfaces" : [
{
"in" : "234.72",
"interface" : "bond1",
"out" : "0.00"
},
{
"in" : "77.42",
"interface" : "eth6",
"out" : "0.00"
},
{
"in" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
},
{
"in" : "815.69",
"interface" : "bond2",
"out" : "4300.38"
}
]
}
}
Parameter respons
Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kunci followeing:
Bidang | Tipe | Deskripsi |
---|---|---|
tanggal | Tali | Tanggal sistem. |
hostname | Tali | Nama tuan rumah. |
interface | Obyek[] | Statistik lalu lintas jaringan. |
Objek antarmuka
Bidang | Tipe | Deskripsi |
---|---|---|
in | Tali | Total lalu lintas input dalam MB. |
antarmuka | Tali | Nama antarmuka. |
di luar | Tali | Total lalu lintas keluaran dalam MB. |
Tampilkan statistik antarmuka
Tampilkan statistik antarmuka
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/network/interfaces
GET /stats/system/network/interfaces
Dapatkan ringkasan dari setiap antarmuka jaringan.
Contoh respons:
{
"description" : "Interfaces info",
"params" : {
"bond" : [
{
"in" : "234.72",
"interface" : "bond1",
"ip" : "",
"mac" : "3a:3a:a7:e3:33:73",
"out" : "0.00",
"slaves" : [
"eth2"
],
"status" : "down",
"virtual" : [],
"vlan" : []
},
{
"in" : "815.70",
"interface" : "bond3",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "4300.38",
"slaves" : [
"eth4",
"eth5",
"eth6"
],
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "234.72",
"interface" : "bond0",
"ip" : "",
"mac" : "c2:d0:d7:64:df:68",
"out" : "0.00",
"slaves" : [
"eth1"
],
"status" : "down",
"virtual" : [],
"vlan" : [
"bond0.10"
]
}
],
"nic" : [
{
"in" : "77.42",
"interface" : "eth6",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "2704.81",
"interface" : "eth0",
"ip" : "192.168.101.46",
"mac" : "9e:2e:3e:a5:2e:6a",
"out" : "51039.13",
"status" : "up",
"virtual" : [
"eth0:1",
"eth0:2",
"eth0.2:6"
],
"vlan" : [
"eth0.2"
]
},
{
"in" : "234.72",
"interface" : "eth1",
"ip" : "192.168.101.58",
"mac" : "c2:d0:d7:64:df:68",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "234.72",
"interface" : "eth2",
"ip" : "",
"mac" : "3a:3a:a7:e3:33:73",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : []
},
{
"in" : "0.00",
"interface" : "eth3",
"ip" : "192.168.101.72",
"mac" : "16:97:ab:43:87:02",
"out" : "0.00",
"status" : "down",
"virtual" : [
"eth3:1",
"eth3:8",
"eth3:6"
],
"vlan" : []
},
{
"in" : "436.89",
"interface" : "eth4",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "4300.38",
"status" : "up",
"virtual" : [
"eth4.6:5"
],
"vlan" : [
"eth4.6"
]
},
{
"in" : "301.39",
"interface" : "eth5",
"ip" : "",
"mac" : "ea:00:7d:88:1d:bd",
"out" : "0.00",
"status" : "up",
"virtual" : [],
"vlan" : [
"eth5.5"
]
}
]
}
}
Parameter respons
Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kunci ikatan dan nic.
Bidang | Tipe | Deskripsi |
---|---|---|
ikatan | Obyek[] | Statistik antarmuka ikatan. |
nic | Obyek[] | Statistik antarmuka NIC. |
Objek ikatan:
Bidang | Tipe | Deskripsi |
---|---|---|
in | Tali | Total lalu lintas input dalam MB. |
antarmuka | Tali | Nama antarmuka digunakan sebagai pengidentifikasi unik. |
ip | Tali | IP antarmuka. |
mac | Tali | MAC antarmuka. |
di luar | Tali | Total lalu lintas keluaran dalam MB. |
budak | String [] | Daftar budak yang membangun antarmuka ikatan. |
status | Tali | Status antarmuka. Nilainya bisa turun, antarmuka dinonaktifkan; up, antarmuka diaktifkan. |
maya | String [] | Antarmuka virtual yang mewarisi dari antarmuka ini. |
vlan | String [] | Antarmuka VLAN yang mewarisi dari antarmuka ini. |
Objek Nic:
Bidang | Tipe | Deskripsi |
---|---|---|
in | Tali | Total lalu lintas input dalam MB. |
antarmuka | Tali | Nama antarmuka digunakan sebagai pengidentifikasi unik. |
ip | Tali | IP antarmuka. |
mac | Tali | MAC antarmuka. |
di luar | Tali | Total lalu lintas keluaran dalam MB. |
status | Tali | Status antarmuka. Nilainya bisa turun, antarmuka dinonaktifkan; up, antarmuka diaktifkan. |
maya | String [] | Antarmuka virtual yang mewarisi dari antarmuka ini. |
vlan | String [] | Antarmuka VLAN yang mewarisi dari antarmuka ini. |
Tampilkan statistik memori
Tampilkan statistik memori
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/memory
GET /stats/system/memory
Dapatkan ringkasan memori sistem.
Contoh respons:
{
"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"
}
}
Parameter respons
Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek memori.
Memori obyek.
Bidang | Tipe | Deskripsi |
---|---|---|
Buffer | Jumlah | Ini memori yang digunakan oleh buffer. Jumlah ini ditunjukkan dalam Mb. |
Dalam cache | Jumlah | Ini adalah total memori yang di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
MemFree | Jumlah | Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
MemTotal | Jumlah | Ini total memori ram pada sistem. Jumlah ini ditunjukkan dalam Mb. |
MemUsed | Jumlah | Ini memori yang digunakan oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
SwapCached | Jumlah | Ini adalah total memori cache yang dipesan. |
SwapFree | Jumlah | Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb. |
SwapTotal | Jumlah | Ini memori swap total yang dicadangkan. |
Ditukar | Jumlah | Ini swap memori yang digunakan oleh sistem, pada sistem yang optimal harus 0. |
tanggal | Tali | Tanggal sistem. |
hostname | Tali | Nama tuan rumah. |
Tampilkan statistik muat
Tampilkan statistik muat
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/load
GET /stats/system/load
Dapatkan ringkasan dari beban sistem CPU.
Contoh respons:
{
"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"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
Last_1 | Jumlah | Muat penggunaan sistem yang terakhir. |
Last_5 | Jumlah | Muat penggunaan sistem lima menit terakhir. |
Last_15 | Jumlah | Muat penggunaan sistem selama lima belas menit terakhir. |
tanggal | Tali | Tanggal sistem. |
hostname | Tali | Nama tuan rumah. |
Tampilkan statistik CPU
Tampilkan statistik CPU
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/cpu
GET /stats/system/cpu
Contoh respons:
{
"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
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
warna | Jumlah | Jumlah inti dalam prosesor. |
siaga | Jumlah | CPU tidak digunakan oleh program apa pun. |
iowait | Jumlah | CPU digunakan oleh proses input atau output. |
irq | Jumlah | CPU digunakan oleh gangguan perangkat keras. |
bagus | Jumlah | Prioritas penjadwalan CPU. |
softirq | Jumlah | CPU digunakan oleh gangguan perangkat lunak. |
sys | Jumlah | CPU digunakan oleh sistem. |
pemakaian | Jumlah | Total CPU yang digunakan. |
pemakai | Jumlah | CPU digunakan oleh pengguna. |
tanggal | Tali | Tanggal sistem. |
hostname | Tali | Nama tuan rumah. |
Tampilkan statistik koneksi
Tampilkan statistik koneksi
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/system/connections
GET /stats/system/connections
Dapatkan total koneksi saat ini dalam sistem. Penghitung menjumlahkan semua jenis koneksi terlacak: ASSURED, ESTABLISHED, SYN_SENT, TIME_WAIT, LISTEN…
Contoh respons:
{
"description" : "System connections",
"params" : {
"connections" : 324
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
koneksi | Jumlah | Total koneksi yang terlacak sebenarnya. |
Tampilkan jumlah peternakan
Tampilkan jumlah peternakan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/farms/total
GET /stats/farms/total
Tampilkan total kebun yang dibuat dalam sistem.
Contoh respons:
{
"description" : "Number of farms.",
"number" : 8
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
jumlah | Jumlah | Ini adalah jumlah pertanian yang ada dalam sistem. |
Tampilkan statistik peternakan
Tampilkan statistik peternakan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/farms
GET /stats/farms
Dapatkan ringkasan koneksi dan konfigurasi untuk semua tambak di sistem.
Contoh respons:
{
"description" : "List all farms stats",
"farms" : [
{
"established" : 0,
"farmname" : "testHttps",
"pending" : 0,
"profile" : "https",
"status" : "up",
"vip" : "192.168.101.20",
"vport" : "120"
},
{
"established" : 0,
"farmname" : "httpFarm",
"pending" : 0,
"profile" : "http",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "8080"
},
{
"established" : 0,
"farmname" : "testDL",
"pending" : 0,
"profile" : "datalink",
"status" : "up",
"vip" : "192.168.102.72",
"vport" : "eth1"
},
{
"established" : 0,
"farmname" : "testL4",
"pending" : 0,
"profile" : "l4xnat",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "30"
},
{
"established" : 0,
"farmname" : "testGSLB",
"pending" : 0,
"profile" : "gslb",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "53"
}
]
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
mapan | Jumlah | Jumlah total koneksi yang ada saat ini. |
nama pertanian | Tali | Nama pertanian, pengidentifikasi unik. |
tertunda | Jumlah | Jumlah koneksi yang tertunda. |
profil | Tali | Jenis pertanian. Nilai yang mungkin adalah: datalink, l4xnat, http, https or gslb. Setiap profil didefinisikan di bagiannya. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up, pertanian sedang berjalan; turun, peternakan dihentikan atau diperlukan restart, tambak perlu dimulai kembali agar perubahan terbaru berlaku. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. |
Tampilkan statistik pertanian
Tampilkan statistik pertanian
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/farms/farmname
GET /stats/farms/<farmname>
Menunjukkan status peternakan saat ini, status backend dan koneksi mereka. Setiap tambak akan merespons dengan objek yang berbeda, tergantung pada profilnya.
Contoh respons untuk layanan 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"
}
]
}
Parameter respons di ladang HTTP
Bidang | Tipe | Deskripsi |
---|---|---|
backends | Obyek[] | Tampilkan informasi tentang backend. |
sesi | Obyek[] | Tampilkan informasi tentang sesi. |
Objek Backend
Bidang | Tipe | Deskripsi |
---|---|---|
mapan | Jumlah | Jumlah total koneksi yang dibangun. |
id | Jumlah | Backend pengidentifikasi unik. |
ip | Tali | IP tempat layanan sebenarnya mendengarkan. |
tertunda | Jumlah | Jumlah koneksi yang tertunda. |
pelabuhan | Jumlah | Port tempat layanan sebenarnya mendengarkan. |
layanan | Tali | Nama layanan digunakan sebagai pengidentifikasi unik. |
status | Tali | Status backend. Nilai yang mungkin adalah: up, backend siap menerima koneksi; turun, layanan telah mendeteksi bahwa backend tidak berfungsi; fgDOWN, penjaga pertanian telah menonaktifkan backend karena pemeriksaan penjaga pertanian tidak berhasil; pemeliharaan, backend ditandai sebagai tidak siap untuk menerima koneksi oleh administrator, opsi ini berguna untuk tugas pemeliharaan backend. |
Objek Sesi
Bidang | Tipe | Deskripsi |
---|---|---|
klien | Tali | Pengidentifikasi unik klien. |
id | Tali | Backend pengidentifikasi unik yang ditugaskan untuk klien. |
layanan | Tali | Pengidentifikasi unik layanan yang diberikan kepada klien. |
Sidang | Tali | Sesi pengidentifikasi unik. Nilai ini tergantung dari jenis ketekunan. |
Contoh respons untuk kebun GSLB:
{
"backends" : [
{
"id" : 1,
"ip" : "127.0.0.1",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 2,
"ip" : "192.168.55.40",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 4,
"ip" : "192.135.10.2",
"port" : 53,
"service" : "service1",
"status" : "down"
},
{
"id" : 1,
"ip" : "127.0.0.1",
"port" : 80,
"service" : "prioServ",
"status" : "down"
},
{
"id" : 2,
"ip" : "127.0.0.1",
"port" : 80,
"service" : "prioServ",
"status" : "down"
}
],
"client" : {
"edns_big" : 0,
"edns_tc" : 0,
"recvfail" : 0,
"reqs" : 0,
"sendfail" : 0,
"tc" : 0
},
"description" : "List farm stats",
"extended" : {
"badvers" : 0,
"dropped" : 0,
"edns" : 0,
"edns_clientsub" : 0,
"formerr" : 0,
"noerror" : 0,
"notimp" : 0,
"nxdomain" : 0,
"refused" : 0,
"v6" : 0
},
"server" : {
"recvfail" : 0,
"reqs" : 0,
"sendfail" : 0
}
}
Parameter respons di peternakan GSLB
Bidang | Tipe | Deskripsi |
---|---|---|
backends | Obyek[] | Tampilkan informasi tentang backend. |
klien | obyek | Statistik yang terkait dengan klien. |
luas | obyek | Informasi tambahan tentang layanan ini. |
Server | obyek | Statistik terkait dengan server. |
Objek backend
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Backend pengidentifikasi unik. |
ip | Tali | IP tempat layanan sebenarnya mendengarkan. |
pelabuhan | Jumlah | Port tempat layanan sebenarnya mendengarkan. |
layanan | Tali | Nama layanan digunakan sebagai pengidentifikasi unik. |
status | Tali | Status backend. Nilai yang mungkin adalah: up, backend siap menerima koneksi; turun, layanan telah mendeteksi bahwa backend tidak berfungsi; pemeliharaan, backend ditandai sebagai tidak siap untuk menerima koneksi oleh administrator, opsi ini berguna untuk tugas pemeliharaan backend. |
Objek klien
Bidang | Tipe | Deskripsi |
---|---|---|
edns_big | Jumlah | Respons yang lebih besar dari 512 byte. |
edns_tc | Jumlah | Ukuran buffer dns diperpanjang yang ditentukan klien terlalu kecil untuk data yang diminta. |
penerimaan | Jumlah | Jumlah kesalahan UDP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi saat menerima. |
reqs | Jumlah | Jumlah total permintaan UDP yang ditangani oleh server. |
sendfail | Jumlah | Jumlah kesalahan UDP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi pada pengiriman. |
tc | Jumlah | Respons yang terpotong dengan set bit TC. |
Objek diperpanjang
Bidang | Tipe | Deskripsi |
---|---|---|
penjahat | Jumlah | Permintaan yang memiliki EDNS OPT-RR dengan versi yang tidak didukung. |
menjatuhkan | Jumlah | Permintaan yang dibatalkan untuk format yang salah. |
edn | Jumlah | Permintaan berisi EDNS OPT-RR. |
edns_clientsub | Jumlah | Subset permintaan edns yang menentukan opsi edns_client_subnet. |
mantan | Jumlah | Permintaan diformat dengan buruk, tetapi cukup waras sehingga kami mengirim respons dengan FORMERR rcode. |
noerror | Jumlah | Permintaan yang berhasil. |
notimp | Jumlah | Layanan yang diminta tidak diterapkan oleh daemon ini, seperti permintaan transfer zona. |
nxdomain | Jumlah | Permintaan untuk nama domain yang tidak ada. |
menolak | Jumlah | Permintaan ditolak oleh server karena server tidak berwenang untuk nama yang ditanyakan. |
v6 | Jumlah | Permintaan dari klien IPv6. |
Objek server
Bidang | Tipe | Deskripsi |
---|---|---|
penerimaan | Jumlah | Jumlah kesalahan TCP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi saat menerima. |
reqs | Jumlah | Jumlah total permintaan TCP yang ditangani oleh server. |
sendfail | Jumlah | Jumlah kesalahan TCP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi pada pengiriman. |
Contoh respons untuk tambak 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" : "fgDOWN"
},
{
"established" : null,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats"
}
Parameter respons di peternakan L4xNAT
Respons akan menjadi JSON dengan kunci backends dan nilai array objek dengan parameter di bawah ini.
Objek backend:
Bidang | Tipe | Deskripsi |
---|---|---|
mapan | Jumlah | Jumlah total koneksi yang ada saat ini. |
id | Jumlah | Backend pengidentifikasi unik. |
ip | Tali | IP tempat layanan sebenarnya mendengarkan. |
tertunda | Jumlah | Jumlah koneksi yang tertunda. |
pelabuhan | Jumlah | Port tempat layanan sebenarnya mendengarkan. |
status | Tali | Status backend. Nilai yang mungkin adalah: up, backend siap menerima koneksi; fgDOWN, wali pertanian telah mendeteksi bahwa backend tidak berfungsi; pemeliharaan, backend ditandai sebagai tidak siap untuk menerima koneksi oleh administrator, opsi ini berguna untuk tugas pemeliharaan backend. |
Parameter respons di peternakan datalink
Statistik peternakan Datalink sebenarnya tidak tersedia.
Tampilkan status modul
Tampilkan status modul
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/farms/modules
GET /stats/farms/modules
Dapatkan ringkasan statistik modul. Panggilan ini menunjukkan setiap status modul, jumlah yang dikonfigurasi, jumlah peternakan yang diletakkan dan naik.
Definisi tentang modul ada di Pertanian bagian.
Contoh respons:
{
"description" : "Module status",
"params" : {
"dslb" : {
"down" : 1,
"total" : 2,
"up" : 1
},
"gslb" : {
"down" : 0,
"total" : 1,
"up" : 1
},
"lslb" : {
"down" : 2,
"total" : 4,
"up" : 2
}
}
}
Parameter respons
Respons akan menjadi JSON dengan tiga kunci: dslb, gslb dan lslb.
Bidang | Tipe | Deskripsi |
---|---|---|
turun | Jumlah | Jumlah peternakan yang dihentikan. Peternakan ini dihentikan oleh administrator sistem. |
total | Jumlah | Jumlah total pertanian. |
up | Jumlah | Jumlah peternakan yang beroperasi. |
Tampilkan statistik modul
Tampilkan statistik modul
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/stats/farms/modules/lslb
GET /stats/farms/modules/<module>
Tampilkan statistik peternakan dari modul yang ditentukan.
Nilai yang tersedia untuk modul parameternya adalah: lslb, gslb or dslb.
Contoh respons:
{
"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"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan informasi tentang tambak dalam modul.
Bidang | Tipe | Deskripsi |
---|---|---|
mapan | Jumlah | Jumlah total koneksi yang ada saat ini. |
nama pertanian | Tali | Nama pertanian, pengidentifikasi unik untuk peternakan. |
tertunda | Jumlah | Jumlah koneksi yang tertunda. |
profil | Tali | Jenis pertanian. Nilai yang mungkin adalah: datalink, l4xnat, http, https or gslb. Setiap profil didefinisikan sendiri bagian. |
status | Tali | Status pertanian. Nilai yang mungkin adalah: up, pertanian sedang berjalan; turun, peternakan dihentikan atau diperlukan restart, tambak perlu dimulai kembali agar perubahan terbaru berlaku. |
vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. |
Pemantauan - Grafik
Bagian ini berguna untuk memantau sistem penyeimbang beban internal untuk mendeteksi masalah melalui parameter penggunaan CPU, memori swap, memori ram, semua antarmuka kerja baru yang dikonfigurasi, penyimpanan beban dan hard disk.
Selain itu, Anda dapat mengakses riwayat mingguan, ngengat, dan tahunan.
Grafik dengan informasi dijawab dalam format base64.
Daftar grafik yang tersedia
Daftar grafik yang tersedia
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs
GET /graphs
Tampilkan objek dengan semua grafik yang tersedia di sistem. Ini menunjukkan kemungkinan permintaan yang dapat dibuat.
Contoh respons:
{
"description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
"farms" : [
"l4farm",
"newfarm",
"gslbfarm",
"nwl4farm",
"httpweb"
],
"interfaces" : [
"eth0.1",
"eth2",
"eth1",
"eth3",
"bondiface",
"eth0"
],
"system" : [
"cpu",
"load",
"ram",
"swap",
{
"disk" : [
"root/",
"root/boot",
"root/usr/local/zenloadbalancer/config",
"root/var/log"
]
}
]
}
Parameter respons
Responsnya akan menjadi JSON tiga jenis grafik, peternakan, interface dan sistem.
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar grafik pertanian tersedia. |
interface | Tali[] | Daftar grafik antarmuka yang tersedia. |
sistem | Obyek[] | Daftar grafik sistem yang tersedia. Array memiliki objek dengan array yang menunjukkan titik pemasangan disk. |
Objek sistem:
Objek sistem berisi daftar array yang terkait dengan sistem, dan objek disk dengan format berikutnya.
Bidang | Tipe | Deskripsi |
---|---|---|
cakram | Tali[] | Nilai array ini semuanya ada mount point dalam sistem, masing-masing memiliki grafik yang tersedia. |
Tampilkan grafik
Tampilkan grafik
Minta contoh untuk tambak:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/farms/httpweb
Contoh permintaan untuk antarmuka:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/interfaces/eth3
Minta contoh untuk disk:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/system/disk/root/boot
GET /graphs/<graph>
Nilai yang tersedia untuk grafik adalah:
Nilai | Deskripsi |
---|---|
farms/<farmname> |
nama pertanian, tandai pengidentifikasi unik. |
interfaces/<interface> |
antarmuka, antarmuka pengidentifikasi unik. |
system/<system> |
sistem, kemungkinan grafik sistem adalah: cpu, memuat, ram or menukar. |
system/disk/<mount point> |
titik mount, adalah nilai cakram objek, dikembalikan oleh panggilan 'GET / graphs'. |
Contoh respons:
{
"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"
}
]
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
frekuensi | Tali | Periode waktu yang digunakan untuk menghasilkan grafik. Nilai yang mungkin adalah: harian, mingguan, bulanan or tahunan. |
grafik | Tali | Grafik dalam format 64 dasar. |
Tampilkan grafik frekuensi
Tampilkan grafik frekuensi
Minta contoh untuk tambak:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/farms/httpweb/daily
Contoh permintaan untuk antarmuka:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/interfaces/eth3/monthly
Minta contoh untuk disk:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/graphs/system/disk/root/boot/yearly
GET /graphs/<graph>/<frequency>
Nilai yang tersedia untuk grafik adalah:
Nilai | Deskripsi |
---|---|
farms/<farmname> |
nama pertanian, tandai pengidentifikasi unik. |
interfaces/<interface> |
antarmuka, antarmuka pengidentifikasi unik. |
system/<system> |
sistem, kemungkinan grafik sistem adalah: cpu, memuat, ram or menukar. |
system/disk/<mount point> |
titik mount, adalah nilai cakram objek, dikembalikan oleh panggilan 'GET / graphs'. |
Nilai yang tersedia untuk frekuensi adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
frekuensi | Tali | Periode waktu yang digunakan untuk menghasilkan grafik. Nilai yang mungkin adalah: harian, mingguan, bulanan or tahunan. |
Contoh respons:
{
"description" : "Get farm graphs",
"graph" : "PNG IN BASE 64"
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
grafik | Tali | Grafik dalam format 64 dasar. |
IPDS
Modul ini merupakan implementasi dari a IPS (Sistem Pencegahan Intrusi) dan IDS (Intrusion Detection System) sistem untuk menawarkan kepada pengguna lapisan keamanan. Modul IPDS memeriksa lalu lintas sebelum mencapai modul Load Balancing LSLB or GSLB, jika lalu lintas terdeteksi sebagai berbahaya maka akan ditolak.
Ia bekerja menerapkan aturan keamanan ke sistem yang akan didefinisikan sebagai objek yang berbeda sifatnya. Masing-masing menawarkan solusi untuk tindakan berbahaya atau mencurigakan eksternal. Alat ini membantu administrator sistem yang mengendalikan ancaman dan serangan.
Aturan yang tersedia untuk diterapkan pada Zevenet dapat berupa daftar hitam dan DoS.
IPDS - Daftar Hitam
Daftar hitam memungkinkan pengguna untuk menggunakan daftar untuk menyaring atau mengizinkan lalu lintas sesuai dengan IP sumber (Lalu lintas incomming).
Ada dua jenis daftar:
- Jarak jauh: Daftar diperoleh dari URL, daftar itu tidak dapat dimodifikasi dan dapat dijadwalkan untuk diunduh.
- Lokal: Pengguna dapat membuat daftar sendiri dengan kebijakan yang diberikan, menyangkal jika IP incomming cocok maka lalu lintas akan ditolak atau mengizinkan jika IP incomming cocok maka lalu lintas akan diizinkan.
Modul ini termasuk sudah dimuat daftar yang disediakan oleh tim Zevenet, daftar siap diterapkan ke peternakan. Secara tradisional, pengguna dapat membuat daftar pribadi mereka sendiri.
Beberapa daftar dapat diterapkan ke tambak yang sama, jika IP sumber cocok dengan beberapa daftar, lalu lintas akan diizinkan atau ditolak tergantung dari kebijakan daftar hitam. Pada saat IP cocok maka tidak ada lagi cek daftar hitam yang dilakukan untuk IP sumber.
Jika IP sumber ada dalam dua daftar yang berbeda menyangkal dan mengizinkan, maka selalu kebijakan izin dievalusi terlebih dahulu.
Daftar semua aturan daftar hitam
Daftar semua daftar hitam
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists
GET /ipds/blacklists
Daftar semua daftar hitam yang dibuat oleh pengguna atau dimuat dalam sistem yang dapat diterapkan ke peternakan.
Contoh respons:
{
"description" : "Get black lists",
"params" : [
{
"farms" : [],
"name" : "china",
"policy" : "deny",
"preload" : "true",
"type" : "local"
},
{
"farms" : [],
"name" : "russia",
"policy" : "deny",
"preload" : "true",
"type" : "local"
},
{
"farms" : [],
"name" : "northkorea",
"policy" : "deny",
"preload" : "true",
"type" : "local"
},
{
"farms" : [
"FarmHttp1",
"FarmGslb1",
],
"name" : "remoteList",
"policy" : "deny",
"preload" : "false",
"type" : "remote"
},
{
"farms" : [],
"name" : "myWhiteList",
"policy" : "allow",
"preload" : "false",
"type" : "local"
},
]
}
Parameter respons
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array objek daftar hitam, yang masing-masing berisi atribut kunci di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar tambak tempat daftar hitam diterapkan. |
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
preload | Tali | Nilai yang mungkin adalah: benar, daftar hitam telah dimuat dalam sistem; atau palsu, daftar hitam telah dibuat oleh administrator sistem. |
mengetik | Tali | Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan di sistem lokal dan dapat dimodifikasi secara lokal, atau terpencil, daftar diunduh dari sumber jarak jauh melalui a url, Ini tidak dapat dimodifikasi secara lokal sehingga modifikasi perlu dilakukan di sumber jarak jauh. |
Ambil aturan daftar hitam
Ambil daftar hitam
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/loc
GET /ipds/blacklists/<name>
Tampilkan parameter konfigurasi dan deskripsi daftar hitam. nama adalah pengidentifikasi unik daftar hitam.
Parameter respons
Contoh daftar respons lokal:
{
"description" : "Get list loc",
"params" : {
"farms" : [],
"name" : "loc",
"policy" : "deny",
"preload" : "false",
"sources" : [
{
"id" : 0,
"source" : "192.168.0.167"
},
{
"id" : 1,
"source" : "192.168.0.186"
}
],
"type" : "local"
}
}
Objek daftar hitam lokal:
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar tambak tempat daftar hitam diterapkan. |
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
preload | Tali | Nilai yang mungkin adalah: benar, daftar hitam telah dimuat dalam sistem; atau palsu, daftar hitam telah dibuat oleh sistem administrator. |
mengetik | Tali | Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan dikelola oleh administrator sistem; atau terpencil, daftar diunduh dari url jarak jauh. |
sumber | Obyek[] | Daftar IP yang dicek daftar. Format jaringan sumber diterima: Alamat jaringan / Mask sedikit atau IP |
Contoh daftar respons jarak jauh:
{
"description" : "Get list remoteList",
"params" : {
"day" : "thursday",
"farms" : [
"FarmHttp1",
"FarmGslb1",
],
"frequency" : "weekly",
"name" : "remoteList",
"policy" : "deny",
"sources" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
}
],
"time" : {
"hour" : 0,
"minutes" : 0
},
"update_status" : "This list isn't downloaded yet.",
"type" : "remote",
"url" : "http://192.168.10.10/lists/test.txt"
}
}
Objek daftar hitam jarak jauh:
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar tambak tempat daftar hitam diterapkan. |
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
preload | Tali | Nilai yang mungkin adalah: benar, daftar hitam telah dimuat dalam sistem; atau palsu, daftar hitam telah dibuat oleh sistem administrator. |
mengetik | Tali | Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan dikelola oleh administrator sistem; atau terpencil, daftar diunduh dari jarak jauh url. |
sumber | Obyek[] | Sumber IP yang dicek daftar. Jika daftar adalah mengetik terpencil maka konten daftar tidak ditampilkan sampai unduhan pertama. |
memperbaharui status | Tali | Status unduhan terakhir dari daftar dan tanggal pembaruan terakhir yang berhasil di sistem lokal. |
url | Tali | Dari mana daftar jarak jauh diunduh. Format jarak jauh harus berupa daftar sumber network / bit mask atau IP per line. |
frekuensi | Tali | Frekuensi pembaruan daftar jauh. Opsinya adalah: harian, perbarui semua hari, sekali atau secara berkala, ini ditunjukkan dalam jenis frekuensi bidang; mingguan, perbarui seminggu sekali; atau bulanan, perbarui sebulan sekali. |
jenis frekuensi | Tali | Parameter ini melengkapi frekuensi setiap hari saat nilainya harian. Nilai yang mungkin adalah: tepat. tentukan satu jam dalam sehari; atau periode, tentukan periode waktu untuk memperbarui di siang hari. |
hari | String atau Angka | Parameter ini melengkapi parameter frekuensi ketika Frecuency Nilai adalah mingguan or bulanan. Jika Frecuency is mingguan parameter ini harus aday of the week (Senin, Selasa, Rabu, Kamis, Jumat, Sabtu or Minggu) jika frekuensi Nilai adalah bulanan maka parameter ini harus berupa hari dalam sebulan (angka di antaranya 1 dan 31). |
waktu | obyek | Ini adalah struct yang bergantung pada bidang frekuensi. |
Objek waktu untuk frekuensi harian dan frequency_type periode
Bidang | Tipe | Deskripsi |
---|---|---|
periode | Jumlah | Seberapa sering daftar diperbarui. |
satuan | Tali | Unit periode. Opsinya adalah: menit, menunjukkan daftar akan diperbarui setiap menit yang dikonfigurasi; atau jam, daftar akan diperbarui setiap jam yang dikonfigurasi. |
Objek waktu untuk frekuensi lain
Bidang | Tipe | Deskripsi |
---|---|---|
jam | Jumlah | Jam untuk memperbarui daftar. Nilai harus berupa angka di antara 0 dan 23. |
menit | Jumlah | Beberapa menit untuk memperbarui daftar. Nilai harus berupa angka di antara 0 dan 59. |
Sumber objek
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Sumber pengidentifikasi unik dalam daftar. |
sumber | Tali | Alamat IP atau segmen bersih yang dicek daftar. |
Buat aturan daftar hitam
Buat daftar hitam baru
Minta contoh untuk daftar lokal:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListLoc", "type":"local", "policy":"allow"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists
Contoh permintaan untuk daftar jarak jauh:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListRem", "type":"remote", "url":"https://192.168.10.12/lists/test.txt"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists
POST /ipds/blacklists
Buat daftar hitam untuk digunakan di peternakan. Daftar hitam dapat terdiri dari dua jenis:
- Lokal: Sumber ditambahkan oleh pengguna. Daftar ini disimpan secara lokal.
- Remote: Sumber diperoleh dari lokasi yang jauh. Lokasi ini ditunjukkan oleh URL. Format daftar jarak jauh yang didukung adalah satu Alamat jaringan / bit Mask or IP baris per baris.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. | benar |
mengetik | Tali | Di mana daftar disimpan dan siapa yang merawatnya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan pemeliharaan untuk sistem administrasi; atau terpencil, daftar diambil dari layanan keluar melalui a url dan layanan administrator akan memelihara daftar. | benar |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. Nilai default ditolak. | |
url | Tali | Dari mana daftar jarak jauh diunduh. Format jarak jauh harus berupa daftar sumber per baris dalam format Alamat jaringan / bit Mask or IP. | berlaku untuk daftar jarak jauh |
{
"description" : "Post list list1",
"params" : {
"farms" : [],
"name" : "newListLoc",
"policy" : "deny",
"preload" : "false",
"type" : "local"
}
}
Parameter respons
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array objek daftar hitam, yang masing-masing berisi atribut kunci berikutnya.
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar tambak tempat daftar hitam diterapkan. |
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
preload | Tali | Nilai yang mungkin adalah: benar, daftar hitam telah dimuat dalam sistem; atau palsu, daftar hitam telah dibuat untuk administrator sistem. |
mengetik | Tali | Di mana daftar disimpan dan siapa yang merawatnya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan pemeliharaan untuk sistem administrasi; atau terpencil, daftar diambil dari layanan keluar melalui a url dan layanan administrator akan memelihara daftar. |
Ubah aturan daftar hitam
Ubah daftar hitam
Minta contoh untuk daftar lokal:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"policy":"allow","source":["78.12.0.4","68.100.15.5","65.12.12.95"]}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/whiteList
PUT /ipds/blacklists/<name>
Ubah konfigurasi aturan daftar hitam. nama adalah pengidentifikasi unik daftar hitam.
Parameter permintaan untuk daftar lokal:
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. Hanya itu dimodifikasi pada no preload daftar. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
sumber | Tali[] | Ini adalah daftar alamat IP atau segmen bersih yang diperiksa daftar. Untuk mengubah, ubah hanya sumber, lihat bagian dokumentasi IPDS> Daftar Hitam> Ubah sumber daftar hitam. Sumber saja dimodifikasi pada no preload daftar. |
Contoh respons:
{
"description" : "Modify list whiteList.",
"params" : {
"name" : "whiteList",
"policy" : "allow",
"preload" : "false",
"type" : "local"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Contoh permintaan untuk daftar jarak jauh:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"remoteList","url":"http://192.168.10.10/lists/test.txt","policy":"deny","frequency":"daily","frequency_type":"exact","time":{"hour":1,"minutes":0}}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem
Minta contoh untuk memperbarui daftar setiap jam 2:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"daily","frequency_type":"period","time":{"period":2,"units":"hours"}}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem
Minta contoh untuk memperbarui daftar sepanjang hari di 2: 00 AM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"daily","frequency_type":"exact","time":{"hour":2,"minutes":0}}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem
Minta contoh untuk memperbarui semua Senin di 0: 00 AM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"weekly","day":"monday","time":{"hour":0,"minutes":0}}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem
Minta contoh untuk memperbarui hari 1 bulan di 12: 00 PM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"monthly","day":"1","time":{"hour":12,"minutes":0}}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem
Parameter permintaan untuk daftar jarak jauh
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Daftar tambak tempat daftar hitam diterapkan. |
nama | Tali | Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. |
kebijaksanaan | Tali | Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. |
url | Tali | Dari mana daftar jarak jauh diunduh. |
frekuensi | Tali | Frekuensi pembaruan daftar jauh. Opsinya adalah: harian, perbarui semua hari, sekali atau berkala, ini ditunjukkan dalam jenis frekuensi bidang; mingguan, perbarui seminggu sekali; atau bulanan, perbarui sebulan sekali. |
jenis frekuensi | Tali | Parameter ini melengkapi frekuensi setiap hari saat nilainya harian. Nilai yang mungkin adalah: tepat. tentukan satu jam dalam sehari; atau periode, tentukan periode waktu untuk memperbarui di siang hari. |
hari | String atau Angka | Parameter ini melengkapi frekuensi ketika nilainya mingguan atau bulanan. Jika mingguan, parameter ini harus satu hari seminggu (Senin, Selasa, Rabu, Kamis, Jumat, Sabtu or Minggu) kalau tidak frekuensi adalah bulanan maka parameter ini harus satu bulan hari (angka di antara 1 dan 31). |
waktu | obyek | Ini adalah struct yang bergantung pada bidang frekuensi. |
Objek periode waktu
Ini adalah bidang ketika suatu periode waktu akan dikonfigurasi.
Ini adalah konfigurasi yang diperlukan frekuensi dengan nilai harian, dan jenis frekuensi dengan nilai periode.
Bidang | Tipe | Deskripsi |
---|---|---|
periode | Jumlah | Seberapa sering memperbarui daftar. |
satuan | Tali | Unit periode. Opsinya adalah: menit or jam, menunjukkan unit pengukuran untuk pembaruan daftar. |
Waktu yang tepat objek jam
Ini adalah bidang ketika waktu jam yang tepat akan dikonfigurasi.
Objek ini digunakan dengan konfigurasi selanjutnya:
frekuensi bidang memiliki nilai harian dan jenis frekuensi is tepat.
frekuensi bidang memiliki nilai mingguan dan hari adalah hari minggu ketika daftar diperbarui.
frekuensi bidang memiliki nilai bulanan dan hari adalah jumlah hari bulan ketika daftar diperbarui.
Bidang | Tipe | Deskripsi |
---|---|---|
jam | Jumlah | Jam untuk memperbarui daftar. Nilai harus berupa angka di antara 0 dan 23. |
menit | Jumlah | Beberapa menit untuk memperbarui daftar. Nilai harus berupa angka di antara 0 dan 59. |
Contoh respons:
{
"description" : "Modify list newListRem.",
"params" : {
"day": 1,
"frequency" : "monthly",
"name" : "newListRem",
"policy" : "deny",
"preload" : "false",
"time" : {
"hour" : 12,
"minutes" : 0
},
"type" : "remote",
"update_status" : "Sync fail. Last update: 2017-02-16 14:23:00",
"url" : "https://192.168.10.12/lists/test.txt"
}
}
Parameter respons
Respons akan menjadi json dengan semua konfigurasi daftar. Lihat contoh respons untuk informasi lebih lanjut.
Perbarui aturan blacklist jarak jauh
Perbarui daftar hitam jarak jauh
Contoh permintaan untuk daftar jarak jauh:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"update"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/remoteList/actions
POST /ipds/blacklists/<name>/actions
Perbarui daftar jarak jauh, unduh sumbernya. nama adalah pengidentifikasi unik daftar hitam.
Parameter permintaan untuk daftar jarak jauh
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk mengirim ke daftar. Parameter ini harus memperbarui. | benar |
Contoh respons:
{
"description" : "Update a remote list",
"update" : "Sync OK. Last update: 2017-02-01 05:31:57"
}
Parameter respons
Responsnya akan menjadi json dengan status unduhan. Lihat contoh respons untuk informasi lebih lanjut.
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
memperbarui | Tali | Status unduhan terakhir dari daftar dan tanggal pembaruan terakhir yang berhasil. |
Hapus aturan daftar hitam
Hapus daftar blacklist
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/remoteList
DELETE /ipds/blacklists/<name>
Hapus daftar hitam yang diberikan. nama adalah pengidentifikasi unik daftar hitam.
Contoh respons:
{
"description" : "Delete list 'remoteList'",
"message" : "The list remoteList has been deleted successful.",
"success" : "true"
}
Daftar sumber dari daftar hitam
Daftar sumber dari daftar hitam
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList
GET /ipds/blacklists/<name>/sources
Daftar sumber daftar hitam. nama adalah pengidentifikasi unik daftar hitam.
Contoh respons:
{
"description" : "Get localList sources",
"params" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
}
]
}
Parameter respons
Respons akan menjadi JSON dengan kunci params dan sumber objek array sebagai nilai.
Sumber objek:
Bidang | Tipe | Deskripsi |
---|---|---|
id | Jumlah | Sumber pengidentifikasi unik dalam daftar. |
sumber | Tali[] | Alamat IP atau segmen bersih yang dicek daftar. |
Tambahkan sumber ke daftar hitam
Tambahkan sumber ke daftar hitam
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources
POST /ipds/blacklists/<name>/sources
Dorong sumber baru ke daftar hitam. Hanya tersedia untuk daftar lokal dan daftar yang tidak dimuat. nama adalah pengidentifikasi unik daftar hitam.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
sumber | Tali | Alamat IP atau segmen bersih yang dicek daftar. | benar |
Contoh respons:
{
"description" : "Post source to localList.",
"message" : "Added 192.168.3.1 successful.",
"params" : [
{
"id" : 0,
"source" : "78.12.0.4"
},
{
"id" : 1,
"source" : "68.100.15.5"
},
{
"id" : 2,
"source" : "65.12.12.95"
},
{
"id" : 3,
"source" : "192.168.3.1"
}
]
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah sumber daftar hitam
Ubah sumber daftar hitam
Contoh permintaan:
curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources/2
PUT /ipds/blacklists/<name>/sources/<id>
Ubah sumber daftar hitam.
nama adalah pengidentifikasi unik daftar hitam. id adalah pengidentifikasi unik sumber.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
sumber | Tali | Alamat IP atau segmen bersih yang dicek daftar. | benar |
Contoh respons:
{
"description" : "Put source into localList",
"message" : "Source 2 has been modified successful.",
"params" : {
"id" : 2,
"source" : "192.168.3.1"
}
}
Parameter respons
Respons akan menjadi json dengan sumber diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus sumber daftar hitam
Hapus sumber daftar hitam
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources/2
DELETE /ipds/blacklists/<name>/sources/<id>
Hapus sumber dari daftar hitam.
nama adalah pengidentifikasi unik daftar hitam. id adalah pengidentifikasi unik sumber.
Contoh respons:
{
"description" : "Delete source from the list localList",
"message" : "Source 2 has been deleted successful.",
"success" : "true"
}
IPDS - DoS
DoS protection memiliki berbagai jenis aturan, tergantung dari aturan perlindungan, diterapkan untuk bagian penyeimbang yang berbeda. Jadi ada sistem aturan bahwa itu berlaku semua penyeimbang. Aturan berorientasi koneksi, khusus untuk kebun bekerja dengan protokol TCP. Sebelum menerapkan aturan ke a kebun, buat objek dengan konfigurasi yang diinginkan. Selanjutnya, menerapkannya ke semua peternakan yang Anda butuhkan. Itu sistem aturan memiliki objek yang sudah dibuat dan hanya memiliki satu konfigurasi yang memungkinkan. Setelah dikonfigurasi, aktifkan.
Aturan DoS pertanian
Perlu membuat objek sebelum menerapkan aturan ke sebuah peternakan.
limitec
Batas koneksi baru per detik dan sumber. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
membatasi | Jumlah | Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
limitconns
Batasi total koneksi saat ini per sumber. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
limit_conns | Jumlah | Ini adalah jumlah maksimal dari koneksi saat ini dari sumber. |
bogustcpflags
Periksa protokol TCP dihormati. Aturan ini tidak memiliki parameter konfigurasi sehingga hanya membuat objek yang dapat Anda gunakan di semua tambak. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
limitrst
Batasi jumlah permintaan koneksi ulang per detik. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
membatasi | Jumlah | Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
Aturan Sistem DoS
Dalam aturan sistem DoS, objek belum dibuat.
sshbruteforce
Batas koneksi ssh baru.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. Identifier telah didefinisikan sebagai ssh_brute_force. |
hit | Jumlah | Jumlah klik untuk sumber sebelum koneksi diblokir. |
waktu | Jumlah | Waktu dalam detik untuk mengatur ulang hit melawan. |
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
dropicmp
Sistem menjatuhkan permintaan icmp.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. Identifier telah didefinisikan sebagai drop_icmp. |
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
Daftar semua jenis aturan DoS
Daftar semua jenis aturan DoS
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/rules
GET /ipds/dos/rules
Tampilkan daftar aturan DoS. Mereka bukan objek tetapi tipe untuk mendefinisikannya.
Setiap aturan memiliki parameter konfigurasi yang berbeda
Contoh respons:
{
"description" : "Get DoS settings.",
"params" : {
"farm" : [
{
"description" : "Connection limit per seconds.",
"rule" : "limitsec"
},
{
"description" : "Total connections limit per source IP.",
"rule" : "limitconns"
},
{
"description" : "Check bogus TCP flags.",
"rule" : "bogustcpflags"
},
{
"description" : "Limit RST request per second.",
"rule" : "limitrst"
}
],
"system" : [
{
"description" : "SSH brute force.",
"rule" : "sshbruteforce"
},
{
"description" : "Drop icmp packets",
"rule" : "dropicmp"
}
]
}
}
Parameter respons
Respons JSON memiliki dua larik kebun dan sistem. Setiap item array adalah jenis aturan yang diterapkan ke tambak o sistem.
Bidang | Tipe | Deskripsi |
---|---|---|
deskripsi | Tali | Deskripsi singkat tentang aturan. |
memerintah | Tali | ketik aturan pengidentifikasi unik. |
Daftar semua aturan DoS
Daftar semua objek DoS
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos
GET /ipds/dos
Tampilkan konfigurasi tentang semua objek DoS yang ada.
Contoh respons:
{
"description" : "Get DoS settings.",
"params" : [
{
"farms" : [],
"limit_conns" : 10,
"name" : "limitConnHttp",
"rule" : "limitconns",
"type" : "farm"
},
{
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "limitUsers",
"rule" : "limitsec",
"type" : "farm"
},
{
"hits" : 5,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "down",
"time" : 180,
"type" : "system"
},
{
"name" : "drop_icmp",
"rule" : "dropicmp",
"status" : "down",
"type" : "system"
},
{
"farms" : [],
"name" : "tcpAuth",
"rule" : "bogustcpflags",
"type" : "farm"
},
{
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "dos4",
"rule" : "limitrst",
"type" : "farm"
},
]
}
Parameter respons
Respons akan berupa array dengan semua objek DoS yang tersedia.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
memerintah | Tali | Ini adalah pengenal aturan tipe. |
mengetik | Tali | Nilai yang mungkin adalah: kebun, aturan tersebut berlaku untuk peternakan; atau sistem, aturannya berlaku untuk sistem. |
Selain bergantung pada aturan, objek tersebut berisi parameter berikutnya
limitec
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
membatasi | Jumlah | Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
limitconns
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
limit_conns | Jumlah | Ini adalah jumlah maksimal dari koneksi saat ini dari sumber. |
bogustcpflags
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
limitrst
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
membatasi | Jumlah | Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
sshbruteforce
Bidang | Tipe | Deskripsi |
---|---|---|
hit | Jumlah | Jumlah klik untuk sumber sebelum koneksi diblokir. |
waktu | Jumlah | Waktu dalam detik untuk mengatur ulang hit melawan. |
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
dropicmp
Bidang | Tipe | Deskripsi |
---|---|---|
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
Ambil aturan DoS
Ambil aturan DoS
Minta contoh untuk aturan pertanian:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/limitConnHttp
Minta contoh untuk aturan sistem:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/ssh_brute_force
GET /ipds/dos/<name>
Setiap objek DoS dapat memiliki konfigurasi yang berbeda. nama adalah pengidentifikasi unik aturan DoS.
Contoh respons untuk aturan pertanian:
{
"description" : "Get DoS limitConnHttp settings",
"params" : {
"farms" : [],
"limit_conns" : 10,
"name" : "limitConnHttp",
"rule" : "limitconns",
"type" : "farm"
}
}
Contoh respons untuk aturan sistem:
{
"description" : "Get DoS ssh_brute_force settings",
"params" : {
"hits" : 5,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "down",
"time" : 180,
"type" : "system"
}
}
Parameter respons
Respons akan berupa array dengan semua objek DoS yang tersedia.
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. |
memerintah | Tali | Ini adalah pengenal aturan tipe. |
mengetik | Tali | Nilai yang mungkin adalah: kebun, aturan tersebut berlaku untuk peternakan; atau sistem, aturannya berlaku untuk sistem. |
Selain bergantung pada aturan, objek tersebut berisi parameter berikutnya
limitec
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
membatasi | Jumlah | Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
limitconns
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
limit_conns | Jumlah | Ini adalah jumlah maksimal dari koneksi saat ini dari sumber. |
bogustcpflags
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
limitrst
Bidang | Tipe | Deskripsi |
---|---|---|
peternakan | Tali[] | Peternakan tempat aturan diterapkan. |
membatasi | Jumlah | Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
sshbruteforce
Bidang | Tipe | Deskripsi |
---|---|---|
hit | Jumlah | Jumlah klik untuk sumber sebelum koneksi diblokir. |
waktu | Jumlah | Waktu dalam detik untuk mengatur ulang hit melawan. |
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
dropicmp
Bidang | Tipe | Deskripsi |
---|---|---|
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
Buat aturan DoS
Buat aturan DoS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"limitUsers", "rule":"limitsec"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos
POST /ipds/dos
Buat objek DoS untuk menggunakannya sebagai peternakan sesuai kebutuhan.
Setiap objek DoS dapat memiliki konfigurasi yang berbeda.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
nama | Tali | Ini adalah pengidentifikasi unik aturan objek. | benar |
memerintah | Tali | Ini adalah pengenal aturan tipe. Opsinya adalah: limitconns, limitec, limitrst or bogustcpflags. | benar |
Contoh respons:
{
"description" : "Post a DoS rule",
"params" : {
"farms" : [],
"limit" : 2,
"limit_burst" : 2,
"name" : "limitUsers",
"rule" : "limitsec",
"type" : "farm"
}
}
Parameter respons
Respons akan menjadi json dengan konfigurasi default untuk aturan yang dibuat. Lihat contoh respons untuk informasi lebih lanjut.
Ubah aturan DoS
Ubah aturan DoS
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"hits":"10","status":"up","time":"100"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/ssh_brute_force
PUT /ipds/dos/<name>
Ubah aturan DoS. nama adalah pengidentifikasi unik aturan DoS.
Parameter permintaan
Setiap jenis aturan dapat menjadi parameter yang berbeda. Parameter yang dapat dimodifikasi adalah sebagai berikut:
limitec
Bidang | Tipe | Deskripsi |
---|---|---|
membatasi | Jumlah | Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
limitconns
Bidang | Tipe | Deskripsi |
---|---|---|
limit_conns | Jumlah | Ini adalah jumlah maksimal dari koneksi saat ini dari sumber. |
bogustcpflags
Tidak ada parameter.
limitrst
Bidang | Tipe | Deskripsi |
---|---|---|
membatasi | Jumlah | Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber. |
limit_burst | Jumlah | Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu. |
sshbruteforce
Bidang | Tipe | Deskripsi |
---|---|---|
hit | Jumlah | Jumlah klik untuk sumber sebelum koneksi diblokir. |
waktu | Jumlah | Waktu dalam detik untuk mengatur ulang hit melawan. |
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
dropicmp
Bidang | Tipe | Deskripsi |
---|---|---|
status | Tali | Tampilkan status aturan, nilai yang mungkin adalah: up sistem menjatuhkan permintaan icmp; atau turun sistem memungkinkan permintaan icmp. |
Contoh respons:
{
"description" : "Put DoS rule settings",
"params" : {
"hits" : 10,
"name" : "ssh_brute_force",
"port" : 22,
"rule" : "sshbruteforce",
"status" : "up",
"time" : 100,
"type" : "system"
},
"success" : "true"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Hapus aturan DoS
Hapus aturan DoS
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/limitConnHttp
DELETE /ipds/dos/<name>
Aturan sistem tidak bisa dihapus. Untuk menonaktifkannya, masukkan status ke turun. nama adalah pengidentifikasi unik aturan DoS.
Contoh respons:
{
"description" : "Delete DoS rule",
"message" : "Deleted limitConnHttp successful.",
"success" : "true"
}
System
Opsi sistem menawarkan kepada Anda kemungkinan untuk mempersonalisasikan layanan yang berjalan di balancer dan parameter global.
Tampilkan versi
Tampilkan versi
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/version
GET /system/version
Tampilkan informacion tentang versi produk.
Contoh respons:
{
"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"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
appliance_version | Tali | Versi aplikasi Tunjukkan juga hypervisor jika merupakan mesin virtual. |
hostname | Tali | Nama host |
kernel_version | Tali | Versi kernel Linux. |
system_date | Tali | Tanggal sistem. |
zevenet_version | Tali | Versi Zevenet. |
Tampilkan DNS
Tampilkan DNS
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/dns
GET /system/dns
Tampilkan konfigurasi layanan DNS.
Contoh respons:
{
"description" : "Get dns",
"params" : {
"primary" : "8.8.8.8",
"secondary" : null
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
primer | Tali | DNS primer dikonfigurasi dalam sistem. |
sekunder | Tali | DNS sekunder dikonfigurasi dalam sistem. |
Ubah DNS
Ubah DNS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/dns
POST /system/dns
Ubah konfigurasi layanan DNS.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
primer | Tali | DNS primer dikonfigurasi dalam sistem. |
sekunder | Tali | DNS sekunder dikonfigurasi dalam sistem. |
Contoh respons:
{
"description" : "Post dns",
"params" : {
"primary" : "8.8.4.4",
"secondary" : "8.8.8.8"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tampilkan SSH
Tampilkan SSH
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/ssh
GET /system/ssh
Tampilkan konfigurasi layanan SSH.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
mendengarkan | Tali | IP sistem tempat layanan SSH mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi. |
pelabuhan | Tali | Port dikonfigurasikan untuk layanan SSH. |
Contoh respons:
{
"description" : "Get ssh",
"params" : {
"listen" : "*",
"port" : "22"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah SSH
Ubah SSH
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"listen":"192.168.100.241","port":"22"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/ssh
POST /system/ssh
Ubah konfigurasi layanan SSH.
Parameter permintaan
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
mendengarkan | Tali | IP sistem tempat layanan SSH mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi. |
pelabuhan | Tali | Port dikonfigurasikan untuk layanan SSH. |
Contoh respons:
{
"description" : "Post ssh",
"params" : {
"listen" : "192.168.100.241",
"port" : "22"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tampilkan SNMP
Tampilkan SNMP
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/snmp
GET /system/snmp
Tampilkan konfigurasi layanan SNMP.
Contoh respons:
{
"description" : "Get snmp",
"params" : {
"community" : "public",
"ip" : "*",
"port" : "161",
"scope" : "0.0.0.0/0",
"status" : "false"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
masyarakat | Tali | Nama komunitas. Baca Hanya Komunitas yang digunakan. |
ip | Tali | IP antarmuka tempat layanan SNMP berjalan. Aman untuk mengaktifkan semua antarmuka menggunakan karakter *. |
pelabuhan | Tali | Port tempat layanan SNMP berjalan. |
cakupan | Tali | IP atau subnet dengan akses (IP / bit). IP klien yang diizinkan mengakses layanan SNMPD, jika Anda ingin mengizinkan hanya satu IP, gunakan bit “/ 32”. |
status | Tali | Status layanan SNMP. Nilai yang mungkin adalah: benar, layanan sedang berjalan; atau palsu, layanan dihentikan. |
Ubah SNMP
Ubah SNMP
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/snmp
POST /system/snmp
Ubah konfigurasi layanan SNMP.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
masyarakat | Tali | Nama komunitas. Baca Hanya Komunitas yang digunakan. |
ip | Tali | IP antarmuka tempat layanan SNMP berjalan. Aman untuk mengaktifkan semua antarmuka menggunakan karakter *. |
pelabuhan | Tali | Port tempat layanan SNMP berjalan. |
cakupan | Tali | IP atau subnet dengan akses (IP / bit). IP klien yang diizinkan mengakses layanan SNMPD, jika Anda ingin mengizinkan hanya satu IP, gunakan bit “/ 32”. |
status | Tali | Status layanan SNMP. Nilai yang mungkin adalah: benar, layanan sedang berjalan; atau palsu, layanan dihentikan. |
Contoh respons:
{
"description" : "Post snmp",
"params" : {
"community" : "public",
"ip" : "192.168.100.241",
"port" : "170",
"scope" : "0.0.0.0/0",
"status" : "true"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ambil lisensi
Ambil lisensi
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/license/txt
GET /system/license/<format>
Tunjukkan lisensi Zevenet dalam format. Tersedia format nilai adalah html or txt.
Tampilkan NTP
Tampilkan NTP
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/ntp
GET /system/ntp
Tampilkan konfigurasi layanan NTP.
Contoh respons:
{
"description" : "Get ntp",
"params" : {
"server" : "pool.ntp.org"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
Server | Tali | Server tempat klien NTP melakukan permintaan. |
Ubah NTP
Ubah NTP
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"server":"pool.ntp.org"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/ntp
POST /system/ntp
Ubah konfigurasi layanan NTP.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
Server | Tali | Server tempat klien NTP melakukan permintaan. |
Contoh respons:
{
"description" : "Post ntp",
"params" : "pool.ntp.org"
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tampilkan server HTTP
Tampilkan server HTTP
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/http
GET /system/http
Tampilkan konfigurasi layanan HTTP. Di sinilah Zevenet API dan GUI berjalan.
Contoh respons:
{
"description" : "Get http",
"params" : {
"ip" : "*",
"port" : "444"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP tempat server HTTP mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi. |
pelabuhan | Tali | Port tempat layanan HTTP mendengarkan. |
Ubah server HTTP
Ubah server HTTP
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"80"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/http
POST /system/http
Ubah konfigurasi layanan HTTP.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | IP tempat server HTTP mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi. |
pelabuhan | Tali | Port tempat layanan HTTP mendengarkan. |
Contoh respons:
{
"description" : "Post http",
"params" : {
"ip" : "192.168.100.241",
"port" : "80"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Daftar semua pengguna
Daftar semua pengguna
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/users
GET /system/users
Daftar pengguna yang tersedia dalam sistem.
Contoh respons:
{
"description" : "Get users",
"params" : [
{
"status" : "true",
"user" : "root"
},
{
"status" : "true",
"user" : "zapi"
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
status | Tali | Status pengguna. Nilai yang mungkin adalah: benar, pengguna diaktifkan; atau tidak palsu, pengguna dinonaktifkan. |
pemakai | Tali | Nama pengguna. |
Ambil pengguna zapi
Ambil pengguna zapi
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/users/zapi
GET /system/users/zapi
Tampilkan konfigurasi pengguna zapi. Parameter ini diperlukan untuk mengakses layanan Zevenet melalui zapi.
Contoh respons:
{
"description" : "Zapi user configuration.",
"params" : {
"key" : "root",
"status" : "true"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array parameter di bawah ini.
Bidang | Tipe | Deskripsi |
---|---|---|
kunci | Tali | Kunci untuk mengautentikasi dalam zapi. Ini adalah parameternya ZAPI_KEY digunakan dalam panggilan ke zapi. |
status | Tali | Status pengguna Zapi. Jika nilainya benar, dimungkinkan untuk menggunakan zapi; atau tidak palsu, zapi dinonaktifkan dan tidak mungkin mengirimnya permintaan. |
Ubah konfigurasi pengguna zapi
Ubah konfigurasi pengguna zapi
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"key":"newzapikey","status":"enable","newpassword":"password1234"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/users/zapi
POST /system/users/zapi
Ubah konfigurasi pengguna zapi. Parameter ini diperlukan untuk mengakses layanan Zevenet melalui zapi.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
kunci | Tali | Kunci untuk mengautentikasi dalam zapi. Ini adalah parameternya ZAPI_KEY digunakan dalam panggilan ke zapi. |
kata sandi baru | Tali | Kata sandi baru untuk pengguna zapi. |
status | Tali | Status pengguna Zapi. Jika nilainya benar, dimungkinkan untuk menggunakan zapi; atau tidak palsu, zapi dinonaktifkan dan tidak mungkin mengirimnya permintaan. |
Contoh respons:
{
"description" : "Zapi user settings.",
"message" : "Settings was changed successful.",
"params" : {
"key" : "newzapikey",
"newpassword" : "password1234",
"status" : "enable"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ubah kata sandi root
Ubah kata sandi root
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"password":"admin","newpassword":"alwaysisbetterastrongpass"}
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/users/root
POST /system/users/root
Ubah kata sandi root. Pengguna ini digunakan untuk mengakses layanan zevenet melalui GUI
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
kata sandi | Tali | Kata sandi pengguna root saat ini. | benar |
kata sandi baru | Tali | Kata sandi baru untuk pengguna root. | benar |
Contoh respons:
{
"description" : "User settings.",
"message" : "Settings was changed succesful.",
"params" : {
"newpassword" : "alwaysisbetterastrongpass",
"password" : "admin"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Daftar file-file log
Daftar file-file log
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/logs
GET /system/logs
Buat daftar file log yang tersedia.
Contoh respons:
{
"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"
}
]
}
Parameter respons
Responsnya akan menjadi JSON dengan array file log. Parameter dari setiap objek adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
tanggal | Tali | Tanggal modifikasi file terakhir. |
fillet | Tali | Nama file file log. Ini digunakan sebagai pengidentifikasi unik log. |
Unduh file log
Unduh file log
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
Unduh file log dari file log yang tersedia yang terdaftar saat MENDAPATKAN permintaan.
fillet adalah pengidentifikasi unik file log.
Sistem - Cadangan
Dengan opsi Cadangan, Anda dapat menyimpan konfigurasi sistem saat ini dan mengunduhnya.
Di bagian ini, Anda dapat membuat, memulihkan, mengunggah, dan mengunduh file cadangan.
Buat daftar cadangan
Buat daftar cadangan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup
GET /system/backup
Contoh respons:
{
"description" : "Get backups",
"params" : [
{
"date" : "Fri Feb 3 06:01:04 2017",
"name" : "newbackup"
},
{
"date" : "Fri Feb 3 05:50:48 2017",
"name" : "firstConf"
}
]
}
Parameter respons
Responsnya akan menjadi JSON dengan berbagai cadangan. Parameter dari setiap elemen array adalah:
Bidang | Tipe | Deskripsi |
---|---|---|
tanggal | Tali | Tanggal modifikasi terakhir. |
nama | Tali | Ini adalah nama file yang digunakan sebagai pengidentifikasi unik. Ekstensi file adalah .tar.gz . |
Buat cadangan
Buat cadangan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"firstConf"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup
POST /system/backup
Buat cadangan konfigurasi sistem dari konfigurasi saat ini.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
nama | Tali | Ini adalah nama file yang digunakan sebagai pengidentifikasi unik. Ekstensi file adalah .tar.gz . |
Contoh respons:
{
"description" : "Create a backups",
"message" : "Backup firstConf was created successful.",
"params" : "firstConf"
}
Unduh cadangan
Unduh cadangan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz
File cadangan dalam format TAR GZ.
GET /system/backup/<name>
Unduh cadangan konfigurasi sistem. nama adalah pengidentifikasi unik cadangan.
Unggah cadangan
Unggah cadangan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: text/plain'
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup/newbackup
PUT /system/backup/<name>
Unggah cadangan tersimpan lokal ke Zevenet. nama adalah pengidentifikasi unik cadangan yang akan disimpan di Zevenet.
Parameter permintaan
Anda perlu menggunakan –data-binary untuk mengupload cadangan.
Contoh respons:
{
"description" : "Upload a backup",
"message" : "Backup newbackup was created successful.",
"params" : "newbackup"
}
Hapus cadangan
Hapus cadangan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup/firstConf
DELETE /system/backup/<name>
Hapus file cadangan dari sistem Zevenet. nama adalah pengidentifikasi unik cadangan.
Contoh respons:
{
"description" : "Delete backup firstConf'",
"message" : "The list firstConf has been deleted successful.",
"success" : "true"
}
Terapkan cadangan
Terapkan cadangan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"apply"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/backup/firstConf/actions
POST /system/backup/<name>/actions
Kembalikan konfigurasi dari file cadangan. nama adalah pengidentifikasi unik cadangan.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Untuk mengembalikan konfigurasi cadangan, nilainya harus menerapkan. |
Contoh respons:
{
"description" : "Apply a backup to the system",
"params" : {
"action" : "apply"
}
}
Sistem - Pemberitahuan
Notifikasi dibentuk oleh dua elemen: Pengirim metode dan jenis waspada.
Di bagian lansiran Anda akan dapat memilih jenis lansiran yang ingin Anda terima. Sebenarnya, lansiran fokus pada status backend atau klaster, sehingga penyeimbang akan mengirim pemberitahuan jika ada yang beralih.
Di bagian metode Anda akan dapat memilih pengirim mana yang akan digunakan ketika Zevenet harus mengirim pemberitahuan.
Tampilkan status peringatan
Tampilkan status peringatan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts
GET /system/notifications/alerts
Daftar semua jenis peringatan dengan statusnya.
Contoh respons:
{
"description" : "Get notifications alert status",
"params" : [
{
"alert" : "backends",
"status" : "disabled"
},
{
"alert" : "cluster",
"status" : "disabled"
}
]
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
waspada | Tali | Jenis lansiran, digunakan sebagai pengenal unik lansiran. Lansiran yang tersedia adalah: backend, beri tahu ketika backend perubahan status; atau kelompok, kirim pemberitahuan ketika simpul master klaster beralih ke simpul lain. |
status | Tali | Tunjukkan jika peringatan cacat, sistem tidak mengirimkan notifikasi saat ada acara; atau diaktifkan, sistem mengirimkan peringatan ketika terdeteksi perubahan status. |
Ambil lansiran pemberitahuan
Ambil lansiran pemberitahuan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts/backends
GET /system/notifications/alerts/<alert>
Tampilkan konfigurasi tentang jenis peringatan.
waspada adalah pengidentifikasi unik lansiran.
Contoh respons:
{
"description" : "Get notifications alert backends settings",
"params" : {
"avoidflappingtime" : 5,
"prefix" : "",
"status" : "disabled"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
hindari waktu flapping | Jumlah | Kadang-kadang backend tersedia atau tidak dalam waktu singkat, bidang ini memungkinkan untuk mengkonfigurasi periode waktu untuk menghindari pesan notifikasi sementara backend berubah status, setelah periode waktu ini berakhir, jika status backend itu berbeda untuk memulai, maka pemberitahuan dikirim. |
awalan | Tali | Ini adalah awalan untuk subjek email, yang dikirim oleh sistem untuk jenis peringatan ini. |
status | Tali | Tunjukkan jika peringatan cacat, sistem tidak mengirimkan notifikasi saat ada acara; atau diaktifkan, sistem mengirimkan peringatan ketika terdeteksi perubahan status. |
Ubah lansiran pemberitahuan
Ubah pemberitahuan pemberitahuan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"avoidflappingtime":10,"prefix":"[backend alert]"}
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts/backends
POST /system/notifications/alerts/<alert>
waspada adalah pengidentifikasi unik lansiran.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
hindari waktu flapping | Jumlah | Kadang-kadang backend tersedia atau tidak dalam waktu singkat, bidang ini memungkinkan untuk mengkonfigurasi periode waktu untuk menghindari pesan notifikasi sementara backend berubah status, setelah periode waktu ini berakhir, jika status backend itu berbeda untuk memulai, maka pemberitahuan dikirim. Parameter ini tidak ada dalam peringatan cluster, cluster memiliki waktu swich sendiri. |
awalan | Tali | Ini adalah awalan untuk subjek email, yang dikirim oleh sistem untuk jenis peringatan ini. |
Contoh respons:
{
"description" : "Set notifications alert backends",
"params" : {
"avoidflappingtime" : 10,
"prefix" : "[backend alert]"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Aktifkan lansiran
Aktifkan lansiran
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"action":"enable"}
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts/backends/actions
POST /system/notifications/alerts/<alert>/actions
Mengaktifkan atau menonaktifkan notifikasi untuk jenis peringatan.
waspada adalah pengidentifikasi unik lansiran.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Tindakan yang tersedia untuk peringatan adalah cacat, sistem tidak mengirimkan notifikasi saat ada acara; atau diaktifkan, sistem mengirimkan peringatan ketika terdeteksi perubahan status. |
Contoh respons:
{
"description" : "Set notifications alert backends actions",
"params" : {
"action" : "enable"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Ambil konfigurasi email
Ambil konfigurasi email
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/methods/email
GET /system/notifications/methods/email
Tampilkan semua konfigurasi pengirim email.
Catatan: Port SMTP yang digunakan untuk mengirim email adalah TCP 25 bahkan jika TLS diaktifkan.
Contoh respons:
{
"description" : "Get notifications email methods",
"params" : {
"from" : "user@zevenet.com",
"method" : "email",
"password" : "******",
"server" : "smtp.gmail.com",
"tls" : "true",
"to" : "adminuser@zevenet.net",
"user" : "user@zevenet.com"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
dari | Tali | Akun email yang mengirim email, akun ini akan muncul di header SMTP Dari: dan itu akan digunakan jika penerima membalas email. |
metode | Tali | Ini adalah metode pengidentifikasi unik. Sebenarnya metode yang tersedia adalah e-mail. |
kata sandi | Tali | Kata sandi untuk pemakai Akun SMTP, kata sandi ini diperlukan jika Server memerlukan otentikasi SMTP. |
Server | Tali | Server SMTP melalui email dikirim. |
tls | Tali | Aktifkan validasi TLS untuk mengirim email, properti ini menggunakan STARTTLS dan fitur ini harus didukung di server SMTP. Beberapa server SMTP harus mengaktifkannya. Nilai yang mungkin adalah: benar, Validasi TLS diaktifkan untuk mengirim email; atau palsu, mengirim email tidak menggunakan validasi TLS. |
untuk | Tali | Akun email yang menerima email, akun ini akan muncul di header SMTP Ke. |
pemakai | Tali | Akun email diperbolehkan mengirim email, akun ini diperlukan jika server memerlukan otentikasi SMTP. |
Ubah konfigurasi email
Ubah konfigurasi email
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"from":"user@zevenet.com","password":"verystrongpass","server":"smtp.gmail.com","to":"adminuser@zevenet.net","tls":"true","user":"user@zevenet.com"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/methods/email
POST /system/notifications/methods/email
Ubah konfigurasi metode pengirim email.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
dari | Tali | Akun email yang mengirim email, akun ini akan muncul di header SMTP Dari: dan itu akan digunakan jika penerima membalas email. |
kata sandi | Tali | Kata sandi untuk pemakai Akun SMTP, kata sandi ini diperlukan jika Server memerlukan otentikasi SMTP. |
Server | Tali | Server SMTP melalui email dikirim. |
tls | Tali | Aktifkan validasi TLS untuk mengirim email, properti ini menggunakan STARTTLS dan fitur ini harus didukung di server SMTP. Beberapa server SMTP harus mengaktifkannya. Nilai yang mungkin adalah: benar, Validasi TLS diaktifkan untuk mengirim email; atau palsu, mengirim email tidak menggunakan validasi TLS. |
untuk | Tali | Akun email yang menerima email, akun ini akan muncul di header SMTP Ke. |
pemakai | Tali | Akun email diperbolehkan mengirim email, akun ini diperlukan jika server memerlukan otentikasi SMTP. |
Contoh respons:
{
"description" : "Get notifications email methods",
"params" : {
"from" : "user@zevenet.com",
"method" : "email",
"password" : "verystrongpass",
"server" : "smtp.gmail.com",
"tls" : "true",
"to" : "adminuser@zevenet.net",
"user" : "user@zevenet.com"
}
}
Parameter respons
Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Kirim surat uji
Kirim surat uji
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"test"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/methods/email/actions
POST /system/notifications/methods/email/actions
Kirim surat uji dengan konfigurasi email, untuk mengujinya.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
tindakan | Tali | Nilai untuk mengirim surat uji adalah uji. |
Contoh respons:
{
"description" : "Send test mail",
"message" : "Test mail sent successful.",
"success" : "true"
}
Unduh supportave
Unduh supportave
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/supportsave > supportsave.tar.gz
GET /system/supportsave
Dapatkan gambar status sistem dengan semua konfigurasi dan proses berjalan di sistem. Dukungan ini membuat perlu untuk menemukan masalah atau bantuan dukungan.
Sistem - Cluster
Cluster adalah elemen yang dikerjakan oleh master node, yang mengelola koneksi untuk backend, dan sebuah backup node memeriksa master, ia siap untuk swich untuk menguasai node jika ia pergi ke status turun.
Ketika ada status yang diaktifkan, simpul cadangan akan mengembalikan semua status koneksi itu sendiri. Jadi, klien tidak mendeteksi gangguan dalam layanan.
Ini memungkinkan penyeimbang muatan berada dalam ketersediaan tinggi. Jadi jika ada masalah dalam Zevenet, layanan akan terus bekerja dengan konfigurasi yang diunggah.
Tampilkan konfigurasi cluster
Tampilkan konfigurasi cluster
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster
GET /system/cluster
Tampilkan semua konfigurasi tentang kluster.
Respon BODY:
{
"description" : "Show the cluster configuration",
"params" : {
"check_interval" : 5,
"failback" : "disabled",
"interface" : "eth0",
"nodes" : [
{
"ip" : "192.168.100.241",
"name" : "canoDEV4100",
"node" : "local"
},
{
"ip" : "192.168.100.240",
"name" : "maqvir",
"node" : "remote"
}
]
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan konfigurasi cluster dan array dengan node di dalamnya.
Objek Cluster:
Bidang | Tipe | Deskripsi |
---|---|---|
check_interval | Jumlah | Ini adalah waktu tunggu antara dua pemeriksaan status master node. |
gagal kembali | Tali | Node mana yang lebih disukai sebagai master. Nilai bisa berupa a nama simpul, untuk memberikan preferensi ke simpul; atau cacat, jika ada simpul yang bisa dikuasai dan tidak ada prioritas untuk satu simpul. |
antarmuka | Tali | Antarmuka tempat IP node dikonfigurasikan. |
node | Obyek[] | Node cluster. |
Objek Simpul:
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | Ini adalah IP yang dikonfigurasi dalam node untuk memeriksa status node dan melakukan replikasi informasi. |
nama | Tali | Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul. |
simpul | Tali | Nilai yang mungkin adalah: lokal, jika simpul adalah yang menerima permintaan zapi; atau terpencil, jika node lain dikonfigurasi dalam cluster. |
Aktifkan sebuah cluster
Aktifkan sebuah cluster
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"local_ip":"192.168.100.241","remote_ip":"192.168.100.240","remote_password":"admin"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster
POST /system/cluster
Apakah cluster berkomunikasi dua penyeimbang.
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
remote_ip | Tali | IP host jarak jauh yang digunakan untuk cluster. | benar |
local_ip | Tali | IP host lokal yang digunakan untuk cluster. | benar |
kata sandi jarak jauh | Tali | Rooting kata sandi pengguna untuk penyeimbang jarak jauh. | benar |
Respon BODY:
{
"description" : "Enabling cluster",
"message" : "Cluster enabled successfully",
"success" : "true"
}
Ubah konfigurasi cluster
Ubah konfigurasi cluster
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"check_interval":4,"failback":"disabled"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster
PUT /system/cluster
Mengkonfigurasi parameter mode kerja untuk cluster.
Parameter permintaan
Bidang | Tipe | Deskripsi |
---|---|---|
check_interval | Jumlah | Ini adalah waktu tunggu antara dua pemeriksaan status master node. |
gagal kembali | Tali | Node mana yang lebih disukai sebagai master. Nilai bisa berupa a nama simpul, untuk memberikan preferensi ke simpul; atau cacat, jika ada simpul yang bisa dikuasai dan tidak ada prioritas untuk satu simpul. |
Respon BODY:
{
"description" : "Modifying the cluster configuration",
"params" : {
"check_interval" : "4",
"failback" : "disabled"
}
}
Nonaktifkan cluster
Nonaktifkan cluster
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster
DELETE /system/cluster
Hapus kluster.
Respon BODY:
{
"description" : "Disabling cluster",
"message" : "Cluster disabled successfully",
"success" : "true"
}
Dalam perawatan
Dalam perawatan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance","status":"enable"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster/actions
POST /system/cluster/actions
Ubah node cluster lokal ke mode pemeliharaan.
Respon BODY:
{
"description" : "Setting maintenance mode",
"message" : "Local cluster node changed to maintenance mode successfully",
"success" : "true"
}
Parameter permintaan
Bidang | Tipe | Deskripsi | Wajib |
---|---|---|---|
tindakan | Tali | Tindakan untuk diterapkan ke kluster. Tindakan yang tersedia adalah pemeliharaan. | benar |
status | Tali | Status untuk meletakkan node, nilai yang mungkin adalah aktif, letakkan di mode pemeliharaan; atau menonaktifkan, letakkan simpul yang tersedia. | benar |
Tampilkan status node
Tampilkan status node
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster/nodes
GET /system/cluster/nodes
Tampilkan status semua node.
Respon BODY:
{
"description" : "Cluster nodes status",
"params" : [
{
"ip" : "192.168.100.241",
"message" : "Node online and active",
"name" : "canoDEV4100",
"node" : "local",
"role" : "master",
"status" : "ok"
},
{
"ip" : "192.168.100.240",
"message" : "Node online and passive",
"name" : "maqvir",
"node" : "remote",
"role" : "backup",
"status" : "ok"
}
]
}
Parameter respons
Respons akan menjadi JSON dengan kunci berhenti dan nilai array objek status simpul.
Objek status simpul
Bidang | Tipe | Deskripsi |
---|---|---|
ip | Tali | Ini adalah IP yang dikonfigurasi dalam node untuk memeriksa status node dan melakukan replikasi informasi. |
nama | Tali | Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul. |
simpul | Tali | Nilai yang mungkin adalah: lokal, jika simpul adalah yang menerima permintaan zapi; atau terpencil, jika node lain dikonfigurasi dalam cluster. |
pesan | Tali | Pesan deskriptif yang menunjukkan status dan mode kerja node. |
peran | Tali | Mode kerja aktual dari simpul ini. Nilai yang mungkin adalah: menguasai, simpul ini mengatur koneksi antara backend dan klien; atau backup, simpul ini telah menjawab koneksi status master dan konfigurasi master, dan sedang memeriksa apakah layanan master berfungsi. |
status | Tali | Tunjukkan jika beberapa proses cluster gagal. |
Tampilkan status cluster localhost
Tampilkan status cluster localhost
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster/nodes/localhost
GET /system/cluster/nodes/localhost
Tampilkan status simpul lokal.
Respon BODY:
{
"description" : "Cluster status for localhost",
"params" : {
"message" : "Node online and active",
"name" : "canoDEV4100",
"role" : "master",
"status" : "ok"
}
}
Parameter respons
Bidang | Tipe | Deskripsi |
---|---|---|
pesan | Tali | Pesan deskriptif yang menunjukkan status dan mode kerja node. |
nama | Tali | Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul. |
peran | Tali | Mode kerja aktual dari simpul ini. Nilai yang mungkin adalah: menguasai, simpul ini mengatur koneksi antara backend dan klien; atau backup, simpul ini telah menjawab koneksi status master dan konfigurasi master, dan sedang memeriksa apakah layanan master berfungsi. |
status | Tali | Tunjukkan jika beberapa proses cluster gagal. |