Referensi Zevenet API v4.0
ZAPI (Zmalam hari AHal Program Interface) adalah alat untuk administrator sistem untuk mengontrol perilaku penyeimbang beban Zevenet.
Diperlukan untuk mengaktifkan pengguna root zapi dari antarmuka web sebelum menggunakannya, Sistem> Pengguna.
Setelah pengguna ZAPI dibuat, dimungkinkan untuk mengirim permintaan ke server HTTP. Permintaan URI terlihat seperti:
HTTP verb https://zevenet_server: 444 / zapi / v4.0 / zapi.cgi /URI_path,
dimana zevenet_server adalah IP tempat layanan HTTP mendengarkan, antarmuka kelola HTTP, dan URI_path mendefinisikan objek yang akan diminta. Cara mengakses dan cara memodifikasi setiap objek Zevenet akan ditentukan dalam setiap bagian dokumentasi.
The HTTP verbs yang diterima untuk ZAPI adalah:
DAPATKAN, digunakan untuk mendapatkan daftar elemen atau mengambil objek.
POST, digunakan untuk membuat objek baru, memodifikasi objek sistem (objek yang belum dibuat admin) dan untuk menerapkan tindakan.
PUT, digunakan untuk memodifikasi objek yang sudah ada yang dibuat oleh admin.
DELETE, Digunakan untuk menghapus objek yang dibuat oleh admin dan dalam beberapa kasus untuk mengatur ulang konfigurasi (kasus antarmuka).
Parameter ZAPI
Parameter ZAPI
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-H 'Content-Type: application/json' -d ''
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
A PUT serta POST permintaan selalu membutuhkan hampir suatu parameter meskipun panggilan ZAPI tidak memerlukan parameter yang diperlukan (wajib). Jika permintaan PUT atau POST dikirim tanpa parameter, ZAPI akan mengembalikan daftar parameter yang diharapkan dan opsi yang memungkinkan.
Contoh respons:
{
"description" : "No parameter has been sent. Please, try with:",
"params" : [
{
"name" : "profile",
"options" : [
"required"
],
"possible_values" : [
"http",
"gslb",
"l4xnat",
"datalink"
]
},
{
"format" : "ip_addr",
"name" : "vip",
"options" : [
"required"
]
},
{
"description" : "expects a port",
"name" : "vport",
"options" : [
"required"
]
},
{
"description" : "The farm name is required to have alphabet letters, numbers or hypens (-) only.",
"format" : "farm_name",
"name" : "farmname",
"options" : [
"required"
]
}
]
}
Parameter respons
Responsnya adalah daftar bidang yang menjelaskan parameter dan opsi konfigurasi yang memungkinkan:
Deskripsi parameter:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Ini adalah kunci ke nilai yang diterima. Parameter berikut digunakan untuk mendefinisikannya. |
| deskripsi | Tali | Ini adalah informasi tentang nilai yang diharapkan. |
| selang | Tali | Parameter harus memiliki nilai numerik dengan memperhatikan batas rendah, tinggi atau keduanya. Nilai yang digunakan sebagai batasan dianggap valid. |
| format | Tali | Ini bisa berupa petunjuk dengan format parameter yang diharapkan, bisa berupa ekspresi reguler atau kunci yang mengidentifikasi data. |
| mungkin_nilai | Tali[] | Ini adalah daftar nilai yang mungkin dimiliki oleh parameter. |
| Pilihan | Tali[] | Ini menunjukkan lebih banyak konfigurasi yang perlu diingat. |
Daftar opsi:
| Bidang | Deskripsi |
|---|---|
| wajib | Opsi ini menunjukkan bahwa parameter tersebut wajib, harus dikirim dalam permintaan. |
| non_blank | Opsi ini memungkinkan pengiriman string kosong sebagai nilai parameter. Mungkin bermanfaat untuk menghapus parameter. |
Kode kesalahan
ZAPI dapat merespons salah satu kode kesalahan berikut:
| Kode kesalahan | Singkat | Deskripsi |
|---|---|---|
| 400 | Permintaan yang buruk | Beberapa parameter permintaan salah. |
| 401 | Tidak resmi | Kunci ZAPI Anda salah. |
| 402 | Sertifikat tidak valid | Penyeimbang beban memerlukan sertifikat yang valid untuk memproses permintaan. |
| 403 | Terlarang | Pemilik pengguna kunci ZAPI tidak memiliki izin untuk permintaan atau objek yang digunakan di dalamnya. |
| 404 | Tidak Ditemukan | URI yang digunakan atau satu objek yang digunakan dalam panggilan tidak ada. |
| 405 | Metode Tidak Diizinkan | Kata kerja HTTP tidak ada atau tidak diterapkan untuk panggilan ZAPI saat ini. |
| 406 | Tidak dapat diterima | Fitur ini tidak tersedia untuk waktu. |
| 409 | Konflik | Permintaan itu valid, tetapi tidak bisa diproses, konfigurasi baru membuat konflik dengan yang sekarang. Syslog dapat menawarkan informasi lebih lanjut. |
| 410 | Mati | Fitur ini telah dihapus. |
| 500 | Internal Server Error | Terjadi kesalahan di server. |
| 504 | Gateway Timeout | Batas waktu respons server telah tercapai dan permintaan belum selesai diproses. |
Log perubahan
Ini adalah daftar perubahan yang telah disertakan dalam setiap versi. Daftar daftar perubahan dalam versi ZAPI selalu mengenai sebelumnya.
API 4.0.2
Versi ZAPI ini merupakan perpanjangan dari versi 4.0.1. Beberapa parameter dan URI ditambahkan tetapi tidak satupun yang dihapus.
- VPN
Modul VPN baru:
Ditambahkan GET|POST|PUT|DELETE /vpns/*
- Peternakan HTTP/S
Param baru:
kesalahanWAF, rewritelocation (menambahkan opsi baru hanya untuk zproxy), rewriteurl, koneksi yang disematkan, kebijakan perutean, koneksi_batas:
Diubah: GET|PUT /farms/<farmname>. Diubah: GET|PUT /farms/<farmname>/services/<id>.
API baru untuk menambahkan rewriteurl:
Ditambahkan ADD|DELETE /farms/<farmname>/service/<servicename>/rewriteurl/*
API baru untuk menambahkan Aturan Penulisan Ulang Header:
Ditambahkan ADD|DELETE /farms/MyHttpFarm/replacerequestheader/*
Ditambahkan ADD|DELETE /farms/MyHttpFarm/replaceresponseheader/*
Menambahkan permintaan untuk mengelola sesi statis (khusus zproxy):
Ditambahkan GET|POST|DELETE /farms/<farmname>/services/<servicename>/sessions/*
- Penjaga pertanian
Menambahkan parameter batas waktu:
Diubah: GET /monitoring/fg/<name>. Diubah: POST|PUT /monitoring/fg.
- SSH
Konfigurasikan beberapa ip dan port:
Diubah ADD|POST /system/ssh, sekarang terima array di params mendengarkan dan port.
- Server HTTP:
Konfigurasikan beberapa ip dan port untuk server cherokee:
Diubah ADD|POST /system/http, sekarang terima array dalam parameter ip dan port.
Konfigurasikan sertifikat server:
Ditambahkan GET|POST /system/https/certificate.
- Statistik:
Menambahkan parameter total_sessions serta Ttl:
Diubah: GET /stats/farms/<farmname>
- Konfigurasi global:
Menambahkan parameter waf_asisten:
Diubah GET|POST /system/global
- rsyslog
API rsyslog baru untuk mengonfigurasi log untuk mengirimnya ke server jauh:
ditambahkan: GET|POST|DELETE /system/rsyslog.
- Gugus:
Menambahkan parameter track_interface:
Diubah: GET|PUT /system/cluster.
API 4.0.1
Versi ZAPI ini merupakan perpanjangan dari versi 4.0. Beberapa parameter dan URI ditambahkan tetapi tidak satupun yang dihapus.
- ID
Tambahkan permintaan untuk menampilkan pohon dengan semua objek penyeimbang beban
Tambahkan: DAPATKAN / id
- Pertanian
Opsi untuk menyalin tambak
Diubah: POST /farms
- Pertanian HTTP
Tambahkan parameter addresponseheader serta hapus tajuk tanggapan dan memperluas parameter httpverb:
Diubah GET /farms/<farmname>
Diubah PUT /farms/<farmname>
Add POST /farms/<farmname>/addresponseheader|removeresponseheader
Add DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>
- L4xNAT Peternakan
Tambahkan permintaan untuk mengelola sesi statis:
Add GET /farms/<farmname>/sessions
Add POST /farms/<farmname>/sessions
Add DELETE /farms/<farmname>/sessions/<session>
- jaringan
Modul perutean baru:
Ditambahkan GET|POST|PUT|DELETE /routing/*
- Pemantauan
Farmguardian dapat menggunakan alias backend sebagai nama host untuk cek:
Ditambahkan GET|PUT /monitoring/fg*/<farmguardian>
- IPDS
Kelola file untuk aturan WAF:
Ditambahkan GET|PUT|DELETE /ipds/waf/files
- System
Dapatkan informasi sistem:
ditambahkan: GET /system/info
Pengaturan global yang dimodifikasi:
ditambahkan: GET|POST /system/global
- RBAC
Otentikasi menggunakan LDAP:
Ditambahkan GET|POST /rbac/services
Ditambahkan GET|POST /rbac/ldap*
Diubah GET|POST /rbac/users
Diubah GET|PUT /rbac/users/<user>
API 4.0
- Pertanian HTTP
Daftar ringkasan peternakan dan layanan yang dikelompokkan untuk modul:
ditambahkan: /farms/modules/summary
Tindakan untuk menautkan aturan WAF diatur dengan pertanian HTTP:
ditambahkan: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*
Diubah: GET /farms/<farm>
Pindahkan sertifikat di kebun HTTPS:
ditambahkan: POST /farms/<farm>/certificates/<cert>/actions
- L4xNAT Peternakan
Ubah panggilan pertanian yang terkait dengan l4xnat untuk mendukung inti baru:
Diubah: GET|POST|PUT|DELETE /farms/<l4farm>
- jaringan
Menambahkan DHCP serta MAC fitur dalam panggilan ZAPI berikut:
diubah: PUT /interfaces/nic/<if>
diubah: PUT /interfaces/bonding/<if>
diubah: POST /interfaces/vlan
diubah: PUT /interfaces/vlan/<if>
- Pemantauan
Ganti nama parameter untuk menyalin wali pertanian:
Diubah: POST /monitoring/fg
- IPDS
Manajemen paket IPDS:
ditambahkan: GET /ipds/package
ditambahkan: POST /ipds/package/actions
Firewall aplikasi web baru, WAF, fitur:
ditambahkan: GET|POST|PUT|DELETE /ipds/waf/*
Hapus panggilan untuk menyalin aturan RBL. Sekarang ini adalah parameter dari panggilan yang dibuat:
dihapus: POST /ipds/rbl/<name>
diubah: POST /ipds/waf/<name>
- System
Fitur-fitur Reset pabrik, wakil serta periksa pembaruan paket telah ditambahkan:
ditambahkan: POST /system/factory
ditambahkan: GET /system/proxy
ditambahkan: POST /system/proxy
ditambahkan: GET /system/packages
- RBAC
Tambahkan parameter untuk mengelola menu GUI web:
ditambahkan: GET /rbac/menus
Diubah: PUT /rbac/roles/<ROLE>
Sertifikat Aktivasi
Sertifikat aktivasi adalah lisensi yang dikeluarkan oleh Zevenet yang memungkinkan penggunaan lengkap penyeimbang beban dalam versi Enterprise-nya.
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/v4.0/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.
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/v4.0/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"
}
Hapus Sertifikat aktivasi
Hapus Sertifikat aktivasi
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/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"
}
SSL Sertifikat
Zevenet mendukung sertifikat dalam format PEM untuk menggunakannya dengan farm HTTP yang diatur dengan pendengar HTTPS. Jika Anda ingin mempelajari lebih lanjut tentang cara membuat pem sertifikat, 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/v4.0/zapi.cgi/certificates
zcli certificate list
GET /certificates
Sebutkan semua sertifikat CSR dan PEM di toko sertifikat, sertifikat itu dapat digunakan dengan kebun HTTPS.
Contoh respons:
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.
{
"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 | Ini adalah 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate download example.pem
GET /certificates/<file>
Unduh sertifikat yang dipasang di toko sertifikat, gunakan nama file dalam permintaan untuk mengidentifikasinya.
Header respons:
Respons akan mencakup tajuk yang ditunjukkan di bawah ini dengan informasi tentang file. Tubuh respons akan menjadi konten file.
HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359
Tampilkan detail Sertifikat
Tampilkan detail Sertifikat
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem/info
zcli certificate get example.pem
GET /certificates/<file>/info
Tampilkan semua informasi yang termasuk dalam sertifikat yang diberikan di toko sertifikat, termasuk tanda tangan, diperlukan nama file untuk merujuk.
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:
...
Hapus Sertifikat
Hapus Sertifikat
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate delete example.pem
DELETE /certificates/<file>
Hapus sertifikat dengan nama file di toko sertifikat.
Contoh respons:
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
Buat sertifikat PEM
Buat sertifikat PEM
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"host.domain.com","key":"-----BEGIN PRIVATE KEY-----\nRTQwew...",
"ca","-----BEGIN CERTIFICATE-----\nFQOEW...","intermediates":"-----BEGIN CERTIFICATE-----\nQWESw..."}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/pem
zcli certificate-pem create -name host.domain.com -key "-----BEGIN PRIVATE KEY..." -ca "-----BEGIN CERTIFICATE..." -intermediates "-----BEGIN CERTIFICATE..."
"
POST /certificates/pem
Buat Sertifikat PEM (file PEM).
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| nama | Tali | Nama ID sertifikat. | benar |
| kunci | Tali | Tidak Ada Kunci Pribadi Terenkripsi | benar |
| ca | Tali | Sertifikat Server atau Sertifikat rantai penuh | benar |
| perantara | Tali | Sertifikat Menengah jika diperlukan | palsu |
Contoh respons:
{
"description" : "Create certificate",
"message" : "Certificate host.domain.com created",
"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/v4.0/zapi.cgi/certificates
zcli certificate create -name NewCSR -fqdn host.domain.com -division IT -organization 'Example Corp.' -locality Madrid -state Madrid -country ES -mail info@domain.com
POST /certificates
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 dilokalisasi. | 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate upload example.pem /local_path/to/example.pem
POST /certificates/<file>
Unggah sertifikat PEM untuk pertanian HTTP dengan pendengar HTTPS.
Minta parameter URI
Membutuhkan parameter --tcp-nodelay, dan --data-binary untuk mengunggah file dalam mode biner.
| 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"
}
Daftar Ciphers
Daftar Ciphers
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ciphers
GET /ciphers
Buat daftar cipher yang tersedia yang dapat digunakan tambak HTTPS.
The Pembongkaran SSL sandi hanya akan tersedia jika didukung oleh prosesor.
Contoh respons:
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.
{
"description" : "Get the ciphers available",
"params" : [
{
"ciphers" : "all",
"description" : "All"
},
{
"ciphers" : "highsecurity",
"description" : "High security"
},
{
"ciphers" : "customsecurity",
"description" : "Custom security"
},
{
"ciphers" : "ssloffloading",
"description" : "SSL offloading"
}
]
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| cipher | Tali | Ini digunakan sebagai pengidentifikasi unik. |
| deskripsi | Tali | Nama yang ramah |
Letsencrypt Sertifikat SSL
Zevenet mendukung pembuatan dan pembaruan sertifikat Letsencrypt. Sertifikat akhirnya adalah sertifikat ZEVENET PEM yang dapat digunakan dengan HTTPS Farms. . Jika Anda ingin mempelajari lebih lanjut tentang cara membuat pem sertifikat, silakan kunjungi artikel berikut: Hasilkan SERTIFIKAT DALAM FORMAT PEM
Tampilkan Konfigurasi Letsencrypt
Tampilkan Konfigurasi Letsencrypt
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificate-le-config list
GET /certificates/letsencryptz/config
Tampilkan Konfigurasi Letsencrypt.
Contoh respons:
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
{
"description" : "Get LetsEncrypt Config",
"params" : {
"email" : "test_le@zevenet.com"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Tali | Email untuk Letsencrypt |
Ubah Konfigurasi Letsencrypt
Ubah Konfigurasi Letsencrypt
Contoh permintaan:
curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"email":"test_le@zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificates-le-config set -email test_le@zevenet.com
PUT /certificates/letsencryptz/config
Ubah Konfigurasi Letsencrypt.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Tali | Email untuk digunakan sebagai kontak di Letsencrypt | benar |
Contoh respons:
Responsnya akan menjadi objek JSON dengan parameter di bawah ini.
{
"description" : "Modify LetsEncrypt Config",
"message" : "The Letsencrypt Config has been updated successfully.",
"params" : {
"email" : "test_le@zevenet.com"
},
"success" : "true"
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Tali | Email untuk Letsencrypt |
Daftar semua Sertifikat Letsencrypt
Daftar semua Sertifikat Letsencrypt
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le list
GET /certificates/letsencryptz
Daftar semua sertifikat Letsencrypt yang dibuat.
Contoh respons:
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi larik objek sertifikat letsencrypt, yang masing-masing berisi atribut kunci di bawah ini.
{
"description" : "List LetsEncrypt certificates",
"params" : [
{
"CN" : "*.wildcard.test.zevenet.com",
"creation" : "May 31 05:51:49 2021 GMT",
"domains" : [
"*.wildcard.test.zevenet.com"
],
"expiration" : "Aug 29 05:51:49 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/acme/*.wildcard.test.zevenet.com/fullchain.cer",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "true"
},
{
"CN" : "*.test1.wildcard.test.zevenet.io",
"creation" : "",
"dnstxt" : [
{
"domain" : "*.test1.wildcard.test.zevenet.io",
"txt" : "QpbOLzMrJapoQmcbrA5_dr6ciwLzNF-y3z5XR5i-I2c"
}
],
"domains" : [
"*.test1.wildcard.test.zevenet.io"
],
"expiration" : "",
"file" : null,
"issuer" : "",
"status" : "not issued",
"type" : "LE Certificate",
"wildcard" : "true"
}
]
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| CN | Tali | Nama umum domain. |
| penciptaan | Tali | Tanggal pembuatan. |
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. |
| kedaluwarsa | Tali | Tanggal kadaluarsa. |
| dnstxt | Obyek[] | Daftar Data TXT DNS untuk setiap domain untuk divalidasi jika sertifikat belum diterbitkan. |
| fillet | Tali | Ini adalah nama file sertifikat, ID unik. |
| penerbit | Tali | Otoritas Bersertifikat menandatangani sertifikat. |
| status | Tali | Status sertifikat.sah, sertifikatnya valid.akan kadaluarsa, sertifikat akan segera kedaluwarsa.kadaluarsa, sertifikat kedaluwarsa.tidak dikeluarkan, sertifikat menunggu untuk diterbitkan.tidak dikenal, sertifikat tidak valid. |
| mengetik | Tali | Sertifikat LE. |
| wildcard | Tali | benar, sertifikat untuk domain wildcard. palsu, sertifikatnya untuk domain non-wildcard. |
Objek dnstxt
| Bidang | Tipe | Deskripsi |
|---|---|---|
| domain | Tali | Nama domain |
| txt | Tali | Data txt DNS LetsEncrypt harus divalidasi. Data TXT DNS akan dapat diakses oleh _acme-challenge.domain. |
Mari Enkripsi Sertifikat Wildcard SSL
Let's Encrypt wildcard certificate adalah sertifikat yang hanya valid untuk domain wildcard.
Buat Sertifikat Wildcard Let's Encrypt baru
Buat Sertifikat Wildcard Let's Encrypt baru
Contoh permintaan:
url -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"domains":["*.wildcard.test.zevenet.com"],"test":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard
zcli certificate-le-wildcard create -wildcard true
POST /certificates/letsencryptz-wildcard
Buat sertifikat wildcard Let's Encrypt baru.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. | benar |
| uji | Tali | benar, sertifikat dikeluarkan oleh LetsEncrypt Staging Server. palsu, sertifikat dikeluarkan oleh LetsEncrypt Server dan akan berlaku untuk lingkungan Produksi. | benar |
Contoh respons:
{
"description" : "Create Let's Encrypt Wildcard certificate",
"params" : [
{
"CN" : "*.wildcard.test.zevenet.com",
"creation" : "",
"dnstxt" : [
{
"domain" : "*.wildcard.test.zevenet.com",
"txt" : "jtt2WBHXl0cRw33mgoHUo1hbFGLipNbeb2EtTWpRORM"
}
],
"domains" : [
"*.wildcard.test.zevenet.com"
],
"expiration" : "",
"file" : null,
"issuer" : "",
"status" : "not issued",
"type" : "LE Certificate",
"wildcard" : "true"
}
]
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek[] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| CN | Tali | Nama umum domain. |
| penciptaan | Tali | Tanggal pembuatan. |
| dnstxt | Obyek[] | Daftar Data TXT DNS untuk setiap domain untuk divalidasi jika sertifikat belum diterbitkan. |
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. |
| kedaluwarsa | Tali | Tanggal kadaluarsa. |
| fillet | Tali | Ini adalah nama file sertifikat, ID unik. |
| penerbit | Tali | Otoritas Bersertifikat menandatangani sertifikat. |
| status | Tali | Status sertifikat.sah, sertifikatnya valid.akan kadaluarsa, sertifikat akan segera kedaluwarsa.kadaluarsa, sertifikat kedaluwarsa.tidak dikeluarkan, sertifikat menunggu untuk diterbitkan.tidak dikenal, sertifikat tidak valid. |
| mengetik | Tali | Sertifikat LE. |
| wildcard | Tali | benar, sertifikat untuk domain wildcard. palsu, sertifikatnya untuk domain non-wildcard. |
Objek dnstxt
| Bidang | Tipe | Deskripsi |
|---|---|---|
| domain | Tali | Nama domain |
| txt | Tali | Data txt DNS LetsEncrypt harus divalidasi. Data TXT DNS akan dapat diakses oleh _acme-challenge.domain. |
Tetapkan tindakan di Let's Encrypt Wildcard Certificate
Tetapkan tindakan di Let's Encrypt Wildcard Certificate
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com/actions
zcli certificate-le-wildcard renew *.example.domain.com
POST /certificates/letsencryptz-wildcard/<domain>/actions
Menerapkan tindakan ke sertifikat Let's Encrypt, lihat tabel Parameter permintaan untuk tindakan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| tindakan | Tali | Tindakan untuk mengeksekusi, kemungkinannya adalah: memperbarui, sertifikat akan diperpanjang; uji catatan txt dns akan diperiksa melalui kueri dns. | |
| force_renewal | Tali | (Hanya untuk tindakan "perbarui") benar, memaksa sertifikat untuk diperbarui meskipun tidak kedaluwarsa, palsu, sertifikat akan diperpanjang jika akan diperpanjang ( kurang dari 30 hari kedaluwarsa ). | |
| Restart | Tali | (Hanya untuk tindakan "perbarui") benar, semua peternakan yang menggunakan sertifikat akan dimulai ulang. palsu, tidak ada peternakan yang menggunakan sertifikat yang akan dimulai ulang. | |
| dns | Tali | (Hanya untuk tindakan "pengujian") Server DNS yang akan digunakan untuk menguji data TXT DNS _acme-challenge.domain. |
Contoh respons:
{
"description" : "Let's Encrypt wildcard certificate actions",
"message" : "The action renew has been performed in Let's Encrypt certificate *.test1.wildcard.test.zevenet.io.",
"params" : {
"action" : "renew",
"status" : "valid"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| tindakan | Tali | Tanggal pembuatan. |
| status | Tali | Status sertifikat.sah, sertifikatnya valid.akan kadaluarsa, sertifikat akan segera kedaluwarsa.kadaluarsa, sertifikat kedaluwarsa.tidak dikeluarkan, sertifikat menunggu untuk diterbitkan.tidak dikenal, sertifikat tidak valid. |
| dnstxt | Obyek[] | (Hanya untuk tindakan "pengujian") Daftar Catatan DNS TXT untuk setiap domain dan hasil kueri dnsnya melalui server DNS. |
Objek dnstxt
| Bidang | Tipe | Deskripsi |
|---|---|---|
| dns | Tali | DNS Server yang akan digunakan. "kosong" berarti menggunakan dikonfigurasi dalam sistem. |
| domain | Tali | Nama domain |
| sumber | obyek | Sumber daya DNS untuk diperiksa. |
| status | Tali | Hasil dari pengecekan DNS TXT Record melalui DNS server. turun jika DNS TXT re |
kabel tidak ditemukan server DNS. up jika data TXT DNS ditemukan.
objek sumber daya
| Bidang | Tipe | Deskripsi |
|---|---|---|
| rname | Tali | Nama sumber daya DNS. Let's Encrypt membutuhkan _acme-challenge |
| mengetik | Tali | jenis catatan DNS. Let's Encrypt membutuhkan TXT |
| rdata | Tali | nilai catatan DNS. |
Hapus wildcard Let's Encrypt Certificate
Hapus wildcard Let's Encrypt Certificate
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com
zcli certificate-le-wildcard delete *.example.domain.com
DELETE /certificates/letsencryptz-wildcard/<domain>
Hapus sertifikat wildcard Let's Encrypt menurut domain.
Contoh respons:
{
"description" : "Delete Let's Encrypt wildcard certificate",
"message" : "Let's Encrypt wildcard Certificate example.domain.com has been deleted.",
"success" : "true"
}
Mari Enkripsi SSL Tanpa Sertifikat Wildcard
Let'sEncrypt no wildcard certificate adalah sertifikat yang valid hanya untuk domain tanpa wildcard.
Buat Sertifikat Let'sEncrypt No Wildcard baru
Buat Let's Encrypt No Wildcard Certificate baru
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"lefarm","domains":["test.zevenet.com"],"test":"true","wildcard":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le create -wildcard false
POST /certificates/letsencryptz
Buat sertifikat wildcard Let's Encrypt baru.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| nama pertanian | Tali | Nama pertanian tempat Layanan temporal "Let's Encryptz" dikonfigurasi. | benar jika param vip tidak terkirim. |
| vip | Tali | IP sistem, di mana Farm temporal "Let's Encryptz" dikonfigurasi. | benar jika nama pertanian param tidak terkirim. |
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. | benar |
| wildcard | Tali | benar, sertifikat untuk domain wildcard. palsu, sertifikatnya untuk domain non-wildcard. | benar |
| uji | Tali | benar, sertifikat dikeluarkan oleh LetsEncrypt Staging Server. palsu, sertifikat dikeluarkan oleh LetsEncrypt Server dan akan berlaku untuk lingkungan Produksi. | benar |
Contoh respons:
{
"description" : "Create Let's Encrypt certificate",
"params" : {
"CN" : "test.zevenet.com",
"creation" : "May 31 11:05:30 2021 GMT",
"domains" : [
"test.zevenet.io"
],
"expiration" : "Aug 29 11:05:30 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "false"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| CN | Tali | Nama umum domain. |
| penciptaan | Tali | Tanggal pembuatan. |
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. |
| kedaluwarsa | Tali | Tanggal kadaluarsa. |
| fillet | Tali | Ini adalah nama file sertifikat, ID unik. |
| penerbit | Tali | Otoritas Bersertifikat menandatangani sertifikat. |
| status | Tali | Status sertifikat.sah, sertifikatnya valid.akan kadaluarsa, sertifikat akan segera kedaluwarsa.kadaluarsa, sertifikat kedaluwarsa.tidak dikeluarkan, sertifikat menunggu untuk diterbitkan.tidak dikenal, sertifikat tidak valid. |
| mengetik | Tali | Sertifikat LE. |
| wildcard | Tali | benar, sertifikat untuk domain wildcard. palsu, sertifikatnya untuk domain non-wildcard. |
Tetapkan tindakan di Let's Encrypt no Wildcard Certificate
Tetapkan tindakan di Let's Encrypt No Wildcard Certificate
Contoh permintaan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","vip":"192.168.101.44","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com/actions
zcli certificate-le renew example.domain.com ( not implemented )
POST /certificates/letsencryptz/<domain>/actions
Setel tindakan dalam sertifikat Let's Encrypt no wildcard, lihat tabel Parameter permintaan untuk tindakan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| tindakan | Tali | Tindakan untuk mengeksekusi: kemungkinannya adalah: memperbarui, sertifikat akan diperpanjang. | |
| nama pertanian | Tali | Nama pertanian tempat Layanan temporal "Let's Encryptz" dikonfigurasi untuk memperbarui sertifikat. | benar jika param vip tidak terkirim. |
| vip | Tali | IP sistem, di mana Farm temporal "Let's Encryptz" dikonfigurasi untuk memperbarui sertifikat. | benar jika nama pertanian param tidak terkirim. |
| force_renewal | Tali | benar, memaksa sertifikat untuk diperbarui meskipun tidak kedaluwarsa, palsu, sertifikat akan diperpanjang jika akan diperpanjang ( kurang dari 30 hari kedaluwarsa ). | |
| Restart | Tali | benar, semua peternakan yang menggunakan sertifikat akan dimulai ulang. palsu, tidak ada peternakan yang menggunakan sertifikat yang akan dimulai ulang. |
Contoh respons:
{
"description" : "Let's Encrypt certificate actions",
"params" : {
"CN" : "test.zevenet.com",
"creation" : "May 31 11:35:08 2021 GMT",
"domains" : [
"test.zevenet.com"
],
"expiration" : "Aug 29 11:35:08 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "false"
},
"warning" : "The following farms were been restarted: testl7farm"
}
Parameter respons
Jika are peternakan dimulai kembali, peringatan bidang akan menggambarkannya.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| params | Obyek [] | Daftar objek sertifikat. |
Objek Sertifikat
| Bidang | Tipe | Deskripsi |
|---|---|---|
| CN | Tali | Nama umum domain. |
| penciptaan | Tali | Tanggal pembuatan. |
| domain | Tali[] | Daftar domain tempat sertifikat berlaku. |
| kedaluwarsa | Tali | Tanggal kadaluarsa. |
| fillet | Tali | Ini adalah nama file sertifikat, ID unik. |
| penerbit | Tali | Otoritas Bersertifikat menandatangani sertifikat. |
| status | Tali | Status sertifikat.sah, sertifikatnya valid.akan kadaluarsa, sertifikat akan segera kedaluwarsa.kadaluarsa, sertifikat kedaluwarsa.tidak dikeluarkan, sertifikat menunggu untuk diterbitkan.tidak dikenal, sertifikat tidak valid. |
| mengetik | Tali | Sertifikat LE. |
| wildcard | Tali | benar, sertifikat untuk domain wildcard. palsu, sertifikatnya untuk domain non-wildcard. |
Hapus tanpa wildcard Let's Encrypt Certificate
Hapus tanpa wildcard Let's Encrypt Certificate
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com
zcli certificate-le delete example.domain.com
DELETE /certificates/letsencryptz/<domain>
Hapus sertifikat Let's Encrypt menurut domain.
Contoh respons:
{
"description" : "Delete Let's Encrypt certificate",
"message" : "Let's Encrypt Certificate example.domain.com has been deleted.",
"success" : "true"
}
Pertanian
Zevenet dapat mengatur lalu lintas dengan tiga cara berbeda, setiap cara dikelola oleh modul 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 spesifik 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 serta 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 ringkasan pertanian
Daftar peternakan ringkasan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/modules/summary
GET /farms/modules/summary
Daftar ringkasan dengan peternakan di sistem, dikelompokkan berdasarkan modul.
Contoh respons:
{
"description" : "Farm Modules summary",
"params" : {
"dslb" : [],
"gslb" : [
{
"name" : "dnsServ",
"profile" : "gslb",
"services" : []
}
],
"lslb" : [
{
"name" : "CatalogueWeb",
"profile" : "http",
"services" : [
"technology",
"food"
]
},
{
"name" : "shopApp",
"profile" : "http",
"services" : [
"provider",
"clients"
]
},
{
"name" : "VirtualApps",
"profile" : "l4xnat"
}
]
}
}
Parameter respons
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array peternakan dengan layanan mereka.
Objek Pertanian:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama pertanian | Tali | Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik untuk pertanian. |
| 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 |
| layanan | Tali[] | Ini adalah daftar nama layanan yang terdapat di tambak. Bidang ini akan tersedia di tambak jenis http, https, dan gslb. |
Daftar semua peternakan
Daftar semua peternakan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm list
GET /farms
Daftar semua peternakan yang tersedia
Contoh respons:
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
Parameter respons
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.
Objek Pertanian:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama pertanian | Tali | Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik untuk pertanian. |
| 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 pertanian. Nilai status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, tambak sudah habis dan semua backend tidak dapat dijangkau atau pemeliharaan; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; pemeliharaan, tambak naik dan ada backend dalam status naik, tetapi hampir sebuah backend dalam mode pemeliharaan; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| vip | Tali | IP virtual tempat tambak 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. |
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/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm delete FarmHTTP
DELETE /farms/<farmname>
Hapus sebuah peternakan melalui pengidentifikasi namanya.
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/v4.0/zapi.cgi/farms/FarmTCP/actions
zcli farm stop FarmTCP
PUT /farms/<farmname>/actions
Terapkan tindakan ke tambak, lihat tabel Parameter permintaan untuk tindakan.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| tindakan | Tali | Tindakan untuk mengeksekusi, kemungkinannya adalah: berhenti, tambak akan dihentikan, memotong koneksi saat ini dan tidak menerima lebih banyak koneksi; awal, tambak akan dimulai, menjalankan pendengar dan menyeimbangkan koneksi baru di antara backend-nya; 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 proksi. Profil ini menawarkan beberapa fitur seperti penyeimbangan beban HTTPS yang dikombinasikan dengan akselerasi pemuatan SSL. Profil ini memadai 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 pertanian ini, alamat IP virtual, dan TCP virtual port 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/v4.0/zapi.cgi/farms/httpFarm
zcli farm get httpFarm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Contoh respons:
{
"description" : "List farm httpFarm",
"ipds" : {
"blacklists" : [
{
"name" : "outside",
"status" : "down"
}
],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
],
"waf" : [
{
"name" : "XSSi",
"status" : "down"
},
{
"name" : "SQLi",
"status" : "up"
}
]
},
"params" : {
"addheader" : [
{
"header" : "load-balancer: true",
"id" : 0
}
],
"addresponseheader" : [
{
"header" : "Session: true",
"id" : 0
}
],
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"errorWAF" : "The request was rejected by the server.",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"headremove" : [
{
"id" : 0,
"pattern" : "^client"
}
],
"httpverb" : "MSRPCext",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "false",
"removeresponseheader" : [
{
"id" : 0,
"pattern" : "Host"
}
],
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : "check_tcp",
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"redirect" : "http://192.168.101.254/index.html",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
{
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"priority" : null
}
],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : null,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
]
}
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 | Obyek[] | Aturan daftar hitam diterapkan ke tambak. |
| dos | Obyek[] | Aturan DoS diterapkan ke tambak. |
| rbl | Obyek[] | Aturan RBL diterapkan ke tambak. |
| WAF | Obyek[] | Ini adalah objek dengan satu kunci, nama. |
Daftar Hitam, Objek DoS dan RBL:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Nama aturan. |
| status | Tali | Status aturan. |
Objek parameter untuk HTTP farms:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| addheader | Obyek[] | Ini adalah daftar objek dengan header untuk ditambahkan ke permintaan klien. |
| tajuk tanggapan tambahan (dari 4.0.1) | Obyek[] | Ini adalah daftar objek dengan header untuk ditambahkan ke respon backend. |
| daftar sertifikat | Obyek[] | Hanya jika pendengarnya adalah HTTPS. Daftar sertifikat telah digunakan oleh tambak, mereka memiliki dalam format PEM, diizinkan untuk menambahkan lebih dari satu sertifikat PEM ke tambak yang sama untuk dukungan SNI. Sertifikat apa pun di toko sertifikat dapat digunakan di sini. |
| sandi | Tali | Hanya di pendengar https. Ini adalah daftar penyandian yang diizinkan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti pada penyandian OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai "keamanan pabean". |
| cipher | Tali | Hanya jika pendengarnya adalah HTTPS. Digunakan untuk membuat daftar sandi yang diterima oleh koneksi SSL untuk mengeraskan koneksi SSL. Opsinya adalah: semua, semua sandi akan diterima; keamanan tinggi, hanya cipher untuk keamanan tinggi yang akan diterima; keamanan bea cukai, hanya cipher yang dimuat sandi bidang akan diterima; atau ssloffloading, itu mengalihkan pekerjaan enkripsi ke proses, sandi ini tergantung pada prosesor. |
| contimeout | Jumlah | Berapa lama peternakan akan menunggu koneksi TCP ke backend dalam hitungan detik. |
| disable_sslv2 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan SSL dengan versi 2 tidak diizinkan; atau palsu jika protokol SSLv2 diizinkan. |
| disable_sslv3 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan SSL dengan versi 3 tidak diizinkan; atau palsu jika protokol SSLv3 diizinkan. |
| disable_tlsv1 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1 tidak diizinkan; atau palsu jika protokol TLSv1 diizinkan. |
| disable_tlsv1_1 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1.1 tidak diizinkan; atau palsu jika protokol TLSv1.1 diizinkan. |
| disable_tlsv1_2 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1.2 tidak diizinkan; atau palsu jika protokol TLSv1.2 diizinkan. |
| kesalahanWAF | Tali | Pesan yang dipersonalisasi untuk merespons ketika WAF menolak permintaan (dari 4.0.2). |
| 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. |
| Headremove | Obyek[] | Ini adalah daftar ekspresi reguler untuk menghapus header dari permintaan klien. Header yang dihapus tidak akan mencapai backend. |
| httpverb | Tali | Bidang ini menunjukkan operasi yang akan diizinkan untuk permintaan klien HTTP. nilai yang tersedia adalah: standardHTTP, permintaan HTTP yang diterima GET, POST, HEAD. extendedHTTP, menerima permintaan HTTP sebelumnya plus PUT, DELETE. pilihanHTTP (dari 4.0.1), tambahkan kata kerja OPSI ke yang sebelumnya. 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 itu peka terhadap huruf besar-kecil. |
| Abaikan_100_lanjutkan | Tali | Jika bidang ini memiliki nilai benar itu 100 melanjutkan Header HTTP akan diabaikan; jika nilainya palsu, yang 100 melanjutkan header akan diproses. |
| 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. |
| log | Tali | Peternakan Mencatat jejak koneksi HTTP. Jika parameter ini memiliki nilai benar, log diaktifkan; jika memiliki nilai palsu, log dinonaktifkan. |
| hapus tajuk tanggapan (dari 4.0.1) | Obyek[] | Ini adalah daftar ekspresi reguler untuk menghapus header dari respons backend. Header yang dihapus tidak akan mencapai klien. |
| 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 | Obyek[] | 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. Dari 4.0.2 pilihan baru yang tersedia: jalur yang diaktifkan serta jalur-backend yang diaktifkan. jalur berlaku jika arahan RewriteUrl mengubah URL permintaan. Bendera ini memaksa untuk mengembalikan transformasi URL yang dilakukan RewriteUrl. |
| status | Tali | Status pertanian. Nilai status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, tambak sudah habis dan semua backend tidak dapat dijangkau atau pemeliharaan; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; pemeliharaan, tambak naik dan ada backend dalam status naik, tetapi hampir sebuah backend dalam mode pemeliharaan; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| 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, tidak ada 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. |
| penjaga pertanian | Tali | Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik. |
| httpsb | Tali | Parameter ini menunjukkan kepada tambak bahwa backend diatur untuk 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 penyeimbangan respons paling sedikit. benar sering kali profil memeriksa backend yang membutuhkan waktu lebih sedikit untuk merespons untuk mengirim lebih banyak koneksi ke koneksi ini, the 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 | Itu berperilaku seperti backend khusus, karena permintaan klien dijawab oleh pengalihan ke URL baru secara otomatis. Jika pengalihan dikonfigurasi maka permintaan tidak akan diteruskan ke backend, Pengalihan akan ditanggapi kepada klien sebagai gantinya. |
| redirect_code | Jumlah | Ini adalah kode HTTP yang dikembalikan ketika pengalihan dikonfigurasi. Nilai yang mungkin adalah 301, 302, 307, |
| 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 tajuk HTTP dan akan mengelola sesi klien. |
| sts_status | Tali | Status tajuk Keamanan Transportasi Ketat. Untuk mengaktifkan fitur ini, perlu untuk mengatur pendengar farm sebagai HTTPS. Nilai yang mungkin adalah: benar untuk mengaktifkan arahan STS dalam layanan; atau palsu untuk menonaktifkan arahan STS dalam layanan. |
| sts_timeout | Jumlah | Waktu (dalam detik) bahwa klien ingat bahwa layanan hanya tersedia dengan HTTS. |
| Ttl | Jumlah | Hanya dengan kegigihan. Nilai ini menunjukkan waktu hidup maksimum untuk sesi klien tidak aktif (usia sesi maks) dalam detik. |
| urlp | Tali | Mengizinkan 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. |
| koneksi yang disematkan (dari versi 4.0.2) | Jumlah | Tentukan jika kita ingin menyematkan semua koneksi, (default: 0, tidak disematkan). Jika Pinnedconnection disetel ke 1, zproxy langsung meneruskan semua data tanpa menguraikan atau mengedit. |
| kebijakan perutean (dari versi 4.0.2) | Tali | Tentukan kebijakan perutean. Semua algoritme diberi bobot dengan semua bobot yang ditetapkan di setiap backend. Ada empat opsi: ROUND_ROBIN menggunakan algoritma round robin sebagai kebijakan routing (kegagalan). LEAST_CONNECTIONS pilih backend dengan koneksi paling sedikit dibuat menggunakan proporsi bobot yang ditetapkan. WAKTU MERESPON pilih backend dengan waktu respons terendah menggunakan proporsi bobot yang ditetapkan. PENDING_CONNECTIONS pilih backend dengan koneksi tertunda paling sedikit menggunakan proporsi bobot yang ditetapkan. |
| penulisan ulang (dari versi 4.0.2) | Obyek[] | Itu memeriksa pola untuk mendapatkan string dari URL dan menggantinya. Beberapa arahan RewriteUrl dapat ditambahkan. Semuanya akan diterapkan secara berurutan ke URL yang masuk kecuali jika flag terakhir disetel yang akan menyelesaikan fase penulisan ulang url. |
Objek backend untuk pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
| batas waktu | Jumlah | Ini adalah waktu maksimum menunggu tanggapan backend sebelum menandainya sebagai tidak tersedia. Waktu ini dalam detik. |
| 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. Nilai yang mungkin berasal dari 1 untuk 9. |
| prioritas (dari 4.0.1) | Jumlah | (Hanya ketika proxy generasi baru bekerja) Ini adalah nilai prioritas untuk server nyata saat ini, backend dengan nilai prioritas yang lebih rendah akan siap menerima koneksi sebelum dari yang lain dengan prioritas yang lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9 |
| koneksi_batas (dari 4.0.2) | Jumlah | (Hanya ketika proxy generasi baru berfungsi) Jumlah maksimum koneksi yang dibuat per backend. Dengan nilai 0, tidak akan ada batasan di backend. Klien akan menerima kesalahan 503 jika tidak ada backend yang tersedia. |
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/v4.0/zapi.cgi/farms
zcli farm create -farmname newHTTPfarm -profile http -vip 192.168.100.23 -vport 80
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 HTTP farms 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 |
| salin_dari (dari 4.0.1) | Tali | Parameter ini mengharapkan nama pertanian yang ada. Jika parameter ini dikirim, tambak disalin dari tambak yang ditentukan di dalamnya. Itu nama pertanian, vip serta olahraga nilai akan ditimpa. |
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,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP", "errorWAF":"Message error WAF",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -contimeout 22 -newfarmname FarmHTTP2 -vip 178.62.126.152 -vport 88 -ignore_100_continue true -restimeout 47 -resurrectime 12 -reqtimeout 32 -rewritelocation enabled -httpverb standardHTTP -errorcode414 'Message error 414' -logs true
PUT /farms/<farmname>
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. |
| disable_sslv2 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan SSL dengan versi 2 tidak diizinkan; atau palsu jika protokol SSLv2 diizinkan. |
| disable_sslv3 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan SSL dengan versi 3 tidak diizinkan; atau palsu jika protokol SSLv3 diizinkan. |
| disable_tlsv1 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1 tidak diizinkan; atau palsu jika protokol TLSv1 diizinkan. |
| disable_tlsv1_1 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1.1 tidak diizinkan; atau palsu jika protokol TLSv1.1 diizinkan. |
| disable_tlsv1_2 | Tali | Hanya di pendengar https. Jika bidang ini memiliki nilai benar koneksi yang menggunakan protokol keamanan TLS dengan versi 1.2 tidak diizinkan; atau palsu jika |
| 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 diterima GET, POST, HEAD. extendedHTTP, menerima permintaan HTTP sebelumnya plus PUT, DELETE. pilihanHTTP (dari 4.0.1), tambahkan kata kerja OPSI ke yang sebelumnya. 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 itu peka terhadap huruf besar-kecil. |
| Abaikan_100_lanjutkan | Tali | Jika bidang ini memiliki nilai benar itu 100 melanjutkan Header HTTP akan diabaikan; jika nilainya palsu, yang 100 melanjutkan header akan diproses. |
| kesalahanWAF | Tali | Pesan kesalahan yang dipersonalisasi WAF (dari versi 4.0.2). |
| 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. |
| log | Tali | Peternakan Mencatat jejak koneksi HTTP. Jika parameter ini memiliki nilai benar, log diaktifkan; jika memiliki nilai palsu, log dinonaktifkan. |
| 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 sandi akan diterima; keamanan tinggi, hanya cipher untuk keamanan tinggi yang akan diterima; keamanan bea cukai, hanya cipher yang dimuat sandi bidang akan diterima; atau ssloffloading, itu mengalihkan pekerjaan enkripsi ke proses, sandi ini tergantung pada prosesor. |
| sandi | Tali | Hanya di pendengar https. Ini adalah daftar penyandian yang diizinkan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti pada penyandian OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai "keamanan pabean". |
| 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. |
| nama pasti | Tali | Sertifikat HTTPs dikonfigurasi |
Contoh respons:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
"ciphers" : "customsecurity",
"contimeout" : 22,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"errorWAF" : "Message error WAF",
"error414" : "Message error 414",
"error500" : "Message error 500",
"error501" : "Message error 501",
"error503" : "Message error 503",
"httpverb" : "standardHTTP",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "true",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
Parameter respons
Respons akan menjadi JSON dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan Header Kustom ke Permintaan
Tambahkan Header Kustom ke Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"
POST /farms/<farmname>/addheader
Peternakan akan menambahkan header ke backend.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Ini adalah string dengan tajuk yang akan dikirim ke backend. | benar |
Contoh respons:
{
"description" : "Add addheader directive.",
"message" : "Added a new item to the addheader list",
"status" : "needed restart",
"success" : "true"
}
Ubah dan tambahkan Header Kustom ke aturan Permintaan
Ubah dan tambahkan Header Kustom ke aturan Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/id
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"
PUT /farms/<farmname>/addheader/<id>
Peternakan akan menambahkan header ke backend.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Ini adalah string dengan tajuk yang akan dikirim ke backend. | benar |
Contoh respons:
{
"description" : "Modify an addheader directive.",
"message" : "Modified an item from the addheader list",
"success" : "true"
}
Hapus Header Kustom dari Permintaan
Hapus Header Kustom dari Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/0
zcli farm-add-request-header remove MyHttpFarm 0
DELETE /farms/<farmname>/addheader/<index>
indeks adalah indeks dari array addheader yang akan dihapus.
Contoh respons:
{
"description" : "Delete addheader directive.",
"message" : "The addheader 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Tambahkan Aturan untuk Menghapus Tajuk dari Permintaan
Tambahkan Aturan untuk Menghapus Tajuk dari Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"
POST /farms/<farmname>/headremove
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Add headremove directive.",
"message" : "Added a new item to the headremove list",
"status" : "needed restart",
"success" : "true"
}
Ubah Header Hapus dari aturan Permintaan
Ubah Header Hapus dari aturan Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/id
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"
PUT /farms/<farmname>/headremove/<id>
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Modify an headremove directive.",
"message" : "Modified an item from the headremove list",
"success" : "true"
}
Hapus Aturan untuk Menghapus Tajuk dari Permintaan
Hapus Aturan untuk Menghapus Tajuk dari Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/0
zcli farm-remove-request-header remove MyHttpFarm 0
DELETE /farms/<farmname>/headremove/<index>
indeks adalah indeks array headremove untuk dihapus.
Contoh respons:
{
"description" : "Delete headremove directive.",
"message" : "The headremove 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Tambahkan Header Kustom ke Respons
Tambahkan Header Kustom ke Respons
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/addresponseheader
Peternakan akan menambahkan tajuk ke respons backend.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Ini adalah string dengan tajuk yang akan dikirim ke backend. | benar |
Contoh respons:
{
"description" : "Add a header to the backend repsonse.",
"message" : "Added a new header to the backend response",
"status" : "needed restart",
"success" : "true"
}
Ubah dan tambahkan Header Kustom ke aturan Respon
Ubah dan tambahkan Header Kustom ke aturan Respon
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/id
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/addresponseheader/<id>
Peternakan akan menambahkan tajuk ke respons backend.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Ini adalah string dengan tajuk yang akan dikirim ke backend. | benar |
Contoh respons:
{
"description" : "Modify an addresponseheader directive.",
"message" : "Modified an item from the addresponseheader list",
"success" : "true"
}
Hapus Header Kustom dari Respons
Hapus Header Kustom dari Respons
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/0
zcli farm-add-response-header remove torta 0
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/addresponseheader/<index>
indeks adalah indeks dari array addresponseheader untuk dihapus.
Contoh respons:
{
"description" : "Delete a header previously added to the backend response.",
"message" : "The header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Tambahkan Aturan untuk Menghapus Tajuk dari Respons
Tambahkan Aturan untuk Menghapus Tajuk dari Respons
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/removeresponseheader
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Remove a header from the backend response.",
"message" : "Added a patter to remove reponse headers",
"status" : "needed restart",
"success" : "true"
}
Ubah aturan Hapus Header dari Respon
Ubah aturan Hapus Header dari Respon
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/id
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/removeresponseheader/<id>
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Modify a remove response header directive.",
"message" : "Modified an item from the removeresponseheader list",
"success" : "true"
}
Hapus Aturan untuk Menghapus Tajuk dari Respons
Hapus Aturan untuk Menghapus Tajuk dari Respons
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/0
zcli farm-remove-response-header remove torta 0
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/removeresponseheader/<index>
indeks adalah indeks dari array removeresponseheader untuk dihapus.
Contoh respons:
{
"description" : "Delete a pattern to remove response headers.",
"message" : "The pattern 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Tambahkan Aturan untuk Menulis Ulang Header dari Permintaan
Tambahkan Aturan untuk Menulis Ulang Header dari Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/replacerequestheader
Tambahkan aturan untuk menulis ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"status" : "needed restart",
"success" : "true"
}
Ubah Header Penulisan Ulang dari aturan Permintaan
Ubah Header Penulisan Ulang dari aturan Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/replacerequestheader/<id>
Tambahkan aturan untuk menulis ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Hapus Aturan untuk Menulis Ulang Header dari Permintaan
Hapus Aturan untuk Menulis Ulang Header dari Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/0
zcli farm-replace-request-header remove MyHttpFarm 0
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/replacerequestheader/<index>
indeks adalah indeks dari array replacerequestheader yang akan dihapus.
Contoh respons:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Pindahkan Header Tulis Ulang dari aturan Permintaan
Pindahkan Header Tulis Ulang dari aturan Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id/actions
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/replacerequestheader/<id>/actions
Pindahkan Header ReplaceRequest.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Jumlah | Posisi aturan baru | benar |
Contoh respons:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Tambahkan Aturan untuk Menulis Ulang Header dari Respon
Tambahkan Aturan untuk Menulis Ulang Header dari Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/replaceresponseheader
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"status" : "needed restart",
"success" : "true"
}
Ubah Header Penulisan Ulang dari aturan Respon
Ubah Header Penulisan Ulang dari aturan Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/replaceresponseheader/<id>
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Hapus Aturan untuk Menulis Ulang Header dari Respon
Hapus Aturan untuk Menulis Ulang Header dari Respon
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/0
zcli farm-replace-response-header remove MyHttpFarm 0
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/replaceresponseheader/<index>
indeks adalah indeks dari array replaceresponseheader yang akan dihapus.
Contoh respons:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Pindahkan Header Tulis Ulang dari aturan Permintaan
Pindahkan Header Tulis Ulang dari aturan Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/replaceresponseheader/<id>/actions
Pindahkan Header ReplaceRequest.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Jumlah | Posisi aturan baru | benar |
Contoh respons:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
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/v4.0/zapi.cgi/farms/httpFarm/certificates
zcli farm-certificate add httpFarm -file example.pem
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"
}
Pindahkan Sertifikat
Pindahkan Sertifikat
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/v4.0/zapi.cgi/farms/newfarm/certificates/certif.pem/actions
zcli farm-certificate move newfarm zertif.pem -position 0
POST /farms/<farmname>/certificates/<file>/actions
URI file parameter adalah nama file sertifikat yang akan dipindahkan.
Fitur ini memungkinkan pemindahan sertifikat untuk mengubah urutan bahwa mereka akan diperiksa.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Bilangan bulat | Ini adalah posisi yang akan dimiliki sertifikat dalam konfigurasi tambak ketika panggilan ZAPI akan diproses | benar |
Contoh respons:
{
"description" : "Move service",
"params" : {
"position" : 0
},
"status" : "needed restart",
"info" : "There\'re changes that need to be applied, stop and start farm to apply them!",
"message" : "certif.pem was moved successfully."
}
Hapus Sertifikat
Hapus Sertifikat
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
zcli farm-certificate remove MyHttpFarm example.pem
DELETE /farms/<farmname>/certificates/<file>
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/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists
zcli farm-blacklist add httpFarm -name china
POST /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>
Terapkan aturan blacklist, DoS, RBL atau WAF 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"
}
Pindahkan aturan IPDS
Pindahkan aturan IPDS
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2
POST /farms/<farmname>/ipds/<waf|blacklists>/<name>/actions
Aturan pemindahan IPDS hanya tersedia untuk aturan WAF dan Daftar Hitam. Dalam aturan semacam ini penting urutan yang akan diperiksa.
The name Parameter URI adalah nama aturan dari set yang akan dipindahkan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Bilangan bulat | Ini adalah posisi yang akan dimiliki aturan IPDS dalam konfigurasi tambak ketika panggilan ZAPI akan diproses | benar |
Contoh respons:
{
"message" : "The rule was moved properly to the position 2.",
"description" : "Move a rule in the set test_waf_ori"
}
Hapus aturan IPDS
Hapus aturan IPDS
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists/china
zcli farm-blacklist remove httpFarm china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>/<name>
Hapus aturan blacklist, DoS, RBL atau WAF dari farm yang diberikan menggunakan indikatornya 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.
Ambil layanan dengan ID
Ambil layanan dengan ID
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/cookiefarm/services/serv
zcli farm get cookiefarm -filter services
GET /farms/<farmname>/services/<id>
Tampilkan semua konfigurasi tentang layanan yang diberikan.
Contoh respons:
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null,
"priority" : null,
"connection_limit" : null
},
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"priority" : null,
"connection_limit" : null
}
],
"cookiedomain" : "zevenet.cpm",
"cookieinsert" : "true",
"cookiename" : "peasocookie",
"cookiepath" : "/patfh",
"cookiettl" : 20,
"farmguardian" : "check_tcp-cut_conns",
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirect_code" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN",
"replacerequestheader" : [],
"replaceresponseheader" : [],
"addrequestheader" : [],
"addresponseheader" : [],
"removerequestheader" : [],
"removeresponseheader" : [],
"rewriteurl" : [],
"sessions" : []
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan format di bawah ini.
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. |
| penjaga pertanian | Tali | Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik. |
| httpsb | Tali | Parameter ini menunjukkan kepada tambak bahwa backend dikonfigurasikan untuk menggunakan HTTPS, maka 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 penyeimbangan respons paling sedikit. benar sering kali profil memeriksa backend yang membutuhkan waktu lebih sedikit 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 | Itu berperilaku seperti backend khusus, karena permintaan klien dijawab oleh pengalihan ke URL baru secara otomatis. Jika pengalihan dikonfigurasi maka permintaan tidak akan diteruskan ke backend, Pengalihan akan ditanggapi kepada klien sebagai gantinya. |
| redirect_code | Jumlah | Ini adalah kode HTTP yang dikembalikan ketika pengalihan dikonfigurasi. Nilai yang mungkin adalah 301, 302, 307. |
| 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 tajuk HTTP dan akan mengelola sesi klien. |
| sts_status | Tali | Status tajuk Keamanan Transportasi Ketat. Untuk mengaktifkan fitur ini, perlu untuk mengatur pendengar farm sebagai HTTPS. Nilai yang mungkin adalah: benar untuk mengaktifkan arahan STS dalam layanan; atau palsu untuk menonaktifkan arahan STS dalam layanan. |
| sts_timeout | Jumlah | Waktu (dalam detik) bahwa klien ingat bahwa layanan hanya tersedia dengan HTTS. |
| Ttl | Jumlah | Hanya dengan kegigihan. Nilai ini menunjukkan waktu hidup maksimum untuk sesi klien tidak aktif (usia sesi maks) dalam detik. |
| urlp | Tali | Mengizinkan 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. |
| koneksi yang disematkan (dari versi 4.0.2) | Jumlah | Tentukan jika kita ingin menyematkan semua koneksi, (default: 0, tidak disematkan). Jika Pinnedconnection disetel ke 1, zproxy langsung meneruskan semua data tanpa menguraikan atau mengedit. |
| kebijakan perutean (dari versi 4.0.2) | Tali | Tentukan kebijakan perutean. Semua algoritme diberi bobot dengan semua bobot yang ditetapkan di setiap backend. Ada empat opsi: ROUND_ROBIN menggunakan algoritma round robin sebagai kebijakan routing (defaultT). LEAST_CONNECTIONS pilih backend dengan koneksi paling sedikit dibuat menggunakan proporsi bobot yang ditetapkan. WAKTU MERESPON pilih backend dengan waktu respons terendah menggunakan proporsi bobot yang ditetapkan. PENDING_CONNECTIONS pilih backend dengan koneksi tertunda paling sedikit menggunakan proporsi bobot yang ditetapkan. |
| ganti requestheader (dari versi 4.0.2) | Obyek[] | Array aturan untuk mengganti header dalam permintaan. Jika beberapa regex cocok di header, hanya yang pertama yang akan berlaku. Arahan replaceHeader dalam layanan memiliki prioritas di atas pendengar. |
| ganti responsheader (dari versi 4.0.2) | Obyek[] | Array aturan untuk mengganti header sebagai tanggapan. Jika beberapa regex cocok di header, hanya yang pertama yang akan berlaku. Arahan replaceHeader dalam layanan memiliki prioritas di atas pendengar. |
| alamat permintaan (dari versi 4.0.2) | Obyek[] | Array aturan untuk Menambahkan header yang ditentukan ke permintaan yang diteruskan ke klien. Header ditambahkan kata demi kata. |
| tajuk tanggapan tambahan (dari versi 4.0.2) | Obyek[] | Array aturan untuk Menambahkan header yang ditentukan ke respons yang diteruskan ke klien. Header ditambahkan kata demi kata. |
| hapus permintaanheader (dari versi 4.0.2) | Obyek[] | Array aturan untuk Hapus header tertentu dari permintaan hasil, header yang dikirim oleh backend tidak dikirim ke klien. |
| hapus tajuk tanggapan (dari versi 4.0.2) | Obyek[] | Array aturan untuk Menghapus tajuk tertentu dari respons hasil, tajuk yang dikirim oleh backend tidak dikirim ke klien. |
| penulisan ulang (dari versi 4.0.2) | Obyek[] | Array aturan untuk Mengubah header Lokasi dan Lokasi Konten dalam respons untuk menunjukkan host virtual yang dikirim dalam permintaan. |
| sesi (dari versi 4.0.2) | Obyek[] | Daftar sesi statis dan dinamis yang dibuat untuk layanan pertanian ini. |
Objek backend untuk pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
| batas waktu | Jumlah | Ini adalah waktu maksimum menunggu tanggapan backend sebelum meletakkannya sebagai down. Waktu ini dalam detik. |
| 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. Nilai yang mungkin berasal dari 1 untuk 9. |
| prioritas (dari 4.0.1) | Jumlah | (Hanya ketika proxy generasi baru bekerja) Ini adalah nilai prioritas untuk server nyata saat ini, backend dengan nilai prioritas yang lebih rendah akan siap menerima koneksi sebelum dari yang lain dengan prioritas yang lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9. |
| koneksi_batas (dari 4.0.2) | Jumlah | (Hanya ketika proxy generasi baru berfungsi) Jumlah maksimum koneksi yang dibuat per backend. Dengan nilai 0, tidak akan ada batasan di backend. Klien akan menerima kesalahan 503 jika tidak ada backend yang tersedia. |
replaceRequestHeader dan replaceResponseHeader objek untuk layanan pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang. |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti. |
| menggantikan | Tali | Nilai untuk mengganti kecocokan. |
addRequestHeader dan objek addResponseHeader untuk layanan pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang. |
removeRequestHeader dan removeResponseHeader objek untuk layanan pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp yang harus dicari dalam permintaan klien. Jika beberapa header cocok dengan pola, header akan dihapus. |
rewriteUrl objek untuk layanan pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp yang harus dicari di url. Jika url cocok dengan pola, teks yang cocok akan diganti. |
| menggantikan | Tali | Ini adalah string untuk menggantikan teks yang cocok. |
| terakhir | Tali | Benar atau salah. Jika true disetel, itu akan menyelesaikan fase url penulisan ulang. |
objek sesi untuk layanan pertanian HTTP:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'IP' Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi tidak bertipe statis. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
zcli farm-service add FarmHTTP -id newserv
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_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true","pinnedconnection":0,"routingpolicy":"ROUND_ROBIN"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -vhost www.mywebserver.com -urlp ^/myapp1$ -persistence URL -redirect_code 302 -redirect http://zenloadbalancer.com -ttl 125 -sessionid sid -sts_status true -sts_timeout 21600000 -pinnedconnection 0 -routingpolicy ROUND_ROBIN
PUT /farms/<farmname>/services/<id>
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 | Mengizinkan 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. |
| redirect_code | Jumlah | Ini adalah kode HTTP yang dikembalikan ketika pengalihan dikonfigurasi. Nilai yang mungkin adalah 301, 302, 307, |
| 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. |
| sts_status | Tali | Status tajuk Keamanan Transportasi Ketat. Untuk mengaktifkan fitur ini, perlu untuk mengatur pendengar farm sebagai HTTPS. Nilai yang mungkin adalah: benar untuk mengaktifkan arahan STS dalam layanan; atau palsu untuk menonaktifkan arahan STS dalam layanan. |
| sts_timeout | Jumlah | Waktu (dalam detik) bahwa klien ingat bahwa layanan hanya tersedia dengan HTTS. |
| setidaknya respons | Tali | Ini memungkinkan metode penyeimbangan respons paling sedikit. benar, sering kali profil memeriksa backend yang membutuhkan waktu lebih sedikit untuk merespons untuk mengirim lebih banyak koneksi ke yang ini, palsu, profil tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons. |
| httpsb | Tali | Ini menunjukkan kepada farm bahwa server backend diatur untuk menggunakan HTTPS, maka 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. |
| koneksi yang disematkan (dari versi 4.0.2) | Jumlah | Tentukan jika kita ingin menyematkan semua koneksi, (default: 0, tidak disematkan). Jika Pinnedconnection disetel ke 1, zproxy langsung meneruskan semua data tanpa menguraikan atau mengedit. |
| kebijakan perutean (dari versi 4.0.2) | Tali | Tentukan kebijakan perutean. Semua algoritme diberi bobot dengan semua bobot yang ditetapkan di setiap backend. Ada empat opsi: ROUND_ROBIN menggunakan algoritma round robin sebagai kebijakan routing (kegagalan). LEAST_CONNECTIONS pilih backend dengan koneksi paling sedikit dibuat menggunakan proporsi bobot yang ditetapkan. WAKTU MERESPON pilih backend dengan waktu respons terendah menggunakan proporsi bobot yang ditetapkan. PENDING_CONNECTIONS pilih backend dengan koneksi tertunda paling sedikit menggunakan proporsi bobot yang ditetapkan. |
| lokasi penulisan ulang (dari versi 4.0.2) | 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. Pilihan lain yang tersedia: jalur yang diaktifkan serta jalur-backend yang diaktifkan. jalur berlaku jika arahan RewriteUrl mengubah URL permintaan. Bendera ini memaksa untuk mengembalikan transformasi URL yang dilakukan RewriteUrl. |
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,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "sid",
"sts_status" : "true",
"sts_timeout" : 21600000,
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
"status" : "needed restart"
}
Parameter Respon
Respons akan menjadi JSON dengan parameter yang diminta diperbarui dan status bidang dengan status pertanian saat ini. Jika perlu Restart tindakan untuk menerapkan perubahan tambak, nilainya akan menjadi diperlukan restart.
Tambahkan FarmGuardian
Tambahkan FarmGuardian
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/fg
zcli farm-service-farmguardian add FarmHTTP service1 -name check_tcp-cut_conns
POST /farms/<farmname>/services/<id>/fg
Terapkan FarmGuardian ke layanan.
Parameter URI adalah pengidentifikasi unik layanan.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Pengidentifikasi unik FarmGuardian. FarmGuardians dibuat dan dimodifikasi di bagian pemantauan. |
Contoh respons:
{
"description" : "Add the farm guardian check_tcp-cut_conns to the service service1 in the farm FarmHTTP",
"message" : "Success, The farm guardian check_tcp-cut_conns was added to the service service1 in the farm FarmHTTP"
}
Hapus FarmGuardian
Hapus FarmGuardian
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove FarmHTTP service1 check_tcp-cut_conns
DELETE /farms/<farmname>/services/<id>/fg/<name>
Hapus FarmGuardian dari layanan di sebuah peternakan.
Contoh respons:
{
"description" : "Remove the farm guardian check_tcp-cut_conns from the service service1 in the farm FarmHTTP",
"message" : "Sucess, check_tcp-cut_conns was removed from the service service1 in the farm FarmHTTP"
}
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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/actions
zcli farm-service move FarmHTTP service1 -position 0
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 ulang tambak 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1
zcli farm-service remove FarmHTTP 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"
}
Tambahkan Aturan untuk Menulis Ulang Header dari Permintaan
Tambahkan Aturan untuk Menulis Ulang Header dari Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/service/<servicename>/replacerequestheader
Tambahkan aturan untuk menulis ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header"
}
Ubah Header Penulisan Ulang dari aturan Permintaan
Ubah Header Penulisan Ulang dari aturan Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>
Ubah aturan penulisan ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Modify replaceHeader directive.",
"message" : "Modified an item from the ReplaceHeader list",
"success" : "true"
}
Ubah Header Penulisan Ulang dari aturan Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>
Ubah aturan penulisan ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Modify replaceHeader directive.",
"message" : "Modified an item from the ReplaceHeader list",
"success" : "true"
}
Hapus Aturan untuk Menulis Ulang Header dari Permintaan
Hapus Aturan untuk Menulis Ulang Header dari Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/Index
zcli farm-service-replacerequestheader remove MyHttpFarm MyService Index
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/service/<servicename>/replacerequestheader/<index>
indeks adalah indeks dari array replacerequestheader yang akan dihapus.
Contoh respons:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"success" : "true"
}
Tambahkan Aturan untuk Menulis Ulang Header dari Respon
Tambahkan Aturan untuk Menulis Ulang Header dari Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/service/<servicename>/replaceresponseheader
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"success" : "true"
}
Pindahkan Header Tulis Ulang dari aturan Permintaan
Pindahkan Header Tulis Ulang dari aturan Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/services/<service>/replacerequestheader/<id>/actions
Pindahkan Header ReplaceRequest.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Jumlah | Posisi aturan baru | benar |
Contoh respons:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Ubah Header Penulisan Ulang dari aturan Respon
Ubah Header Penulisan Ulang dari aturan Respon
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/service/<servicename>/replaceresponseheader/<id>
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
| pertandingan | Tali | Nilai regex agar sesuai dengan yang ingin kita ganti | benar |
| menggantikan | Tali | Nilai untuk mengganti korek api | benar |
Contoh respons:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Hapus Aturan untuk Menulis Ulang Header dari Respon
Hapus Aturan untuk Menulis Ulang Header dari Respon
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/Index
zcli farm-service-replaceresponseheader remove MyHttpFarm MyService Index
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/service/<servicename>/replaceresponseheader/<index>
indeks adalah indeks dari array replaceresponseheader yang akan dihapus.
Contoh respons:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header <index> was deleted successfully"
}
Pindahkan Header Tulis Ulang dari aturan Respon
Pindahkan Header Tulis Ulang dari aturan Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/services/<service>/replaceresponseheader/<id>/actions
Pindahkan Header ReplaceRequest.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Jumlah | Posisi aturan baru | benar |
Contoh respons:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Tambahkan Aturan untuk Menambahkan Header ke Permintaan
Tambahkan Aturan untuk Menambahkan Header ke Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader
farm-service-addrequestheader add farm1 -header "header: value"
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/addrequestheader
Tambahkan aturan untuk menulis ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
Contoh respons:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Ubah sebuah Tambahkan Header ke aturan Permintaan
Ubah sebuah Tambahkan Header ke aturan Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/id
farm-service-addrequestheader add farm1 -header "header: value"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/addrequestheader/<id>
Tambahkan aturan untuk menulis ulang header dari permintaan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
Contoh respons:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Hapus Aturan untuk Menambahkan Header ke Permintaan
Hapus Aturan untuk Menambahkan Header ke Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/Index
zcli farm-service-addrequestheader remove MyHttpFarm MyService Index
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/addrequestheader/<index>
indeks adalah indeks dari array replacerequestheader yang akan dihapus.
Contoh respons:
{
"message": "The add request header <index> has been deleted successfully"
}
Tambahkan Aturan untuk Menambahkan Header ke Respon
Tambahkan Aturan untuk Menambahkan Header ke Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader
zcli farm-service-addresponseheader add farm1 -header "header: value"
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/addresponseheader
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
Contoh respons:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Ubah sebuah Tambahkan Header ke aturan Respon
Ubah sebuah Tambahkan Header ke aturan Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/id
zcli farm-service-addresponseheader add farm1 -header "header: value"
Panggilan ini tersedia dari versi 4.0.2
PUT /farms/<farmname>/addresponseheader/<id>
Tambahkan aturan untuk menulis ulang header dari respons.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Header | Tali | Regex dengan nama header yang akan ditulis ulang | benar |
Contoh respons:
{
"description" : "Modify an addheader directive.",
"message" : "Modified an item from the addheader list",
"success" : "true"
}
Hapus Aturan untuk Menambahkan Header ke Respon
Hapus Aturan untuk Menambahkan Header ke Respon
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/Index
zcli farm-service-addresponseheader remove MyHttpFarm MyService Index
Panggilan ini tersedia dari versi 4.0.2
DELETE /farms/<farmname>/addrequestheader/<index>
indeks adalah indeks dari array replaceresponseheader yang akan dihapus.
Contoh respons:
{
"message": "The add response header 0 has been deleted successfully"
}
Tambahkan Aturan untuk Menghapus Tajuk dari Permintaan
Tambahkan Aturan untuk Menghapus Tajuk dari Permintaan
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""
POST /farms/<farmname>/service/<servicename>/removerequestheader
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"message": "Added a new remove request header"
}
Ubah Aturan untuk Menghapus Header dari Permintaan
Ubah Aturan untuk Menghapus Header dari Permintaan
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/id
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""
PUT /farms/<farmname>/service/<servicename>/removerequestheader/<id>
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Modify RemoveResponseHeader directive.",
"message" : "Modify an item from the removeresponseheader list",
"success" : "true"
}
Hapus Aturan untuk Menghapus Tajuk dari Permintaan
Hapus Aturan untuk Menghapus Tajuk dari Permintaan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/removerequestheader/<index>
indeks adalah indeks dari array removerequestheader untuk dihapus.
Contoh respons:
{
"message": "The remove request header <index> has been deleted successfully"
}
Tambahkan Aturan untuk Menghapus Header dari Respon
Tambahkan Aturan untuk Menghapus Header dari Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""
POST /farms/<farmname>/service/<servicename>/removeresponseheader
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"message": "Added a new remove response header"
}
Ubah Header Hapus dari aturan Respon
Ubah Header Hapus dari aturan Respon
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/id
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""
PUT /farms/<farmname>/service/<servicename>/removeresponseheader/<id>
Hapus tajuk tertentu dari permintaan yang masuk. Semua kemunculan tajuk yang ditentukan akan dihapus.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp untuk dicari dalam permintaan klien. Jika beberapa tajuk cocok dengan pola, tajuk akan dihapus | benar |
Contoh respons:
{
"description" : "Modify RemoveResponseHeader directive.",
"message" : "Modify an item from the removeresponseheader list",
"success" : "true"
}
Hapus Aturan untuk Menghapus Header dari Respon
Hapus Aturan untuk Menghapus Header dari Respon
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/removeresponseheader/<index>
indeks adalah indeks dari array removeresponseheader untuk dihapus.
Contoh respons:
{
"message": "The remove request header <index> has been deleted successfully"
}
Tambahkan Aturan untuk memeriksa dan menulis ulang pola dari URL
Tambahkan Aturan untuk memeriksa dan menulis ulang pola dari URL
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"
POST /farms/<farmname>/service/<servicename>/rewriteurl
Dari versi 4.0.2. Ini memeriksa pola untuk mendapatkan string dari URL dan menggantinya.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp yang harus dicari di url. Jika url cocok dengan pola, teks yang cocok akan diganti | benar |
| menggantikan | Tali | Ini adalah string untuk menggantikan teks yang cocok | benar |
| terakhir | Tali | Benar atau salah. Jika benar disetel, itu akan menyelesaikan fase penulisan ulang url | benar |
Contoh respons:
{
"message": "Added a new rewriteurl"
}
Ubah Aturan pemeriksaan dan tulis ulang pola dari URL
Ubah Aturan pemeriksaan dan tulis ulang pola dari URL
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"
PUT /farms/<farmname>/service/<servicename>/rewriteurl/<id>
Dari versi 4.0.2. Ini memeriksa pola untuk mendapatkan string dari URL dan menggantinya.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| belt hold | Tali | Ini adalah string dengan regexp yang harus dicari di url. Jika url cocok dengan pola, teks yang cocok akan diganti | benar |
| menggantikan | Tali | Ini adalah string untuk menggantikan teks yang cocok | benar |
| terakhir | Tali | Benar atau salah. Jika benar disetel, itu akan menyelesaikan fase penulisan ulang url | benar |
Contoh respons:
{
"description" : "Modify a RewriteUrl.",
"message" : "Modify a new rewrite url",
"success" : "true"
}
Hapus Aturan untuk memeriksa dan menulis ulang pola dari URL
Hapus Aturan untuk memeriksa dan menulis ulang pola dari URL
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/Index
zcli arm-service-rewriteurl remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/rewriteurl/<index>
Dari versi 4.0.2. indeks adalah indeks dari array rewriteurl yang akan dihapus.
Contoh respons:
{
"message": "The rewriteurl <index> has been deleted successfully"
}
Pindahkan tanda centang dan tulis ulang pola dari aturan URL
Pindahkan tanda centang dan tulis ulang pola dari aturan URL
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
Panggilan ini tersedia dari versi 4.0.2
POST /farms/<farmname>/services/<service>/rewriteurl/<id>/actions
Pindahkan Header ReplaceRequest.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| posisi | Jumlah | Posisi aturan baru | benar |
Contoh respons:
{
"description" : "Move a rewriteurl directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Daftar sesi
Daftar sesi
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session list farm1 service0
GET /farms/<farmname>/services/<servicename>/sessions
Dari versi 4.0.2. Dapatkan daftar sesi di pertanian:layanan. Properti hanya tersedia untuk proxy generasi baru zproxy.
Contoh respons:
{
"description" : "Get farm sessions",
"params": [
{
"id": "0",
"session": "10.0.0.2",
"ttl": null,
"type": "static"
},
{
"id": "0",
"session": "10.0.0.2",
"ttl": "58m28s148ms",
"type": "dynamic"
},
{
"id": "0",
"session": "10.0.0.2",
"ttl": "59m56s496ms",
"type": "dynamic"
}
]
}
Parameter Respon
Permintaan ini mengembalikan daftar objek sesi, setiap objek sesi berisi kunci berikut:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'IP' Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi tidak bertipe statis. |
Tambahkan satu sesi
Tambahkan satu sesi
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session add farm1 service0 -backend 0 -session 10.0.0.2
POST /farms/<farmname>/services/<servicename>/sessions
Dari versi 4.0.2. Itu menciptakan sesi statis dengan backend dalam sebuah sesi. Koneksi input yang cocok dengan Sidang akan selalu diteruskan ke backend itu. Properti hanya tersedia untuk proxy generasi baru zproxy.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'IP', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; |
Contoh respons:
{
"description" : "Adding a static session to the farm1",
"message" : "Added a session for the farm 'farm1'",
"params" : {
"id" : "0",
"session" : "10.0.0.1",
"ttl" : null,
"type" : "static"
}
}
Parameter Respon
Permintaan ini mengembalikan objek sesi yang berisi kunci berikut:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'IP', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi adalah tipe statis. |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
Hapus satu sesi
Hapus satu sesi
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions/10.0.0.1
zcli farm-service-session remove farm1 service0 10.0.0.1
DELETE /farms/<farmname>/services/<servicename>/sessions/<session>
Ini menghapus sesi statis.
Contoh respons:
{
"description" : "Delete a 'static' session",
"message" : "The session '10.0.0.1' was deleted properly from the farm 'farm1'.",
"success" : "true"
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
zcli farm get httpfarm
GET /farms/<farmname>/services/<id>/backends
Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.
Contoh respons:
{
"description" : "List service backends",
"params" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1,
"priority" : null,
"connection_limit" : null
},
{
"alias" : null,
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2,
"priority" : null,
"connection_limit": null
}
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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. Nilai yang mungkin berasal dari 1 untuk 9. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
| prioritas (dari 4.0.1) | Jumlah | (Hanya ketika proxy generasi baru bekerja) Ini adalah nilai prioritas untuk server nyata saat ini. Backend dengan nilai prioritas yang lebih rendah akan siap menerima koneksi lebih dulu daripada yang lain dengan prioritas yang lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9 |
| koneksi_batas (dari 4.0.2) | Jumlah | (Hanya ketika proxy generasi baru berfungsi) Jumlah maksimum koneksi yang dibuat per backend. Dengan nilai 0, tidak akan ada batasan di backend. Klien akan menerima kesalahan 503 jika tidak ada backend yang tersedia. |
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,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2 -connection_limit 10
POST /farms/<farmname>/services/<id>/backends
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. Nilai yang mungkin berasal dari 1 untuk 9. | |
| prioritas (dari 4.0.1) | Jumlah | (Hanya ketika proxy generasi baru bekerja) Ini adalah nilai prioritas untuk server nyata saat ini. Backend dengan nilai prioritas yang lebih rendah akan siap menerima koneksi lebih dulu daripada yang lain dengan prioritas yang lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9 | |
| koneksi_batas (dari 4.0.2) | Jumlah | (Hanya ketika proxy generasi baru berfungsi) Jumlah maksimum koneksi yang dibuat per backend. Dengan nilai 0, tidak akan ada batasan di backend. Klien akan menerima kesalahan 503 jika tidak ada backend yang tersedia. |
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,
"priority" : 1,
"connection_limit" : 10
},
"status" : "needed restart"
}
Parameter Respon
Respons akan menjadi JSON dengan parameter yang diminta diperbarui dan status bidang dengan status pertanian saat ini. Jika perlu Restart tindakan untuk menerapkan perubahan tambak, nilainya akan menjadi diperlukan restart.Jika ada
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,"weight":1,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1 -connection_limit 10
PUT /farms/<farmname>/services/<id>/backends/<id>
Ubah parameter layanan HTTP backend.
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. Nilai yang mungkin berasal dari 1 untuk 9. |
| prioritas (dari 4.0.1) | Jumlah | (Hanya ketika proxy generasi baru bekerja) Ini adalah nilai prioritas untuk server nyata saat ini. Backend dengan nilai prioritas yang lebih rendah akan siap menerima koneksi lebih dulu daripada yang lain dengan prioritas yang lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9 |
| koneksi_batas (dari 4.0.2) | Jumlah | (Hanya ketika proxy generasi baru berfungsi) Jumlah maksimum koneksi yang dibuat per backend. Dengan nilai 0, tidak akan ada batasan di backend. Klien akan menerima kesalahan 503 jika tidak ada backend yang tersedia. |
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,
"priority" : 4,
"connection_limit" : 10
},
"status" : "needed restart",
"warning" : "Backends with high priority value (4) will not be used."
}
Parameter Respon
Respons akan menjadi JSON dengan parameter yang diminta diperbarui dan status bidang dengan status pertanian saat ini. Jika perlu Restart tindakan untuk menerapkan perubahan tambak, nilainya akan menjadi diperlukan restart. Jika parameter Prioritas diperbarui dengan nilai yang tidak konsisten, parameter peringatan bidang akan menggambarkannya.
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","mode":"cut"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
zcli farm-service-backend maintenance httpfarm newsrv 0 -mode cut
PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance
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 | Wajib |
|---|---|---|---|
| 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 efek ke klien. | |
| mode | Tali | Pilih mode perawatan. Opsi yang tersedia adalah: menguras, backend tidak menerima koneksi baru, tetapi akan terus menangani koneksi saat ini; atau memotong, koneksi saat ini akan ditutup. | Jika bidang ini tidak ditentukan, mode default adalah menguras. |
Contoh respons:
{
"description" : "Set service backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
Hapus backend
Hapus backend
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
zcli farm-service-backend remove newfarmHTTP service1 4
DELETE /farms/<farmname>/services/<id>/backends/<id>
Hapus backend yang diberikan dari layanan 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 pembuatan farm balancing yang berfungsi pada layer 4 dari model OSI, dengan kinerja yang sangat tinggi dan koneksi yang jauh lebih bersamaan dari pada load balancer core 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, peternakan L4xNAT dapat mengikat berbagai port, tidak hanya satu port virtual seperti yang digunakan dengan profil lapisan 7 lainnya. Untuk dapat memilih berbagai port virtual atau port virtual tertentu di peternakan L4xNAT, itu wajib untuk memilih jenis protokol. Dalam kasus lain, tambak akan mendengarkan di semua port dari IP virtual (ditunjukkan dengan karakter '*'). Setelah protokol TCP atau UDP dipilih, itu akan tersedia untuk menentukan port, beberapa port antara ',', port berkisar antara ':' atau semua port dengan '*'. Kombinasi dari semuanya akan valid 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/v4.0/zapi.cgi/farms/l4farm
zcli farm get l4farm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Respon BODY:
{
"backends" : [
{
"alias" : null,
"max_conns" : 0,
"id" : 0,
"ip" : "192.168.55.40",
"port" : "88",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"alias" : "server-1",
"id" : 1,
"max_conns" : 500,
"ip" : "192.168.55.41",
"port" : "88",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"ipds" : {
"blacklists" : [
{
"status" : "down",
"name" : "blacklist"
}
],
"dos" : [
{
"name" : "newlimitconns",
"status" : "down"
}
],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"algorithm" : "weight",
"farmguardian" : "check_tcp-cut_conns",
"listener" : "l4xnat",
"logs" : "false",
"nattype" : "nat",
"persistence" : "ip",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88",
"sessions": []
}
}
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 | Obyek[] | Aturan daftar hitam diterapkan ke tambak. |
| dos | Obyek[] | Aturan DoS diterapkan ke tambak. |
| rbl | Obyek[] | Aturan RBL diterapkan ke tambak. |
Daftar Hitam, Objek DoS dan RBL:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Nama aturan. |
| status | Tali | Status aturan. |
Objek parameter untuk peternakan L4xNAT:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| algoritma | Tali | Jenis penjadwalan load balancing yang digunakan untuk mengirimkan lalu lintas antara backend. Opsinya adalah: lessconn meneruskan koneksi selalu ke server koneksi yang paling sedikit; berat koneksi pengiriman linear tergantung pada berat backend; roundrobin apakah pemilihan berurutan antara kumpulan backend, setiap backend akan menerima jumlah permintaan yang sama; hash_srcip paket saldo yang cocok dengan IP sumber yang sama dengan backend yang sama; hash_srcip_srcport paket saldo yang cocok dengan IP sumber yang sama dan port ke backend yang sama; symhash menyeimbangkan paket yang cocok dengan IP sumber dan port yang sama dan IP tujuan dan port, sehingga bisa memiliki koneksi dalam dua cara (selama inbound dan outbound). |
| pendengar | Tali | Seorang pendengar menjelaskan bagaimana pertanian akan bermain dengan permintaan dari klien. bidang informasional, tidak dapat diubah. |
| log | Tali | Informasi paket Log pertanian lapisan transport, tidak tersedia informasi lapisan aplikasi. Jika parameter ini memiliki nilai benar, log diaktifkan; jika memiliki nilai palsu, log dinonaktifkan. |
| 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; Di DSR Mode (Pengembalian Server Langsung) yang disambungkan klien ke VIP, kemudian penyeimbang beban mengubah alamat MAC tujuannya untuk alamat MAC backend (server harus berada pada media tautan yang sama dengan penyeimbang beban); DNAT tanpa kewarganegaraan. Di stateless_dnat alamat tujuan saklar penyeimbang beban untuk alamat backend dan meneruskannya ke backend seperti DNAT, tetapi tidak mengelola segala jenis informasi koneksi. |
| ketekunan | Tali | Parameter ini meneruskan permintaan yang masuk ke backend yang sama berdasarkan mode persistensi yang dipilih. Opsinya adalah: "" nilai kosong menonaktifkan kegigihan, setiap paket yang masuk akan seimbang antara backend; ip or srcip, Sumber IP, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada alamat IP sumber saja; pelabuhan, Source Port, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada port sumber saja. srcmac, Source MAC, Dengan opsi ini, tambak akan menetapkan backend yang sama untuk setiap koneksi masuk tergantung pada alamat MAC link-layer paket; srcip_srcport, Source IP dan Source Port, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada keduanya, IP sumber dan port sumber; srcip_dstport, Sumber IP dan Port Tujuan, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada keduanya, IP sumber dan port tujuan. |
| 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, juga untuk TCP, dimungkinkan untuk menetapkan satu dari protokol berikut untuk mengurai header dan menggunakannya untuk mendistribusikan dengan benar: ftp, irc, pPTP, atau waras; udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, juga untuk UDP, dimungkinkan untuk menetapkan satu dari protokol berikut untuk mengurai header dan menggunakannya untuk mendistribusikan dengan benar: menyesap, tftp, amanda, netbios-ns, atau snmp; sctp, penyeimbang beban hanya akan menyeimbangkan protokol SCTP L4. Jika h323 dipilih, tambak akan mendengarkan TCP serta UDP meminta dan mengurai header untuk menyeimbangkan antara backend. |
| status | Tali | Status pertanian. Nilai status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, tambak sudah habis dan semua backend tidak dapat dijangkau atau pemeliharaan; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; pemeliharaan, tambak naik dan ada backend dalam status naik, tetapi hampir sebuah backend dalam mode pemeliharaan; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| Ttl | Jumlah | Nilai bidang ini menunjukkan jumlah detik yang tetap ada antara sumber klien dan backend, dalam hitungan detik. Ketekunan harus dikonfigurasi. |
| vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
| olahraga | Tali | Port of the farm, tempat layanan virtual mendengarkan. Port unik dapat ditentukan, port rentang dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,. |
| penjaga pertanian | Tali | Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik. |
| sesi (dari versi 4.0.2) | Obyek[] | Daftar sesi statis dan dinamis yang dibuat untuk tambak ini. |
Objek backend untuk tambak L4xNAT:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| id | Jumlah | ID untuk mengidentifikasi backend di kolam backend pertanian. |
| 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 dengan port virtual. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
| prioritas | Jumlah | Ini adalah nilai prioritas untuk server nyata saat ini. Backend dengan nilai prioritas lebih rendah akan siap untuk menerima koneksi sebelum daripada yang lain dengan prioritas lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9. |
| berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. Nilai yang mungkin berasal dari 1 untuk 9. |
| max_conns | Jumlah | Ini adalah jumlah koneksi maksimum yang akan diterima backend secara bersamaan. Jika sudah diatur dengan a 0 nilai backend belum menentukan batas apa pun. |
Objek sesi untuk tambak L4xNAT:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| klien | Jumlah | Ini adalah pengidentifikasi klien. |
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'mac', Sidang harus berupa MAC, mis. 02: 8e: 69: 38: 12: 8e; jika ketekunan adalah 'ip' atau 'srcip', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; jika ketekunan adalah 'port', Sidang harus merupakan port yang valid, misalnya 5445; jika ketekunan adalah 'srcip_srcport' atau 'srcip_dstport'; Sidang harus berupa string dengan IP dan port yang digabungkan dengan garis bawah '', misalnya 122.36.54.280. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi adalah tipe statis. |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
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/v4.0/zapi.cgi/farms
zcli farm create -farmname newl4farm -vip 192.168.100.241 -vport 88 -profile l4xnat
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 |
| salin_dari (dari 4.0.1) | Tali | Parameter ini mengharapkan nama pertanian yang ada. Jika parameter ini dikirim, tambak disalin dari tambak yang ditentukan di dalamnya. Itu nama pertanian, vip serta olahraga nilai akan ditimpa. |
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","logs":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
zcli farm set newfarml4 -algorithm weight -newfarmname l4farm -protocol tcp -nattype nat -ttl 125 -vip 178.62.126.152 -vport 81 -logs true
PUT /farms/<farmname>
Ubah konfigurasi tambak L4xNAT.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| newfarmname | Tali | Nama Peternakan baru. Pertanian harus dihentikan. |
| log | Tali | Informasi paket Log pertanian lapisan transport, tidak tersedia informasi lapisan aplikasi. Jika parameter ini memiliki nilai benar, log diaktifkan; jika memiliki nilai palsu, log dinonaktifkan. |
| 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 rentang dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,. |
| ketekunan | Tali | Parameter ini meneruskan permintaan yang masuk ke backend yang sama berdasarkan mode persistensi yang dipilih. Opsinya adalah: "" nilai kosong menonaktifkan kegigihan, setiap paket yang masuk akan seimbang antara backend; ip or srcip, Sumber IP, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada alamat IP sumber saja; pelabuhan, Source Port, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada port sumber saja. srcmac, Source MAC, Dengan opsi ini, tambak akan menetapkan backend yang sama untuk setiap koneksi masuk tergantung pada alamat MAC link-layer paket; srcip_srcport, Source IP dan Source Port, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada keduanya, IP sumber dan port sumber; srcip_dstport, Sumber IP dan Port Tujuan, akan menetapkan backend yang sama untuk setiap koneksi yang masuk tergantung pada keduanya, IP sumber dan port tujuan. |
| 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; Di DSR Mode (Pengembalian Server Langsung) yang disambungkan klien ke VIP, kemudian penyeimbang beban mengubah alamat MAC tujuannya untuk alamat MAC backend (server harus berada pada media tautan yang sama dengan penyeimbang beban); DNAT tanpa kewarganegaraan. Di stateless_dnat alamat tujuan saklar penyeimbang beban untuk alamat backend dan meneruskannya ke backend seperti DNAT, tetapi tidak mengelola segala jenis informasi koneksi. |
| algoritma | Tali | Jenis penjadwalan load balancing yang digunakan untuk mengirimkan lalu lintas antara backend. Opsinya adalah: lessconn meneruskan koneksi selalu ke server koneksi yang paling sedikit; berat koneksi pengiriman linear tergantung pada berat backend; roundrobin apakah pemilihan berurutan antara kumpulan backend, setiap backend akan menerima jumlah permintaan yang sama; hash_srcip paket saldo yang cocok dengan IP sumber yang sama dengan backend yang sama; hash_srcip_srcport paket saldo yang cocok dengan IP sumber yang sama dan port ke backend yang sama; symhash menyeimbangkan paket yang cocok dengan IP sumber dan port yang sama dan IP tujuan dan port, sehingga bisa memiliki koneksi dalam dua cara (selama inbound dan outbound). |
| 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, juga untuk TCP, dimungkinkan untuk menetapkan satu dari protokol berikut untuk mengurai header dan menggunakannya untuk mendistribusikan dengan benar: ftp, irc, pPTP, atau waras; udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, juga untuk UDP, dimungkinkan untuk menetapkan satu dari protokol berikut untuk mengurai header dan menggunakannya untuk mendistribusikan dengan benar: menyesap, tftp, amanda, netbios-ns, atau snmp; sctp, penyeimbang beban hanya akan menyeimbangkan protokol SCTP L4. Jika h323 dipilih, tambak akan mendengarkan TCP serta UDP meminta dan mengurai header untuk menyeimbangkan antara backend. |
Contoh respons:
{
"description" : "Modify farm l4farm",
"params" : {
"algorithm" : "weight",
"logs" : "true",
"nattype" : "nat",
"newfarmname" : "l4farm",
"persistence" : "",
"protocol" : "tcp",
"ttl" : 125,
"vip" : "178.62.126.152",
"vport" : "81"
}
}
Parameter respons
Respons akan menjadi JSON dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.
Tambahkan FarmGuardian
Tambahkan FarmGuardian
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg
zcli farm-service-farmguardian add l4Farm default_service -name check_tcp-cut_conns
POST /farms/<farmname>/fg
Terapkan FarmGuardian ke pertanian.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Pengidentifikasi unik FarmGuardian. FarmGuardians dibuat dan dimodifikasi di bagian pemantauan. |
Contoh respons:
{
"description" : "Add the farm guardian check_tcp-cut_conns to the farm fgl4",
"message" : "Success, The farm guardian check_tcp-cut_conns was added to the farm fgl4"
}
Hapus FarmGuardian
Hapus FarmGuardian
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove l4Farm default_service check_tcp-cut_conns
DELETE /farms/<farmname>/fg/<name>
Hapus FarmGuardian dari pertanian.
Contoh respons:
{
"description" : "Remove the farm guardian check_tcp-cut_conns from the farm fgl4",
"message" : "Sucess, check_tcp-cut_conns was removed from the farm fgl4"
}
Add POST /farms/<farmname>/sessions
Add DELETE /farms/<farmname>/sessions/<session>
Daftar sesi
Daftar sesi
Contoh permintaan:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session list farm1
GET /farms/<farmname>/sessions
Dapatkan daftar sesi di peternakan.
Contoh respons:
{
"description" : "Get farm sessions",
"params": [
{
"client": 0,
"id": "0",
"session": "10.0.0.2_56",
"ttl": null,
"type": "static"
},
{
"client": 1,
"id": "0",
"session": "10.0.0.2_54936",
"ttl": "58m28s148ms",
"type": "dynamic"
},
{
"client": 2,
"id": "0",
"session": "10.0.0.2_54968",
"ttl": "59m56s496ms",
"type": "dynamic"
}
]
}
Parameter Respon
Permintaan ini mengembalikan daftar objek sesi, setiap objek sesi berisi kunci-kunci berikut:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| klien | Jumlah | Ini adalah pengidentifikasi klien. |
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'mac', Sidang harus berupa MAC, mis. 02: 8e: 69: 38: 12: 8e; jika ketekunan adalah 'ip' atau 'srcip', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; jika ketekunan adalah 'port', Sidang harus merupakan port yang valid, misalnya 5445; jika ketekunan adalah 'srcip_srcport' atau 'srcip_dstport'; Sidang harus berupa string dengan IP dan port yang digabungkan dengan garis bawah '', misalnya 122.36.54.280. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi adalah tipe statis. |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
Tambahkan satu sesi
Tambahkan satu sesi
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2_56","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session add farm1 -id 0 -session 10.0.0.2_56
POST /farms/<farmname>/sessions
Itu menciptakan sesi statis dengan backend. Koneksi input yang cocok dengan Sidang akan diteruskan selalu ke backend itu.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'mac', Sidang harus berupa MAC, mis. 02: 8e: 69: 38: 12: 8e; jika ketekunan adalah 'ip' atau 'srcip', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; jika ketekunan adalah 'port', Sidang harus merupakan port yang valid, misalnya 5445; jika ketekunan adalah 'srcip_srcport' atau 'srcip_dstport'; Sidang harus berupa string dengan IP dan port yang digabungkan dengan garis bawah '', misalnya 122.36.54.280. |
Contoh respons:
{
"description" : "Adding a static session to the farm1",
"message" : "Added a session for the farm 'farm1'",
"params" : {
"client" : 1,
"id" : "0",
"session" : "10.0.0.1_56",
"ttl" : null,
"type" : "static"
}
}
Parameter Respon
Permintaan ini mengembalikan objek sesi yang berisi kunci berikut:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| klien | Jumlah | Ini adalah pengidentifikasi klien. |
| id | Jumlah | ID Backend yang akan menerima koneksi. |
| Sidang | Tali | Ini adalah pengidentifikasi sesi atau koneksi, nilainya tergantung pada ketekunan parameter pertanian. Jika ketekunan adalah 'mac', Sidang harus berupa MAC, mis. 02: 8e: 69: 38: 12: 8e; jika ketekunan adalah 'ip' atau 'srcip', Sidang harus berupa IPv4 atau IPv6, misalnya 192.168.42.65; jika ketekunan adalah 'port', Sidang harus merupakan port yang valid, misalnya 5445; jika ketekunan adalah 'srcip_srcport' atau 'srcip_dstport'; Sidang harus berupa string dengan IP dan port yang digabungkan dengan garis bawah '', misalnya 122.36.54.280. |
| Ttl | Tali | Ini adalah string dengan waktu sesi berakhir. Itu Ttl nilai akan nol jika sesi adalah tipe statis. |
| mengetik | Tali | Ada dua jenis sesi: dinamis adalah koneksi yang memuat pin penyeimbang dengan backend menggunakan algoritma penyeimbangan muatan pertanian; statis adalah koneksi yang pin administrator load balancer dengan backend. Sesi statis tidak akan dialihkan ke backend lain jika didukung dalam unreachable. |
Hapus satu sesi
Hapus satu sesi
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56
DELETE /farms/<farmname>/sessions/<session>
Ini menghapus sesi statis.
Contoh respons:
{
"description" : "Delete a 'static' session",
"message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
"success" : "true"
}
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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists
zcli farm-blacklist add l4Farm -name china
POST /farms/<farmname>/ipds/<dos|blacklists|rbl>
Terapkan daftar hitam, aturan DoS atau RBL 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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists/china
zcli farm-blacklist remove l4Farm china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>
Hapus daftar hitam, aturan DoS atau RBL modul IPDS dari farm yang diberikan menggunakan indikatornya 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm get l4farm
GET /farms/<farmname>/backends
Dapatkan daftar backend dalam suatu layanan.
Contoh respons:
{
"description" : "List backends",
"params" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.5.1.1",
"max_conns" : 400,
"port" : 787,
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"alias" : "server-2",
"id" : 1,
"ip" : "192.5.1.3",
"max_conns" : 200,
"port" : 787,
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| id | Jumlah | ID untuk mengidentifikasi backend di kolam backend pertanian. |
| 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 dengan port virtual. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
| max_conns | Jumlah | Ini jumlah maksimum koneksi bersamaan 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 prioritas paling tersedia di mana 1 adalah prioritas terbanyak dan 9 adalah prioritas paling kecil. |
| berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. Nilai yang mungkin berasal dari 1 untuk 9. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm-service-backend add l4farm default_service -ip 192.168.5.100 -port 8080 -max_conns 400
POST /farms/<farmname>/backends
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 dengan port virtual. | |
| max_conns | Jumlah | Ini jumlah maksimum koneksi bersamaan 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. Backend dengan nilai prioritas lebih rendah akan siap untuk menerima koneksi sebelum daripada yang lain dengan prioritas lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9. | |
| berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. Nilai yang mungkin berasal dari 1 untuk 9. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
zcli farm-service-backend set l4farm default_service 2 -ip 192.168.5.40 -port 8080 -max_conns 220 -priority 4 -weight 7
PUT /farms/<farmname>/backends/<id>
Ubah parameter backend in untuk 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 dengan port virtual. |
| max_conns | Jumlah | Ini jumlah maksimum koneksi bersamaan 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. Backend dengan nilai prioritas lebih rendah akan siap untuk menerima koneksi sebelum daripada yang lain dengan prioritas lebih tinggi. Nilai default nol, nilai prioritas 1 digunakan. Nilai yang mungkin berasal dari 1 untuk 9. |
| berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Backend dengan bobot lebih besar akan menerima lebih banyak koneksi. Nilai yang mungkin berasal dari 1 untuk 9. |
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","mode":"cut"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/1/maintenance
zcli farm-service-backend maintenance l4farm default_service 1 -mode cut
PUT /farms/<farmname>/backends/<id>/maintenance
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 efek ke klien. |
| mode | Tali | Pilih mode perawatan. Opsi yang tersedia adalah: menguras, backend tidak menerima koneksi baru, tetapi akan terus menangani koneksi saat ini; atau memotong, koneksi saat ini akan ditutup. |
Contoh respons:
{
"description" : "Set backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/4
zcli farm-service-backend remove l4farm default_service 4
DELETE /farms/<farmname>/backends/<id>
Hapus backend yang diberikan untuk 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 menciptakan 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/v4.0/zapi.cgi/farms/gslbfarm
zcli farm get gslbfarm
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak yang diberikan.
Contoh respons:
{
"description" : "List farm gslbfarm",
"ipds" : {
"blacklists" : [],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"status" : "needed restart",
"vip" : "192.168.100.155",
"vport" : 60
},
"services" : [
{
"algorithm" : "roundrobin",
"backends" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port" : 53,
"status" : "up"
},
{
"alias" : "dns-server",
"id" : 2,
"ip" : "192.168.55.40",
"port" : 53,
"status" : "up"
},
{
"alias" : null,
"id" : 4,
"ip" : "192.135.10.2",
"port" : 53,
"status" : "up"
}
],
"deftcpport" : 53,
"farmguardian" : "dns-request",
"id" : "service1"
},
{
"algorithm" : "prio",
"backends" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port" : 80,
"status" : "up"
},
{
"alias" : "localhost",
"id" : 2,
"ip" : "127.0.0.1",
"port" : 80,
"status" : "up"
}
],
"deftcpport" : 80,
"farmguardian" : null,
"id" : "prioServ"
}
],
"zones" : [
{
"defnamesv" : "ns3",
"id" : "global.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns3",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns3",
"ttl" : null,
"type" : "A"
},
{
"id" : 3,
"rdata" : "resource2",
"rname" : "ns2",
"ttl" : null,
"type" : "NS"
},
{
"id" : 4,
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
}
]
},
{
"defnamesv" : "ns1",
"id" : "DOM.com",
"resources" : [
{
"id" : 0,
"rdata" : "ns1",
"rname" : "@",
"ttl" : null,
"type" : "NS"
},
{
"id" : 1,
"rdata" : "192.168.100.155",
"rname" : "ns1",
"ttl" : null,
"type" : "A"
}
]
}
]
}
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 | Obyek[] | Daftar hitam diterapkan ke pertanian. |
| dos | Obyek[] | Aturan DoS diterapkan ke tambak. |
| rbl | Obyek[] | Aturan RBL diterapkan ke tambak. |
Daftar Hitam, Objek DoS dan RBL:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Nama aturan. |
| status | Tali | Status aturan. |
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 status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, pertanian sudah habis dan semua backend tidak dapat dijangkau; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
Objek layanan untuk pertanian GSLB:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| backends | Obyek[] | Backends didefinisikan dalam layanan. |
| penjaga pertanian | Tali | Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik. Log farmguard tidak tersedia untuk pertanian GSLB |
| 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 port TCP pemeriksaan kesehatan yang akan diperiksa oleh layanan untuk menentukan bahwa layanan backend hidup. Nilai kosong dinonaktifkan. |
Objek backend untuk pertanian GSLB:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan layanan telah mendeteksi bahwa backend tidak berfungsi; tidak terdefinisi, status backend belum dicentang. |
Objek zona:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | Nama zona digunakan sebagai pengindentifikasi 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 Daya 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 pada 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/v4.0/zapi.cgi/farms
zcli farm create -farmname gslbfarm -vip 192.168.100.241 -vport 53 -profile gslb
POST /farms
Buat peternakan GSLB baru.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| nama pertanian | Tali | Nama tambak digunakan sebagai 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 |
| salin_dari (dari 4.0.1) | Tali | Parameter ini mengharapkan nama pertanian yang ada. Jika parameter ini dikirim, tambak disalin dari tambak yang ditentukan di dalamnya. Itu nama pertanian, vip serta olahraga nilai akan ditimpa. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm
zcli farm set gslbfarm -newfarmname gslbnewname -vip 192.168.100.155 -vport 60
PUT /farms/<farmname>
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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists
zcli farm farm-blacklist add gslbFarm -name china
POST /farms/<farmname>/ipds/<dos|blacklists|rbl>
Terapkan daftar hitam, aturan DoS atau RBL 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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
zcli farm-blacklist remove gslbFarm china
DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>
Hapus aturan blacklist, DoS atau RBL dari farm yang diberikan menggunakan pengenalnya 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. Neraca lalu lintas yang sama untuk semua server nyata yang aktif. Untuk setiap koneksi yang masuk, penyeimbang menetapkan server real robin putaran berikutnya untuk mengirimkan permintaan.
Prioritas: koneksi selalu ke prioritas yang paling 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 Aktif-Pasif dengan beberapa server nyata.
Objek layanan untuk peternakan GSLB
| Bidang | Tipe | Deskripsi |
|---|---|---|
| backends | Obyek[] | Backends didefinisikan dalam layanan. |
| penjaga pertanian | Tali | Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik. |
| 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 port TCP pemeriksaan kesehatan yang akan diperiksa oleh 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services
zcli farm-service add gslbfarm -id service1 -algorithm roundrobin
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service set gslbfarm service1 -deftcpport 53
PUT /farms/<farmname>/services/<id>
Ubah parameter layanan GSLB. id adalah pengidentifikasi unik layanan yang akan dimodifikasi.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| deftcpport | Jumlah | Ini adalah port TCP pemeriksaan kesehatan yang akan diperiksa oleh 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.
Tambahkan FarmGuardian
Tambahkan FarmGuardian
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"dns-request"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg
zcli farm-service-farmguardian add gslbfarm service1 -name dns-request
POST /farms/<farmname>/services/<id>/fg
Terapkan FarmGuardian ke layanan.
Parameter URI adalah pengidentifikasi unik layanan.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| nama | Tali | Pengidentifikasi unik FarmGuardian. FarmGuardians dibuat dan dimodifikasi di bagian pemantauan. Log FarmGuardian tidak tersedia untuk peternakan gslb. |
Contoh respons:
{
"description" : "Add the farm guardian dns-request to the service service1 in the farm gslbfarm",
"message" : "Success, The farm guardian dns-request was added to the service service1 in the farm gslbfarm"
}
Hapus FarmGuardian
Hapus FarmGuardian
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
zcli farm-service-farmguardian remove gslbfarm service1 dns-request
DELETE /farms/<farmname>/fg/<name>
Hapus FarmGuardian dari layanan GSLB.
Contoh respons:
{
"description" : "Remove the farm guardian dns-request from the service service1 in the farm gslbfarm",
"message" : "Sucess, dns-request was removed from the service service1 in the farm gslbfarm"
}
Hapus Layanan
Hapus Layanan
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service remove gslbfarm service1
DELETE /farms/<farmname>/services/<id>
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm get gslbfarm
GET /farms/<farmname>/services/<id>/backends
Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.
Contoh respons:
{
"description" : "List service backends",
"params" : [
{
"alias" : "localhost",
"id" : 1,
"ip" : "127.0.0.1",
"port":53,
"status":"up"
},
{
"alias" : "dns-server",
"id" : 2,
"ip" : "192.168.55.40",
"port":53,
"status":"up"
}
]
}
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan layanan telah mendeteksi bahwa backend tidak berfungsi; tidak terdefinisi, status backend belum dicentang. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm-service-backend add gslbfarm service1 -ip 192.135.10.2
POST /farms/<farmname>/services/<id>/backends
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/1
zcli farm-service-backend set gslbfarm service1 1 -ip 192.168.2.30
PUT /farms/<farmname>/services/<id>/backends/<id>
Ubah parameter backend untuk layanan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/3
zcli farm-service-backend remove gslbfarm service1 3
DELETE /farms/<farmname>/services/<servicename>/backends/<id>
Hapus backend yang diberikan dalam layanan 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.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones
zcli farm-zone add gslbfarm -id global.com
POST /farms/<farmname>/zones
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 sebagai 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com
zcli farm-zone set gslbfarm global.com -defnamesv ns3
PUT /farms/<farmname>/zones/<id>
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/dom.com
zcli farm-zone remove gslbfarm dom.com
DELETE /farms/<farmname>/zones/<id>
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. Pointer record, sebuah 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource list gslbfarm global.com
GET /farms/<farmname>/zones/<id>/resources
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 pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource add gslbfarm global.com -rname resource2 -rdata 192.168.0.9 -ttl 10 -type A
POST /farms/<farmname>/zones/<id>/resources
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 rekor saat ini. Ini adalah jumlah maksimum perangkat router yang dapat dilalui permintaan sampai mati. Berguna adalah bahwa paket tidak dimasukkan dalam loop bersih. | |
| 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 pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
zcli farm-zone-resource set gslbfarm global.com 1 -rname resource2 -rdata 192.168.200.30 -type A
PUT /farms/<farmname>/zones/<id>/resources/<id>
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 pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
zcli farm-zone-resource remove gslbfarm global.com 3
DELETE /farms/<farmname>/zones/<id>/resources/<id>
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 farm datalink atau DSLB (Datalink Service Load Balancing) memungkinkan pembuatan farm berbasis rute di mana backend adalah router atau gateway uplink. Profil farm semacam ini siap untuk membagikan beberapa akses router WAN uplink menggunakan penyeimbang beban sebagai multipleksor saluran uplink (1 masukan dan beberapa keluaran jalur router). Oleh karena itu, kumpulan datalink dapat digunakan sebagai tautan komunikasi yang tersedia dan sebagai tambahan dapat digunakan sebagai peningkatan bandwidth yang menggabungkan 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/v4.0/zapi.cgi/farms/dlink
zcli farm get dlink
GET /farms/<farmname>
Tampilkan semua konfigurasi tentang tambak.
Contoh respons:
{
"backends" : [
{
"alias" : "main-gateway",
"id" : 0,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"alias" : "secondary-gateway",
"id" : 1,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
],
"description" : "List farm dlink",
"ipds" : {
"blacklists" : []
},
"params" : {
"algorithm" : "weight",
"status" : "down",
"vip" : "192.168.100.199"
}
}
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[] | Server nyata dibuat di tambak ini dan konfigurasinya. |
Objek IPDS:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| daftar hitam | Tali[] | Daftar hitam diterapkan ke pertanian. |
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 atribut bobot lebih tinggi atau prio, yang mengirim semua koneksi ke backend dengan nilai minor prioritas. |
| status | Tali | Status pertanian. Nilai status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, pertanian sudah habis dan semua backend tidak dapat dijangkau; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. |
Objek backend untuk peternakan datalink:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| id | Jumlah | Pengidentifikasi unik untuk backend pertanian. |
| 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 dikonfigurasi sebagai prioritas dan prioritas yang lebih rendah akan memiliki preferensi |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan layanan telah mendeteksi bahwa backend tidak berfungsi; tidak terdefinisi, status backend belum dicentang. |
| berat | Jumlah | Ini adalah nilai bobot untuk server nyata saat ini. Ini akan digunakan saat algoritma bidang dikonfigurasikan 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/v4.0/zapi.cgi/farms
zcli farm create -profile datalink -farmname dlink -vip 192.168.100.241
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 membuat kebun tipe datalink, kuncinya adalah datalink | benar |
| vip | Tali | IP pertanian, tempat layanan virtual mendengarkan. | benar |
| salin_dari (dari 4.0.1) | Tali | Parameter ini mengharapkan nama pertanian yang ada. Jika parameter ini dikirim, tambak disalin dari tambak yang ditentukan di dalamnya. Itu nama pertanian serta vip nilai akan ditimpa. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm set dlink -newfarmname dlink2 -vip 192.168.100.199 -algorithm weight
PUT /farms/<farmname>
Ubah konfigurasi pertanian datalink.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| newfarmname | Tali | Nama pertanian baru. Kebun harus dihentikan untuk mengubah bidang ini. |
| 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 atribut bobot 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.
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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists
zcli farm-blacklist add dlink2 -name china
POST /farms/<farmname>/ipds/<blacklists>
Terapkan aturan daftar hitam ke tambak. Profil datalink hanya menerima aturan daftar hitam.
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 dlink2.",
"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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists/china
zcli farm-blacklist remove dlink -name china
DELETE /farms/<farmname>/ipds/<blacklists>/<name>
Hapus aturan daftar hitam modul IPDS dari tambak yang diberikan menggunakan indikatornya nama.
Contoh respons:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm dlink2.",
"success" : "true"
}
Datalink - Backends
Backends di peternakan datalink adalah gateway melalui routing layanan. Layanan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm get dlink
GET /farms/<farmname>/backends
Dapatkan daftar backend dalam suatu layanan.
Contoh respons:
[
{
"alias" : "main-gateway",
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"alias" : "secondary-gateway",
"id" : 7,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
]
Parameter Respon
Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi backend. Alias |
| 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 dikonfigurasi sebagai prioritas dan prioritas yang lebih rendah akan memiliki preferensi. |
| status | Tali | Status backend. Nilai yang mungkin adalah: up, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan layanan telah mendeteksi bahwa backend tidak berfungsi; tidak terdefinisi, status backend belum dicentang. |
| berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. Ini akan digunakan saat algoritma bidang dikonfigurasikan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm-service-backend add dlink default_service -ip 192.168.100.10 -interface eth0 -priority 2 -weight 2
POST /farms/<farmname>/backends
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 dikonfigurasi sebagai prioritas dan prioritas yang lebih rendah akan memiliki preferensi. Nilai standarnya adalah 1. | |
| berat | Jumlah | Ini adalah nilai bobot untuk backend saat ini. Ini akan digunakan saat algoritma bidang dikonfigurasikan sebagai bobot. Nilai standarnya 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,"priority":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/datalink/backends/2
zcli farm-service-backend set datalink default_service 2 -ip 192.168.102.50 -interface eth0 -weight 1 -priority 1
PUT /farms/<farmname>/backends/<id>
Ubah parameter backend dalam layanan Farm datalink. id adalah pengidentifikasi unik backend.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| ip | Tali | IP backend, tempat layanan sebenarnya mendengarkan. |
| antarmuka | Tali | Ini adalah antarmuka jaringan lokal tempat backend terhubung. |
| prioritas | Jumlah | Ini adalah prioritas 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",
"priority" : 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends/4
zcli farm-service-backend remove dlink default_service 4
DELETE /farms/<farmname>/backends/<id>
Hapus backend yang diberikan dari 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, itu adalah komponen perangkat keras komputer. Sisa antarmuka didasarkan pada NIC.
vlan: atau kartu LAN virtual adalah sejenis antarmuka jaringan yang menyediakan layanan segmentasi jaringan. Lebih dari satu VLAN dapat dibuat melalui antarmuka yang bagus.
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 dan mereka menggunakan tabel perutean antarmuka induknya, sehingga harus dikonfigurasi di segmen jaringan yang sama dari induknya. Antarmuka semacam ini harus digunakan untuk Peternakan.
Daftar semua antarmuka
Daftar semua antarmuka
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network list
GET /interfaces
Dapatkan daftar antarmuka dalam sistem dengan konfigurasinya.
Contoh respons:
{
"description" : "List interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "bond2",
"netmask" : "",
"status" : "down",
"dhcp" : "false",
"type" : "bond"
},
{
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"status" : "up",
"dhcp" : "false",
"type" : "bond"
},
{
"alias" : null,
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up",
"dhcp" : "false",
"type" : "nic",
"is_slave" : "false"
},
{
"alias" : null,
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "down",
"dhcp" : "false",
"type" : "vlan"
},
{
"alias" : null,
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "virtual"
},
{
"alias" : "gestion",
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up",
"dhcp" : "false",
"type" : "nic",
"is_slave" : "false"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"name" : "eth2",
"netmask" : "",
"status" : "up",
"dhcp" : "false",
"type" : "nic",
"is_slave" : "true"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"status" : "up",
"type" : "nic",
"dhcp" : "false",
"is_slave" : "true"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka.
Objek antarmuka:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| ip | Tali | IP antarmuka. IP harus berada di segmen jaringan yang sama dengan antarmuka orang tuanya di antarmuka virtual. |
| has_vlan | Tali | benar, antarmuka itu adalah induk dari antarmuka VLAN; atau palsu, antarmuka belum mendapatkan antarmuka VLAN yang menambahkannya. Bidang ini hanya untuk antarmuka NIC. |
| netmask | Tali | Netmask antarmuka. Nilai ini tidak dapat dimodifikasi dalam antarmuka virtual, itu diwarisi dari antarmuka induk. |
| pintu gerbang | Tali | Gerbang antarmuka. Nilai ini tidak dapat dimodifikasi dalam antarmuka virtual, itu diwarisi dari antarmuka induk. |
| 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
Ambil gateway default
Ambil gateway default
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 get
GET /interfaces/gateway/<ip_version>
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.
Sistem telah mengkonfigurasi dua gateway, satu untuk merutekan IPv4 dan lainnya untuk merutekan IPv6. URI mengharapkan versi IP ipv4 or ipv6.
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 set -interface eth0 -address 192.168.100.5
PUT /interfaces/gateway/<ip_version>
Ubah konfigurasi antarmuka gateway.
URI mengharapkan versi IP yang digunakan di bidang alamat. Nilai yang mungkin adalah ipv4 serta ipv6.
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/<ip_version>
Hapus konfigurasi konfigurasi gateway default.
URI mengharapkan satu versi IP dari gateway default untuk dihapus. Nilai yang mungkin adalah ipv4 serta ipv6.
peringatan: jika gateway tidak disetel, 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 delete
Pesan tanggapan
Jika gateway tidak disetel 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 serta 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network-nic list
Contoh respons:
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"is_slave" : "false",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"dhcp" : "false",
"status" : "up"
},
{
"alias" : "gestion",
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"dhcp" : "false",
"status" : "up"
},
{
"alias" : null,
"gateway" : "",
"has_vlan" : "false",
"ip" : "",
"is_slave" : "false",
"mac" : "a2:6d:80:29:87:c6",
"name" : "eth3",
"netmask" : "",
"dhcp" : "false",
"status" : "down"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka NIC.
Objek antarmuka NIC:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| ip | Tali | IP antarmuka. |
| has_vlan | Tali | benar, antarmuka itu adalah induk dari antarmuka VLAN; atau palsu, antarmuka belum mendapatkan antarmuka VLAN yang menambahkannya. |
| netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
| pintu gerbang | Tali | IP digunakan untuk mengirim paket ke segmen jaringan yang berbeda. |
| mac | Tali | Tautan pengidentifikasi 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
Ambil antarmuka NIC
Ambil antarmuka NIC
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic get eth1
GET /interfaces/nic/<name>
Dapatkan semua parameter antarmuka NIC. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show NIC interface",
"interface" : {
"alias" : "gestion",
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"dhcp" : "false",
"status" : "up"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| 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 pengidentifikasi 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 | Jenis antarmuka yang berbeda 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic set eth0 -ip 192.168.100.102 -netmask 255.255.255.0 -gateway 192.168.100.5
PUT /interfaces/nic/<name>
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. |
| kekuatan | Tali | Jika sebuah tambak menggunakan antarmuka, antarmuka tidak dapat diubah. Kemudian, jika parameter ini dikirim dengan nilai benar, antarmuka akan dipaksa untuk mengambil konfigurasi baru dan semua peternakan menggunakan antarmuka akan dimulai kembali. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
Contoh respons:
{
"description" : "Configure NIC interface",
"params" : {
"alias" : null,
"dhcp" : "false",
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"is_slave" : "false",
"mac" : "4a:4f:3c:d7:dd:70",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "down"
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
zcli network-nic unset 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1/actions
zcli network-nic stop eth1
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 - antarmuka VLAN
Antarmuka VLAN memungkinkan NIC atau antarmuka ikatan bekerja di jaringan lain, sehingga konfigurasi jaringan (IP, pintu gerbang, dan netmask) harus berada di segmen jaringan yang berbeda. 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan list
GET /interfaces/vlan
Dapatkan semua parameter antarmuka VLAN.
Contoh respons:
{
"description" : "List VLAN interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"dhcp" : "false",
"status" : "down"
}
]
}
Parameter respons
Respons akan berupa objek JSON dengan array objek antarmuka VLAN.
Parameter VLAN adalah:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| ip | Tali | IP antarmuka. Ini bisa berbeda dari IP antarmuka 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 rantai yang diformat 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
Ambil antarmuka VLAN
Ambil antarmuka VLAN
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan get eth0.1
GET /interfaces/vlan/<name>
Dapatkan semua parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show VLAN interface",
"interface" : {
"alias" : null,
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"dhcp" : "false",
"status" : "up"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| 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 rantai yang diformat 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
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","mac":"52:98:19:6a:c9:18","dhcp":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan create -name eth0.1 -ip 192.168.120.120 -netmask 255.255.255.0 -gateway 192.168.120.1 -mac 52:98:19:61:c9:18 -dhcp false
POST /interfaces/vlan
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 dari IP antarmuka 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 rantai yang diformat oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan VLAN. | benar |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. | |
| mac | Tali | Menulis ulang MAC antarmuka. |
Contoh respons:
{
"description" : "Add a vlan interface",
"params" : {
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "52:98:19:6a:c9:18",
"name" : "eth0.1",
"dhcp" : "false",
"netmask" : "255.255.255.0"
}
}
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","mac":"96:23:25:8b:d4:af"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan set eth0.1 -ip 192.168.131.151 -netmask 255.255.255.0 -gateway 192.168.131.1 -mac 96:23:25:8b:d4:af
PUT /interfaces/vlan/<name>
Ubah parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| ip | Tali | IP antarmuka. Ini bisa berbeda dari IP antarmuka induk. |
| netmask | Tali | Tentukan segmen jaringan tempat antarmuka bekerja. |
| pintu gerbang | Tali | IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
| mac | Tali | Menulis ulang MAC antarmuka. |
| kekuatan | Tali | Jika sebuah tambak menggunakan antarmuka, antarmuka tidak dapat diubah. Kemudian, jika parameter ini dikirim dengan nilai benar, antarmuka akan dipaksa untuk mengambil konfigurasi baru dan semua peternakan menggunakan antarmuka akan dimulai kembali. |
Contoh respons:
{
"description" : "Modify VLAN interface",
"params" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"netmask" : "255.255.255.0",
"mac" : "96:23:25:8b:d4:af",
"dhcp" : "false",
"force" : "true"
}
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
zcli network-vlan stop eth0.1
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 mengatur antarmuka jaringan lain di segmen jaringan yang sama dari orang tuanya, 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 membangun identitas untuk antarmuka virtual.
Daftar antarmuka virtual
Daftar antarmuka virtual
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual list
GET /interfaces/virtual
Dapatkan semua parameter antarmuka virtual.
Contoh respons:
{
"description" : "List virtual interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "up"
},
{
"alias" : null,
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| ip | Tali | IP antarmuka. IP harus berada di segmen jaringan yang sama dengan 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 diformat 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual get eth0:vip1
GET /interfaces/virtual/<name>
Dapatkan semua parameter antarmuka virtual. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show virtual interface",
"interface" : {
"alias" : null,
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"status" : "down"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| ip | Tali | IP antarmuka. IP harus berada di segmen jaringan yang sama dengan 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 diformat 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual create -name eth0:virtiface -ip 192.168.100.41
POST /interfaces/virtual
Buat antarmuka virtual.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| ip | Tali | IP antarmuka. IP harus berada di segmen jaringan yang sama dengan antarmuka induk. | benar |
| nama | Tali | Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang diformat 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 berada di segmen jaringan yang sama dengan 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 diformat oleh antarmuka induk, karakter titik dua ":" dan string alfanumerik 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual set eth0:virtiface -ip 192.168.131.155
PUT /interfaces/virtual/<name>
Ubah parameter antarmuka virtual. nama adalah pengenal unik antarmuka.
Parameter permintaan
| Bidang | Tipe | Deskripsi | wajib |
|---|---|---|---|
| ip | Tali | IP antarmuka. IP harus berada di segmen jaringan yang sama dengan antarmuka induk. | benar |
| kekuatan | Tali | Jika sebuah tambak menggunakan antarmuka, antarmuka tidak dapat diubah. Kemudian, jika parameter ini dikirim dengan nilai benar, antarmuka akan dipaksa untuk mengambil konfigurasi baru dan semua peternakan menggunakan antarmuka akan dimulai kembali. |
Contoh respons:
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10",
"force" : "true"
}
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
zcli network-virtual stop eth0:virtiface
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 - Ikatan antarmuka
Antarmuka pengikatan Linux atau juga disebut oleh vendor lain sebagai Trunk menyediakan metode untuk menggabungkan beberapa antarmuka jaringan ke dalam satu antarmuka “terikat” logis. 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 itu.
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding list
GET /interfaces/bonding
Dapatkan konfigurasi tentang semua antarmuka ikatan dalam sistem.
Contoh respons:
{
"description" : "List bonding interfaces",
"interfaces" : [
{
"alias" : null,
"gateway" : "",
"ip" : "",
"mac" : "66:eb:31:0e:07:71",
"mode" : "broadcast",
"name" : "bond2",
"netmask" : "",
"dhcp" : "false",
"slaves" : [
{
"name" : "eth2"
}
],
"status" : "down"
},
{
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"dhcp" : "false",
"netmask" : "255.255.255.0",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth4"
}
],
"status" : "up"
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array objek antarmuka ikatan.
Parameter ikatan adalah:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| 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 pengidentifikasi 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding get bondiface
GET /interfaces/bonding/<name>
Dapatkan semua parameter antarmuka. nama adalah pengenal unik antarmuka.
Contoh respons:
{
"description" : "Show bonding interface",
"interface" : {
"alias" : null,
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"mac" : "a2:6d:80:29:87:c6",
"mode" : "balance-rr",
"name" : "bondiface",
"netmask" : "255.255.255.0",
"dhcp" : "false",
"slaves" : [
{
"name" : "eth3"
},
{
"name" : "eth2"
}
],
"status" : "up"
}
}
Parameter respons
Responsnya akan menjadi objek JSON dengan objek antarmuka ikatan.
Parameter ikatan adalah:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| 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 pengidentifikasi 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. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding create -slave eth3,eth2 -name bondiface -mode balance-rr
POST /interfaces/bonding
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 pengidentifikasi 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 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. |
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","mac":"86:2f:0e:9a:30:14"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding set bondiface -ip 192.168.100.121 -netmask 255.255.255.0 -gateway 192.168.100.1 -mac 86:2f:0e:9a:30:14
PUT /interfaces/bonding/<name>
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. |
| kekuatan | Tali | Jika sebuah tambak menggunakan antarmuka, antarmuka tidak dapat diubah. Kemudian, jika parameter ini dikirim dengan nilai benar, antarmuka akan dipaksa untuk mengambil konfigurasi baru dan semua peternakan menggunakan antarmuka akan dimulai kembali. |
| dhcp | Tali | Mengaktifkan layanan DHCP untuk mendapatkan konfigurasi jaringan untuk antarmuka dari server DHCP. Parameter ini menerima: benar, untuk mengaktifkan layanan, konfigurasi antarmuka akan diblokir saat layanan DHCP diaktifkan; palsu untuk menghentikan layanan, antarmuka akan kehilangan semua konfigurasi jaringannya. |
| mac | Tali | Menulis ulang MAC antarmuka. |
Contoh respons:
{
"description" : "Modify bond address",
"params" : {
"gateway" : "192.168.100.1",
"ip" : "192.168.100.121",
"netmask" : "255.255.255.0",
"mac" : "86:2f:0e:9a:30:14",
"dhcp" : "false",
"force" : "true"
}
}
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding delete bondiface
DELETE /interfaces/bonding/<name>
Hapus konfigurasi antarmuka ikatan. Parameter konfigurasi adalah: pintu gerbang, ip serta 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/actions
zcli network-bond start bondiface
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 antarmuka anggota sebelum 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves
zcli network-bonding-slave add bondiface -name eth4
POST /interfaces/bonding/<name>/slaves
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
Responsnya akan menjadi 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
zcli network-bonding-slave remove bondiface eth2
DELETE /interfaces/bonding/<name>/slaves/<name>
Hapus antarmuka budak NIC dari antarmuka ikatan. Antarmuka ikatan 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 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating
zcli network-floating list
GET /interfaces/floating
Tampilkan semua antarmuka yang tersedia atau dikonfigurasi di mana IP mengambang telah dibuat.
Contoh respons:
{
"description" : "List floating interfaces",
"params" : [
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : null,
"interface" : "bondiface",
"interface_virtual" : null
},
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : "192.168.100.41",
"interface" : "eth0",
"interface_virtual" : "eth0:virtiface"
},
{
"alias" : null,
"floating_alias" : null,
"floating_ip" : null,
"interface" : "eth0.1",
"interface_virtual" : null
},
{
"alias" : "gestion",
"floating_alias" : null,
"floating_ip" : null,
"interface" : "eth1",
"interface_virtual" : null
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan array objek antarmuka mengambang:
Mengambang obyek:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| floating_alias | Tali | Ini adalah alias dari antarmuka virtual. |
| 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. |
| interface_virtual | Tali | Ini adalah nama antarmuka virtual dari IP mengambang yang digunakan untuk menutupi antarmuka. |
Ambil antarmuka Mengambang
Ambil antarmuka Mengambang
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating get eth0
GET /interfaces/floating/<name>
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" : {
"alias" : null,
"floating_alias" : null,
"floating_ip" : "192.168.100.41",
"interface" : "eth0",
"interface_virtual" : "eth0:virtiface"
}
}
Parameter respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| alias | Tali | Ini adalah nick untuk membantu mengidentifikasi antarmuka. Alias |
| floating_alias | Tali | Ini adalah alias dari antarmuka virtual. |
| 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. |
| interface_virtual | Tali | Ini adalah nama antarmuka virtual dari IP mengambang yang digunakan untuk menutupi antarmuka. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating set eth0 -floating_ip 192.168.100.199
PUT /interfaces/floating/<name>
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating delete 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"
}
Jaringan - Alias
Masukkan alias ke antarmuka atau backend untuk mengidentifikasinya dengan cepat.
Ada dua jenis alias, alias antarmuka dapat diterapkan di semua jenis antarmuka: NIC, bonding, VLAN atau virtual. Ini adalah cara mudah menghubungkan nama antarmuka dengan nama yang lebih ramah.
Jenis alias lainnya adalah untuk backend. Ini menghubungkan backend IP dengan alias.
Alias hanya informasi visual, itu tidak menggantikan backend IP atau nama antarmuka dalam permintaan ZAPI.
Daftar alias
Daftar alias
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/backends
zcli network-alias-backend list
GET /aliases/<backends|interfaces>
Daftar alias di sistem untuk antarmuka atau backend.
Contoh respons:
{
"description" : "List the aliases",
"params" : [
{
"id" : "192.168.11.13",
"alias" : "http-backend"
},
{
"id" : "127.0.0.1",
"alias" : "localhost"
}
]
}
Parameter respons
ZAPI mengembalikan hash di mana kuncinya adalah backend IP atau nama antarmuka dan nilainya adalah alias.
Buat alias
Buat alias
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"eth0","alias":"management"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces
zcli network-alias-interface set eth0 -alias management
POST /aliases/<backends|interfaces>
Jenis objek backend atau antarmuka yang akan menerima alias.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| alias | Tali | Ini adalah nick untuk elemen id dikirim dalam URI. | benar |
| id | Tali | Ini adalah IP backend atau nama antarmuka. | benar |
Contoh respons:
{
"description" : "Set an alias",
"message" : "Alias for eth0 has been updated successfully",
"success" : "true"
}
Parameter respons
ZAPI mengembalikan pesan sukses jika prosesnya benar.
Ubah alias
Ubah alias
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"gateway"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zcli network-alias-interface set eth0 -alias gateway
PUT /aliases/<backends|interfaces>/<id>
Jika objek memiliki alias, itu akan diganti, kalau tidak alias akan dibuat untuk objek.
The id Parameter URI adalah IP backend atau nama antarmuka.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| alias | Tali | Ini adalah nick untuk elemen id dikirim dalam URI. | benar |
Contoh respons:
{
"description" : "Set an alias",
"message" : "Alias for eth0 has been updated successfully",
"success" : "true"
}
Parameter respons
ZAPI mengembalikan pesan sukses jika prosesnya benar.
Hapus alias
Hapus alias
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zli network-alias-interface delete eth0
DELETE /aliases/<backends|interfaces>/<id>
Ini menghapus alias antarmuka atau backend.
The id Parameter URI adalah IP backend atau nama antarmuka.
Contoh respons:
{
"description" : "Delete an alias",
"message" : "The alias has been deleted.",
"success" : "true"
}
Parameter respons
ZAPI mengembalikan pesan sukses jika prosesnya benar.
Jaringan - Routing
Modul ini tersedia dari zapi versi 4.0.1.
Modul ini mengatur rute untuk lalu lintas yang melewati atau dari penyeimbang beban. Proses ini menghitung antarmuka keluaran tergantung pada sumber paket dan tujuan paket. Untuk tugas ini, penyeimbang beban menggunakan dua jenis objek aturan serta tabel.
Langkah pertama adalah mencari a memerintah di mana sumber paket cocok, setelah aturan ditemukan, antarmuka paket keluar mencari di tabel bahwa memerintah didefinisikan. Antarmuka adalah token dari rute yang sesuai dengan tujuan paket.
Daftar aturan perutean
Daftar aturan perutean
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule list
GET /routing/rules
Buat daftar aturan perutean penyeimbang beban. Aturan perutean digunakan untuk mendapatkan tabel antarmuka bergantung pada paket IP sumber
Contoh respons:
{
"description" : "List routing rules",
"params" : [
{
"id" : 1024,
"not" : "true",
"from" : "10.10.10.0/24",
"priority" : 30000,
"table" : "table_eth1",
"type" : "user"
},
{
"table" : "local",
"type" : "system",
"id" : 0,
"priority" : 0,
"from" : "all"
},
{
"id" : 0,
"priority" : 31000,
"from" : "10.3.0.0/24",
"table" : "205",
"type" : "system"
},
{
"type" : "system",
"table" : "table_eth1",
"priority" : 31000,
"from" : "4.4.4.0/24",
"id" : 0
},
{
"type" : "system",
"table" : "main",
"priority" : 32766,
"from" : "all",
"id" : 0
}
]
}
Parameter respons
Responsnya akan berupa daftar JSON dengan semua aturan perutean dalam sistem. Setiap aturan adalah objek dengan parameter berikut:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | Ini adalah pengidentifikasi unik yang digunakan untuk aturan routing. |
| tidak | Tali | Bidang ini digunakan dikombinasikan dengan parameter dari untuk meniadakan hasil pertandingan. Parameter ini adalah string boolean dengan nilai benar untuk mengaktifkannya atau dengan nilai palsu jika hasil pertandingan tidak dinegasikan. |
| dari | Tali | Ini adalah sumber IP atau segmen jaringan yang digunakan untuk mencocokkan dengan IP sumber paket. |
| prioritas | Jumlah | Ini adalah prioritas aturan, nilai minor prioritas adalah prioritas tinggi. |
| tabel | Tali | Ini adalah tabel antarmuka yang digunakan untuk merutekan jika sumber IP paket cocok dengan parameter dari. |
| mengetik | Tali | Ini adalah jenis aturan, bidang ini dapat memiliki nilai: kebun adalah rute yang digunakan untuk merutekan lalu lintas di peternakan l4xnat, pemakai adalah aturan yang dibuat oleh administrator load balancer atau sistem adalah aturan yang dibuat secara otomatis untuk sistem. |
Buat Aturan Routing
Buat Aturan Routing
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","not":"true","priority":"30000","from":"192.168.0.0/16"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule -table table_eth1 -not true -priority 30000 -from 192.168.0.0/16
POST /routing/rules
Buat aturan perutean.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| tidak | Tali | Bidang ini digunakan dikombinasikan dengan parameter dari untuk meniadakan hasil pertandingan. Parameter ini adalah string boolean dengan nilai benar untuk mengaktifkannya atau dengan nilai palsu jika hasil pertandingan tidak dinegasikan. | |
| dari | Tali | Ini adalah sumber IP atau segmen jaringan yang digunakan untuk mencocokkan dengan IP sumber paket. | benar |
| prioritas | Jumlah | Ini adalah prioritas aturan, nilai minor prioritas adalah prioritas tinggi. Aturan yang dibuat harus memiliki nilai di antaranya 29000 serta 30999 | |
| tabel | Tali | Ini adalah tabel antarmuka yang digunakan untuk merutekan jika sumber IP paket cocok dengan parameter dari. | benar |
Contoh respons:
{
"description" : "Create a routing rule",
"params" : [
{
"not" : "true",
"id" : 1024,
"from" : "192.168.0.0/16",
"priority" : 30000,
"table" : "table_eth1",
"type" : "user"
},
{
"table" : "table_eth0",
"type" : "system",
"id" : 0,
"priority" : 32765,
"from" : "192.168.100.0/24"
},
{
"from" : "all",
"priority" : 32766,
"id" : 0,
"type" : "system",
"table" : "main"
},
{
"id" : 0,
"priority" : 32767,
"from" : "all",
"table" : "default",
"type" : "system"
}
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan semua aturan rute sistem. Setiap rute adalah objek dengan parameter:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | Ini adalah pengidentifikasi unik yang digunakan untuk aturan routing. |
| tidak | Tali | Bidang ini digunakan dikombinasikan dengan parameter dari untuk meniadakan hasil pertandingan. Parameter ini adalah string boolean dengan nilai benar untuk mengaktifkannya atau dengan nilai palsu jika hasil pertandingan tidak dinegasikan. |
| dari | Tali | Ini adalah sumber IP atau segmen jaringan yang digunakan untuk mencocokkan dengan IP sumber paket. |
| prioritas | Jumlah | Ini adalah prioritas aturan, nilai minor prioritas adalah prioritas tinggi. |
| tabel | Tali | Ini adalah tabel antarmuka yang digunakan untuk merutekan jika sumber IP paket cocok dengan parameter dari. |
| mengetik | Tali | Ini adalah jenis aturan, bidang ini dapat memiliki nilai: kebun adalah rute yang digunakan untuk merutekan lalu lintas di peternakan l4xnat, pemakai adalah aturan yang dibuat oleh administrator load balancer atau sistem adalah aturan yang dibuat secara otomatis untuk sistem. |
Ubah Aturan Routing
Ubah Aturan Routing
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","from":"10.10.10.0/24","priority":"30000","not":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule set 1024 -table table_eth1 -from 10.10.10.0/24 -priority 30000 -not false
PUT /routing/rules/<id>
Ubah parameter aturan perutean.
The id Parameter URI adalah pengidentifikasi unik aturan.
Aturan mengetik pemakai adalah keunikan yang bisa dimodifikasi
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| tidak | Tali | Bidang ini digunakan dikombinasikan dengan parameter dari untuk meniadakan hasil pertandingan. | |
| dari | Tali | Ini adalah sumber IP atau segmen jaringan yang digunakan untuk mencocokkan dengan IP sumber paket. Parameter ini adalah string boolean dengan nilai benar untuk mengaktifkannya atau dengan nilai palsu jika hasil pertandingan tidak dinegasikan. | benar |
| prioritas | Jumlah | Ini adalah prioritas aturan, nilai minor prioritas adalah prioritas tinggi. Aturan yang dibuat harus memiliki nilai di antaranya 29000 serta 30999 | |
| tabel | Tali | Ini adalah tabel antarmuka yang digunakan untuk merutekan jika sumber IP paket cocok dengan parameter dari. | benar |
Contoh respons:
{
"description" : "Modify a routing rule",
"params" : [
{
"not" : "true",
"id" : 1024,
"priority" : 30000,
"from" : "10.10.10.0/24",
"table" : "table_eth1",
"type" : "user"
},
{
"id" : 0,
"from" : "4.4.4.0/24",
"priority" : 31000,
"table" : "table_eth1",
"type" : "system"
},
{
"table" : "table_eth2",
"type" : "system",
"id" : 0,
"from" : "5.5.5.0/24",
"priority" : 31000
},
{
"type" : "system",
"table" : "table_eth0",
"from" : "192.168.100.0/24",
"priority" : 32765,
"id" : 0
},
]
}
Parameter respons
Responsnya akan menjadi objek JSON dengan semua aturan rute sistem. Setiap rute adalah objek dengan parameter:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| id | Jumlah | Ini adalah pengidentifikasi unik yang digunakan untuk aturan routing. |
| tidak | Tali | Bidang ini digunakan dikombinasikan dengan parameter dari untuk meniadakan hasil pertandingan. Parameter ini adalah string boolean dengan nilai benar untuk mengaktifkannya atau dengan nilai palsu jika hasil pertandingan tidak dinegasikan. |
| dari | Tali | Ini adalah sumber IP atau segmen jaringan yang digunakan untuk mencocokkan dengan IP sumber paket. |
| prioritas | Jumlah | Ini adalah prioritas aturan, nilai minor prioritas adalah prioritas tinggi. |
| tabel | Tali | Ini adalah tabel antarmuka yang digunakan untuk merutekan jika sumber IP paket cocok dengan parameter dari. |
| mengetik | Tali | Ini adalah jenis aturan, bidang ini dapat memiliki nilai: kebun adalah rute yang digunakan untuk merutekan lalu lintas di peternakan l4xnat, pemakai adalah aturan yang dibuat oleh administrator load balancer atau sistem adalah aturan yang dibuat secara otomatis untuk sistem. |
Hapus Aturan Perutean
Hapus Aturan Perutean
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule remove 1024
DELETE /routing/rules/<id>
Hapus aturan perutean.
The id Parameter URI adalah pengidentifikasi unik aturan.
Contoh respons:
{
"message" : "The routing rule '1024' has been deleted successfully.",
"description" : "Delete the routing rule '1024'"
}
Daftar tabel perutean
Daftar tabel perutean
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables
zcli network-routing-table list
GET /routing/tables
Daftar tabel perutean yang dikelola penyeimbang beban.
Tabel utama adalah global untuk semua antarmuka. Ini berisi rute default untuk semua antarmuka yang akan digunakan jika tidak ada aturan yang cocok dengan paket. Setiap tabel antarmuka mengelola rute untuk lalu lintas keluar dari antarmuka itu.
Contoh respons:
{
"description" : "List routing tables",
"params" : [
"main",
"table_eth0",
"table_eth1",
"table_eth2",
"table_eth3"
]
}
Parameter respons
Respons akan berupa objek JSON dengan params kunci yang berisi daftar dengan tabel yang ada di sistem.
Daftar Rute tabel
Daftar aturan perutean
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2
zcli network-routing-table get table_eth2
GET /routing/tables/<table>
Daftar entri rute yang dikelola tabel antarmuka. Entri tersebut digunakan untuk mencocokkan IP tujuan paket. Antarmuka yang keluar untuk paket akan menjadi antarmuka pertama yang akan cocok dengan entri tabel.
Contoh respons:
{
"description" : "Get the routing table 'table_eth2'",
"params" : [
{
"to" : "84.1.21.5",
"via" : "4.4.4.45",
"priority" : 2,
"raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
"id" : 1024,
"source" : "4.4.4.4",
"type" : "user",
"interface" : "eth1"
},
{
"priority" : 10,
"raw" : "5.5.5.0/24 dev eth2 scope link src 5.5.5.5 initcwnd 10 initrwnd 10 table table_eth2",
"interface" : "eth2",
"source" : "5.5.5.5",
"type" : "system",
"to" : "5.5.5.0/24",
"via" : ""
},
{
"via" : "",
"to" : "192.168.100.0/24",
"interface" : "eth0",
"type" : "system",
"source" : "192.168.100.241",
"raw" : "192.168.100.0/24 dev eth0 scope link src 192.168.100.241 initcwnd 10 initrwnd 10 table table_eth2",
"priority" : 10
}
]
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan daftar rute yang berisi tabel.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| mentah | Tali | Ini adalah entri rute dengan Rute IP Format. |
| prioritas | Jumlah | Ini adalah prioritas di mana rute akan diperiksa. Nilai yang lebih rendah lebih diprioritaskan. Bidang ini harus memiliki nilai di antara 1 serta 10. |
| antarmuka | Tali | Ini adalah antarmuka keluar yang digunakan jika rute cocok. |
| sumber | Tali | Ini adalah IP yang digunakan untuk menyamarkan paket. Sumber ini harus ada di load balancer sebagai antarmuka virtual. |
| mengetik | Tali | Ini adalah jenis rute. Rute dapat bertipe sistem yang dibuat dan dikelola secara otomatis oleh sistem, atau pemakai saat rute dibuat oleh pengguna penyeimbang beban. Memeriksa tidak dikelola fitur untuk menghapus a sistem rute. |
| untuk | Tali | Ini adalah kondisi yang tidak cocok. Jika IP tujuan paket cocok dengan itu, rute tersebut berhasil. |
| melalui | Tali | Ini adalah lompatan paket berikutnya. Ini digunakan sebagai gateway. IP ini harus dicapai dari segmen jaringan antarmuka. |
| id | Jumlah | Ini adalah pengidentifikasi unik rute. Parameter ini digunakan untuk mengubah atau menghapus rute dan hanya tersedia dalam rute jenis pemakai. |
Buat Entri Routing
Buat Entri Routing
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"source":"4.4.4.4","via":"4.4.4.45","interface":"eth1","priority":2,"to":"84.1.21.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes
zcli network-routing-table add table_eth2 -source 4.4.4.4 -via 4.4.4.45 -interface eth1 -priority 2 -to 84.1.21.5
POST /routing/tables/<table>/routes
Buat rute untuk antarmuka.
The tabel Parameter URI adalah tabel antarmuka tempat rute akan ditambahkan.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| mentah | Tali | Ini adalah entri rute dengan Rute IP format. Jika parameter ini digunakan, yang lain akan dihindari. | |
| untuk | Tali | Ini adalah kondisi yang tidak cocok. Jika IP tujuan paket cocok dengan itu, rute tersebut berhasil. | Diperlukan saat mentah tidak terkirim |
| prioritas | Jumlah | Ini adalah prioritas di mana rute akan diperiksa. Nilai yang lebih rendah lebih diprioritaskan. Bidang ini harus memiliki nilai di antara 1 serta 10. | |
| antarmuka | Tali | Ini adalah antarmuka keluar yang digunakan jika rute cocok. | |
| sumber | Tali | Ini adalah IP yang digunakan untuk menyamarkan paket. Sumber ini harus ada di load balancer sebagai antarmuka virtual. | |
| melalui | Tali | Ini adalah lompatan paket berikutnya. Ini digunakan sebagai gateway. IP ini harus dicapai dari segmen jaringan antarmuka. |
Contoh respons:
{
"description" : "Create a routing entry in the table 'table_eth2'",
"params" : [
{
"to" : "84.1.21.5",
"via" : "4.4.4.45",
"priority" : 2,
"raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
"id" : 1024,
"source" : "4.4.4.4",
"type" : "user",
"interface" : "eth1"
},
{
"raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10 table table_eth2",
"priority" : 10,
"source" : "",
"type" : "system",
"interface" : "eth2",
"to" : "default",
"via" : "5.5.5.1"
},
{
"priority" : 10,
"raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10 table table_eth2",
"source" : "4.4.4.4",
"type" : "system",
"interface" : "eth1",
"to" : "4.4.4.0/24",
"via" : ""
},
]
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan daftar rute yang berisi tabel.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| prioritas | Jumlah | Ini adalah prioritas di mana rute akan diperiksa. Nilai yang lebih rendah lebih diprioritaskan. Bidang ini harus memiliki nilai di antara 1 serta 10. |
| mentah | Tali | Ini adalah entri rute dengan Rute IP Format. |
| antarmuka | Tali | Ini adalah antarmuka keluar yang digunakan jika rute cocok. |
| sumber | Tali | Ini adalah IP yang digunakan untuk menyamarkan paket. Sumber ini harus ada di load balancer sebagai antarmuka virtual. |
| mengetik | Tali | Ini adalah jenis rute. Rute dapat bertipe sistem yang dibuat dan dikelola secara otomatis oleh sistem, atau pemakai saat rute dibuat oleh pengguna penyeimbang beban. Memeriksa tidak dikelola fitur untuk menghapus a sistem rute. |
| untuk | Tali | Ini adalah kondisi yang tidak cocok. Jika IP tujuan paket cocok dengan itu, rute tersebut berhasil. |
| melalui | Tali | Ini adalah lompatan paket berikutnya. Ini digunakan sebagai gateway. IP ini harus dicapai dari segmen jaringan antarmuka. |
| id | Jumlah | Ini adalah pengidentifikasi unik rute. Parameter ini digunakan untuk mengubah atau menghapus rute dan hanya tersedia dalam rute jenis pemakai. |
Ubah Entri Rute
Ubah Entri Rute
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"priority":2,"source":"4.4.4.4","interface":"eth1","to":"71.71.71.0/24","via":"4.4.4.45"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table -id 1024 -priority 2 -source 4.4.4.4 -interface eth1 -to 71.71.71.0/24 -via 4.4.4.45
PUT /routing/tables/<table>/routes/<id>
Ubah parameter entri rute.
The tabel Parameter URI adalah tabel antarmuka dari rute yang akan dimodifikasi. Itu id Parameter URI adalah pengidentifikasi unik rute yang akan dimodifikasi.
Parameter permintaan
| Bidang | Tipe | Deskripsi |
|---|---|---|
| mentah | Tali | Ini adalah entri rute dengan Rute IP format. Jika parameter ini digunakan, yang lain akan dihindari. |
| prioritas | Jumlah | Ini adalah prioritas di mana rute akan diperiksa. Nilai yang lebih rendah lebih diprioritaskan. Bidang ini harus memiliki nilai di antara 1 serta 10. |
| antarmuka | Tali | Ini adalah antarmuka keluar yang digunakan jika rute cocok. |
| sumber | Tali | Ini adalah IP yang digunakan untuk menyamarkan paket. Sumber ini harus ada di load balancer sebagai antarmuka virtual. |
| untuk | Tali | Ini adalah kondisi yang tidak cocok. Jika IP tujuan paket cocok dengan itu, rute tersebut berhasil. |
| melalui | Tali | Ini adalah lompatan paket berikutnya. Ini digunakan sebagai gateway. IP ini harus dicapai dari segmen jaringan antarmuka. |
Contoh respons:
{
"description" : "Modify a routing entry in the table 'table_eth2'",
"params" : [
{
"to" : "71.71.71.0/24",
"via" : "4.4.4.45",
"raw" : "71.71.71.0/24 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
"priority" : 2,
"id" : 1024,
"type" : "user",
"source" : "4.4.4.4",
"interface" : "eth1"
},
{
"raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10 table table_eth2",
"priority" : 10,
"interface" : "eth2",
"source" : "",
"type" : "system",
"to" : "default",
"via" : "5.5.5.1"
},
{
"via" : "",
"to" : "4.4.4.0/24",
"interface" : "eth1",
"source" : "4.4.4.4",
"type" : "system",
"priority" : 10,
"raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10 table table_eth2"
},
]
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan daftar rute yang berisi tabel.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| prioritas | Jumlah | Ini adalah prioritas di mana rute akan diperiksa. Nilai yang lebih rendah lebih diprioritaskan. Bidang ini harus memiliki nilai di antara 1 serta 10. |
| mentah | Tali | Ini adalah entri rute dengan Rute IP Format. |
| antarmuka | Tali | Ini adalah antarmuka keluar yang digunakan jika rute cocok. |
| sumber | Tali | Ini adalah IP yang digunakan untuk menyamarkan paket. Sumber ini harus ada di load balancer sebagai antarmuka virtual. |
| mengetik | Tali | Ini adalah jenis rute. Rute dapat bertipe sistem yang dibuat dan dikelola secara otomatis oleh sistem, atau pemakai saat rute dibuat oleh pengguna penyeimbang beban. Memeriksa tidak dikelola fitur untuk menghapus a sistem rute. |
| untuk | Tali | Ini adalah kondisi yang tidak cocok. Jika IP tujuan paket cocok dengan itu, rute tersebut berhasil. |
| melalui | Tali | Ini adalah lompatan paket berikutnya. Ini digunakan sebagai gateway. IP ini harus dicapai dari segmen jaringan antarmuka. |
| id | Jumlah | Ini adalah pengidentifikasi unik rute. Parameter ini digunakan untuk mengubah atau menghapus rute dan hanya tersedia dalam rute jenis pemakai. |
Hapus Entri Rute
Hapus Entri Rute
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table remove table_eth2 1024
DELETE /routing/tables/<table>/routes/<id>
Hapus rute dari tabel antarmuka.
The tabel Parameter URI adalah tabel antarmuka tempat rute akan dihapus. Itu id Parameter URI adalah pengidentifikasi unik rute yang akan dihapus.
Contoh respons:
{
"description" : "Delete the routing entry '1024' from the table 'table_eth2'",
"message" : "The routing rule '1024' has been deleted successfully."
}
Daftar Antarmuka Tidak dikelola dalam Tabel
Daftar Antarmuka Tidak Terkelola dalam Tabel
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged get table_eth1
GET /routing/tables/<table>/unmanaged
Fitur ini digunakan untuk menghindari lalu lintas dari antarmuka yang dapat keluar untuk antarmuka lainnya.
tabel adalah tabel routing dari antarmuka yang masuk.
Daftar antarmuka dan jika mereka dapat digunakan untuk keluar lalu lintas.
Contoh respons:
{
"params" : [
{
"unmanaged" : "false",
"interface" : "eth3"
},
{
"unmanaged" : "false",
"interface" : "eth0"
}
],
"description" : "Get the list of interfaces that cannot manage traffic when traffic incoming through the table 'table_eth1'"
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params yang berisi daftar objek dengan parameter berikut.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| antarmuka | Tali | Ini adalah nama antarmuka keluaran. |
| tidak dikelola | Tali | Ini adalah status perutean antarmuka. Jika punya nilai palsu, antarmuka ini dapat dijangkau dari tabel; jika memiliki nilai benar, itu tidak akan mengeluarkan lalu lintas dari tabel. |
Tambahkan antarmuka ke daftar tidak terkelola
Membatalkan pengelolaan Antarmuka
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged add table_eth1 interface eth0
POST /routing/tables/<table>/unmanaged
Nonaktifkan antarmuka untuk lalu lintas keluar.
The tabel Parameter URI adalah nama tabel perutean dari mana rute tidak dapat dijangkau. Jika tabel memiliki nilai "*”(Tanda bintang), file antarmuka tidak akan dapat diakses dari tabel apa pun.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| antarmuka | Tali | Ini adalah antarmuka yang tidak dapat dirutekan dari tabel. | benar |
Contoh respons:
{
"description" : "Do not route traffic through an interface for the table 'table_eth1'",
"message" : "The interface 'eth2' is not accesible from the table 'table_eth1'"
}
Hapus antarmuka dari daftar tidak terkelola
Kelola Tabel Perutean
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged/eth2
zcli network-routing-table-unmanaged remove table_eth1 eth2
DELETE /routing/tables/<table>/unmanaged/<interface>
Izinkan antarmuka akan terlihat dari tabel antarmuka lain
The tabel Parameter URI adalah tabel antarmuka yang sedang dimodifikasi. Jika tabel memiliki nilai "*”(Tanda bintang), file antarmuka akan dikelola dari semua tabel. Itu antarmuka Parameter URI adalah antarmuka yang akan diizinkan untuk tabel tabel.
Contoh respons:
{
"description" : "Enable an interface as possible route path from the table 'table_eth1'",
"message" : "The interface 'eth2' is now accesible from the table 'table_eth1'"
}
Pemantauan - FarmGuardian
FarmGuardian digunakan untuk memantau keadaan backend yang canggih. Ketika masalah terdeteksi oleh FarmGuardian secara otomatis menonaktifkan server sebenarnya dan akan ditandai sebagai daftar hitam.
Daftar FarmGuardians
Daftar FarmGuardians
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian list
GET /monitoring/fg
Daftar FarmGuardians. Template dan custom FarmGuardians muncul di daftar ini.
Contoh respons:
{
"description" : "List farm guardian checks and templates",
"params" : [
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true",
"backend_alias" : "false"
},
{
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [
"web_service",
"my_welcome_web"
],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false",
"backend_alias" : "true"
},
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true",
"backend_alias" : "false"
}
]
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Command | Tali | Perintah untuk memeriksa status layanan di backend. Perintah-perintah yang tersedia berada di libexec path. |
| cut_conns | Tali | Nilai yang mungkin adalah: benar, FarmGuardian memotong koneksi saat ini ketika backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| deskripsi | Tali | Deskripsi singkat cek. |
| peternakan | String [] | Peternakan tempat FarmGuardian diterapkan. |
| selang | Jumlah | Waktu antar cek. |
| mencatat | Tali | Nilai yang mungkin adalah: benar, FarmGuardian akan mencatat setiap cek; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| nama | Tali | Pengenal unik. |
| Template | Tali | Jika FarmGuardian adalah templat, itu tidak akan diterapkan ke pertanian mana pun. Template berguna untuk membuat FarmGuardian baru. |
| backend_alias (dari 4.0.1) | Tali | Jika parameter ini memiliki nilai palsu, host backend akan menjadi backend IP. Alias dari backend akan digunakan sebagai host jika parameter ini memiliki nilai benar, alias harus didefinisikan dan penyeimbang beban harus dapat menyelesaikannya. |
Ambil FarmGuardian
Ambil FarmGuardian
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
zcli farmguardian get check_tcp
GET /monitoring/fg/<name>
Tampilkan konfigurasi FarmGuardian.
Parameter URI nama adalah pengidentifikasi unik FarmGuardian.
Contoh respons:
{
"description" : "Retrive the farm guardian check_tcp",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 10,
"log" : "false",
"name" : "check_tcp",
"template" : "true",
"backend_alias" : "false",
"timeout" : 5
}
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Command | Tali | Perintah untuk memeriksa status layanan di backend. Perintah-perintah yang tersedia berada di libexec path. |
| cut_conns | Tali | Nilai yang mungkin adalah: benar, FarmGuardian memotong koneksi saat ini ketika backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| deskripsi | Tali | Deskripsi singkat cek. |
| peternakan | String [] | Peternakan tempat FarmGuardian diterapkan. |
| selang | Jumlah | Waktu antara pemeriksaan. Ini adalah waktu sejak backend terakhir dalam daftar diuji hingga backend pertama diuji lagi. |
| mencatat | Tali | Nilai yang mungkin adalah: benar, FarmGuardian akan mencatat setiap cek; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| nama | Tali | Pengenal unik. |
| Template | Tali | Jika FarmGuardian adalah template, itu tidak akan dimodifikasi. Templat ini berguna untuk membuat Penjaga Pertanian baru atau melamar langsung ke pertanian. |
| backend_alias (dari 4.0.1) | Tali | Jika parameter ini memiliki nilai palsu, host backend akan menjadi backend IP. Alias dari backend akan digunakan sebagai host jika parameter ini memiliki nilai benar, alias harus didefinisikan dan penyeimbang beban harus dapat menyelesaikannya. |
| waktu habis (dari 4.0.2) | Jumlah | Batas waktu untuk setiap backend. Setelah waktu ini selama pengujian backend, itu akan dianggap turun. Secara default, batas waktu sama dengan interval. |
Buat FarmGuardian
Buat FarmGuardian
Contoh permintaan:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "copy_from":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian create -name check_tcp-cut_conns -copy_from check_tcp
POST /monitoring/fg
Buat FarmGuardian baru.
Parameter permintaan
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| nama | Tali | Pengenal unik. | benar |
| copy_from | Tali | Ini adalah FarmGuardian yang digunakan sebagai templat untuk membuat FarmGuardian baru. Jika bidang ini tidak dikirim, FarmGuardian baru dibuat tanpa konfigurasi. |
Contoh respons:
{
"description" : "Create a farm guardian check_tcp-cut_conns",
"message" : "The farm guardian check_tcp-cut_conns has been created successfully",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true",
"backend_alias" : "false",
"timeout" : 5
}
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Command | Tali | Perintah untuk memeriksa status layanan di backend. Perintah-perintah yang tersedia berada di libexec path. |
| cut_conns | Tali | Nilai yang mungkin adalah: benar, FarmGuardian memotong koneksi saat ini ketika backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| deskripsi | Tali | Deskripsi singkat cek. |
| peternakan | String [] | Peternakan tempat FarmGuardian diterapkan. |
| selang | Jumlah | Waktu antara pemeriksaan. Ini adalah waktu sejak backend terakhir dalam daftar diuji hingga backend pertama diuji lagi. |
| mencatat | Tali | Nilai yang mungkin adalah: benar, FarmGuardian akan mencatat setiap cek; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| nama | Tali | Pengenal unik. |
| Template | Tali | Jika FarmGuardian adalah template, itu tidak akan dimodifikasi. Templat ini berguna untuk membuat Penjaga Pertanian baru atau melamar langsung ke pertanian. |
| backend_alias (dari 4.0.1) | Tali | Jika parameter ini memiliki nilai palsu, host backend akan menjadi backend IP. Alias dari backend akan digunakan sebagai host jika parameter ini memiliki nilai benar, alias harus didefinisikan dan penyeimbang beban harus dapat menyelesaikannya. |
| waktu habis (dari 4.0.2) | Jumlah | Batas waktu untuk setiap backend. Setelah waktu ini selama pengujian backend, itu akan dianggap turun. Secara default, batas waktu sama dengan interval. |
Ubah FarmGuardian
Ubah FarmGuardian
Contoh permintaan:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian set custom-tcp -interval 7 -log true -description 'TCP check to the port 80' -command 'check_tcp -p 80 -H HOST' -cut_conns false
PUT /monitoring/fg/<name>
Ubah FarmGuardian.
Parameter URI nama adalah pengidentifikasi unik FarmGuardian.
Parameter permintaan
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| Command | Tali | Perintah untuk memeriksa status layanan di backend. Perintah-perintah yang tersedia berada di libexec path. | |
| cut_conns | Tali | Nilai yang mungkin adalah: benar, FarmGuardian memotong koneksi saat ini ketika backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. | |
| deskripsi | Tali | Deskripsi singkat cek. | |
| selang | Jumlah | Waktu antara pemeriksaan. Ini adalah waktu sejak backend terakhir dalam daftar diuji hingga backend pertama diuji lagi. | |
| mencatat | Tali | Nilai yang mungkin adalah: benar, FarmGuardian akan mencatat setiap cek; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. | |
| kekuatan | Tali | Jika peternakan yang sedang berjalan menggunakan FarmGuardian, FarmGuardian tidak akan dapat dimodifikasi. Kemudian, jika parameter ini dikirim dengan nilai benar, FarmGuardian akan dipaksa untuk mengambil konfigurasi baru. | |
| backend_alias (dari 4.0.1) | Tali | Jika parameter ini memiliki nilai palsu, host backend akan menjadi backend IP. Alias dari backend akan digunakan sebagai host jika parameter ini memiliki nilai benar, alias harus didefinisikan dan penyeimbang beban harus dapat menyelesaikannya. | |
| waktu habis (dari 4.0.2) | Jumlah | Batas waktu untuk setiap backend. Setelah waktu ini selama pengujian backend, itu akan dianggap turun. Secara default, batas waktu sama dengan interval. |
Contoh respons:
{
"description" : "Modify farm guardian custom-tcp",
"message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
"params" : {
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false",
"backend_alias" : "false",
"timeout" : 7
}
}
Parameter respons
Respons akan menjadi objek JSON dengan kunci params dan format di bawah ini:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| Command | Tali | Perintah untuk memeriksa status layanan di backend. Perintah-perintah yang tersedia berada di libexec path. |
| cut_conns | Tali | Nilai yang mungkin adalah: benar, FarmGuardian memotong koneksi saat ini ketika backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| deskripsi | Tali | Deskripsi singkat cek. |
| peternakan | String [] | Peternakan tempat FarmGuardian diterapkan. |
| selang | Jumlah | Waktu antara pemeriksaan. Ini adalah waktu sejak backend terakhir dalam daftar diuji hingga backend pertama diuji lagi. |
| mencatat | Tali | Nilai yang mungkin adalah: benar, FarmGuardian akan mencatat setiap cek; atau palsu, jika backend itu tidak tersedia, itu akan dinonaktifkan tetapi sesi hidup berlanjut. |
| nama | Tali | Pengenal unik. |
| Template | Tali | Jika FarmGuardian adalah templat, itu tidak akan diterapkan ke pertanian mana pun. Template berguna untuk membuat FarmGuardian baru. |
| backend_alias (dari 4.0.1) | Tali | Jika parameter ini memiliki nilai palsu, host backend akan menjadi backend IP. Alias dari backend akan digunakan sebagai host jika parameter ini memiliki nilai benar, alias harus didefinisikan dan penyeimbang beban harus dapat menyelesaikannya. |
| waktu habis (dari 4.0.2) | Jumlah | Batas waktu untuk setiap backend. Setelah waktu ini selama pengujian backend, itu akan dianggap turun. Secara default, batas waktu sama dengan interval. |
Hapus sebuah FarmGuardian
Hapus sebuah FarmGuardian
Contoh permintaan:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian delete custom-tcp
DELETE /monitoring/fg/<name>
HAPUS a FarmGuardian.
Parameter URI nama adalah pengidentifikasi unik FarmGuardian.
Contoh respons:
{
"description" : "Delete the farm guardian custom-tcp",
"message" : "custom-tcp has been deleted successful.",
"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/v4.0/zapi.cgi/stats
zcli statistics-system get
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 persentase sistem pada menit terakhir. |
| Last_5 | Jumlah | Muat persentase sistem lima menit yang lalu. |
| Last_15 | Jumlah | Muat persentase sistem 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 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/v4.0/zapi.cgi/stats/system/network
zcli statistic-network get
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 berikut:
| 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/v4.0/zapi.cgi/stats/system/network/interfaces
zcli statistics-network get
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 serta 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/v4.0/zapi.cgi/stats/system/memory
zcli statistics-system get -filter 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 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/v4.0/zapi.cgi/stats/system/load
zcli statistics-system get -filter 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 dalam lima menit terakhir. |
| Last_15 | Jumlah | Muat penggunaan sistem 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/v4.0/zapi.cgi/stats/system/cpu
zcli statistics-system get -filter 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/v4.0/zapi.cgi/stats/system/connections
zcli statistics-network-connections get
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. |
Tampilkan jumlah peternakan
Tampilkan jumlah peternakan
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/total
GET /stats/farms/total
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/v4.0/zapi.cgi/stats/farms
statistics-farm list
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 status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, tambak sudah habis dan semua backend tidak dapat dijangkau atau pemeliharaan; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; pemeliharaan, tambak naik dan ada backend dalam status naik, tetapi hampir sebuah backend dalam mode pemeliharaan; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| 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/v4.0/zapi.cgi/stats/farms/farmname
zcli statistic-farm list
GET /stats/farms/<farmname>
Menunjukkan status peternakan saat ini, status backend dan koneksi mereka. Setiap tambak akan merespons dengan objek yang berbeda, tergantung pada profil.
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"
"backend_ip" : "192.168.0.168"
"backend_port" : 80
"service" : "srv1",
"session" : "192.168.0.186",
"ttl" : "1m28s0ms"
}
],
"total_sessions" : 1
}
Parameter respons di ladang HTTP
| Bidang | Tipe | Deskripsi |
|---|---|---|
| backends | Obyek[] | Tampilkan informasi tentang backend. |
| sesi | Obyek[] | Tampilkan informasi tentang sesi. |
| total_sessions | Jumlah | Dari versi 4.0.2. Menampilkan jumlah total sesi yang terdaftar. |
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, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
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 pada jenis ketekunan. |
| Ttl | Tali | Dari versi 4.0.2. Waktu tersisa sampai sesi berakhir |
| backend_ip | Tali | Dari versi 4.0.2. Backend Ip ditugaskan ke klien. |
| backend_port | Tali | Dari versi 4.0.2. Port backend ditetapkan ke klien. |
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, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan layanan telah mendeteksi bahwa backend tidak berfungsi; tidak terdefinisi, status backend belum dicentang. |
Objek klien
| Bidang | Tipe | Deskripsi |
|---|---|---|
| edns_big | Jumlah | Respons yang lebih besar dari 512 byte. |
| edns_tc | Jumlah | Ukuran buffer DNS tambahan 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" : "down"
},
{
"established" : 1,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"client": 0,
"id" : 5,
"backend_ip" : "192.168.5.100",
"backend_port" : "8080",
"session" : "192.168.5.100",
"ttl" : "1m51s564ms",
"type" : "dynamic"
}
],
"total_sessions" : 1
}
Parameter respons di peternakan L4xNAT
Responsnya akan menjadi JSON dengan objek backends serta sesi:
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, tambak berjalan dan backend siap menerima koneksi; turun, tambak berjalan dan 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; tidak terdefinisi, status backend belum dicentang. |
Objek sesi:
| Bidang | Tipe | Deskripsi |
|---|---|---|
| klien | Jumlah | Pengidentifikasi sekuensial sesi. |
| id | Jumlah | Backend pengidentifikasi unik tempat klien ditugaskan. |
| Sidang | Tali | Sesi pengidentifikasi unik. Ini adalah IP klien. |
| mengetik | Tali | Nilainya adalah: statis atau dinamis. Statis jika sesi dibuat secara manual dan dinamis jika sesi dibuat secara otomatis. |
| Ttl | Tali | Dari versi 4.0.2. Waktu tersisa sampai sesi berakhir |
| backend_ip | Tali | Dari versi 4.0.2. Ip backend ditetapkan ke klien. |
| backend_port | Jumlah | Dari versi 4.0.2. Port backend ditetapkan ke klien. |
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/v4.0/zapi.cgi/stats/farms/modules
GET /stats/farms/modules
Dapatkan ringkasan modul statistik. Panggilan ini menunjukkan setiap status modul, jumlah yang dikonfigurasi, jumlah peternakan yang diletakkan dan naik.
Definisi modul ada di Pertanian bagian.
Contoh respons:
{
"description" : "Module status",
"params" : {
"dslb" : {
"critical" : 0,
"down" : 1,
"problem" : 0,
"total" : 2,
"up" : 1
},
"gslb" : {
"critical" : 0,
"down" : 0,
"problem" : 0,
"total" : 1,
"up" : 1
},
"lslb" : {
"critical" : 0,
"down" : 2,
"problem" : 0,
"total" : 4,
"up" : 2
}
}
}
Parameter respons
Respons akan menjadi JSON dengan tiga kunci: dslb, gslb serta lslb.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| kritis | Jumlah | Jumlah peternakan dalam status kritis. Kebun sangat penting ketika sudah habis dan semua backend tidak dapat dijangkau (down atau maintenance). |
| turun | Jumlah | Jumlah peternakan yang dihentikan. Peternakan dihentikan oleh administrator sistem. |
| masalah | Jumlah | Jumlah peternakan dalam status masalah. Kebun adalah masalah ketika sudah naik dan hampir backend dalam status down. |
| total | Jumlah | Jumlah total pertanian. |
| up | Jumlah | Jumlah peternakan yang beroperasi. Di sini ditampilkan pemeliharaan dan perlu memulai kembali status tambak. |
Tampilkan statistik modul
Tampilkan statistik modul
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/modules/lslb
GET /stats/farms/modules/<module>
Tampilkan statistik pertanian 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 status yang tersedia adalah: turun, tambak tidak berjalan; diperlukan restart, tambak sudah habis tetapi sedang menunggu tindakan mulai kembali; kritis, tambak sudah habis dan semua backend tidak dapat dijangkau atau pemeliharaan; masalah, tambak sudah habis dan ada beberapa backend tidak dapat dijangkau, tetapi hampir sebuah backend dalam status naik; pemeliharaan, tambak naik dan ada backend dalam status naik, tetapi hampir sebuah backend dalam mode pemeliharaan; up, pertanian sudah habis dan semua backend bekerja dengan sukses. |
| 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, RAM, semua antarmuka jaringan yang dikonfigurasi, penyimpanan beban dan hard disk.
Selain itu, Anda dapat mengakses riwayat mingguan, bulanan, 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/v4.0/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 serta sistem.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| peternakan | Tali[] | Daftar grafik tambak tersedia. |
| interface | Tali[] | Daftar grafik antarmuka 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/v4.0/zapi.cgi/graphs/farms/httpweb
Contoh permintaan untuk antarmuka:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3
Minta contoh untuk disk:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/system/disk/root/boot
GET /graphs/<graph>
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 yang digunakan untuk menghasilkan grafik. Nilai yang mungkin adalah: harian, mingguan, bulanan or tahunan. |
| grafik | Tali | Grafik dalam format base64. |
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/v4.0/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/v4.0/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/v4.0/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 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 base64. |
IPDS
Modul ini adalah implementasi dari suatu 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 dari sifat yang berbeda. Masing-masing menawarkan solusi untuk aktivitas 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, DoS, RBL or WAF.
Ambil paket IPDS
Ambil paket IPDS
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package
zcli ipds-package get
GET /ipds/package
Ambil informasi paket zevenet-ipds. Paket ini berisi aturan yang diperbarui untuk setiap modul IPDS.
Contoh respons:
{
"description" : "zevenet-ipds package status info",
"params" : {
"frequency" : 0,
"mode" : "disabled",
"ruleset_date" : "05-06-2019",
"scheduled" : "none",
"status" : "Updates available",
"time" : {
"hour" : 0,
"minute" : 0
}
}
}
Parameter respons
Respons akan berupa objek JSON dengan kunci yang disetel ke params, nilainya akan menjadi informasi dari paket IPDS.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| status | Tali | Menunjukkan informasi status pembaruan tentang paket IPDS. Jika paket diinstal, jika diperbarui dan jika ada pembaruan yang tertunda. |
| ruleset_date | Tali | Ini adalah tanggal ketika paket dibangun. Ini bukan tanggal yang diinstal. |
| dijadwalkan | Tali | Pesan deskriptif menjelaskan konfigurasi jadwal. |
| mode | Tali | Ini menunjukkan seberapa sering pembaruan akan terjadi atau untuk menonaktifkan jadwal. Nilai yang tersedia adalah: Harian Jadwalkan pembaruan yang akan dilakukan setiap hari, ini memungkinkan bidang Frekuensi untuk menunjukkan berapa jam pembaruan akan diulang, dari waktu yang ditetapkan; Mingguan, Jadwalkan pembaruan dilakukan seminggu sekali, ini memungkinkan frekuensi sebagai Hari dalam seminggu untuk menunjukkan hari mana dalam minggu yang akan dijadwalkan untuk pembaruan (dari Senin hingga Minggu); bulanan, jadwalkan pembaruan yang akan dilakukan sebulan sekali. |
| frekuensi | Jumlah | If mode setiap hari, frekuensi adalah jumlah jam antara pembaruan paket dari waktu; Jika mode adalah mingguan, nilai yang diharapkan adalah angka hari kerja (dari hari Senin, 1, hingga hari Minggu, 7); Jika mode adalah bulanan, nilai yang diharapkan adalah hari bulan nomor (dari 1 untuk 31). |
| waktu | obyek | Memungkinkan untuk mengatur kapan pembaruan akan terjadi atau dari mana paket akan diperbarui jika mode ditetapkan sebagai Harian dan Frekuensi lebih besar dari 0. |
Objek waktu:
Objek ini, jam: menit, adalah jam ketika paket akan diperbarui.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| jam | Jumlah | Apakah jam dalam format format 0 untuk 23. |
| menit | Jumlah | adalah menit dalam format format 0 untuk 59. |
Terapkan tindakan ke paket IPDS
Terapkan tindakan ke paket IPDS
Minta contoh untuk memperbarui aturan IPDS:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"action":"upgrade"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions
zcli ipds-package upgrade
Contoh respons:
{
"desc" : "Execute an action over the zevenet-ipds package",
"params" : {
"ruleset_date" : "07-06-2019",
"status" : "Installed and updated"
}
}
Contoh permintaan untuk pembaruan penjadwalan:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"mode":"daily","frequency":1,"time":{"hour":0,"minute":0},"action":"schedule"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions
Contoh respons:
{
"desc" : "Execute an action over the zevenet-ipds package",
"params" : {
"frequency" : 1,
"mode" : "daily",
"scheduled" : "daily from 0:00 to 23:00 each 1 hours",
"status" : "Installed and updated",
"time" : {
"hour" : 0,
"minute" : 0
}
}
}
POST /ipds/package
Terapkan tindakan tentang paket zevenet-ipds.
Parameter permintaan
| Bidang | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| tindakan | Tali | Ini adalah tindakan untuk diterapkan terkait paket aturan IPDS. Opsinya adalah: meningkatkan untuk memaksa peningkatan paket. menjadwalkan untuk mengkonfigurasi sistem, upgrade paket dengan periodisitas. | |
| mode | Tali | Ini menunjukkan seberapa sering pembaruan akan terjadi atau untuk menonaktifkan jadwal. Nilai yang tersedia adalah: Harian Jadwalkan pembaruan yang akan dilakukan setiap hari, ini memungkinkan bidang Frekuensi untuk menunjukkan berapa jam pembaruan akan diulang, dari waktu yang ditetapkan; Mingguan, Jadwalkan pembaruan dilakukan seminggu sekali, ini memungkinkan frekuensi sebagai Hari dalam seminggu untuk menunjukkan hari mana dalam minggu yang akan dijadwalkan untuk pembaruan (dari Senin hingga Minggu); bulanan, jadwalkan pembaruan yang akan dilakukan sebulan sekali. | |
| frekuensi | Jumlah | If mode setiap hari, frekuensi adalah jumlah jam di antara formulir pembaruan paket waktu; Jika mode adalah mingguan, nilai yang diharapkan adalah angka hari kerja (dari hari Senin, 1, hingga hari Minggu, 7); Jika mode adalah bulanan, nilai yang diharapkan adalah hari bulan nomor (dari 1 untuk 31). | |
| waktu | obyek | Memungkinkan untuk mengatur kapan pembaruan akan terjadi atau dari mana paket akan diperbarui jika mode ditetapkan sebagai Harian dan Frekuensi lebih besar dari 0. |
Objek waktu:
Objek ini, jam: menit, adalah jam ketika paket akan diperbarui.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| jam | Jumlah | Apakah jam dalam format format 0 untuk 23. |
| menit | Jumlah | adalah menit dalam format format 0 untuk 59. |
Parameter respons
Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi informasi tentang paket IPDS.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| status | Tali | Menunjukkan informasi status pembaruan tentang paket IPDS. Jika paket diinstal, jika diperbarui dan jika ada pembaruan yang tertunda. |
| ruleset_date | Tali | Ini adalah tanggal ketika paket dibangun. Ini bukan tanggal yang diinstal. |
| dijadwalkan | Tali | Pesan deskriptif menjelaskan konfigurasi jadwal. |
| mode | Tali | Ini menunjukkan seberapa sering pembaruan akan terjadi atau untuk menonaktifkan jadwal. Nilai yang tersedia adalah: Harian Jadwalkan pembaruan yang akan dilakukan setiap hari, ini memungkinkan bidang Frekuensi untuk menunjukkan berapa jam pembaruan akan diulang, dari waktu yang ditetapkan; Mingguan, Jadwalkan pembaruan dilakukan seminggu sekali, ini memungkinkan frekuensi sebagai Hari dalam seminggu untuk menunjukkan hari mana dalam minggu yang akan dijadwalkan untuk pembaruan (dari Senin hingga Minggu); bulanan, jadwalkan pembaruan yang akan dilakukan sebulan sekali. |
| frekuensi | Jumlah | If mode setiap hari, frekuensi adalah jumlah jam antara pembaruan paket dari waktu; Jika mode adalah mingguan, nilai yang diharapkan adalah angka hari kerja (dari hari Senin, 1, hingga hari Minggu, 7); Jika mode adalah bulanan, nilai yang diharapkan adalah hari bulan nomor (dari 1 untuk 31). |
| waktu | obyek | Memungkinkan untuk mengatur kapan pembaruan akan terjadi atau dari mana paket akan diperbarui jika mode ditetapkan sebagai Harian dan Frekuensi lebih besar dari 0. |
Objek waktu:
Objek ini, jam: menit, adalah jam ketika paket akan diperbarui.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| jam | Jumlah | Apakah jam dalam format format 0 untuk 23. |
| menit | Jumlah | adalah menit dalam format format 0 untuk 59. |
Daftar semua aturan IPDS
Daftar aturan ipds
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds
zcli ipds list
GET /ipds
Daftar semua aturan IPDS yang ada di sistem.
Contoh respons:
{
"description" : "List the available IPDS rules.",
"params" : [
{
"name" : "dosrst",
"rule" : "dos",
"type" : "farm"
},
{
"name" : "ssh_brute_force",
"rule" : "dos",
"type" : "system"
},
{
"name" : "geo_IL_israel",
"rule" : "blacklist"
},
{
"name" : "geo_ME_montenegro",
"rule" : "blacklist"
},
{
"name" : "sip",
"rule" : "rbl"
},
{
"name" : "ssh",
"rule" : "rbl"
}
]
}
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 |
|---|---|---|
| nama | Tali | Nama aturan IPDS. Ini digunakan sebagai pengidentifikasi unik. |
| memerintah | Tali | Ini adalah sifat dari aturan IPDS. Itu bisa saja blacklist, dos or rbl. |
| mengetik | Tali | Bidang ini muncul dalam aturan dos dan menentukan apakah aturannya sistem, itu berlaku untuk penyeimbang; atau kebun, aturan berlaku untuk sebuah peternakan. |
IPDS - Daftar Hitam
Daftar hitam memungkinkan pengguna menggunakan daftar untuk memfilter atau mengizinkan lalu lintas sesuai dengan IP sumber (Lalu lintas masuk).
Ada dua jenis daftar:
- Remote: Daftar diperoleh dari URL, daftar itu tidak dapat dimodifikasi dan dapat dijadwalkan untuk diunduh.
- Lokal: Pengguna dapat membuat daftar mereka dengan kebijakan yang diberikan, menyangkal jika IP yang masuk cocok maka lalu lintas akan ditolak atau mengizinkan jika IP yang masuk cocok maka lalu lintas akan diizinkan.
Modul ini termasuk sudah dimuat daftar yang disediakan oleh tim Zevenet, daftar siap diterapkan ke peternakan. Selain itu, pengguna dapat membuat daftar pribadi mereka.
Beberapa daftar dapat diterapkan ke tambak yang sama jika sumber IP cocok dengan beberapa daftar lalu lintas akan diizinkan atau ditolak tergantung pada kebijakan daftar hitam. Saat ini IP cocok maka tidak ada lagi pemeriksaan daftar hitam yang dilakukan untuk IP sumber.
Jika IP sumber ada dalam dua daftar yang berbeda, satu dari jenis menyangkal dan jenis lainnya mengizinkan, maka selalu kebijakan izin dievaluasi terlebih dahulu.
Daftar semua aturan daftar hitam
Daftar semua daftar hitam
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
zcli ipds-blacklist list
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",
"status" : "down",
"type" : "local"
},
{
"farms" : [],
"name" : "russia",
"policy" : "deny",
"preload" : "true",
"status" : "down",
"type" : "local"
},
{
"farms" : [],
"name" : "northkorea",
"policy" : "deny",
"preload" : "true",
"status" : "down",
"type" : "local"
},
{
"farms" : [
"FarmHttp1",
"FarmGslb1",
],
"name" : "remoteList",
"policy" : "deny",
"preload" : "false",
"status" : "up",
"type" : "remote"
},
{
"farms" : [],
"name" : "myWhiteList",
"policy" : "allow",
"preload" : "false",
"status" : "down",
"type" : "local"
},
]
}
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. |
| status | Tali | Nilai yang mungkin adalah: up, daftar hitam diaktifkan dan memblokir (atau mengizinkan) lalu lintas sumber membentuk daftar; atau turun, sebenarnya aturannya tidak berjalan dan tidak menyaring lalu lintas. |
| 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/loc
zcli ipds-blacklist get 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"
}
],
"status" : "up",
"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 administrator sistem. |
| status | Tali | Nilai yang mungkin adalah: up, daftar hitam diaktifkan dan memblokir (atau mengizinkan) lalu lintas sumber membentuk daftar; atau turun, sebenarnya aturannya tidak berjalan dan tidak menyaring lalu lintas. |
| mengetik | Tali | Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan di 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
},
"status" : "up",
"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 administrator sistem. |
| mengetik | Tali | Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan di sistem dan dikelola oleh administrator sistem; atau terpencil, daftar diunduh dari jarak jauh url. |
| sumber | Obyek[] | Sumber IP yang dicek daftar. Jika daftar adalah tipe 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 jaringan / bitmask atau IP per baris. |
| 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 frekuensi Nilai adalah mingguan or bulanan. Jika frekuensi is mingguan parameter ini harus menjadi hari dalam seminggu (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 serta 31). |
| waktu | obyek | Ini adalah struct yang bergantung pada bidang frekuensi. |
| status | Tali | Nilai yang mungkin adalah: up, daftar hitam diaktifkan dan memblokir (atau mengizinkan) lalu lintas sumber membentuk daftar; atau turun, sebenarnya aturannya tidak berjalan dan tidak menyaring lalu lintas. |
Objek waktu untuk frekuensi harian dan frequency_type periode
| Bidang | Tipe | Deskripsi |
|---|---|---|
| periode | Jumlah | Seberapa sering daftar diperbarui. |
| unit | 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 serta 23. |
| menit | Jumlah | Beberapa menit untuk memperbarui daftar. Nilai harus berupa angka di antara 0 serta 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
ipds-blacklist create -name newListLoc -type local -policy allow
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://<zevenet_server>:444/zapi/v4.0/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 tersebut. | 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 tersebut. |
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/whiteList
zcli ipds-blacklist set whiteList -policy allow
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 dapat 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 hanya sumber, lihat bagian dokumentasi IPDS> Daftar Hitam> Ubah sumber daftar hitam. Sumber saja dapat 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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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 periode, 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 menjadi hari kerja (Senin, Selasa, Rabu, Kamis, Jumat, Sabtu or Minggu) kalau tidak frekuensi adalah bulanan maka parameter ini harus satu bulan hari (angka di antara 1 serta 31). |
| waktu | obyek | Ini adalah struct yang bergantung pada bidang frekuensi. |
Objek periode waktu
Ini adalah bidang ketika suatu periode 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 serta jenis frekuensi is tepat.
frekuensi bidang memiliki nilai mingguan serta hari adalah hari kerja ketika daftar diperbarui.
frekuensi bidang memiliki nilai bulanan serta hari adalah jumlah hari bulan ketika daftar diperbarui.
| Bidang | Tipe | Deskripsi |
|---|---|---|
| jam | Jumlah | Jam untuk memperbarui daftar. Nilai harus berupa angka di antara 0 serta 23. |
| menit | Jumlah | Beberapa menit untuk memperbarui daftar. Nilai harus berupa angka di antara 0 serta 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
Responsnya akan menjadi JSON dengan semua konfigurasi daftar. Lihat contoh respons untuk informasi lebih lanjut.
Hapus aturan daftar hitam
Hapus daftar blacklist
Contoh permintaan:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/remoteList
zcli ipds-blacklist delete 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 daftar hitam
Daftar sumber dari daftar hitam
Contoh permintaan:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist get 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist-source add<