Referensi Zevenet API v3.2

ZAPI (Zevenet Application Programming Interface) adalah alat bagi administrator sistem untuk mengendalikan penyeimbang beban Zevenet.

Sangat penting untuk mengaktifkan pengguna zapi dari antarmuka web sebelum menggunakannya, Sistem / Pengguna.

Setelah pengguna zapi dibuat, dimungkinkan mengirimkan permintaan ke URL, https: // (zevenet_server): 444 / zapi / v3.2 / zapi.cgi / (URI_path), di mana zevenet_server adalah IP tempat layanan HTTP mendengarkan.

URI_path mendefinisikan objek atau tindakan untuk bertindak. Perilaku dan parameternya akan ditentukan dalam setiap bagian dokumentasi.

Kata kerja yang digunakan dalam API ini adalah DAPATKAN, POST, PUT or DELETE. Permintaan PUT atau POST selalu membutuhkan hampir satu parameter meskipun ini tidak memerlukan parameter yang diperlukan.

sertifikat

Zevenet mendukung sertifikat dalam format PEM untuk menggunakannya dengan HTTP farms Anda dengan pendengar HTTPS. Jika Anda ingin mempelajari lebih lanjut tentang cara membuat sertifikat pem, silakan kunjungi artikel berikut: Hasilkan SERTIFIKAT DALAM FORMAT PEM

Daftar semua Sertifikat

Daftar semua Sertifikat

Contoh permintaan:

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

GET /certificates

Sebutkan semua sertifikat CSR dan PEM di toko sertifikat, sertifikat itu dapat digunakan dengan kebun HTTPS.

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek sertifikat, yang masing-masing berisi atribut kunci di bawah ini.

Contoh respons:

{
   "description" : "List all certificates",
   "params" : [
      {
         "CN" : "Zen Load Balancer",
         "creation" : "Jan 12 14:49:03 2011 GMT",
         "expiration" : "Jan  9 14:49:03 2021 GMT",
         "file" : "zencert.pem",
         "issuer" : "Zen Load Balancer",
         "type" : "Certificate"
      }
   ]
}

Parameter respons

Bidang	Tipe	Deskripsi
params	Obyek []	Daftar objek sertifikat.

Objek Sertifikat

Bidang	Tipe	Deskripsi
CN	Tali	Nama umum domain.
penciptaan	Tali	Tanggal pembuatan.
kedaluwarsa	Tali	Tanggal kadaluarsa.
fillet	Tali	Nama file sertifikat, ID unik.
penerbit	Tali	Otoritas Bersertifikat menandatangani sertifikat.
mengetik	Tali	CSR atau Sertifikat.

Unduh Sertifikat

Unduh Sertifikat

Contoh permintaan:

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

GET /certificates/<file>

Unduh sertifikat yang dipasang di toko sertifikat, gunakan nama file dalam permintaan untuk mengidentifikasinya.

Respons akan mencakup tajuk yang ditunjukkan di bawah ini dengan informasi tentang file. Tubuh respons akan menjadi konten file.

Header respons:

HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359

Tampilkan detail Sertifikat

Tampilkan detail Sertifikat

Contoh permintaan:

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

GET /certificates/<file>/info

Tampilkan semua informasi yang termasuk dalam sertifikat yang diberikan di toko sertifikat, termasuk tanda tangan, diperlukan nama file untuk membuat referensi.

Contoh respons:

Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number: 14346016480403539444 (0xc71749fb005a45f4)
    Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Validity
            Not Before: Jan 12 14:49:03 2011 GMT
            Not After : Jan  9 14:49:03 2021 GMT
        Subject: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (1024 bit)
                Modulus:
...

Tampilkan detail Sertifikat aktivasi

Tampilkan detail Sertifikat aktivasi

Contoh permintaan:

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

GET /certificates/activation

Tampilkan semua informasi yang termasuk dalam sertifikat aktivasi, termasuk tanda tangan, sertifikat ini disimpan di toko sertifikat. Jika sertifikat aktivasi dihapus maka produk akan dinonaktifkan.

Hapus Sertifikat

Hapus Sertifikat

Contoh permintaan:

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

DELETE /certificates/<file>

Hapus sertifikat dengan nama file di toko sertifikat.

Contoh respons:

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

Hapus Sertifikat aktivasi

Hapus Sertifikat aktivasi

Contoh permintaan:

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

DELETE /certificates/activation

Hapus sertifikat aktivasi yang dipasang di toko sertifikat. Jika sertifikat ini dihapus maka Load Balancer dinonaktifkan.

Contoh respons:

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

Buat sertifikat CSR

Buat sertifikat CSR

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates

POST /certificates

Buat Permintaan Penandatanganan Sertifikat (file CSR).

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama ID sertifikat.	benar
fqdn	Tali	Nama domain yang sepenuhnya memenuhi syarat dari server Anda.	benar
divisi	Tali	Divisi organisasi Anda yang menangani sertifikat.	benar
organisasi	Tali	Nama resmi organisasi Anda.	benar
lokalitas	Tali	Kota tempat organisasi Anda berada.	benar
negara	Tali	Negara bagian / wilayah tempat organisasi Anda berada.	benar
negara	Tali	Kode ISO dua huruf untuk negara tempat organisasi Anda berada.	benar
surat	Tali	Alamat email yang digunakan untuk menghubungi organisasi Anda.	benar

Contoh respons:

{
   "description" : "Create CSR",
   "message" : "Certificate NewCSR created",
   "success" : "true"
}

Unggah Sertifikat

Unggah Sertifikat

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/certificates/example.pem

POST /certificates/<file>

Unggah sertifikat PEM untuk pertanian HTTP dengan pendengar HTTPS.

Membutuhkan parameter --tcp-nodelay, dan --data-binary untuk mengunggah file dalam mode biner.

Minta parameter URI

Bidang	Tipe	Deskripsi	Wajib
fillet	Tali	Nama file sertifikat untuk diunggah dan disimpan di toko sertifikat.	benar

Contoh respons:

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

Unggah Sertifikat aktivasi

Unggah Sertifikat aktivasi

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/path/to/example.pem
https://<zevenet_server>:444/zapi/v3.2/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"
}

Daftar Ciphers

Daftar Ciphers

Contoh permintaan:

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

GET /ciphers

Buat daftar cipher yang tersedia yang dapat digunakan tambak HTTPS.

The Pembongkaran SSL chiper hanya akan tersedia jika didukung oleh prosesor.

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek sertifikat, yang masing-masing berisi atribut kunci di bawah ini.

Contoh respons:

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

Pertanian

Zevenet dapat mengatur lalu lintas dengan tiga cara yang berbeda, masing-masing cara dikelola oleh modul yang berbeda, penyeimbang beban layanan lokal atau modul LSLB, modul Global Service Load Balancer atau GSLB dan modul Datalink Service Load Balancer atau modul DSLB.

Semua modul bekerja dengan konsep Profil tambak, profil tambak adalah sekelompok parameter yang siap untuk melakukan tindakan khusus dengan lalu lintas jaringan, penting untuk memahami apa yang dapat dilakukan setiap profil tambak untuk mendapatkan hasil terbaik dari Zevenet ADC.

• LSLB: Modul ini dapat bekerja dengan http 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 semua peternakan

Daftar semua peternakan

Contoh permintaan:

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

GET /farms

Daftar semua peternakan yang tersedia

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek resume pertanian, yang masing-masing berisi atribut kunci di bawah ini.

Obyek Pertanian

Bidang	Tipe	Deskripsi
nama pertanian	Tali	Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik.
profil	Tali	Jenis profil, nilai-nilai profil yang tersedia adalah: http, https or l4xnat untuk modul LSLB, gslb untuk modul GLSB dan datalink untuk modul DSLB
status	Tali	Status 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 peternakan menerima lalu lintas
olahraga	Tali	Port Virtual tempat tambak menerima lalu lintas, nilai port yang tersedia adalah: nomor port untuk profil http [s], l4xnat dan gslb, sekelompok port yang dipisahkan oleh "," atau rentang port yang dipisahkan oleh ":" untuk profil l4xnat, di l4xnat kedua nilai pemisah ("," dan ":") dapat digunakan di bidang yang sama.

Contoh respons:

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

Hapus sebuah Peternakan

Hapus sebuah Peternakan

Contoh permintaan:

curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP

DELETE /farms/<farmname>

Hapus sebuah peternakan melalui pengidentifikasi nama peternakannya.

Contoh respons:

{
  "description" : "Delete farm FarmHTTP",
  "message" : "The Farm FarmHTTP has been deleted.",
  "success" : "true"
}

Tetapkan tindakan di Peternakan

Tetapkan tindakan di Peternakan

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmTCP/actions

PUT /farms/<farmname>/actions

Terapkan tindakan ke tambak, lihat tabel Parameter permintaan untuk tindakan.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Atur aksi yang diinginkan. Tindakannya adalah: berhenti, pertanian akan dihentikan. awal, pertanian akan dimulai dan Restart, tambak akan dihentikan dan mulai secara otomatis.

Contoh respons:

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

Parameter respons

Jika tidak ada masalah dalam konfigurasi maka zapi akan mengembalikan tindakan yang diminta.

Pertanian HTTP

Profil HTTP adalah penyeimbangan beban lapisan 7 tingkat lanjut (atau Pengendali Pengiriman Aplikasi) dengan properti khusus proxy. Profil ini menawarkan beberapa fitur seperti HTTPS layer 7 load balancing yang dikombinasikan dengan akselerasi offload SSL. Profil ini disarankan untuk layanan web (termasuk server aplikasi web) dan semua protokol aplikasi berdasarkan protokol HTTP dan HTTPS seperti WebDav, RDP melalui HTTP, ICA melalui HTTP, dll. Untuk mengonfigurasi profil tambak ini, alamat IP virtual, dan port TCP virtual akan diperlukan.

Ambil pertanian dengan nama

Ambil pertanian dengan nama

Contoh permintaan:

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

GET /farms/<farmname>

Tampilkan semua konfigurasi tentang tambak yang diberikan.

Contoh respons:

{
   "description" : "List farm httpFarm",
   "ipds" : {
      "blacklists" : [
         {
            "name" : "men",
            "status" : "down"
         }
      ],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "addheader" : [
         {
            "header" : "load-balancer: true",
            "id" : 0
         }
      ],
      "certlist" : [
         {
            "file" : "zencert.pem",
            "id" : 1
         }
      ],
      "cipherc" : "ALL",
      "ciphers" : "all",
      "contimeout" : 20,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "error414" : "Request URI is too long.",
      "error500" : "An internal server error occurred. Please try again later.",
      "error501" : "This method may not be used.",
      "error503" : "The service is not available. Please try again later.",
      "headremove" : [
         {
            "id" : 0,
            "pattern" : "^client"
         }
      ],
      "httpverb" : "MSRPCext",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "false",
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : "check_tcp",
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "redirect" : "http://192.168.101.254/index.html",
         "redirect_code" : 302,
         "redirecttype" : "default",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
      {
         "backends" : [
            {
               "alias" : "http-server",
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null
            }
         ],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : null,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
   ]
}

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.

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 backend.
daftar sertifikat	Obyek[]	Hanya di profil https. Daftar sertifikat diaktifkan di tambak, dalam format pem, diizinkan untuk menambahkan lebih dari satu sertifikat pem ke tambak yang sama untuk dukungan SNI. diperlukan pendengar dengan nilai https. Sertifikat apa pun di toko sertifikat dapat digunakan di sini.
sandi	Tali	Hanya di pendengar https. Ini adalah daftar sandi yang diizinkan yang disesuaikan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti dalam sandi OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai keamanan sutom.
cipher	Tali	Hanya di pendengar dengan nilai https. Digunakan untuk membuat daftar sandi yang diterima oleh koneksi SSL untuk mengeraskan koneksi SSL. Opsinya adalah: semua, semua 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.
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 objek dengan pola untuk menghapus header dari permintaan klien.
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 ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, LAPORAN, MSextWebDAV menerima permintaan http sebelumnya plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahwa nilai-nilai tersebut peka terhadap huruf besar-kecil.
Abaikan_100_lanjutkan	Tali	Jika bidang ini memiliki nilai benar itu 100 melanjutkan Heade 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.
reqtimeout	Jumlah	Berapa lama kebun akan menunggu permintaan klien dalam hitungan detik.
istirahat	Jumlah	Berapa lama peternakan akan menunggu jawaban dari backend dalam hitungan detik.
kebangkitan kembali	Jumlah	Periode untuk keluar dari server nyata yang jatuh, setelah periode ini penyeimbang beban memeriksa apakah server sebenarnya masih hidup, dalam hitungan detik.
penempatan ulang	Tali	Jika diaktifkan, tambak dipaksa untuk mengubah Lokasi: dan konten-lokasi: header dalam menanggapi klien dengan host virtual. Opsinya adalah: diaktifkan, diaktifkan cacat, tidak aktif atau diaktifkan-backend hanya alamat backend yang dibandingkan.
status	Tali	Status pertanian. Nilai 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, 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 server backend yang ditentukan dalam layanan saat ini menggunakan bahasa HTTPS dan kemudian data akan dienkripsi sebelum dikirim. benar, profil mengirimkan lalu lintas dalam protokol HTTPS ke backends, palsu, profil mengirimkan lalu lintas dalam protokol HTTP ke backends.
id	Tali	Nama layanan, tidak dapat diubah setelah layanan dibuat.
setidaknya respons	Tali	Ini memungkinkan metode balancing yang paling tidak berespon. benar seringnya profil memeriksa backend mana yang mengambil lebih sedikit waktu untuk merespons untuk mengirim lebih banyak koneksi ke yang ini, palsu profile tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons.
ketekunan	Tali	Parameter ini menentukan bagaimana layanan HTTP akan mengelola sesi klien. Opsinya adalah: "" string kosong, tidak ada tindakan yang diambil, IP sesi ketekunan dilakukan di dasar IP klien, DASAR sesi ketekunan dilakukan di dasar header BASIC, URL sesi ketekunan dilakukan di dasar bidang di URI, PARM sesi ketekunan dilakukan berdasarkan nilai pada akhir URI, COOKIE sesi ketekunan dilakukan berdasarkan nama cookie, cookie ini harus dibuat oleh backend, dan HEADER, sesi ketekunan dilakukan berdasarkan nama Header.
redirect	Tali	Berperilaku sebagai backend khusus, karena permintaan klien dijawab dengan mengarahkan ulang ke URL baru secara otomatis. Jika redirect dikonfigurasi maka permintaan tidak akan diteruskan ke backend, sebaliknya Redirect akan ditanggapi ke klien.
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 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.
Ttl	Jumlah	Hanya dengan kegigihan. Nilai ini menunjukkan waktu hidup maksimum untuk sesi klien tidak aktif (usia sesi maks) dalam detik.
urlp	Tali	Memungkinkan untuk menentukan layanan web mengenai URL yang diminta klien melalui pola URL tertentu yang akan diperiksa secara sintaksis. Ekspresi reguler PCRE didukung.
vhost	Tali	Ini menentukan kondisi yang ditentukan oleh nama domain melalui IP virtual dan port yang sama yang ditentukan oleh HTTP farm. Ekspresi reguler PCRE didukung.

Objek backend untuk pertanian HTTP:

Bidang	Tipe	Deskripsi
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 batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik. Jika sistem nol akan menggunakan batas waktu parameter global Backends.
berat	Jumlah	Ini adalah nilai bobot untuk server nyata saat ini, backend dengan nilai bobot lebih tinggi akan menerima lebih banyak koneksi. Nilai default null, bukan bobot khusus yang digunakan untuk backend ini. Nilai yang mungkin berasal dari 1 untuk 9.

Buat Pertanian baru

Buat Pertanian baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"newHTTPfarm", "profile":"http", "vip":"192.168.100.23",
"vport":80}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms

POST /farms

Buat ladang HTTP baru.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama pertanian	Tali	Nama deskriptif pertanian. Ini digunakan sebagai pengidentifikasi unik.	benar
profil	Tali	Profil Peternakan yang dibuat. Untuk peternakan http adalah http.	benar
vip	Tali	IP pertanian, tempat layanan virtual akan dijalankan. IP yang ditunjukkan harus dikonfigurasikan dalam sistem dan UP	benar
olahraga	Jumlah	Port of the farm, tempat layanan virtual akan mendengarkan. Port virtual dan IP virtual yang sama tidak boleh digunakan oleh farm lain.	benar

Contoh respons:

{
   "description" : "Creating farm 'newHTTPfarm'",
   "params" : {
      "interface" : "eth0.2",
      "farmname" : "newHTTPfarm",
      "profile" : "http",
      "vip" : "192.168.100.23",
      "vport" : 80
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Pertanian

Ubah Pertanian

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP

PUT /farms/<farmname>

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 ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, LAPORAN, MSextWebDAV menerima permintaan http sebelumnya plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahwa nilai-nilai tersebut peka terhadap huruf besar-kecil.
Abaikan_100_lanjutkan	Tali	Jika bidang ini memiliki nilai benar itu 100 melanjutkan Heade HTTP akan diabaikan; jika nilainya palsu, yang 100 melanjutkan header akan diproses.
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 sandi yang diizinkan yang disesuaikan yang akan diterima oleh koneksi SSL, yang merupakan string dalam format yang sama seperti dalam sandi OpenSSL. Atribut ini hanya digunakan saat cipher bidang memiliki nilai keamanan sutom.
newfarmname	Tali	Nama Peternakan baru. Pertanian harus dihentikan.
olahraga	Jumlah	Port of the farm, tempat layanan virtual mendengarkan.
vip	Tali	IP dari farm, di mana layanan virtual mendengarkan, IP ini harus dikonfigurasi dan di sistem.

Contoh respons:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
      "ciphers" : "customsecurity",
      "contimeout" : 22,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "error414" : "Message error 414",
      "error500" : "Message error 500",
      "error501" : "Message error 501",
      "error503" : "Message error 503",
      "httpverb" : "standardHTTP",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "true",
      "newfarmname" : "FarmHTTP",
      "reqtimeout" : 32,
      "restimeout" : 47,
      "resurrectime" : 12,
      "rewritelocation" : "enabled",
      "vip" : "178.62.126.152",
      "vport" : 88
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tambahkan arahan addheader

Tambahkan arahan addheader

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/v3.2/zapi.cgi/farms/MyHttpFarm/addheader

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

Hapus arahan addheader

Hapus arahan addheader

Contoh permintaan:

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

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

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 direktif headremove

Tambahkan direktif headremove

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/v3.2/zapi.cgi/farms/MyHttpFarm/headremove

POST /farms/<farmname>/headremove

Hapus tajuk tertentu dari permintaan yang masuk. Semua kejadian dari header yang ditentukan yang cocok 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"
}

Hapus perintah headremove

Hapus perintah headremove

Contoh permintaan:

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

DELETE /farms/<farmname>/headremove/<index>

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 Sertifikat

Tambahkan Sertifikat

Contoh permintaan:

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

POST /farms/<farmname>/certificates

Sertakan Sertifikat PEM yang tersedia ke daftar SNI atau certlist array dari HTTP farm dengan pendengar HTTPS. Sertifikat yang digunakan harus sudah diunggah dalam sistem, lihat Sertifikat> Daftar semua Sertifikat untuk daftar sertifikat yang tersedia.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
fillet	Tali	nama file sertifikat, sebelumnya sertifikat harus diunggah dalam sistem.	benar

Contoh respons:

{
   "description" : "Add certificate",
   "message" : "The certificate example.pem has been added to the SNI list of farm httpFarm, you need restart the farm to apply",
   "success" : "true",
   "status": "needed restart"
}

Hapus Sertifikat

Hapus Sertifikat

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/MyHttpFarm/certificates/example.pem

DELETE /farms/<farmname>/certificates/<file>

Hapus sertifikat dengan nama file yang dipilih dari daftar sertifikat di HTTP farm dengan pendengar HTTPS. Sertifikat tidak akan dihapus dari toko sertifikat.

Contoh respons:

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

Tambahkan aturan IPDS

Tambahkan aturan IPDS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpFarm/ipds/blacklists

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 httpFarm.",
   "success" : "true"
}

Hapus aturan IPDS

Hapus aturan IPDS

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpFarm/ipds/blacklists/china

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

Hapus aturan blacklist, DoS atau RBL dari farm yang diberikan menggunakan idenficatornya nama.

Contoh respons:

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm httpFarm.",
   "success" : "true"
}

HTTP - Layanan

Layanan dalam tambak profil HTTP menyediakan metode alih konten untuk memberikan beberapa layanan web dengan properti berbeda, backend, atau bahkan metode kegigihan, melalui beberapa kondisi deterministik yang digunakan oleh inti tambak untuk mencocokkan layanan yang benar untuk setiap permintaan klien. Definisi layanan ini akan digunakan oleh tambak untuk menentukan server backend yang dapat memberikan respons kepada klien.

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/v3.2/zapi.cgi/farms/cookiefarm/services/serv

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
         },
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null
         }
      ],
      "cookiedomain" : "zevenet.cpm",
      "cookieinsert" : "true",
      "cookiename" : "peasocookie",
      "cookiepath" : "/patfh",
      "cookiettl" : 20,
      "farmguardian" : "check_tcp-cut_conns",
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirect_code" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "sts_status" : "false",
      "sts_timeout" : 0,
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : ""
   }
}

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 server backend yang ditentukan dalam layanan saat ini menggunakan bahasa HTTPS dan kemudian data akan dienkripsi sebelum dikirim. benar, profil mengirimkan lalu lintas dalam protokol HTTPS ke backends, palsu, profil mengirimkan lalu lintas dalam protokol HTTP ke backends.
id	Tali	Nama layanan, tidak dapat diubah setelah layanan dibuat.
setidaknya respons	Tali	Ini memungkinkan metode balancing yang paling tidak berespon. benar seringnya profil memeriksa backend mana yang mengambil lebih sedikit waktu untuk merespons untuk mengirim lebih banyak koneksi ke yang ini, palsu profile tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons.
ketekunan	Tali	Parameter ini menentukan bagaimana layanan HTTP akan mengelola sesi klien. Opsinya adalah: "" string kosong, tidak ada tindakan yang diambil, IP sesi ketekunan dilakukan di dasar IP klien, DASAR sesi ketekunan dilakukan di dasar header BASIC, URL sesi ketekunan dilakukan di dasar bidang di URI, PARM sesi ketekunan dilakukan berdasarkan nilai pada akhir URI, COOKIE sesi ketekunan dilakukan berdasarkan nama cookie, cookie ini harus dibuat oleh backend, dan HEADER, sesi ketekunan dilakukan berdasarkan nama Header.
redirect	Tali	Berperilaku sebagai backend khusus, karena permintaan klien dijawab dengan mengarahkan ulang ke URL baru secara otomatis. Jika redirect dikonfigurasi maka permintaan tidak akan diteruskan ke backend, sebaliknya Redirect akan ditanggapi ke klien.
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 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.
Ttl	Jumlah	Hanya dengan kegigihan. Nilai ini menunjukkan waktu hidup maksimum untuk sesi klien tidak aktif (usia sesi maks) dalam detik.
urlp	Tali	Memungkinkan untuk menentukan layanan web mengenai URL yang diminta klien melalui pola URL tertentu yang akan diperiksa secara sintaksis. Ekspresi reguler PCRE didukung.
vhost	Tali	Ini menentukan kondisi yang ditentukan oleh nama domain melalui IP virtual dan port yang sama yang ditentukan oleh HTTP farm. Ekspresi reguler PCRE didukung.

Objek backend untuk pertanian HTTP:

Bidang	Tipe	Deskripsi
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 batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik. Jika sistem nol akan menggunakan batas waktu parameter global Backends.
berat	Jumlah	Ini adalah nilai bobot untuk server nyata saat ini, backend dengan nilai bobot lebih tinggi akan menerima lebih banyak koneksi. Nilai default null, bukan bobot khusus yang digunakan untuk backend ini. Nilai yang mungkin berasal dari 1 untuk 9.

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/v3.2/zapi.cgi/farms/FarmHTTP/services

POST /farms/<farmname>/services

Buat layanan di Farm profil HTTP yang diberikan. Kebun membutuhkan tindakan mulai ulang untuk menerapkan perubahan ini.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
id	Tali	Nama layanan yang digunakan sebagai pengidentifikasi unik. Hanya nilai alfanumerik yang diizinkan.	benar

Contoh respons:

{
   "description" : "New service newserv",
   "params" : {
      "id" : "newserv"
   },
   "status" : "needed restart"
}

Ubah Layanan

Ubah Layanan

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL", "redirect_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/services/sev2

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

Ubah parameter layanan dalam profil HTTP. id adalah pengidentifikasi unik layanan yang akan dimodifikasi.

Parameter permintaan

Bidang	Tipe	Deskripsi
vhost	Tali	Menentukan kondisi yang ditentukan oleh nama domain melalui IP dan port virtual yang sama yang ditentukan oleh farm profil HTTP. Ekspresi reguler PCRE didukung.
urlp	Tali	Memungkinkan untuk menentukan layanan web mengenai URL yang diminta klien melalui pola URL tertentu yang akan diperiksa secara sintaksis. Ekspresi reguler PCRE didukung.
redirect	Tali	Ini berfungsi sebagai backend khusus, permintaan klien dijawab dengan mengarahkan ulang ke URL baru secara otomatis.
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 balancing yang paling tidak berespon. benar, sering kali profil memeriksa backend yang membutuhkan waktu lebih sedikit untuk merespons agar dapat mengirim lebih banyak koneksi ke ini, palsu, profil tidak memeriksa backend mana yang membutuhkan waktu lebih sedikit untuk merespons.
httpsb	Tali	Ini menunjukkan kepada farm bahwa server backend yang didefinisikan dalam layanan saat ini menggunakan bahasa HTTPS dan kemudian data akan dienkripsi sebelum dikirim. benar, profil mengirimkan lalu lintas dalam protokol HTTPS ke backends, palsu, profil mengirimkan lalu lintas dalam protokol HTTP ke backends.

Contoh respons:

{
   "description" : "Modify service newsrv in farm newHTTPfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "backends" : [],
      "cookiedomain" : "",
      "cookieinsert" : "false",
      "cookiename" : "",
      "cookiepath" : "",
      "cookiettl" : 0,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirect_code" : 302,
      "redirecttype" : "default",
      "sessionid" : "sid",
      "sts_status" : "true",
      "sts_timeout" : 21600000,
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com"
   },
   "status" : "needed restart"
}

Parameter Respon

Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.

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/v3.2/zapi.cgi/farms/FarmHTTP/services/service1/fg

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/v3.2/zapi.cgi/farms/FarmHTTP/service/service1/fg/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/v3.2/zapi.cgi/farms/FarmHTTP/services/service1/actions

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

Tindakan ini memindahkan layanan yang diberikan Naik atau Turun dalam Daftar Layanan, opsi ini berguna jika diperlukan untuk mengubah urutan prioritas, perhatikan bahwa layanan dievaluasi dalam urutan yang sama yang ditampilkan. tindakan ini memulai kembali pertanian secara otomatis.

id adalah pengidentifikasi unik layanan yang akan dimodifikasi.

Parameter Permintaan

Bidang	Tipe	Deskripsi	Wajib
posisi	Jumlah	Posisi di mana akan menjadi layanan. Posisi pertama memiliki indeks 0.	benar

Contoh respons:

{
   "description" : "Move service",
   "message" : "service1 was moved successful.",
   "params" : {
      "position" : 0
   }
}

Hapus Layanan

Hapus Layanan

Contoh permintaan:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/services/service1

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

Hapus layanan yang diberikan dari profil http. id adalah pengidentifikasi unik layanan yang akan dihapus.

Contoh respons:

{
  "description" : "Delete service service1 in farm FarmHTTP",
  "message" : "The service service1 in farm FarmHTTP has been deleted.",
  "success" : "true",
  "status": "needed restart"
}

HTTP - Layanan - Backends

Daftar backend

Daftar backend

Contoh permintaan:

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

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

Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.

Contoh respons:

{
   "description" : "List service backends",
   "params" : [
      {
         "alias" : null,
         "id" : 0,
         "ip" : "192.168.0.10",
         "port" : 88,
         "status" : "up",
         "timeout" : 12,
         "weight" : 1
      },
      {
         "alias" : null,
         "id" : 1,
         "ip" : "192.168.102.245",
         "port" : 80,
         "status" : "up",
         "timeout" : 22,
         "weight" : 2
      }
   ]
}

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.

Buat Backend baru

Buat Backend baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpfarm/services/newsrv/backends

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

Buat Backend baru di profil HTTP yang diberikan. id adalah pengidentifikasi unik layanan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.	benar
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan.	benar
batas waktu	Jumlah	Ini batas waktu backend untuk menanggapi permintaan tertentu.
berat	Jumlah	Ini adalah nilai bobot untuk backend saat ini. Nilai yang mungkin berasal dari 1 untuk 9.

Contoh respons:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 0,
      "ip" : "192.168.102.244",
      "port" : 80,
      "timeout" : 2,
      "weight" : 2
   },
   "status" : "needed restart"
}

Parameter Respon

Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai jika tambak harus dimulai kembali. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.

Ubah Backend

Ubah Backend

Contoh permintaan:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.0.10","port":88,"timeout":12,"service":"sev2", "weight":1}'
  https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/FarmHTTP/service/service1/backends/1

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

Ubah parameter backend dalam layanan profil HTTP.

Pertama id adalah pengidentifikasi unik layanan, selanjutnya id adalah pengidentifikasi unik backend.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan.
batas waktu	Jumlah	Ini batas waktu backend untuk menanggapi permintaan tertentu, dalam hitungan detik.
berat	Jumlah	Ini adalah nilai bobot untuk backend saat ini. Nilai yang mungkin berasal dari 1 untuk 9.

Contoh respons:

{
   "description" : "Modify service backend",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.0.10",
      "port" : 88,
      "timeout" : 12,
      "weight" : 1
   },
   "status" : "needed restart"
}

Parameter Respon

Respons akan menjadi json dengan parameter yang diminta diperbarui dan status bidang dengan diperlukan restart nilai jika tambak harus dimulai kembali. Mulai ulang tindakan harus diambil untuk menerapkan perubahan.

Backend dalam pemeliharaan

Backend dalam pemeliharaan

Contoh permintaan:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance

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

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 mempengaruhi 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/v3.2/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4

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

Hapus backend yang diberikan dalam layanan profil HTTP.

Pertama id adalah pengidentifikasi unik layanan, selanjutnya id adalah pengidentifikasi unik backend.

Contoh respons:

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

L4xNAT Peternakan

L4xNAT farm farm memungkinkan untuk membuat farm L4 dengan kinerja yang sangat tinggi dan koneksi lebih banyak bersamaan dari core load balancer di layer 7 seperti profil farm HTTP. Peningkatan kinerja lapisan 4 itu menangkal penanganan konten lanjutan yang dapat dikelola oleh profil lapisan 7.

Selain itu, farm 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 juga akan valid.

Ambil pertanian dengan nama

Ambil pertanian dengan nama

Contoh permintaan:

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

GET /farms/<farmname>

Tampilkan semua konfigurasi tentang tambak yang diberikan.

Respon BODY:

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

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 peternakan.
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 algoritma load balancing yang digunakan di Kebun. Opsinya adalah: lessconn koneksi selalu ke server koneksi yang paling sedikit, berat koneksi linear pengiriman berat, prio koneksi selalu ke yang paling prio tersedia.
pendengar	Tali	Seorang pendengar menjelaskan bagaimana pertanian akan bermain dengan permintaan dari klien. bidang informasional, tidak dapat diubah.
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.
ketekunan	Tali	Alamat ip yang sama akan terhubung ke server yang sama. Opsinya adalah: "" nilai kosong, kegigihan dinonaktifkan, ip kegigihan diaktifkan melalui, IP asal digunakan seperti ID unik dalam sesi.
protokol	Tali	Protokol harus seimbang pada layer 4. Opsinya adalah: semua profil akan memuat saldo protokol L4 apa pun, tcp penyeimbang beban hanya akan menyeimbangkan protokol TCP L4, udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, menyesap penyeimbang beban hanya akan menyeimbangkan protokol SIP atau VoIP L7, ftp penyeimbang beban hanya akan menyeimbangkan protokol FTP L7, tftp penyeimbang beban hanya akan menyeimbangkan protokol TFTP L7.
status	Tali	Status pertanian. Nilai 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 persistensi antara sumber klien dan backend ditugaskan, dalam detik. Kegigihan harus dikonfigurasikan.
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.
olahraga	Tali	Port of the farm, tempat layanan virtual mendengarkan. Port unik dapat ditentukan, port jangkauan dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,.
penjaga pertanian	Tali	Itu adalah nama FarmGuardian yang memeriksa status backend. FarmGuardian akan berjalan saat pertanian dalam status naik.

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 tambak.
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual.
status	Tali	Status backend. 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. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas dan 9 adalah prioritas yang paling sedikit.
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 Pertanian baru

Buat Pertanian baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms

POST /farms

Buat peternakan L4xNAT baru.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama pertanian	Tali	Nama pertanian, pengidentifikasi unik.	benar
profil	Tali	Profil Peternakan yang dibuat. Untuk peternakan L4xNAT adalah l4xnat, pesan informasi, nilai ini tidak dapat diubah	benar
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.	benar
olahraga	Tali	Port of the farm, tempat layanan virtual mendengarkan. L4xNAT farm memungkinkan multiport dipisahkan oleh , atau rentang port dipisahkan oleh :.	benar

Contoh respons:

{
   "description" : "Creating farm 'newl4farm'",
   "params" : {
      "farmname" : "newl4farm",
      "interface" : "eth0",
      "profile" : "l4xnat",
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Pertanian

Ubah Pertanian

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"algorithm":"weight","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81","logs":"true"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/newfarml4

PUT /farms/<farmname>

Ubah konfigurasi tambak L4xNAT.

Parameter permintaan

Bidang	Tipe	Deskripsi
newfarmname	Tali	Nama Peternakan baru. Pertanian harus dihentikan.
algoritma	Tali	Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: lessconn koneksi selalu ke server koneksi yang paling sedikit, berat koneksi linear pengiriman berat, prio koneksi selalu ke yang paling prio tersedia.
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.
ketekunan	Tali	Alamat ip yang sama akan terhubung ke server yang sama. Opsinya adalah: "" nilai kosong, kegigihan dinonaktifkan, ip kegigihan diaktifkan melalui, IP asal digunakan seperti ID unik dalam sesi.
protokol	Tali	Protokol harus seimbang pada layer 4. Opsinya adalah: semua profil akan memuat saldo protokol L4 apa pun, tcp penyeimbang beban hanya akan menyeimbangkan protokol TCP L4, udp penyeimbang beban hanya akan menyeimbangkan protokol UDP L4, menyesap penyeimbang beban hanya akan menyeimbangkan protokol SIP atau VoIP L7, ftp penyeimbang beban hanya akan menyeimbangkan protokol FTP L7, tftp penyeimbang beban hanya akan menyeimbangkan protokol TFTP L7.
Ttl	Jumlah	Nilai bidang ini menunjukkan jumlah detik yang persistensi antara sumber klien dan backend ditugaskan, dalam detik. Kegigihan harus dikonfigurasikan.
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.
olahraga	Tali	Port of the farm, tempat layanan virtual mendengarkan. Port unik dapat ditentukan, port jangkauan dapat ditentukan dengan pemisah : dan beberapa port dapat ditentukan dengan pemisah ,.

Contoh respons:

{
   "description" : "Modify farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "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/v3.2/zapi.cgi/farms/l4Farm/fg

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/v3.2/zapi.cgi/farms/l4Farm/fg/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"
}

Tambahkan aturan IPDS

Tambahkan aturan IPDS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/l4Farm/ipds/blacklists

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

Terapkan aturan daftar hitam, 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/v3.2/zapi.cgi/farms/l4Farm/ipds/blacklists/china

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

Hapus daftar hitam, aturan DoS atau RBL dari modul IPDS dari farm yang diberikan menggunakan idenficatornya 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/v3.2/zapi.cgi/farms/l4farm/backends

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 tambak.
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual.
status	Tali	Status backend. 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 serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun.
prioritas	Jumlah	Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas dan 9 adalah prioritas yang paling sedikit.
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/v3.2/zapi.cgi/farms/l4farm/backends

POST /farms/<farmname>/backends

Buat Backend baru di L4xNAT Farm yang diberikan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.	benar
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual.
max_conns	Jumlah	Ini jumlah maksimum koneksi serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun.
prioritas	Jumlah	Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas dan 9 adalah prioritas yang paling sedikit.
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/v3.2/zapi.cgi/farms/l4farm/backends/2

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

Ubah parameter backend dalam layanan L4xNAT Farm. id adalah pengidentifikasi unik backend.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP backend tempat layanan sebenarnya mendengarkan.
pelabuhan	Jumlah	Port backend tempat layanan nyata mendengarkan. Nilai kosong diterima dan itu akan menggunakan konfigurasi yang sama dari port virtual.
max_conns	Jumlah	Ini jumlah maksimum koneksi serentak untuk backend. Jika bidang ini memiliki nilai 0, backend tidak mengonfigurasi batas koneksi apa pun.
prioritas	Jumlah	Ini adalah nilai prioritas untuk server nyata saat ini. Koneksi selalu ke yang paling prio tersedia di mana 1 adalah yang paling prioritas dan 9 adalah prioritas yang paling sedikit.
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/v3.2/zapi.cgi/farms/l4farm/backends/1/maintenance

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

Tetapkan tindakan yang diberikan di backend dari L4xNAT farm. id adalah pengidentifikasi unik backend.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Atur aksi yang diinginkan. Tindakannya adalah: up backend siap menerima permintaan klien, pemeliharaan backend tidak siap untuk menerima permintaan klien, tindakan ini berguna untuk menghentikan server backend tanpa mempengaruhi klien.
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/v3.2/zapi.cgi/farms/l4farm/backends/4

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

Hapus backend yang diberikan dalam layanan L4xNAT Farm.

id adalah pengidentifikasi unik backend.

Contoh respons:

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

Pertanian GSLB

Penyeimbangan Beban Layanan Global, yang biasa disebut GSLB, memungkinkan untuk membuat layanan penyeimbangan beban berdasarkan arsitektur hierarki layanan DNS. Peternakan semacam ini menyediakan DNS otoritatif khusus dengan algoritma load balancing dan deteksi status layanan pada lapisan aplikasi DNS.

Ambil pertanian dengan nama

Ambil pertanian dengan nama

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/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 pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup. Nilai kosong dinonaktifkan.

Objek backend untuk pertanian GSLB:

Bidang	Tipe	Deskripsi
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 seperti penanda unik.
defnamesv	Tali	Ini akan menjadi server nama root titik masuk yang akan tersedia sebagai catatan DNS Start of Authority (SOA).
sumber daya	Obyek[]	Sumber 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 dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik.

Buat Pertanian baru

Buat Pertanian baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms

POST /farms

Buat peternakan GSLB baru.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama pertanian	Tali	Nama tambak, pengidentifikasi unik untuk tambak.	benar
profil	Tali	Profil Peternakan yang dibuat. Untuk peternakan GSLB adalah gslb.	benar
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.	benar
olahraga	Jumlah	Port of the farm, tempat layanan virtual mendengarkan.	benar

Contoh respons:

{
   "description" : "Creating farm 'gslbfarm'",
   "params" : {
      "farmname" : "gslbfarm",
      "interface" : "eth0",
      "profile" : "gslb",
      "vip" : "192.168.100.241",
      "vport" : 53
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Pertanian

Ubah Pertanian

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"gslbnewname","vip":"192.168.100.155","vport":60}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm

PUT /farms/<farmname>

Ubah konfigurasi tambak GSLB.

Parameter permintaan

Bidang	Tipe	Deskripsi
newfarmname	Tali	Nama Peternakan baru. Pertanian harus dihentikan untuk melakukan perubahan ini.
olahraga	Jumlah	Port of the farm, tempat layanan virtual mendengarkan.
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.

Contoh respons:

{
   "description" : "Modify farm gslbnewname",
   "params" : {
      "newfarmname" : "gslbnewname",
      "vip" : "192.168.100.155",
      "vport" : 60
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tambahkan aturan IPDS

Tambahkan aturan IPDS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbFarm/ipds/blacklists

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/v3.2/zapi.cgi/farms/gslbFarm/ipds/blacklists/china

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

Hapus aturan blacklist, DoS atau RBL dari farm yang diberikan menggunakan idenficatornya nama.

Contoh respons:

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
   "success" : "true"
}

GSLB - Layanan

Layanan GSLB mewakili sekelompok server nyata dan algoritma terkait yang akan digunakan untuk mereka. Untuk membuat layanan baru, Anda harus menetapkan nama identifikasi yang valid dan algoritma yang diinginkan untuk digunakan.

Layanan yang tersedia adalah:

Round Robin: pembagian yang sama. Neraca lalu lintas yang sama untuk semua server nyata yang aktif Untuk setiap koneksi yang masuk, penyeimbang menetapkan server real robin babak berikutnya untuk mengirimkan permintaan.

Prioritas: koneksi selalu ke yang paling prio tersedia. Seimbangkan semua koneksi ke server prioritas tertinggi yang sama. Jika server ini tidak aktif, koneksi akan beralih ke server tertinggi berikutnya. Dengan algoritme ini, Anda dapat membangun layanan cluster Active-Pasive 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 pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup. Nilai kosong dinonaktifkan.

Buat Layanan baru

Buat Layanan baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"service1","algorithm":"roundrobin"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services

POST /farms/<farmname>/services

Buat layanan di Ladang GSLB yang diberikan. Kebun harus dimulai kembali untuk menerapkan perubahan ini.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
id	Tali	Nama layanan yang digunakan sebagai pengidentifikasi unik.	benar
algoritma	Tali	Jenis algoritma load balancing yang digunakan dalam layanan. Opsinya adalah: roundrobin, yang akan menyeimbangkan koneksi di antara semua backend, atau prio yang akan mengirim semua koneksi ke backend pertama yang tersedia.	benar

Contoh respons:

{
   "description" : "New service service1",
   "params" : {
      "algorithm" : "roundrobin",
      "id" : "service1"
   },
   "status" : "needed restart"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Layanan

Ubah Layanan

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"deftcpport":53}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1

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

Ubah parameter layanan di Ladang GSLB. id adalah pengidentifikasi unik layanan yang akan dimodifikasi.

Parameter permintaan

Bidang	Tipe	Deskripsi
deftcpport	Jumlah	Ini adalah pemeriksaan kesehatan port TCP yang akan diperiksa layanan untuk menentukan bahwa layanan backend hidup.

Contoh respons:

{
   "description" : "Modify service service1 in farm gslbfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "deftcpport" : 53
   },
   "status" : "needed restart"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

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/v3.2/zapi.cgi/farms/gslbfarm/service/service1/fg

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/v3.2/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request

DELETE /farms/<farmname>/fg/<name>

Hapus FarmGuardian dari layanan di sebuah peternakan.

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/v3.2/zapi.cgi/farms/gslbfarm/services/service1

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

Hapus layanan yang diberikan dari Peternakan GSLB. id adalah pengidentifikasi unik layanan yang akan dihapus.

Contoh respons:

{
  "description" : "Delete service service1 in farm gslbfarm",
  "message" : "The service service1 in farm gslbfarm has been deleted.",
  "success" : "true",
  "status": "needed restart"
}

GSLB - Layanan - Backends

Bagian ini akan mengelola daftar layanan nyata yang terkait dengan layanan.

Daftar backend

Daftar backend

Contoh permintaan:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends

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

Dapatkan daftar backend dalam suatu layanan. id adalah pengidentifikasi unik layanan.

Contoh respons:

{
   "description" : "List service backends",
   "params" : [
      {
         "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/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends

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

Buat Backend baru di layanan yang diberikan di GSLB Farm. id adalah pengidentifikasi unik layanan di mana backend akan ditambahkan.

Layanan prioritas memiliki backend 2 sebagai maximun, host aktif dan host pasif.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP backend, tempat layanan sebenarnya mendengarkan.	benar

Contoh respons:

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

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Backend

Ubah Backend

Contoh permintaan:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.2.30"}'
  https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends/1

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

Ubah parameter backend dalam layanan Farm GSLB.

Catatan di PUT di atas itu dulu id adalah pengidentifikasi unik layanan dan selanjutnya id adalah pengidentifikasi unik backend.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP backend, tempat layanan sebenarnya mendengarkan.

Contoh respons:

{
   "description" : "Modify service backend",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.2.30"
   },
   "status" : "needed restart"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus backend

Hapus backend

Contoh permintaan:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/services/service1/backends/3

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

Hapus backend yang diberikan dalam layanan Ladang GSLB

Contoh respons:

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

GSLB - Zona

Bagian zona GSLB akan menjelaskan nama domain DNS, subdomain, alias, dll., Yang akan diperlukan untuk menghasilkan zona DNS lengkap dengan tambahan catatan penyeimbangan menggunakan layanan yang ditentukan.

Buat zona

Buat zona

Contoh permintaan:

curl  -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"global.conf"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones

POST /farms/<farmname>/zones

Buat zona DNS.

Parameter Permintaan

Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi	Wajib
id	Jumlah	Nama zona digunakan seperti penanda unik.	benar

Contoh respons:

{
   "description" : "New zone global.com",
   "params" : {
      "id" : "global.com"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah zona

Ubah zona

Contoh permintaan:

curl  -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"defnamesv":"ns3"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com

PUT /farms/<farmname>/zones/<id>

Ubah parameter suatu zona. id adalah pengidentifikasi unik zona yang akan dimodifikasi.

Parameter Permintaan

Panggilan ini mengembalikan array objek backend dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
defnamesv	Tali	Ini akan menjadi server nama root titik masuk yang akan tersedia sebagai catatan DNS Start of Authority (SOA).

Contoh respons:

{
   "description" : "Modify zone global.com in farm gslbfarm",
   "params" : {
      "defnamesv" : "ns3"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus Zona

Hapus Zona

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/dom.com

DELETE /farms/<farmname>/zones/<id>

Hapus zona yang ditentukan dari Ladang GSLB.

Contoh respons:

{
   "description" : "Delete zone dom.com in farm gslbfarm.",
   "message" : "The zone dom.com in farm gslbfarm has been deleted.",
   "success" : "true"
}

GSLB - Zona - Sumber Daya

Sumber daya yang didefinisikan sebagai layanan DNS menyelesaikan permintaan. Sumber daya DNS yang mungkin dalam saldo beban Zevenet adalah:

1. NS. Nama jenis catatan Server, itu mendelegasikan zona DNS untuk menggunakan server nama otoritatif yang diberikan.
2. A. Catatan jenis alamat, ia mengembalikan alamat IPv4 dari sebuah host.
3. CNAME. Jenis catatan nama kanonik, itu mewakili alias dari nama yang diberikan.
4. 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.
5. AAAA. Catatan jenis alamat, ia mengembalikan alamat IPv6 dari sebuah host.
6. MX. Catatan jenis pertukaran surat, memetakan nama domain ke daftar agen transfer pesan untuk domain itu.
7. SRV. Catatan jenis pelacak layanan, Catatan lokasi layanan umum, digunakan untuk protokol yang lebih baru daripada membuat catatan khusus protokol seperti MX.
8. 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.
9. PTR. Catatan pointer, penunjuk ke nama kanonik. Tidak seperti CNAME, pemrosesan DNS berhenti dan hanya namanya yang dikembalikan. Penggunaan yang paling umum adalah untuk menerapkan pencarian DNS terbalik.
10. 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/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources

GET /farms/<farmname>/zones/<id>/resources

Dapatkan daftar sumber daya di zona. id adalah pengidentifikasi unik zona.

Contoh respons:

{
   "description" : "List zone resources",
   "params" : [
      {
         "id" : 0,
         "rdata" : "ns3",
         "rname" : "@",
         "ttl" : null,
         "type" : "NS"
      },
      {
         "id" : 1,
         "rdata" : "192.168.100.155",
         "rname" : "ns3",
         "ttl" : null,
         "type" : "A"
      },
      {
         "id" : 2,
         "rdata" : "192.168.0.9",
         "rname" : "resource2",
         "ttl" : 10,
         "type" : "A"
      },
      {
         "id" : 3,
         "rdata" : "resource2",
         "rname" : "ns2",
         "ttl" : null,
         "type" : "NS"
      }
   ]
}

Parameter Respon

Panggilan ini mengembalikan array objek sumber daya dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
id	Jumlah	Pengidentifikasi unik untuk sumber daya di zona.
rname	Tali	Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata.
Ttl	Jumlah	Nilai Time to Live (opsional) untuk catatan saat ini yang diperlukan untuk menentukan lama waktu di mana nama saat ini akan di-cache.
mengetik	Tali	Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian.
rdata	Tali	Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik.

Buat sumber daya baru

Buat sumber daya baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.0.9", "ttl":10, "type":"A" }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources

POST /farms/<farmname>/zones/<id>/resources

Buat sumber daya baru di zona tertentu di Lahan GSLB. id adalah pengidentifikasi unik zona yang akan dimodifikasi di mana sumber daya akan ditambahkan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
rname	Tali	Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata.	benar
Ttl	Jumlah	Nilai Time to Live untuk catatan saat ini. Ini adalah jumlah maksimal perangkat router yang dapat diminta hingga mati. Berguna adalah bahwa paket tidak diinput dalam loop net.
mengetik	Tali	Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian.	benar
rdata	Tali	Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. Jika DYNA dipilih dalam mengetik maka nilai rdata harus salah satu yang dikonfigurasi layanan di zona ini.	benar

Contoh respons:

{
   "description" : "New zone resource",
   "message" : "Resource added",
   "params" : {
      "rdata" : "192.168.0.9",
      "rname" : "resource2",
      "ttl" : 10,
      "type" : "A",
      "zone" : "global.com"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah sumber daya

Ubah sumber daya

Contoh permintaan:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"rname":"resource2", "rdata":"192.168.200.30","ttl":null, "type":"A" }'
  https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1

PUT /farms/<farmname>/zones/<id>/resources/<id>

Ubah parameter sumber daya di zona Ladang GSLB.

Pertama id adalah pengidentifikasi unik zona, selanjutnya id adalah pengidentifikasi unik sumber daya.

Parameter permintaan

Bidang	Tipe	Deskripsi
rname	Tali	Nama sumber daya adalah nick yang akan diterjemahkan oleh layanan DNS untuk data yang diperlukan di lapangan rdata.
Ttl	Jumlah	Nilai Time to Live (opsional) untuk catatan saat ini yang diperlukan untuk menentukan lama waktu di mana nama saat ini akan di-cache.
mengetik	Tali	Jenis catatan DNS. Opsinya adalah: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk informasi lebih lanjut, lihat di GSLB - Zona - Sumber Daya bagian.
rdata	Tali	Ini data nyata yang dibutuhkan oleh tipe catatan, nilai input tergantung dari jenis Nama Sumber Daya, rname dan jenis sumber daya, mengetik. Jika mengetik dimuat dengan nilai DYNA kemudian rdata harus dimuat dengan yang tersedia layanan nama

Contoh respons:

{
   "description" : "Modify zone resource",
   "message" : "Resource modified",
   "params" : {
      "rdata" : "192.168.200.30",
      "rname" : "resource2",
      "ttl" : null,
      "type" : "A"
   },
   "success" : "true"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus sumber daya

Hapus sumber daya

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3

DELETE /farms/<farmname>/zones/<id>/resources/<id>

Hapus sumber daya yang diberikan di zona Lahan GSLB

Perhatikan bahwa dalam DELETE URI di atas yang pertama id adalah pengidentifikasi unik zona dan berikutnya id adalah pengidentifikasi unik sumber daya.

Contoh respons:

{
   "description" : "Delete zone resource",
   "message" : "Resource removed",
   "success" : "true"
}

Peternakan Datalink

Profil datalink farm memungkinkan untuk membuat farm berbasis rute di mana backend adalah router uplink atau gateway. Profil pertanian semacam ini siap untuk membagikan beberapa akses router WAN uplink menggunakan penyeimbang beban sebagai multipleksor saluran uplink (input 1 dan beberapa output garis router). Oleh karena itu, tambak datalink dapat digunakan sebagai tautan komunikasi yang tersedia tinggi dan juga dapat digunakan sebagai peningkatan bandwidth yang menghubungkan jumlah bandwidth antara tautan backend router.

Ambil pertanian dengan nama

Ambil pertanian dengan nama

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/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 atribusi berat 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 di tambak.
ip	Tali	IP backend, tempat layanan sebenarnya mendengarkan.
antarmuka	Tali	Ini adalah antarmuka jaringan lokal tempat backend terhubung.
prioritas	Jumlah	Ini adalah nilai prioritas untuk server nyata saat ini. Ini akan digunakan kapan algoritma bidang adalah konfigurasi karena prio dan prioritas yang lebih rendah akan memiliki preferensi
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 adalah konfigurasi sebagai bobot.

Buat Pertanian baru

Buat Pertanian baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms

POST /farms

Buat peternakan datalink baru.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama pertanian	Tali	Nama pertanian, pengidentifikasi unik.	benar
profil	Tali	Profil Peternakan yang dibuat. Untuk peternakan datalink adalah datalink	benar
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.	benar

Contoh respons:

{
   "description" : "Creating farm 'dlink'",
   "params" : {
      "farmname" : "dlink",
      "interface" : "eth0",
      "profile" : "datalink",
      "vip" : "192.168.100.241"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Pertanian

Ubah Pertanian

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink

PUT /farms/<farmname>

Ubah konfigurasi pertanian datalink.

Parameter permintaan

Bidang	Tipe	Deskripsi
newfarmname	Tali	Nama pertanian baru. Pertanian harus dihentikan.
algoritma	Tali	Jenis algoritma load balancing yang digunakan di Kebun. Opsinya adalah: berat, penyeimbang mendistribusikan di antara semua backend yang tersedia memberikan backend charge lebih banyak dengan atribusi berat lebih tinggi atau prio, yang mengirim semua koneksi ke backend dengan nilai minor prioritas.
vip	Tali	IP pertanian, tempat layanan virtual mendengarkan.

Contoh respons:

{
   "description" : "Modify farm dlink",
   "params" : {
      "algorithm" : "weight",
      "vip" : "192.168.100.199",
      "newfarmname" : "dlink2"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tambahkan aturan IPDS

Tambahkan aturan IPDS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists

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/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists/china

DELETE /farms/<farmname>/ipds/<blacklists>/<name>

Hapus daftar hitam dari peternakan tertentu menggunakan idenficatornya nama.

Contoh respons:

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm dlink2.",
   "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/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists

POST /farms/<farmname>/ipds/<blacklists>

Terapkan aturan daftar hitam ke tambak.

Parameter permintaan

Bidang	Tipe	Deskripsi
nama	Tali	Nama aturan daftar hitam 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/v3.2/zapi.cgi/farms/dlink2/ipds/blacklists/china

DELETE /farms/<farmname>/ipds/<blacklists>/<name>

Hapus aturan daftar hitam modul IPDS dari tambak yang diberikan menggunakan idenficatornya 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 ini akan multiplexor di antara gateway ini, dan beberapa di antaranya tidak tersedia, layanan menggunakan yang lain.

Daftar backend

Daftar backend

Contoh permintaan:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink/backends

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 adalah konfigurasi karena prio 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 adalah konfigurasi sebagai bobot.

Buat Backend baru

Buat Backend baru

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/dlink/backends

POST /farms/<farmname>/backends

Buat Backend baru di Farm datalink yang diberikan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP backend, tempat layanan sebenarnya mendengarkan.	benar
antarmuka	Tali	Ini adalah antarmuka jaringan lokal tempat backend terhubung.	benar
prioritas	Jumlah	Ini adalah nilai prioritas untuk server nyata saat ini. Ini akan digunakan kapan algoritma bidang adalah konfigurasi karena prio dan prioritas yang lebih rendah akan memiliki preferensi. Nilai default adalah 1.
berat	Jumlah	Ini adalah nilai bobot untuk backend saat ini. Ini akan digunakan saat algoritma bidang adalah konfigurasi sebagai bobot. Nilai default adalah 1.

Contoh respons:

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

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah Backend

Ubah Backend

Contoh permintaan:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"priority":1}'
  https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/farms/datalink/backends/2

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

Ubah parameter backend dalam layanan Farm datalink. id adalah pengidentifikasi unik backend.

Parameter permintaan

Bidang	Tipe	Deskripsi
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/v3.2/zapi.cgi/farms/dlink/backends/4

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

Hapus backend yang diberikan dalam layanan Farm datalink. id adalah pengidentifikasi unik backend.

Contoh respons:

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

jaringan

Zevenet dapat bekerja dengan berbagai jenis antarmuka jaringan.

Di bagian ini Anda dapat membuat daftar, membuat, mengonfigurasi, menghapus, dan mengatur tindakan dalam antarmuka NIC, VLAN, virtual, dan bonding.

nic: atau kartu antarmuka jaringan, ini adalah komponen perangkat keras komputer dan jenis antarmuka ini adalah dasar untuk jenis antarmuka berikut yang dapat didefinisikan dan dikelola di Zevenet.

vlan: atau kartu lan virtual adalah jenis atau antarmuka jaringan yang menyediakan layanan segmentasi jaringan. Lebih dari satu vlan dapat dibuat melalui antarmuka nic.

ikatan: Disebut juga oleh vendor lain sebagai antarmuka trunk, jenis nic ini dapat dibuat dengan lebih dari satu antarmuka nic. Zevenet mendukung 7 berbagai jenis antarmuka ikatan.

maya: Jenis antarmuka ini dapat dibuat di atas jenis antarmuka apa pun yang dijelaskan di atas. Jenis antarmuka ini harus digunakan untuk Farms dan diperlukan bahwa antarmuka virtual didefinisikan dalam subnet yang sama dari induknya.

Daftar semua antarmuka

Daftar semua antarmuka

Contoh permintaan:

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

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",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "type" : "vlan"
      },
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "virtual"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "eth2",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "true"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "true"
      }
   ]
}

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 dalam segmen jaringan yang sama dari antarmuka induk 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 induk inteface.
pintu gerbang	Tali	Gerbang antarmuka. Nilai ini tidak dapat dimodifikasi dalam antarmuka virtual, itu diwarisi dari induk inteface.
mac	Tali	MAC dari antarmuka. Nilai ini diwarisi dari slave NIC pertama di antarmuka ikatan. Dalam antarmuka virtual dan VLAN itu diwarisi dari antarmuka induk.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
mengetik	Tali	Berbagai jenis antarmuka adalah: nic, vlan, maya or ikatan.
is_slave	Tali	Hanya tersedia di antarmuka NIC, benar, antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan.

Ambil gateway default

Ambil gateway default

Contoh permintaan:

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

GET /interfaces/gateway

Gateway default adalah simpul yang mengirim semua lalu lintas tujuan yang tidak dapat dijangkau secara lokal dari antarmuka apa pun di penyeimbang beban.

Dapatkan parameter antarmuka gateway default.

Contoh respons:

{
   "description" : "Default gateway",
   "params" : {
      "address" : "192.168.100.5",
      "interface" : "eth0"
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
alamat	Tali	Ini adalah IP gateway.
antarmuka	Tali	Nama antarmuka untuk gateway.

Ubah gateway default

Ubah gateway default

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth0","address":"192.168.100.5"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces

PUT /interfaces/gateway

Ubah konfigurasi antarmuka gateway.

Contoh respons:

{
   "description" : "Modify default gateway",
   "message" : "The default gateway has been changed successfully",
   "success" : "true"
}

Parameter permintaan

Bidang	Tipe	Deskripsi
alamat	Tali	Ini adalah IP gateway.
antarmuka	Tali	Nama antarmuka untuk gateway.

Hapus konfigurasi gateway

DELETE /interfaces/gateway

Hapus konfigurasi konfigurasi gateway default.

peringatan: jika gateway tidak dikonfigurasi, Zevenet tidak akan dapat dijangkau dari segmen jaringan eksternal.

Hapus konfigurasi gateway

Contoh permintaan:

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

Pesan tanggapan

Jika gateway dikonfigurasi dari segmen jaringan yang sama, pesan ini akan muncul, jika tidak koneksi akan hilang.

Contoh respons:

{
   "description" : "Remove default gateway",
   "message" : "The default gateway has been deleted successfully",
   "params" : {
      "address" : null,
      "interface" : null
   }
}

Jaringan - antarmuka NIC

Antarmuka NIC adalah antarmuka fisik yang terhubung ke penyeimbang beban Zevenet Anda.

Sistem mengenali antarmuka baru secara otomatis setelah terhubung.

Menggunakan antarmuka NIC sebagai orangtua, jenis antarmuka lain dengan karakteristik berbeda dapat dibuat. Antarmuka yang tersedia adalah: VLAN,maya 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/v3.2/zapi.cgi/interfaces/nic

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",
         "status" : "up"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "down"
      }
   ]
}

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 indentifier unik layer. Itu tidak dapat dimodifikasi.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
is_slave	Tali	benar antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan.

Ambil antarmuka NIC

Ambil antarmuka NIC

Contoh permintaan:

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

GET /interfaces/nic/<name>

Dapatkan semua parameter antarmuka NIC. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Show NIC interface",
   "interface" : {
      "alias" : "gestion",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "62:30:43:36:29:ac",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "up"
   }
}

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 indentifier unik layer. Itu tidak dapat dimodifikasi.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
mengetik	Tali	Berbagai jenis antarmuka adalah: nic, vlan, maya or ikatan. Masing-masing didefinisikan dalam submenu jaringan mereka.
is_slave	Tali	benar antarmuka adalah bagian dari antarmuka ikatan, palsu antarmuka bukan bagian dari antarmuka ikatan.

Ubah antarmuka NIC

Ubah antarmuka NIC

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.102","netmask":"255.255.255.0","gateway":"192.168.100.5"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic/eth1

PUT /interfaces/nic/<name>

Ubah parameter antarmuka NIC. nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP antarmuka.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda.
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" : "Configure nic interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "netmask" : "255.255.255.0",
      "force" : "true"
   }
}

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/v3.2/zapi.cgi/interfaces/nic/eth3

DELETE /interfaces/nic/<name>

Hapus konfigurasi untuk antarmuka NIC. Setelah tindakan ini, antarmuka akan menjadi tidak berguna, dan siap untuk dikonfigurasikan lagi. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Delete nic interface",
   "message" : "The configuration for the network interface eth3 has been deleted.",
   "success" : "true"
}

Tetapkan tindakan antarmuka NIC

Tetapkan tindakan antarmuka NIC

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/nic/eth1/actions

POST /interfaces/nic/<name>/actions

Terapkan tindakan ke antarmuka NIC. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.

nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket.	benar

Contoh respons:

{
   "description" : "Action on nic interface",
   "params" : {
      "action" : "up"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Jaringan - Ikatan antarmuka

Antarmuka pengikatan Linux atau juga disebut oleh vendor lain sebagai Trunk menyediakan metode untuk menggabungkan beberapa antarmuka jaringan menjadi satu antarmuka logis "terikat". Perilaku antarmuka terikat tergantung pada mode, Zevenet Load Balancer mendukung metode berikut:

Kebijakan round-robin: Mengirimkan paket secara berurutan dari budak pertama yang tersedia hingga yang terakhir. Mode ini menyediakan penyeimbangan muatan dan toleransi kesalahan.

Kebijakan pencadangan aktif: Hanya satu budak di ikatan yang aktif. Seorang budak yang berbeda menjadi aktif jika, dan hanya jika, budak yang aktif gagal. Alamat MAC ikatan terlihat secara eksternal hanya pada satu port (adaptor jaringan) untuk menghindari membingungkan sakelar. Mode ini memberikan toleransi kesalahan. Opsi utama memengaruhi perilaku mode ini.

Kebijakan XOR: Mengirimkan berdasarkan alamat MAC sumber XOR'd dengan alamat MAC tujuan. Ini memilih budak yang sama untuk setiap alamat MAC tujuan. Mode ini menyediakan penyeimbangan muatan dan toleransi kesalahan.

Kebijakan penyiaran: Mengirimkan semua yang ada di semua antarmuka slave. Mode ini memberikan toleransi kesalahan.

IEEE 802.3ad LACP: Membuat grup agregasi yang berbagi kecepatan dan pengaturan dupleks yang sama. Memanfaatkan semua budak dalam agregator aktif sesuai dengan spesifikasi 802.3ad.

Pra-syarat:

1. Dukungan antarmuka jaringan pada driver dasar untuk mendapatkan kecepatan dan dupleks dari setiap slave.

2. 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/v3.2/zapi.cgi/interfaces/bonding

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" : "",
         "slaves" : [
            {
               "name" : "eth2"
            }
         ],
         "status" : "down"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "mode" : "balance-rr",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "slaves" : [
            {
               "name" : "eth3"
            },
            {
               "name" : "eth4"
            }
         ],
         "status" : "up"
      }
   ]
}

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 indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
budak	Obyek[]	Anggota antarmuka NIC dari antarmuka ikatan.
mode	Tali	Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan di bagian Jaringan - Ikatan antarmuka.

Objek budak:

Bidang	Tipe	Deskripsi
nama	Tali	Nama adalah pengidentifikasi unik antarmuka dari budak NIC.

Ambil antarmuka Bonding

Ambil antarmuka Bonding

Contoh permintaan:

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

GET /interfaces/bonding/<name>

Dapatkan semua parameter antarmuka. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Show bonding interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "netmask" : "255.255.255.0",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "up"
   }
}

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 indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
budak	Obyek[]	Anggota antarmuka NIC dari antarmuka ikatan.
mode	Tali	Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat.

Budak obyek:

Bidang	Tipe	Deskripsi
nama	Tali	Nama adalah pengidentifikasi unik antarmuka dari budak NIC.

Buat antarmuka Bonding

Buat antarmuka Bonding

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"slaves":["eth3","eth2"],"name":"bondiface","mode":"balance-rr"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding

POST /interfaces/bonding

Buat antarmuka ikatan bergabung dengan antarmuka NIC.

Alamat MAC ikatan akan diambil dari antarmuka NIC pertamanya. Mode ikatan tidak dapat diubah setelah antarmuka ikatan dibuat, tetapi antarmuka anggota dapat ditambahkan atau dihapus di antarmuka ikatan sesuai kebutuhan. Antarmuka NIC akan dikunci jika merupakan bagian dari antarmuka ikatan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.	benar
budak	Tali[]	Semua antarmuka NIC yang membangun ikatan. Diperlukan parameter NIC nama.	benar
mode	Tali	Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat.	benar

Contoh respons:

{
   "description" : "Add a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "down"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan ikatan parameter yang dikonfigurasi.

Bidang	Tipe	Deskripsi
mac	Tali	Tautan indentifier unik layer. Ini adalah mac dari budak antarmuka NIC pertama.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik antarmuka.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.
budak	Obyek[]	Antarmuka NIC yang membangun ikatan ikatan.
mode	Tali	Ini adalah mode kerja untuk antarmuka ikatan. Opsinya adalah: balance-rr, Kebijakan round-robin; cadangan aktif, Kebijakan pencadangan aktif; balance-xor, Kebijakan XOR; menyiarkan, Kebijakan penyiaran; 802.3ad, IEEE 802.3ad LACP; balance-tlb, Penyeimbangan beban pengiriman adaptif; balance-alb, Penyeimbangan beban adaptif. Nilai-nilai tersebut didefinisikan dalam Jaringan> Antarmuka pengikat.

Budak obyek:

Bidang	Tipe	Deskripsi
nama	Tali	Nama adalah pengidentifikasi unik antarmuka dari budak NIC.

Ubah antarmuka ikatan

Ubah antarmuka ikatan

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.121","netmask":"255.255.255.0","gateway":"192.168.100.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface

PUT /interfaces/bonding/<name>

Ubah parameter antarmuka ikatan. nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP antarmuka.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda.
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 bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0",
      "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/v3.2/zapi.cgi/interfaces/bonding/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/v3.2/zapi.cgi/interfaces/bonding/bondiface/actions

POST /interfaces/bonding/<name>/actions

Menerapkan tindakan ke antarmuka ikatan. Panggilan ini memungkinkan untuk menghapus antarmuka ikatan dan mengaktifkan atau menonaktifkannya.

Diperlukan untuk menghapus antarmuka ikatan menggunakan menghancurkan tindakan jika Anda ingin membuka kunci antarmuka NIC yang digunakan dalam ikatan Driver ikatan kemudian akan mengembalikan alamat MAC yang dimiliki oleh anggota antarmuka sebelum mereka ditambahkan ke antarmuka ikatan.

nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up aktifkan antarmuka dan persiapkan untuk digunakan, turun nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket, menghancurkan hapus ikatan dan kembalikan antarmuka NIC slave.	benar

Contoh respons:

{
   "description" : "Action on bond interface",
   "params" : {
      "action" : "up"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tambahkan antarmuka budak ikatan

Tambahkan antarmuka budak ikatan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"eth4"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/bonding/bondiface/slaves

POST /interfaces/bonding/<name>/slaves

Tambahkan antarmuka NIC sebagai budak ke antarmuka ikatan yang ada.

nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Antarmuka NIC nama untuk menambah antarmuka ikatan.	benar

Contoh respons:

{
   "description" : "Add a slave to a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         },
         {
            "name" : "eth4"
         }
      ],
      "status" : "up"
   }
}

Parameter respons

Respons akan berupa json dengan nilai konfigurasi yang diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus antarmuka budak Bonding

Hapus antarmuka budak Bonding

Contoh permintaan:

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

DELETE /interfaces/bonding/<name>/slaves/<name>

Hapus antarmuka slave NIC dari antarmuka bonding. Bonding interface harus memiliki hampir satu antarmuka slave NIC.

Pertama nama adalah DELETE panggilan adalah pengidentifikasi unik nama ikatan, selanjutnya nama dalam DELETE panggilan adalah pengidentifikasi unik nama antarmuka NIC.

Contoh respons:

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

Jaringan - antarmuka VLAN

Antarmuka VLAN memungkinkan NIC atau antarmuka ikatan bekerja di jaringan lain, jadi IP, pintu gerbang serta netmask bidang bisa berbeda dari antarmuka induk. Antarmuka VLAN mewarisi alamat MAC dari antarmuka induknya.

Bidang antarmuka VLAN nama akan muncul dengan karakter titik “.” yang akan digunakan untuk membuat tag pengenal untuk antarmuka vlan.

Daftar antarmuka VLAN

Daftar antarmuka VLAN

Contoh permintaan:

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

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",
         "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 dengan inteface IP induk.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda.
mac	Tali	MAC dari antarmuka. Nilai ini diwarisi dari antarmuka induk.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan atau tag vlan.
induk	Tali	Ini adalah Antarmuka yang digunakan untuk membuat yang ini.
status	Tali	Nilai bisa up antarmuka dapat menerima paket, turun antarmuka tidak dapat menerima paket.

Ambil antarmuka VLAN

Ambil antarmuka VLAN

Contoh permintaan:

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

GET /interfaces/vlan/<name>

Dapatkan semua parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Show VLAN interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0.1",
      "netmask" : "255.255.255.0",
      "status" : "up"
   }
}

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 rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan.
status	Tali	Nilai bisa up antarmuka dapat menerima paket, turun antarmuka tidak dapat menerima paket.

Buat antarmuka VLAN

Buat antarmuka VLAN

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1", "name":"eth0.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/vlan

POST /interfaces/vlan

Buat antarmuka VLAN dari antarmuka NIC atau ikatan. Antarmuka VLAN baru akan membagikan MAC, meskipun parameter jaringan berikut harus berbeda: ip, dan berikut ini dapat berubah: pintu gerbang, netmask.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP antarmuka. Itu harus berbeda dengan inteface IP induk.	benar
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja.	benar
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda.	benar
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rangkaian yang dibentuk oleh nama antarmuka induk, karakter titik "." dan nomor untuk antarmuka jaringan vlan.	benar

Contoh respons:

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : null,
      "name" : "eth0.1",
      "netmask" : "255.255.255.0"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah antarmuka VLAN

Ubah antarmuka VLAN

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/vlan/eth0.1

PUT /interfaces/vlan/<name>

Ubah parameter antarmuka VLAN. nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP antarmuka. Ini bisa berbeda dengan inteface IP induk.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda.
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",
      "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/v3.2/zapi.cgi/interfaces/vlan/eth0.1

DELETE /interfaces/vlan/<name>

Hapus antarmuka VLAN. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Delete VLAN interface",
   "message" : "The VLAN interface eth0.1 has been deleted.",
   "success" : "true"
}

Tetapkan tindakan antarmuka VLAN

Tetapkan tindakan antarmuka VLAN

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/vlan/eth0.1/actions

POST /interfaces/vlan/<name>/actions

Terapkan tindakan ke antarmuka VLAN. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.

nama adalah nama pengidentifikasi unik.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket.	benar

Contoh respons:

{
   "description" : "Action on vlan interface",
   "params" : {
      "action" : "down"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Jaringan - Antarmuka virtual

Antarmuka jaringan memungkinkan pengguna untuk memiliki antarmuka jaringan lain di segmen jaringan yang sama dari induknya, sehingga antarmuka virtual selalu mewarisi konfigurasi jaringan dari induknya. Parameter yang berbeda adalah ip. Antarmuka virtual dapat dibuat dari NIC, bonding atau VLAN. Membuat antarmuka virtual baru akan muncul bidang dengan karakter ":" titik dua yang akan digunakan untuk membuat identifikasi untuk antarmuka virtual.

Daftar antarmuka virtual

Daftar antarmuka virtual

Contoh permintaan:

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

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 dalam segmen jaringan yang sama dari antarmuka induk.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk.
mac	Tali	MAC dari antarmuka. Ini mewarisi dari antarmuka induk.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":" dan nama untuk antarmuka jaringan virtual, karakter alfanumerik diperbolehkan.
induk	Tali	Ini adalah Antarmuka yang digunakan untuk membuat yang ini.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.

Ambil antarmuka virtual

Ambil antarmuka virtual

Contoh permintaan:

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

GET /interfaces/virtual/<name>

Dapatkan semua parameter antarmuka virtual. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Show virtual interface",
   "interface" : {
      "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 dalam segmen jaringan yang sama dari antarmuka induk.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk.
pintu gerbang	Tali	IP digunakan untuk mengirim paket dari segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk.
mac	Tali	MAC dari antarmuka. Ini mewarisi dari antarmuka induk.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":", dan string alfanumerik untuk antarmuka jaringan virtual.
induk	Tali	Ini adalah Antarmuka yang digunakan untuk membuat yang ini.
status	Tali	Nilai bisa up, antarmuka dapat menerima paket; turun, antarmuka tidak dapat menerima paket.

Buat antarmuka virtual

Buat antarmuka virtual

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.41", "name":"eth0:virtiface"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual

POST /interfaces/virtual

Buat antarmuka virtual.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
ip	Tali	IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk.	benar
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":", dan string alfanumerik untuk antarmuka jaringan virtual.	benar

Contoh respons:

{
   "description" : "Add a virtual interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0"
   }
}

Parameter respons

Responsnya akan menjadi json dengan konfigurasi antarmuka. Lihat contoh respons untuk informasi lebih lanjut.

Bidang	Tipe	Deskripsi
ip	Tali	IP antarmuka. IP harus dalam segmen jaringan yang sama dari antarmuka induk.
netmask	Tali	Tentukan segmen jaringan tempat antarmuka bekerja. Ini mewarisi dari antarmuka induk.
pintu gerbang	Tali	IP digunakan untuk mengirim paket ke segmen jaringan yang berbeda. Ini mewarisi dari antarmuka induk.
mac	Tali	MAC dari antarmuka. Ini mewarisi dari antarmuka induk.
nama	Tali	Nama antarmuka. Ini digunakan sebagai pengenal unik. Nama ini adalah rantai yang dibentuk oleh antarmuka induk, karakter titik dua ":" dan string alpahnumerik untuk antarmuka jaringan virtual.

Ubah antarmuka virtual

Ubah antarmuka virtual

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface

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 dalam segmen jaringan yang sama dari 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/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface

DELETE /interfaces/virtual/<name>

Hapus antarmuka virtual. nama adalah pengenal unik antarmuka.

Contoh respons:

{
   "description" : "Delete virtual interface",
   "message" : "The virtual interface eth0:virtiface has been deleted.",
   "success" : "true"
}

Tetapkan tindakan antarmuka virtual

Tetapkan tindakan antarmuka virtual

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/interfaces/virtual/eth0:virtiface/actions

POST /interfaces/virtual/<name>/actions

Terapkan tindakan ke antarmuka virtual. Panggilan ini memungkinkan untuk mengaktifkan atau menonaktifkan antarmuka jaringan.

nama adalah pengenal unik antarmuka.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan untuk diterapkan ke antarmuka. Nilai yang tersedia adalah: up, aktifkan antarmuka dan siapkan untuk digunakan; turun, nonaktifkan antarmuka untuk tidak menerima atau tidak mengirim paket.	benar

Contoh respons:

{
   "description" : "Action on virtual interface",
   "params" : {
      "action" : "down"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Jaringan - Antarmuka apung

Jenis antarmuka ini menggunakan antarmuka virtual yang ditentukan dan menutupi lalu lintas keluar a nic, ikatan or VLAN antarmuka dengan seorang anak maya antarmuka. Antarmuka ini digunakan untuk perilaku failover stateful di l4xnat profil jika cluster dikonfigurasi.

Daftar antarmuka Mengambang

Daftar antarmuka Mengambang

Contoh permintaan:

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

GET /interfaces/floating

Tampilkan semua availables atau antarmuka yang dikonfigurasi di mana IP mengambang telah dibuat.

Contoh respons:

{
   "description" : "List floating interfaces",
   "params" : [
      {
         "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/v3.2/zapi.cgi/interfaces/floating/eth0

GET /interfaces/floating/<name>

Ditampilkan jika antarmuka memiliki IP mengambang yang dikonfigurasi. Jika sudah dikonfigurasi, akan ditampilkan di sini.

nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.

Contoh respons:

{
   "description" : "Show floating interface",
   "params" : {
      "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/v3.2/zapi.cgi/interfaces/floating/eth0

PUT /interfaces/floating/<name>

Konfigurasikan IP mengambang untuk antarmuka NIC, bonding atau VLAN.

nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
floating_ip	Tali	IP Apung digunakan di antarmuka. floating_ip harus ada sebagai anak antarmuka virtual dari antarmuka.	benar

Contoh respons:

{
   "description" : "Modify floating interface",
   "message" : "Floating interface modification done",
   "success" : "true"
}

Hapus konfigurasi Floating

Hapus konfigurasi Floating

Contoh permintaan:

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

DELETE /interfaces/floating/<name>

Hapus konfigurasi IP mengambang dalam sebuah antarmuka.

nama adalah pengenal unik antarmuka yang dapat dari jenis nic, bonding atau vlan.

Contoh respons:

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

Pemantauan - 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/v3.2/zapi.cgi/monitoring/fg

GET /monitoring/fg

Daftar FarmGuardians. Template dan ketersediaan FarmGuardians muncul dalam daftar.

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"
      },
      {
         "command" : "check_tcp -p 80 -H HOST",
         "cut_conns" : "false",
         "description" : "TCP check to the port 80",
         "farms" : [
                     "web_service",
                     "my_welcome_web"
         ],
         "interval" : 7,
         "log" : "true",
         "name" : "custom-tcp",
         "template" : "false"
      },
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp",
         "template" : "true"
      }
   ]
}

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 kecil tentang cek.
peternakan	Tali[]	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.

Ambil FarmGuardian

Ambil FarmGuardian

Contoh permintaan:

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

GET /monitoring/fg/<name>

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" : 5,
      "log" : "false",
      "name" : "check_tcp",
      "template" : "true"
   }
}

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 kecil tentang cek.
peternakan	Tali[]	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 template, itu tidak akan dimodifikasi. Templat ini berguna untuk membuat Penjaga Pertanian baru atau melamar langsung ke pertanian.

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", "parent":"check_tcp"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/monitoring/fg

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
induk	Tali	Ini adalah FarmGuardian yang digunakan sebagai templat untuk membuat FarmGuardian baru. Jika bidang ini tidak dikirim, FarmGuardian baru dibuat kosong.

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

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 kecil tentang cek.
peternakan	Tali[]	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 template, itu tidak akan dimodifikasi. Templat ini berguna untuk membuat Penjaga Pertanian baru atau melamar langsung ke pertanian.

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/v3.2/zapi.cgi/monitoring/fg/custom-tcp

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 kecil tentang cek.
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.
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.

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

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 kecil tentang cek.
peternakan	Tali[]	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.

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/v3.2/zapi.cgi/monitoring/fg/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/v3.2/zapi.cgi/stats

GET /stats

Dapatkan statistik sistem global.

Contoh respons:

{
   "description" : "System stats",
   "params" : {
      "cpu" : {
         "cores" : 2,
         "idle" : 94.42,
         "iowait" : 0,
         "irq" : 0,
         "nice" : 0,
         "softirq" : 0,
         "sys" : 2.54,
         "usage" : 5.58,
         "user" : 3.05
      },
      "date" : "Fri Jan 27 11:40:32 2017",
      "hostname" : "api3",
      "load" : {
         "Last_1" : 1.17,
         "Last_15" : 0.36,
         "Last_5" : 0.6
      },
      "memory" : {
         "Buffers" : 21.68,
         "Cached" : 147.95,
         "MemFree" : 348.06,
         "MemTotal" : 2005.01,
         "MemUsed" : 1656.95,
         "SwapCached" : 2.67,
         "SwapFree" : 614.38,
         "SwapTotal" : 672,
         "SwapUsed" : 57.62
      },
      "network" : {
         "bond0 in in" : 234.72,
         "bond0 out out" : 0,
         "bond0.10 in in" : 0,
         "bond0.10 out out" : 0,
         "bond1 in in" : 234.72,
         "bond1 out out" : 0,
         "bond3 in in" : 815.69,
         "bond3 out out" : 4300.38,
         "eth0 in in" : 2702.29,
         "eth0 out out" : 50701.95,
         "eth0.2 in in" : 0,
         "eth0.2 out out" : 0,
         "eth1 in in" : 234.72,
         "eth1 out out" : 0,
         "eth2 in in" : 234.72,
         "eth2 out out" : 0,
         "eth3 in in" : 0,
         "eth3 out out" : 0,
         "eth4 in in" : 436.89,
         "eth4 out out" : 4300.38,
         "eth4.6 in in" : 0,
         "eth4.6 out out" : 0,
         "eth5 in in" : 301.39,
         "eth5 out out" : 0,
         "eth5.5 in in" : 0,
         "eth5.5 out out" : 0,
         "eth6 in in" : 77.42,
         "eth6 out out" : 0
      }
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
cpu	obyek	Statistik CPU.
tanggal	Tali	Tanggal sistem.
hostname	Tali	Nama tuan rumah.
memuat	obyek	Statistik beban inti.
ingatan	obyek	Statistik memori yang digunakan.
jaringan	obyek	Statistik lalu lintas jaringan.

Objek CPU:

Bidang	Tipe	Deskripsi
warna	Jumlah	Jumlah inti dalam prosesor.
siaga	Jumlah	CPU tidak digunakan oleh program apa pun.
iowait	Jumlah	CPU digunakan oleh proses input atau output.
irq	Jumlah	CPU digunakan oleh gangguan perangkat keras.
bagus	Jumlah	Prioritas penjadwalan CPU.
softirq	Jumlah	CPU digunakan oleh gangguan perangkat lunak.
sys	Jumlah	CPU digunakan oleh sistem.
pemakaian	Jumlah	Total CPU yang digunakan.
pemakai	Jumlah	CPU digunakan oleh pengguna.

Memuat objek:

Bidang	Tipe	Deskripsi
Last_1	Jumlah	Muat sistem persentase pada menit terakhir.
Last_5	Jumlah	Muat sistem persentase lima menit yang lalu.
Last_15	Jumlah	Muat sistem persentase lima belas menit yang lalu.

Objek memori.

Bidang	Tipe	Deskripsi
Buffer	Jumlah	Ini memori yang digunakan oleh buffer. Jumlah ini ditunjukkan dalam Mb.
Dalam cache	Jumlah	Ini adalah total memori yang di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemFree	Jumlah	Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemTotal	Jumlah	Ini total memori ram pada sistem. Jumlah ini ditunjukkan dalam Mb.
MemUsed	Jumlah	Ini memori yang digunakan oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapCached	Jumlah	Ini adalah total memori cache yang dipesan.
SwapFree	Jumlah	Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapTotal	Jumlah	Ini memori swap total yang dicadangkan.
Ditukar	Jumlah	Ini swap memori yang digunakan oleh sistem, pada sistem yang optimal harus 0.

Objek jaringan:

Bidang	Tipe	Deskripsi
di dalam	Jumlah	Input traffic untuk ini antarmuka.
keluar keluar	Jumlah	Output traffic untuk ini antarmuka.

Tampilkan throughput antarmuka

Tampilkan throughput antarmuka

Contoh permintaan:

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

GET /stats/interfaces/throughput

Dapatkan rata-rata per detik dari lalu lintas input dan output untuk setiap antarmuka nic, bonding dan vlan.

Contoh respons:

{
   "description" : "throughput stats",
   "params" : {
      "bond" : {
         "in" : {
            "bytes" : "0",
            "packets" : "0"
         },
         "out" : {
            "bytes" : "0",
            "packets" : "0"
         }
      },
      "bond.2" : {
         "in" : {
            "bytes" : "0",
            "packets" : "0"
         },
         "out" : {
            "bytes" : "0",
            "packets" : "0"
         }
      },
      "eth0" : {
         "in" : {
            "bytes" : "2672",
            "packets" : "20"
         },
         "out" : {
            "bytes" : "8234",
            "packets" : "22"
         }
      },
      "eth1" : {
         "in" : {
            "bytes" : "56",
            "packets" : "1"
         },
         "out" : {
            "bytes" : "0",
            "packets" : "0"
         }
      },
      "eth1.2" : {
         "in" : {
            "bytes" : "0",
            "packets" : "0"
         },
         "out" : {
            "bytes" : "0",
            "packets" : "0"
         }
      },
   }
}

Parameter respons

Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek antarmuka dengan nama antarmuka sebagai kunci dan sebagai nilai objek input dan output dengan bidang:

Bidang	Tipe	Deskripsi
byte	Jumlah	Jumlah B / s melalui antarmuka.
paket	Jumlah	Jumlah paket dengan detik melalui antarmuka.

Tampilkan statistik jaringan

Tampilkan statistik jaringan

Contoh permintaan:

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

GET /stats/system/network

Dapatkan ringkasan total lalu lintas input dan output melalui antarmuka jaringan.

Contoh respons:

{
   "description" : "Network interfaces usage",
   "params" : {
      "date" : "Fri Jan 27 11:58:05 2017",
      "hostname" : "api3",
      "interfaces" : [
         {
            "in" : "234.72",
            "interface" : "bond1",
            "out" : "0.00"
         },
         {
            "in" : "77.42",
            "interface" : "eth6",
            "out" : "0.00"
         },
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "bond2",
            "out" : "4300.38"
        }
      ]
   }
}

Parameter respons

Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kunci followeing:

Bidang	Tipe	Deskripsi
tanggal	Tali	Tanggal sistem.
hostname	Tali	Nama tuan rumah.
interface	Obyek[]	Statistik lalu lintas jaringan.

Objek antarmuka

Bidang	Tipe	Deskripsi
in	Tali	Total lalu lintas input dalam MB.
antarmuka	Tali	Nama antarmuka.
di luar	Tali	Total lalu lintas keluaran dalam MB.

Tampilkan statistik antarmuka

Tampilkan statistik antarmuka

Contoh permintaan:

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

GET /stats/system/network/interfaces

Dapatkan ringkasan dari setiap antarmuka jaringan.

Contoh respons:

{
   "description" : "Interfaces info",
   "params" : {
      "bond" : [
         {
            "in" : "234.72",
            "interface" : "bond1",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "slaves" : [
               "eth2"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "815.70",
            "interface" : "bond3",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "slaves" : [
               "eth4",
               "eth5",
               "eth6"
            ],
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "bond0",
            "ip" : "",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "slaves" : [
               "eth1"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : [
               "bond0.10"
            ]
         }
      ],
      "nic" : [
         {
            "in" : "77.42",
            "interface" : "eth6",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "2704.81",
            "interface" : "eth0",
            "ip" : "192.168.101.46",
            "mac" : "9e:2e:3e:a5:2e:6a",
            "out" : "51039.13",
            "status" : "up",
            "virtual" : [
               "eth0:1",
               "eth0:2",
               "eth0.2:6"
            ],
            "vlan" : [
               "eth0.2"
            ]
         },
         {
            "in" : "234.72",
            "interface" : "eth1",
            "ip" : "192.168.101.58",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "eth2",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "0.00",
            "interface" : "eth3",
            "ip" : "192.168.101.72",
            "mac" : "16:97:ab:43:87:02",
            "out" : "0.00",
            "status" : "down",
            "virtual" : [
               "eth3:1",
               "eth3:8",
               "eth3:6"
            ],
            "vlan" : []
         },
         {
            "in" : "436.89",
            "interface" : "eth4",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "status" : "up",
            "virtual" : [
               "eth4.6:5"
            ],
            "vlan" : [
               "eth4.6"
            ]
         },
         {
            "in" : "301.39",
            "interface" : "eth5",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : [
               "eth5.5"
            ]
         }
      ]
   }
}

Parameter respons

Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kunci ikatan 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/v3.2/zapi.cgi/stats/system/memory

GET /stats/system/memory

Dapatkan ringkasan memori sistem.

Contoh respons:

{
   "description" : "Memory usage",
   "params" : {
      "Buffers" : 1.01,
      "Cached" : 42.47,
      "MemFree" : 880.11,
      "MemTotal" : 2005.01,
      "MemUsed" : 1124.91,
      "SwapCached" : 8.27,
      "SwapFree" : 565.15,
      "SwapTotal" : 672,
      "SwapUsed" : 106.84,
      "date" : "Fri Jan 27 12:27:11 2017",
      "hostname" : "api3"
   }
}

Parameter respons

Respons akan menjadi JSON dengan kunci params yang nilainya adalah objek memori.

Memori obyek.

Bidang	Tipe	Deskripsi
Buffer	Jumlah	Ini memori yang digunakan oleh buffer. Jumlah ini ditunjukkan dalam Mb.
Dalam cache	Jumlah	Ini adalah total memori yang di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemFree	Jumlah	Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemTotal	Jumlah	Ini total memori ram pada sistem. Jumlah ini ditunjukkan dalam Mb.
MemUsed	Jumlah	Ini memori yang digunakan oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapCached	Jumlah	Ini adalah total memori cache yang dipesan.
SwapFree	Jumlah	Ini adalah total memori bebas yang tidak di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapTotal	Jumlah	Ini memori swap total yang dicadangkan.
Ditukar	Jumlah	Ini swap memori yang digunakan oleh sistem, pada sistem yang optimal harus 0.
tanggal	Tali	Tanggal sistem.
hostname	Tali	Nama tuan rumah.

Tampilkan statistik muat

Tampilkan statistik muat

Contoh permintaan:

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

GET /stats/system/load

Dapatkan ringkasan dari beban sistem CPU.

Contoh respons:

{
   "description" : "System load",
   "params" : {
      "Last_1" : 0.66,
      "Last_15" : 0.39,
      "Last_5" : 0.49,
      "date" : "Fri Jan 27 13:15:01 2017",
      "hostname" : "api3"
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
Last_1	Jumlah	Muat penggunaan sistem yang terakhir.
Last_5	Jumlah	Muat penggunaan sistem lima menit terakhir.
Last_15	Jumlah	Muat penggunaan sistem selama lima belas menit terakhir.
tanggal	Tali	Tanggal sistem.
hostname	Tali	Nama tuan rumah.

Tampilkan statistik CPU

Tampilkan statistik CPU

Contoh permintaan:

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

GET /stats/system/cpu

Contoh respons:

{
   "description" : "System CPU usage",
   "params" : {
      "cores" : 2,
      "date" : "Fri Jan 27 13:30:52 2017",
      "hostname" : "api3",
      "idle" : 94.9,
      "iowait" : 0,
      "irq" : 0,
      "nice" : 0,
      "softirq" : 0,
      "sys" : 3.06,
      "usage" : 5.1,
      "user" : 2.04
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
warna	Jumlah	Jumlah inti dalam prosesor.
siaga	Jumlah	CPU tidak digunakan oleh program apa pun.
iowait	Jumlah	CPU digunakan oleh proses input atau output.
irq	Jumlah	CPU digunakan oleh gangguan perangkat keras.
bagus	Jumlah	Prioritas penjadwalan CPU.
softirq	Jumlah	CPU digunakan oleh gangguan perangkat lunak.
sys	Jumlah	CPU digunakan oleh sistem.
pemakaian	Jumlah	Total CPU yang digunakan.
pemakai	Jumlah	CPU digunakan oleh pengguna.
tanggal	Tali	Tanggal sistem.
hostname	Tali	Nama tuan rumah.

Tampilkan statistik koneksi

Tampilkan statistik koneksi

Contoh permintaan:

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

GET /stats/system/connections

Dapatkan total koneksi saat ini dalam sistem. Penghitung menjumlahkan semua jenis koneksi terlacak: ASSURED, ESTABLISHED, SYN_SENT, TIME_WAIT, LISTEN…

Contoh respons:

{
   "description" : "System connections",
   "params" : {
      "connections" : 324
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
koneksi	Jumlah	Total koneksi yang terlacak sebenarnya.

Tampilkan jumlah peternakan

Tampilkan jumlah peternakan

Contoh permintaan:

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

GET /stats/farms/total

Tampilkan total kebun yang dibuat dalam sistem.

Contoh respons:

{
   "description" : "Number of farms.",
   "number" : 8
}

Parameter respons

Bidang	Tipe	Deskripsi
jumlah	Jumlah	Ini adalah jumlah pertanian yang ada dalam sistem.

Tampilkan statistik peternakan

Tampilkan statistik peternakan

Contoh permintaan:

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

GET /stats/farms

Dapatkan ringkasan koneksi dan konfigurasi untuk semua tambak di sistem.

Contoh respons:

{
   "description" : "List all farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "testHttps",
         "pending" : 0,
         "profile" : "https",
         "status" : "up",
         "vip" : "192.168.101.20",
         "vport" : "120"
      },
      {
         "established" : 0,
         "farmname" : "httpFarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "8080"
      },
      {
         "established" : 0,
         "farmname" : "testDL",
         "pending" : 0,
         "profile" : "datalink",
         "status" : "up",
         "vip" : "192.168.102.72",
         "vport" : "eth1"
      },
      {
         "established" : 0,
         "farmname" : "testL4",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "30"
      },
      {
         "established" : 0,
         "farmname" : "testGSLB",
         "pending" : 0,
         "profile" : "gslb",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "53"
      }
   ]
}

Parameter respons

Bidang	Tipe	Deskripsi
mapan	Jumlah	Jumlah total koneksi yang ada saat ini.
nama pertanian	Tali	Nama pertanian, pengidentifikasi unik.
tertunda	Jumlah	Jumlah koneksi yang tertunda.
profil	Tali	Jenis pertanian. Nilai yang mungkin adalah: datalink, l4xnat, http, https or gslb. Setiap profil didefinisikan di bagiannya.
status	Tali	Status pertanian. Nilai 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/v3.2/zapi.cgi/stats/farms/farmname

GET /stats/farms/<farmname>

Menunjukkan status peternakan saat ini, status backend dan koneksi mereka. Setiap tambak akan merespons dengan objek yang berbeda, tergantung pada profilnya.

Contoh respons untuk layanan HTTP:

{
   "backends" : [
      {
         "established" : 0,
         "id" : 0,
         "ip" : "192.168.0.168",
         "pending" : 0,
         "port" : 80,
         "service" : "srv1",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
         "client" : "0",
         "id" : "0",
         "service" : "srv1",
         "session" : "192.168.0.186"
      }
   ]
}

Parameter respons di ladang HTTP

Bidang	Tipe	Deskripsi
backends	Obyek[]	Tampilkan informasi tentang backend.
sesi	Obyek[]	Tampilkan informasi tentang sesi.

Objek Backend

Bidang	Tipe	Deskripsi
mapan	Jumlah	Jumlah total koneksi yang dibangun.
id	Jumlah	Backend pengidentifikasi unik.
ip	Tali	IP tempat layanan sebenarnya mendengarkan.
tertunda	Jumlah	Jumlah koneksi yang tertunda.
pelabuhan	Jumlah	Port tempat layanan sebenarnya mendengarkan.
layanan	Tali	Nama layanan digunakan sebagai pengidentifikasi unik.
status	Tali	Status backend. Nilai yang mungkin adalah: up, 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 dari jenis ketekunan.

Contoh respons untuk kebun GSLB:

{
   "backends" : [
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "192.168.55.40",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 4,
         "ip" : "192.135.10.2",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      }
   ],
   "client" : {
      "edns_big" : 0,
      "edns_tc" : 0,
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0,
      "tc" : 0
   },
   "description" : "List farm stats",
   "extended" : {
      "badvers" : 0,
      "dropped" : 0,
      "edns" : 0,
      "edns_clientsub" : 0,
      "formerr" : 0,
      "noerror" : 0,
      "notimp" : 0,
      "nxdomain" : 0,
      "refused" : 0,
      "v6" : 0
   },
   "server" : {
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0
   }
}

Parameter respons di peternakan GSLB

Bidang	Tipe	Deskripsi
backends	Obyek[]	Tampilkan informasi tentang backend.
klien	obyek	Statistik yang terkait dengan klien.
luas	obyek	Informasi tambahan tentang layanan ini.
Server	obyek	Statistik terkait dengan server.

Objek backend

Bidang	Tipe	Deskripsi
id	Jumlah	Backend pengidentifikasi unik.
ip	Tali	IP tempat layanan sebenarnya mendengarkan.
pelabuhan	Jumlah	Port tempat layanan sebenarnya mendengarkan.
layanan	Tali	Nama layanan digunakan sebagai pengidentifikasi unik.
status	Tali	Status backend. Nilai yang mungkin adalah: up, 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 diperpanjang yang ditentukan klien terlalu kecil untuk data yang diminta.
penerimaan	Jumlah	Jumlah kesalahan UDP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi saat menerima.
reqs	Jumlah	Jumlah total permintaan UDP yang ditangani oleh server.
sendfail	Jumlah	Jumlah kesalahan UDP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi pada pengiriman.
tc	Jumlah	Respons yang terpotong dengan set bit TC.

Objek diperpanjang

Bidang	Tipe	Deskripsi
penjahat	Jumlah	Permintaan yang memiliki EDNS OPT-RR dengan versi yang tidak didukung.
menjatuhkan	Jumlah	Permintaan yang dibatalkan untuk format yang salah.
edn	Jumlah	Permintaan berisi EDNS OPT-RR.
edns_clientsub	Jumlah	Subset permintaan edns yang menentukan opsi edns_client_subnet.
mantan	Jumlah	Permintaan diformat dengan buruk, tetapi cukup waras sehingga kami mengirim respons dengan FORMERR rcode.
noerror	Jumlah	Permintaan yang berhasil.
notimp	Jumlah	Layanan yang diminta tidak diterapkan oleh daemon ini, seperti permintaan transfer zona.
nxdomain	Jumlah	Permintaan untuk nama domain yang tidak ada.
menolak	Jumlah	Permintaan ditolak oleh server karena server tidak berwenang untuk nama yang ditanyakan.
v6	Jumlah	Permintaan dari klien IPv6.

Objek server

Bidang	Tipe	Deskripsi
penerimaan	Jumlah	Jumlah kesalahan TCP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi saat menerima.
reqs	Jumlah	Jumlah total permintaan TCP yang ditangani oleh server.
sendfail	Jumlah	Jumlah kesalahan TCP, di mana OS menunjukkan bahwa sesuatu yang buruk terjadi pada pengiriman.

Contoh respons untuk tambak L4xNAT:

{
   "backends" : [
      {
         "established" : 5,
         "id" : 1,
         "ip" : "192.168.5.40",
         "pending" : 0,
         "port" : "8080",
         "status" : "maintenance"
      },
      {
         "established" : null,
         "id" : 3,
         "ip" : "192.5.1.1",
         "pending" : 0,
         "port" : "787",
         "status" : "down"
      },
      {
         "established" : 1,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
         "id" : 5,
         "session" : "192.168.5.100"
      }
   ]

}

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
id	Jumlah	Backend pengidentifikasi unik tempat klien ditugaskan.
Sidang	Tali	Sesi pengidentifikasi unik. Ini adalah IP 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/v3.2/zapi.cgi/stats/farms/modules

GET /stats/farms/modules

Dapatkan ringkasan statistik modul. Panggilan ini menunjukkan setiap status modul, jumlah yang dikonfigurasi, jumlah peternakan yang diletakkan dan naik.

Definisi tentang modul ada di Pertanian bagian.

Contoh respons:

{
   "description" : "Module status",
   "params" : {
      "dslb" : {
         "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 itu bermasalah ketika sudah naik dan hampir backend dalam status down.
total	Jumlah	Jumlah total pertanian.
up	Jumlah	Jumlah peternakan yang beroperasi. Di sini ditampilkan terpelihara 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/v3.2/zapi.cgi/stats/farms/modules/lslb

GET /stats/farms/modules/<module>

Tampilkan statistik peternakan dari modul yang ditentukan.

Nilai yang tersedia untuk modul parameternya adalah: lslb, gslb or dslb.

Contoh respons:

{
   "description" : "List lslb farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "newfarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.100.199",
         "vport" : "40"
      },
      {
         "established" : 0,
         "farmname" : "nwl4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "down",
         "vip" : "192.168.100.241",
         "vport" : "88"
      },
      {
         "established" : 0,
         "farmname" : "l4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.100.102",
         "vport" : "70"
      }
   ]
}

Parameter respons

Respons akan berupa objek JSON dengan informasi tentang tambak dalam modul.

Bidang	Tipe	Deskripsi
mapan	Jumlah	Jumlah total koneksi yang ada saat ini.
nama pertanian	Tali	Nama pertanian, pengidentifikasi unik untuk peternakan.
tertunda	Jumlah	Jumlah koneksi yang tertunda.
profil	Tali	Jenis pertanian. Nilai yang mungkin adalah: datalink, l4xnat, http, https or gslb. Setiap profil didefinisikan sendiri bagian.
status	Tali	Status pertanian. Nilai 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, memori ram, semua antarmuka kerja baru yang dikonfigurasi, penyimpanan beban dan hard disk.

Selain itu, Anda dapat mengakses riwayat mingguan, ngengat, dan tahunan.

Grafik dengan informasi dijawab dalam format base64.

Daftar grafik yang tersedia

Daftar grafik yang tersedia

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/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 pertanian tersedia.
interface	Tali[]	Daftar grafik antarmuka yang tersedia.
sistem	Obyek[]	Daftar grafik sistem yang tersedia. Array memiliki objek dengan array yang menunjukkan titik pemasangan disk.

Objek sistem:

Objek sistem berisi daftar array yang terkait dengan sistem, dan objek disk dengan format berikutnya.

Bidang	Tipe	Deskripsi
cakram	Tali[]	Nilai array ini semuanya ada mount point dalam sistem, masing-masing memiliki grafik yang tersedia.

Tampilkan grafik

Tampilkan grafik

Minta contoh untuk tambak:

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

Contoh permintaan untuk antarmuka:

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

Minta contoh untuk disk:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/graphs/system/disk/root/boot

GET /graphs/<graph>

Nilai yang tersedia untuk grafik adalah:

Nilai	Deskripsi
farms/<farmname>	nama pertanian, tandai pengidentifikasi unik.
interfaces/<interface>	antarmuka, antarmuka pengidentifikasi unik.
system/<system>	sistem, kemungkinan grafik sistem adalah: cpu, memuat, ram or menukar.
system/disk/<mount point>	titik mount, adalah nilai cakram objek, dikembalikan oleh panggilan 'GET / graphs'.

Contoh respons:

{
   "description" : "Get cpu graphs",
   "graphs" : [
      {
         "frequency" : "daily",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "weekly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "monthly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "yearly",
         "graph" : "PNG IN BASE 64"
      }
   ]
}

Parameter respons

Bidang	Tipe	Deskripsi
frekuensi	Tali	Periode waktu yang digunakan untuk menghasilkan grafik. Nilai yang mungkin adalah: harian, mingguan, bulanan or tahunan.
grafik	Tali	Grafik dalam format 64 dasar.

Tampilkan grafik frekuensi

Tampilkan grafik frekuensi

Minta contoh untuk tambak:

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

Contoh permintaan untuk antarmuka:

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

Minta contoh untuk disk:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/graphs/system/disk/root/boot/yearly

GET /graphs/<graph>/<frequency>

Nilai yang tersedia untuk grafik adalah:

Nilai	Deskripsi
farms/<farmname>	nama pertanian, tandai pengidentifikasi unik.
interfaces/<interface>	antarmuka, antarmuka pengidentifikasi unik.
system/<system>	sistem, kemungkinan grafik sistem adalah: cpu, memuat, ram or menukar.
system/disk/<mount point>	titik mount, adalah nilai cakram objek, dikembalikan oleh panggilan 'GET / graphs'.

Nilai yang tersedia untuk frekuensi adalah:

Bidang	Tipe	Deskripsi
frekuensi	Tali	Periode waktu yang digunakan untuk menghasilkan grafik. Nilai yang mungkin adalah: harian, mingguan, bulanan or tahunan.

Contoh respons:

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

Parameter respons

Bidang	Tipe	Deskripsi
grafik	Tali	Grafik dalam format 64 dasar.

Pemantauan - 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/v3.2/zapi.cgi/aliases/backends

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

Api mengembalikan hash di mana kuncinya adalah backend IP atau nama antarmuka dan nilainya adalah alias.

Buat atau modifikasi alias

Buat atau modifikasi alias

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"management"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/aliases/interfaces/eth0

PUT /aliases/<backends|interfaces>/<id>

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
alias	Tali	Ini adalah nick untuk elemen id dikirim dalam URI.

Contoh respons:

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

Parameter respons

Zapi mengembalikan pesan sukses jika prosesnya dengan benar.

Hapus alias

Hapus alias

Contoh permintaan:

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

DELETE /aliases/<backends|interfaces>/<id>

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 dengan benar.

IPDS

Modul ini merupakan implementasi dari a IPS (Sistem Pencegahan Intrusi) dan IDS (Intrusion Detection System) sistem untuk menawarkan kepada pengguna lapisan keamanan. Modul IPDS memeriksa lalu lintas sebelum mencapai modul Load Balancing LSLB or GSLB, jika lalu lintas terdeteksi sebagai berbahaya maka akan ditolak.

Ia bekerja menerapkan aturan keamanan ke sistem yang akan didefinisikan sebagai objek yang berbeda sifatnya. Masing-masing menawarkan solusi untuk tindakan berbahaya atau mencurigakan eksternal. Alat ini membantu administrator sistem yang mengendalikan ancaman dan serangan.

Aturan yang tersedia untuk diterapkan pada Zevenet dapat berupa daftar hitam, DoS or RBL.

Daftar semua aturan IPDS

Daftar aturan ipds

Contoh permintaan:

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

GET /ipds

Buat 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, aturannya berlaku untuk pertanian.

IPDS - Daftar Hitam

Daftar hitam memungkinkan pengguna untuk menggunakan daftar untuk menyaring atau mengizinkan lalu lintas sesuai dengan IP sumber (Lalu lintas incomming).

Ada dua jenis daftar:

1. Jarak jauh: Daftar diperoleh dari URL, daftar itu tidak dapat dimodifikasi dan dapat dijadwalkan untuk diunduh.
2. Lokal: Pengguna dapat membuat daftar sendiri dengan kebijakan yang diberikan, menyangkal jika IP incomming cocok maka lalu lintas akan ditolak atau mengizinkan jika IP incomming cocok maka lalu lintas akan diizinkan.

Modul ini termasuk sudah dimuat daftar yang disediakan oleh tim Zevenet, daftar siap diterapkan ke peternakan. Secara tradisional, pengguna dapat membuat daftar pribadi mereka sendiri.

Beberapa daftar dapat diterapkan ke tambak yang sama, jika IP sumber cocok dengan beberapa daftar, lalu lintas akan diizinkan atau ditolak tergantung dari kebijakan daftar hitam. Pada saat IP cocok maka tidak ada lagi cek daftar hitam yang dilakukan untuk IP sumber.

Jika IP sumber ada dalam dua daftar yang berbeda, 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/v3.2/zapi.cgi/ipds/blacklists

GET /ipds/blacklists

Daftar semua daftar hitam yang dibuat oleh pengguna atau dimuat dalam sistem yang dapat diterapkan ke peternakan.

Contoh respons:

{
   "description" : "Get black lists",
   "params" : [
      {
         "farms" : [],
         "name" : "china",
         "policy" : "deny",
         "preload" : "true",
         "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 dari 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/v3.2/zapi.cgi/ipds/blacklists/loc

GET /ipds/blacklists/<name>

Tampilkan parameter konfigurasi dan deskripsi daftar hitam. nama adalah pengidentifikasi unik daftar hitam.

Parameter respons

Contoh daftar respons lokal:

{
   "description" : "Get list loc",
   "params" : {
      "farms" : [],
      "name" : "loc",
      "policy" : "deny",
      "preload" : "false",
      "sources" : [
         {
            "id" : 0,
            "source" : "192.168.0.167"
         },
         {
            "id" : 1,
            "source" : "192.168.0.186"
         }
      ],
      "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 sistem administrator.
status	Tali	Nilai yang mungkin adalah: up, daftar hitam diaktifkan dan memblokir (atau mengizinkan) lalu lintas sumber dari 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 dalam sistem dan dikelola oleh administrator sistem; atau terpencil, daftar diunduh dari url jarak jauh.
sumber	Obyek[]	Daftar IP yang dicek daftar. Format jaringan sumber diterima: Alamat jaringan / Mask sedikit atau IP

Contoh daftar respons jarak jauh:

{
   "description" : "Get list remoteList",
   "params" : {
      "day" : "thursday",
      "farms" : [
         "FarmHttp1",
         "FarmGslb1",
      ],
      "frequency" : "weekly",
      "name" : "remoteList",
      "policy" : "deny",
      "sources" : [
         {
            "id" : 0,
            "source" : "78.12.0.4"
         },
         {
            "id" : 1,
            "source" : "68.100.15.5"
         },
         {
            "id" : 2,
            "source" : "65.12.12.95"
         }
      ],
      "time" : {
         "hour" : 0,
         "minutes" : 0
      },
      "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 sistem administrator.
mengetik	Tali	Di mana daftar disimpan dan siapa yang menyimpannya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan dikelola oleh administrator sistem; atau terpencil, daftar diunduh dari jarak jauh url.
sumber	Obyek[]	Sumber IP yang dicek daftar. Jika daftar adalah mengetik terpencil maka konten daftar tidak ditampilkan sampai unduhan pertama.
memperbaharui status	Tali	Status unduhan terakhir dari daftar dan tanggal pembaruan terakhir yang berhasil di sistem lokal.
url	Tali	Dari mana daftar jarak jauh diunduh. Format jarak jauh harus berupa daftar sumber network / bit mask atau IP per line.
frekuensi	Tali	Frekuensi pembaruan daftar jauh. Opsinya adalah: harian, perbarui semua hari, sekali atau secara berkala, ini ditunjukkan dalam jenis frekuensi bidang; mingguan, perbarui seminggu sekali; atau bulanan, perbarui sebulan sekali.
jenis frekuensi	Tali	Parameter ini melengkapi frekuensi setiap hari saat nilainya harian. Nilai yang mungkin adalah: tepat. tentukan satu jam dalam sehari; atau periode, tentukan periode waktu untuk memperbarui di siang hari.
hari	String atau Angka	Parameter ini melengkapi parameter frekuensi ketika Frecuency Nilai adalah mingguan or bulanan. Jika Frecuency is mingguan parameter ini harus aday of the week (Senin, Selasa, Rabu, Kamis, Jumat, Sabtu or Minggu) jika frekuensi Nilai adalah bulanan maka parameter ini harus berupa hari dalam sebulan (angka di antaranya 1 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 dari 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/v3.2/zapi.cgi/ipds/blacklists

Contoh permintaan untuk daftar jarak jauh:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListRem", "type":"remote", "url":"https://192.168.10.12/lists/test.txt"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists

POST /ipds/blacklists

Buat daftar hitam untuk digunakan di peternakan. Daftar hitam dapat terdiri dari dua jenis:

1. Lokal: Sumber ditambahkan oleh pengguna. Daftar ini disimpan secara lokal.
2. Remote: Sumber diperoleh dari lokasi yang jauh. Lokasi ini ditunjukkan oleh URL. Format daftar jarak jauh yang didukung adalah satu Alamat jaringan / bit Mask or IP baris per baris.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik.	benar
mengetik	Tali	Di mana daftar disimpan dan siapa yang merawatnya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan pemeliharaan untuk sistem administrasi; atau terpencil, daftar diambil dari layanan keluar melalui a url dan layanan administrator akan memelihara daftar.	benar
kebijaksanaan	Tali	Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar. Nilai default ditolak.
url	Tali	Dari mana daftar jarak jauh diunduh. Format jarak jauh harus berupa daftar sumber per baris dalam format Alamat jaringan / bit Mask or IP.	berlaku untuk daftar jarak jauh

{
   "description" : "Post list list1",
   "params" : {
      "farms" : [],
      "name" : "newListLoc",
      "policy" : "deny",
      "preload" : "false",
      "type" : "local"
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array objek daftar hitam, yang masing-masing berisi atribut kunci berikutnya.

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
nama	Tali	Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik.
kebijaksanaan	Tali	Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar.
preload	Tali	Nilai yang mungkin adalah: benar, daftar hitam telah dimuat dalam sistem; atau palsu, daftar hitam telah dibuat untuk administrator sistem.
mengetik	Tali	Di mana daftar disimpan dan siapa yang merawatnya. Nilai-nilainya adalah: lokal, daftar disimpan dalam sistem dan pemeliharaan untuk sistem administrasi; atau terpencil, daftar diambil dari layanan keluar melalui a url dan layanan administrator akan memelihara daftar.

Ubah aturan daftar hitam

Ubah daftar hitam

Minta contoh untuk daftar lokal:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"policy":"allow","source":["78.12.0.4","68.100.15.5","65.12.12.95"]}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/whiteList

PUT /ipds/blacklists/<name>

Ubah konfigurasi aturan daftar hitam. nama adalah pengidentifikasi unik daftar hitam.

Parameter permintaan untuk daftar lokal:

Bidang	Tipe	Deskripsi
nama	Tali	Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik. Hanya itu dimodifikasi pada no preload daftar.
kebijaksanaan	Tali	Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar.
sumber	Tali[]	Ini adalah daftar alamat IP atau segmen bersih yang diperiksa daftar. Untuk mengubah ubah hanya sumber, lihat bagian dokumentasi IPDS> Daftar Hitam> Ubah sumber daftar hitam. Sumber saja dimodifikasi pada no preload daftar.

Contoh respons:

{
   "description" : "Modify list whiteList.",
   "params" : {
      "name" : "whiteList",
      "policy" : "allow",
      "preload" : "false",
      "type" : "local"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Contoh permintaan untuk daftar jarak jauh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"remoteList","url":"http://192.168.10.10/lists/test.txt","policy":"deny","frequency":"daily","frequency_type":"exact","time":{"hour":1,"minutes":0}}' 
https://<zevenet_server>:444/zapi/v3.2/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/v3.2/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/v3.2/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/v3.2/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/v3.2/zapi.cgi/ipds/blacklists/newListRem

Parameter permintaan untuk daftar jarak jauh

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
nama	Tali	Nama daftar hitam. Ini digunakan sebagai pengidentifikasi unik.
kebijaksanaan	Tali	Tindakan untuk diterapkan ke sumber. Opsinya adalah: menyangkal, memblokir lalu lintas input dari sumber daftar; atau mengizinkan terima lalu lintas dari sumber daftar.
url	Tali	Dari mana daftar jarak jauh diunduh.
frekuensi	Tali	Frekuensi pembaruan daftar jauh. Opsinya adalah: harian, perbarui semua hari, sekali atau berkala, ini ditunjukkan dalam jenis frekuensi bidang; mingguan, perbarui seminggu sekali; atau bulanan, perbarui sebulan sekali.
jenis frekuensi	Tali	Parameter ini melengkapi frekuensi setiap hari saat nilainya harian. Nilai yang mungkin adalah: tepat. tentukan satu jam dalam sehari; atau periode, tentukan periode waktu untuk memperbarui di siang hari.
hari	String atau Angka	Parameter ini melengkapi frekuensi ketika nilainya mingguan atau bulanan. Jika mingguan, parameter ini harus satu hari seminggu (Senin, Selasa, Rabu, Kamis, Jumat, Sabtu or Minggu) kalau tidak frekuensi adalah bulanan maka parameter ini harus satu bulan hari (angka di antara 1 serta 31).
waktu	obyek	Ini adalah struct yang bergantung pada bidang frekuensi.

Objek periode waktu

Ini adalah bidang ketika suatu periode waktu akan dikonfigurasi.

Ini adalah konfigurasi yang diperlukan frekuensi dengan nilai harian, dan jenis frekuensi dengan nilai periode.

Bidang	Tipe	Deskripsi
periode	Jumlah	Seberapa sering memperbarui daftar.
satuan	Tali	Unit periode. Opsinya adalah: menit or jam, menunjukkan unit pengukuran untuk pembaruan daftar.

Waktu yang tepat objek jam

Ini adalah bidang ketika waktu jam yang tepat akan dikonfigurasi.

Objek ini digunakan dengan konfigurasi selanjutnya:

frekuensi bidang memiliki nilai harian serta jenis frekuensi is tepat.

frekuensi bidang memiliki nilai mingguan serta hari adalah hari minggu 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

Respons 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/v3.2/zapi.cgi/ipds/blacklists/remoteList

DELETE /ipds/blacklists/<name>

Hapus daftar hitam yang diberikan. nama adalah pengidentifikasi unik daftar hitam.

Contoh respons:

{
   "description" : "Delete list 'remoteList'",
   "message" : "The list remoteList has been deleted successful.",
   "success" : "true"
}

Daftar sumber dari daftar hitam

Daftar sumber dari daftar hitam

Contoh permintaan:

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

GET /ipds/blacklists/<name>/sources

Daftar sumber daftar hitam. nama adalah pengidentifikasi unik daftar hitam.

Contoh respons:

{
   "description" : "Get localList sources",
   "params" : [
      {
         "id" : 0,
         "source" : "78.12.0.4"
      },
      {
         "id" : 1,
         "source" : "68.100.15.5"
      },
      {
         "id" : 2,
         "source" : "65.12.12.95"
      }
   ]
}

Parameter respons

Respons akan menjadi JSON dengan kunci params dan sumber objek array sebagai nilai.

Sumber objek:

Bidang	Tipe	Deskripsi
id	Jumlah	Sumber pengidentifikasi unik dalam daftar.
sumber	Tali[]	Alamat IP atau segmen bersih yang dicek daftar.

Tambahkan sumber ke daftar hitam

Tambahkan sumber ke daftar hitam

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources

POST /ipds/blacklists/<name>/sources

Dorong sumber baru ke daftar hitam. Hanya tersedia untuk daftar lokal dan daftar yang tidak dimuat. nama adalah pengidentifikasi unik daftar hitam.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
sumber	Tali	Alamat IP atau segmen bersih yang dicek daftar.	benar

Contoh respons:

{
   "description" : "Post source to localList.",
   "message" : "Added 192.168.3.1 successful.",
   "params" : [
      {
         "id" : 0,
         "source" : "78.12.0.4"
      },
      {
         "id" : 1,
         "source" : "68.100.15.5"
      },
      {
         "id" : 2,
         "source" : "65.12.12.95"
      },
      {
         "id" : 3,
         "source" : "192.168.3.1"
      }
   ]
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ubah sumber daftar hitam

Ubah sumber daftar hitam

Contoh permintaan:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources/2

PUT /ipds/blacklists/<name>/sources/<id>

Ubah sumber daftar hitam.

nama adalah pengidentifikasi unik daftar hitam. id adalah pengidentifikasi unik sumber.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
sumber	Tali	Alamat IP atau segmen bersih yang dicek daftar.	benar

Contoh respons:

{
   "description" : "Put source into localList",
   "message" : "Source 2 has been modified successful.",
   "params" : {
         "id" : 2,
         "source" : "192.168.3.1"
    }
}

Parameter respons

Respons akan menjadi json dengan sumber diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus sumber daftar hitam

Hapus sumber daftar hitam

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/localList/sources/2

DELETE /ipds/blacklists/<name>/sources/<id>

Hapus sumber dari daftar hitam.

nama adalah pengidentifikasi unik daftar hitam. id adalah pengidentifikasi unik sumber.

Contoh respons:

{
   "description" : "Delete source from the list localList",
   "message" : "Source 2 has been deleted successful.",
   "success" : "true"
}

Terapkan tindakan ke aturan daftar hitam

Terapkan tindakan

Contoh permintaan untuk daftar jarak jauh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"update"}' 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/blacklists/remoteList/actions

POST /ipds/blacklists/<name>/actions

Terapkan tindakan ke daftar hitam. nama adalah pengidentifikasi unik daftar hitam.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan yang diinginkan untuk diterapkan pada aturan daftar hitam. Nilai yang tersedia adalah: awal, itu mengaktifkan blaclist di semua peternakan di mana ia diterapkan; berhenti, ini menghentikan daftar hitam untuk semua pertanian di mana aturan daftar hitam diterapkan, lalu lintas tidak akan diblokir atau diizinkan; memperbarui, tindakan ini hanya dapat diterapkan ke terpencil daftar hitam, tindakan ini memperbarui daftar sumber dari jarak jauh URL.	benar

Contoh respons:

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

Parameter respons

Responsnya akan menjadi json dengan status unduhan. Lihat contoh respons untuk informasi lebih lanjut.

Bidang	Tipe	Deskripsi	Wajib
memperbarui	Tali	Status unduhan terakhir dari daftar dan tanggal pembaruan terakhir yang berhasil.

IPDS - DoS

DoS protection memiliki berbagai jenis aturan, tergantung dari aturan perlindungan, diterapkan untuk bagian penyeimbang yang berbeda. Jadi ada sistem aturan bahwa itu berlaku semua penyeimbang. Aturan berorientasi koneksi, khusus untuk kebun bekerja dengan protokol TCP. Sebelum menerapkan aturan ke a kebun, buat objek dengan konfigurasi yang diinginkan. Selanjutnya, menerapkannya ke semua peternakan yang Anda butuhkan. Itu sistem aturan memiliki objek yang sudah dibuat dan hanya memiliki satu konfigurasi yang memungkinkan. Setelah dikonfigurasi, aktifkan.

Aturan DoS pertanian

Perlu membuat objek sebelum menerapkan aturan ke sebuah peternakan.

limitec

Batas koneksi baru per detik dan sumber. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.
membatasi	Jumlah	Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

limitconns

Batasi total koneksi saat ini per sumber. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.
limit_conns	Jumlah	Ini adalah jumlah maksimal dari koneksi saat ini dari sumber.

bogustcpflags

Periksa protokol TCP dihormati. Aturan ini tidak memiliki parameter konfigurasi sehingga hanya membuat objek yang dapat Anda gunakan di semua tambak. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.

limitrst

Batasi jumlah permintaan koneksi ulang per detik. Hanya tersedia di pertanian yang berfungsi dengan protokol TCP.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.
membatasi	Jumlah	Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

Aturan Sistem DoS

Dalam aturan sistem DoS, objek belum dibuat.

sshbruteforce

Batas koneksi ssh baru.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek. Identifier telah didefinisikan sebagai ssh_brute_force.
hit	Jumlah	Jumlah klik untuk sumber sebelum koneksi diblokir.
waktu	Jumlah	Waktu dalam detik untuk mengatur ulang hit melawan.

Daftar semua jenis aturan DoS

Daftar semua jenis aturan DoS

Contoh permintaan:

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

GET /ipds/dos/rules

Tampilkan daftar aturan DoS. Mereka bukan objek tetapi tipe untuk mendefinisikannya.

Setiap aturan memiliki parameter konfigurasi yang berbeda

Contoh respons:

{
   "description" : "Get DoS settings.",
   "params" : {
      "farm" : [
         {
            "description" : "Connection limit per seconds.",
            "rule" : "limitsec"
         },
         {
            "description" : "Total connections limit per source IP.",
            "rule" : "limitconns"
         },
         {
            "description" : "Check bogus TCP flags.",
            "rule" : "bogustcpflags"
         },
         {
            "description" : "Limit RST request per second.",
            "rule" : "limitrst"
         }
      ],
      "system" : [
         {
            "description" : "SSH brute force.",
            "rule" : "sshbruteforce"
         },
      ]
   }
}

Parameter respons

Respons JSON memiliki dua larik kebun serta sistem. Setiap item array adalah jenis aturan yang diterapkan ke tambak o sistem.

Bidang	Tipe	Deskripsi
deskripsi	Tali	Deskripsi singkat tentang aturan.
memerintah	Tali	ketik aturan pengidentifikasi unik.

Daftar semua aturan DoS

Daftar semua objek DoS

Contoh permintaan:

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

GET /ipds/dos

Tampilkan konfigurasi tentang semua objek DoS yang ada.

Contoh respons:

{
   "description" : "Get DoS settings.",
   "params" : [
      {
         "farms" : [],
         "limit_conns" : 10,
         "name" : "limitConnHttp",
         "rule" : "limitconns",
         "status" : "down",
         "type" : "farm"
      },
      {
         "farms" : [],
         "limit" : 2,
         "limit_burst" : 2,
         "name" : "limitUsers",
         "rule" : "limitsec",
         "status" : "down",
         "type" : "farm"
      },
      {
         "hits" : 5,
         "name" : "ssh_brute_force",
         "port" : 22,
         "rule" : "sshbruteforce",
         "status" : "down",
         "time" : 180,
         "type" : "system"
      },
      {
         "farms" : [],
         "name" : "tcpAuth",
         "rule" : "bogustcpflags",
         "status" : "down",
         "type" : "farm"
      },
      {
         "farms" : [],
         "limit" : 2,
         "limit_burst" : 2,
         "name" : "dos4",
         "rule" : "limitrst",
         "status" : "down",
         "type" : "farm"
      },
   ]
}

Parameter respons

Respons akan berupa array dengan semua objek DoS yang tersedia.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.
memerintah	Tali	Ini adalah pengenal aturan tipe.
mengetik	Tali	Nilai yang mungkin adalah: kebun, aturan tersebut berlaku untuk peternakan; atau sistem, aturannya berlaku untuk sistem.
status	Tali	Nilai yang mungkin adalah: up, aturan DoS diaktifkan dan menyaring lalu lintas; atau turun, aturannya tidak berjalan dan tidak menyaring lalu lintas.

Selain bergantung pada aturan, objek tersebut berisi parameter berikutnya

limitec

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
membatasi	Jumlah	Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

limitconns

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
limit_conns	Jumlah	Ini adalah jumlah maksimal dari koneksi saat ini dari sumber.

bogustcpflags

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.

limitrst

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
membatasi	Jumlah	Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

sshbruteforce

Bidang	Tipe	Deskripsi
hit	Jumlah	Jumlah klik untuk sumber sebelum koneksi diblokir.
waktu	Jumlah	Waktu dalam detik untuk mengatur ulang hit melawan.

Ambil aturan DoS

Ambil aturan DoS

Minta contoh untuk aturan pertanian:

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

Minta contoh untuk aturan sistem:

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

GET /ipds/dos/<name>

Setiap objek DoS dapat memiliki konfigurasi yang berbeda. nama adalah pengidentifikasi unik aturan DoS.

Contoh respons untuk aturan pertanian:

{
   "description" : "Get DoS limitConnHttp settings",
   "params" : {
      "farms" : [],
      "limit_conns" : 10,
      "name" : "limitConnHttp",
      "rule" : "limitconns",
      "status" : "down",
      "type" : "farm"
   }
}

Contoh respons untuk aturan sistem:

{
   "description" : "Get DoS ssh_brute_force settings",
   "params" : {
      "hits" : 5,
      "name" : "ssh_brute_force",
      "port" : 22,
      "rule" : "sshbruteforce",
      "status" : "down",
      "time" : 180,
      "type" : "system"
   }
}

Parameter respons

Respons akan berupa array dengan semua objek DoS yang tersedia.

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.
memerintah	Tali	Ini adalah pengenal aturan tipe.
mengetik	Tali	Nilai yang mungkin adalah: kebun, aturan tersebut berlaku untuk peternakan; atau sistem, aturannya berlaku untuk sistem.
status	Tali	Nilai yang mungkin adalah: up, aturan DoS diaktifkan dan menyaring lalu lintas; atau turun, aturannya tidak berjalan dan tidak menyaring lalu lintas.

Selain bergantung pada aturan, objek tersebut berisi parameter berikutnya

limitec

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
membatasi	Jumlah	Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

limitconns

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
limit_conns	Jumlah	Ini adalah jumlah maksimal dari koneksi saat ini dari sumber.

bogustcpflags

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.

limitrst

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Peternakan tempat aturan diterapkan.
membatasi	Jumlah	Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

sshbruteforce

Bidang	Tipe	Deskripsi
hit	Jumlah	Jumlah klik untuk sumber sebelum koneksi diblokir.
waktu	Jumlah	Waktu dalam detik untuk mengatur ulang hit melawan.

Buat aturan DoS

Buat aturan DoS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"limitUsers", "rule":"limitsec"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos

POST /ipds/dos

Buat objek DoS untuk menggunakannya sebagai peternakan sesuai kebutuhan.

Setiap objek DoS dapat memiliki konfigurasi yang berbeda.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Ini adalah pengidentifikasi unik aturan objek.	benar
memerintah	Tali	Ini adalah pengenal aturan tipe. Opsinya adalah: limitconns, limitec, limitrst or bogustcpflags.	benar

Contoh respons:

{
   "description" : "Post a DoS rule",
   "params" : {
      "farms" : [],
      "limit" : 2,
      "limit_burst" : 2,
      "name" : "limitUsers",
      "rule" : "limitsec",
      "type" : "farm"
   }
}

Parameter respons

Respons akan menjadi json dengan konfigurasi default untuk aturan yang dibuat. Lihat contoh respons untuk informasi lebih lanjut.

Ubah aturan DoS

Ubah aturan DoS

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"hits":"10","status":"up","time":"100"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/ssh_brute_force

PUT /ipds/dos/<name>

Ubah aturan DoS. nama adalah pengidentifikasi unik aturan DoS.

Parameter permintaan

Setiap jenis aturan dapat menjadi parameter yang berbeda. Parameter yang dapat dimodifikasi adalah sebagai berikut:

limitec

Bidang	Tipe	Deskripsi
membatasi	Jumlah	Ini adalah jumlah maksimal koneksi baru per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak koneksi baru yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

limitconns

Bidang	Tipe	Deskripsi
limit_conns	Jumlah	Ini adalah jumlah maksimal dari koneksi saat ini dari sumber.

bogustcpflags

Tidak ada parameter.

limitrst

Bidang	Tipe	Deskripsi
membatasi	Jumlah	Ini adalah jumlah maksimum permintaan reset per detik untuk suatu sumber.
limit_burst	Jumlah	Ini adalah puncak permintaan penyetelan ulang yang diizinkan. Unit burst meregenerasi ketika detik "batas" akan berlalu.

sshbruteforce

Bidang	Tipe	Deskripsi
hit	Jumlah	Jumlah klik untuk sumber sebelum koneksi diblokir.
waktu	Jumlah	Waktu dalam detik untuk mengatur ulang hit melawan.
status	Tali	Nilai yang mungkin adalah: up, aturan DoS diaktifkan dan menyaring lalu lintas; atau turun, aturannya tidak berjalan dan tidak menyaring lalu lintas.

Contoh respons:

{
   "description" : "Put DoS rule settings",
   "params" : {
      "hits" : 10,
      "name" : "ssh_brute_force",
      "port" : 22,
      "rule" : "sshbruteforce",
      "status" : "up",
      "time" : 100,
      "type" : "system"
   },
   "success" : "true"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Hapus aturan DoS

Hapus aturan DoS

Contoh permintaan:

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

DELETE /ipds/dos/<name>

Aturan sistem tidak bisa dihapus. Untuk menonaktifkannya, masukkan status ke turun. nama adalah pengidentifikasi unik aturan DoS.

Contoh respons:

{
   "description" : "Delete DoS rule",
   "message" : "Deleted limitConnHttp successful.",
   "success" : "true"
}

Terapkan tindakan ke aturan DoS

Terapkan tindakan

Contoh permintaan untuk daftar jarak jauh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"start"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/dos/conns_maximum/actions

POST /ipds/dos/<name>/actions

Terapkan tindakan pada aturan dos. nama adalah aturan pengidentifikasi unik dos.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan yang diinginkan untuk diterapkan pada aturan DoS. Nilai yang tersedia adalah: awal, itu mengaktifkan aturan DoS di semua peternakan di mana ia diterapkan; berhenti, itu menonaktifkan DoS untuk semua pertanian di mana aturan DoS diterapkan, lalu lintas tidak akan diblokir atau diizinkan.	benar

Contoh respons:

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

Parameter respons

Jika tidak ada masalah dalam konfigurasi maka zapi akan mengembalikan tindakan yang diminta.

IPDS - RBL

RBL, Daftar lubang hitam waktu nyata memungkinkan membuat pendelegasian sistem keamanan, tugas membosankan pemeliharaan sistem keamanan yang diperbarui, ke speclialist. RBL memeriksa lalu lintas input penyeimbang beban dalam database eksternal melalui protokol DNS. Pemilik server DNS bertanggung jawab memperbarui dan menyediakan sumber yang berkualitas. Lalu lintas input dari sumber IP yang ada di database DNS akan dihapus.

Untuk bekerja dengan layanan RBL, domain DNS pertama akan ditambahkan, setiap domain DNS berisi daftar penyedia khusus yang mengurutkan sumber untuk kriteria yang berbeda sebagai jenis serangan yang disadari atau tingkat keparahan serangan.

Setelah domain DNS dibuat, perlu untuk membuat aturan RBL dengan konfigurasi aturan. Kemudian menghubungkan domain DNS dengan aturan RBL. Setiap aturan dapat memeriksa domain yang berbeda.

Terakhir berlaku aturan RBL untuk semua peternakan yang diinginkan.

Daftar semua aturan RBL

Daftar semua aturan RBL

Contoh permintaan:

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

GET /ipds/rbl

Daftar semua aturan RBL yang tersedia di penyeimbang beban.

Contoh respons:

{
   "description" : "Get RBL rules",
   "params" : [
      {
         "cache_size" : 8192,
         "cache_time" : 3600,
         "domains" : [
            "ssh.rbl.zevenet.com",
            "ssh.blocklist.de"
         ],
         "farms" : [
            "sshL4farm"
         ],
         "local_traffic" : "false",
         "log_level" : 4,
         "name" : "protection_ssh",
         "only_logging" : "true",
         "queue_size" : 64538,
         "status" : "down",
         "threadmax" : 700
      },
      {
         "cache_size" : 2048,
         "cache_time" : 7200,
         "domains" : [],
         "farms" : [],
         "local_traffic" : "true",
         "log_level" : 4,
         "name" : "sip",
         "only_logging" : "true",

         "queue_size" : 32269,
         "status" : "down",
         "threadmax" : 400
      },
      {
         "cache_size" : 8192,
         "cache_time" : 3600,
         "domains" : [],
         "farms" : [
            "webAPP"
         ],
         "local_traffic" : "false",
         "log_level" : 4,
         "name" : "web_attacks",
         "only_logging" : "true",
         "queue_size" : 64538,
         "status" : "down",
         "threadmax" : 700
      }
   ]
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi larik objek RBL, yang masing-masing berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
domain	Tali[]	Ini adalah daftar dengan semua domain yang diminta oleh aturan.
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
status	Tali	Tampilkan status aturan RBL. Nilainya bisa turun, jika aturannya tidak berfungsi; atau up itu aturannya berfungsi.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Ambil aturan RBL

Ambil aturan RBL

Contoh permintaan:

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

GET /ipds/rbl/<name>

Tampilkan konfigurasi RBL dan parameter deskripsinya. nama adalah pengidentifikasi unik aturan RBL.

Parameter respons

Contoh respons:

{
   "description" : "Get RBL protection_ssh",
   "params" : {
      "cache_size" : 8192,
      "cache_time" : 3600,
      "domains" : [
         "ssh.zevenet.com",
         "ssh.blocklist.de"
      ],
      "farms" : [
        "sshL4farm"
      ],
      "local_traffic" : "false",
      "log_level" : 4,
      "name" : "protection_ssh",
      "only_logging" : "true",
      "queue_size" : 64538,
      "status" : "down",
      "threadmax" : 700
   }
}

Objek aturan RBL:

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
domain	Tali[]	Ini adalah daftar dengan semua domain yang diminta oleh aturan.
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
status	Tali	Tampilkan status aturan RBL. Nilainya bisa turun, jika aturannya tidak berfungsi; atau up itu aturannya berfungsi.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Buat aturan RBL

Buat aturan RBL baru

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"all"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl

POST /ipds/rbl

Buat aturan RBL untuk digunakan di peternakan.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.	benar

{
   "description" : "Create a RBL rule.",
   "params" : {
      "cache_size" : 8192,
      "cache_time" : 3600,
      "domains" : [],
      "farms" : [],
      "local_traffic" : "false",
      "log_level" : 4,
      "name" : "all",
      "only_logging" : "true",
      "queue_size" : 64538,
      "status" : "down",
      "threadmax" : 700
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek RBL, yang masing-masing berisi atribut kunci berikutnya.

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
domain	Tali[]	Ini adalah daftar dengan semua domain yang diminta oleh aturan.
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
status	Tali	Tampilkan status aturan RBL. Nilainya bisa turun, jika aturannya tidak berfungsi; atau up itu aturannya berfungsi.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Ubah aturan RBL

Ubah aturan RBL

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"all_reported","cache_size":16384, "cache_time":180000, "queue_size":32269, "threadmax":500, "local_traffic":"true", "log_level":4, "only_logging":"true"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/all

PUT /ipds/rule/<name>

Ubah konfigurasi aturan RBL. nama adalah pengidentifikasi unik aturan RBL.

Parameter permintaan:

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Contoh respons:

{
   "description" : "Modify RBL rule all.",
   "params" : {
      "cache_size" : 16384,
      "cache_time" : 180000,
      "domains" : [],
      "farms" : [],
      "local_traffic" : "true",
      "log_level" : 4,
      "name" : "all",
      "only_logging" : "true",
      "queue_size" : 32269,
      "status" : "down",
      "threadmax" : 500
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek RBL, yang masing-masing berisi atribut kunci berikutnya.

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
domain	Tali[]	Ini adalah daftar dengan semua domain yang diminta oleh aturan.
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
status	Tali	Tampilkan status aturan RBL. Nilainya bisa turun, jika aturannya tidak berfungsi; atau up itu aturannya berfungsi.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Salin aturan RBL

Salin aturan RBL

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"copied_rule"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/all_reported

POST /ipds/rule/<name>

Salin aturan RBL untuk membuat aturan baru. nama adalah pengidentifikasi unik aturan RBL.

Parameter permintaan:

Bidang	Tipe	Deskripsi	wajib
nama	Tali	Nama aturan RBL untuk aturan baru. Ini digunakan sebagai pengidentifikasi unik.	benar

Contoh respons:

{
   "description" : "Copy a RBL rule.",
   "params" : {
      "cache_size" : 16384,
      "cache_time" : 180000,
      "domains" : [],
      "farms" : [],
      "local_traffic" : "true",
      "log_level" : 4,
      "name" : "copied_rule",
      "only_logging" : "true",
      "queue_size" : 32269,
      "status" : "down",
      "threadmax" : 500
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array objek RBL, yang masing-masing berisi atribut kunci berikutnya.

Bidang	Tipe	Deskripsi
cache_size	Jumlah	Ini adalah jumlah sumber IP yang dapat disimpan oleh aturan RBL.
cache_time	Jumlah	Ini adalah waktu (dalam detik) bahwa sumber IP akan diblokir.
domain	Tali[]	Ini adalah daftar dengan semua domain yang diminta oleh aturan.
peternakan	Tali[]	Daftar tambak tempat daftar hitam diterapkan.
local_traffic	Tali	Jika bidang ini memiliki nilai benar, aturan RBL akan memeriksa lalu lintas dari segmen jaringan pribadi; atau jika nilainya palsu aturan RBL akan mengabaikan lalu lintas dari segmen jaringan pribadi. Lalu lintas lokal tidak akan pernah diblokir oleh DNS publik.
log_level	Jumlah	Ini adalah tingkat keparahan log. Itu dapat memiliki nilai antara 0 dan 7, menjadi 0 darurat dan 7 debug.
nama	Tali	Nama aturan RBL. Ini digunakan sebagai pengidentifikasi unik.
only_logging	Tali	Jika nilainya benar, ketika IP cocok dengan domain, itu akan dicatat; atau jika bidang ini memiliki nilai palsu, ketika IP cocok dengan domain, IP akan dicatat dan paket akan dijatuhkan.
ukuran queue_size	Jumlah	Ini adalah jumlah paket yang dapat disimpan oleh aturan dalam antrian.
status	Tali	Tampilkan status aturan RBL. Nilainya bisa turun, jika aturannya tidak berfungsi; atau up itu aturannya berfungsi.
threadmax	Tali	Ini adalah jumlah paket yang aturan dapat kueri secara bersamaan ke server DNS. Nilai maksimumnya adalah 700. Ketika jumlah paket input lebih besar dari threadmax, paket selanjutnya akan diterima secara otomatis.

Hapus aturan RBL

Hapus RBL

Contoh permintaan:

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

DELETE /ipds/rbl/<name>

Hapus aturan RBL yang diberikan. nama adalah pengidentifikasi unik aturan RBL.

Contoh respons:

{
   "description" : "Delete RBL 'sip'",
   "message" : "The rule sip has been deleted successful.",
   "success" : "true"
}

Daftar semua domain RBL

Daftar semua domain RBL

Contoh permintaan:

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

GET /ipds/rbl/domains

Daftar semua domain yang tersedia untuk ditautkan dengan aturan RBL.

Contoh respons:

{
   "description" : "Get RBL domains",
   "params" : {
      "preloaded" : [
         {
            "domain" : "all.rbl.zevenet.com",
            "id" : 0
         },
         {
            "domain" : "ssh.rbl.zevenet.com",
            "id" : 1
         },
         {
            "domain" : "sip.rbl.zevenet.com",
            "id" : 2
         }
      ],
      "user" : [
         {
            "domain" : "zen.spamhaus.org",
            "id" : 0
         },
         {
            "domain" : "web.dnsbl.sorbs.net",
            "id" : 1
         }
      ]
   }
}

Parameter respons

Respons akan menjadi JSON dengan kunci params dan dua jenis daftar domain sebagai nilai.

Sumber objek:

Bidang	Tipe	Deskripsi
sudah dimuat	Obyek[]	Ini adalah daftar dengan domain yang ditambahkan oleh tim Zevenet.
pemakai	Obyek[]	Ini adalah daftar dengan domain yang ditambahkan oleh administrator penyeimbang beban.

preloaded dan objek pengguna:

Bidang	Tipe	Deskripsi
id	Jumlah[]	Ini adalah id yang mengidentifikasi domain.
domain	Tali[]	Ini adalah domain tempat aturan rbl melakukan kueri.

Tambahkan domain

Tambahkan domain

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"domain":"web.dnsbl.sorbs.net"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains

POST /ipds/rbl/domains

Tambahkan domain baru ke daftar domain pengguna.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
domain	Tali	Ini adalah zona penyedia RBL di mana aturan RBL akan melakukan kueri.	benar

Contoh respons:

{
   "description" : "Post a RBL domain.",
   "message" : "",
   "params" : {
      "domains" : [
         "zen.spamhaus.org",
         "sip.blocklist.de",
         "web.dnsbl.sorbs.net"
      ]
   }
}

Parameter respons

Respons akan menjadi json dengan daftar semua domain yang ditambahkan oleh administrator penyeimbang beban.

Bidang	Tipe	Deskripsi
domain	Tali[]	Ini adalah daftar dengan domain yang ditambahkan oleh administrator penyeimbang beban.

Ubah domain

Ubah domain

Contoh permintaan:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"domain":"ssh.blocklist.de"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains/2

PUT /ipds/rbl/domains/<id>

Ubah domain atau daftar domain pengguna oleh orang lain yang dikirim sebagai parameter.

id adalah pengidentifikasi pengguna domain.

Parameter permintaan

Bidang	Tipe	Deskripsi
domain	Tali	Ini adalah domain yang menggantikan domain yang dikirim dalam URI.

Contoh respons:

{
   "description" : "Replace a domain",
   "message" : "RBL domain ssh.blocklist.de has been modified successful.",
   "params" : {
      "domains" : [
         {
            "domain" : "zen.spamhaus.org",
            "id" : 0
         },
         {
            "domain" : "web.dnsbl.sorbs.net",
            "id" : 1
         },
         {
            "domain" : "ssh.blocklist.de",
            "id" : 2
         }
      ]

   }
}

Parameter respons

Respons akan menjadi json dengan daftar semua domain yang ditambahkan oleh administrator penyeimbang beban.

Objek domain pengguna:

Bidang	Tipe	Deskripsi
id	Jumlah[]	Ini adalah id yang mengidentifikasi domain.
domain	Tali[]	Ini adalah domain tempat aturan rbl melakukan kueri.

Hapus domain

Hapus domain

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/domains/1

DELETE /ipds/rbl/domains/<id>

Hapus domain dari daftar domain pengguna.

id adalah pengidentifikasi pengguna domain yang akan dihapus.

Contoh respons:

{
   "description" : "Delete a RBL domain.",
   "message" : "RBL domain web.dnsbl.sorbs.net has been deleted successful.",
   "success" : "true"
}

Terapkan tindakan dalam aturan RBL

Terapkan tindakan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/ipds/rbl/<name>/action

POST /ipds/rbl/<name>/actions

Terapkan tindakan ke aturan RBL, lihat tabel Parameter permintaan untuk tindakan. Untuk menerapkan suatu tindakan pada suatu aturan, perlu bahwa aturan tersebut diterapkan setidaknya untuk satu tambak dan harus memiliki setidaknya domain yang diaktifkan.

nama adalah pengidentifikasi unik aturan RBL.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Terapkan tindakan yang diinginkan. Tindakannya adalah: berhenti, aturan RBL akan dihentikan dan lalu lintas meneruskan tambak tempat penerapannya aturan tidak akan dibatalkan. awal, aturan RBL akan dimulai dan semua lalu lintas ke depan tambak tempat aturan ini diterapkan akan dibatalkan.

Contoh respons:

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

Parameter respons

Jika tidak ada masalah dalam konfigurasi maka zapi akan mengembalikan tindakan yang diminta.

System

Opsi sistem menawarkan kepada Anda kemungkinan untuk mempersonalisasikan layanan yang berjalan di balancer dan parameter global.

Tampilkan versi

Tampilkan versi

Contoh permintaan:

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

GET /system/version

Tampilkan informacion tentang versi produk.

Contoh respons:

{
   "description" : "Get version",
   "params" : {
      "appliance_version" : "ZVA 4100, hypervisor: xen",
      "hostname" : "DEV5",
      "kernel_version" : "3.16.7-ckt20",
      "system_date" : "Thu Feb  2 10:34:27 2017",
      "zevenet_version" : "5.0"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
appliance_version	Tali	Versi aplikasi Tunjukkan juga hypervisor jika merupakan mesin virtual.
hostname	Tali	Nama host
kernel_version	Tali	Versi kernel Linux.
system_date	Tali	Tanggal sistem.
zevenet_version	Tali	Versi Zevenet.

Tampilkan DNS

Tampilkan DNS

Contoh permintaan:

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

GET /system/dns

Tampilkan konfigurasi layanan DNS.

Contoh respons:

{
   "description" : "Get dns",
   "params" : {
      "primary" : "8.8.8.8",
      "secondary" : null
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
primer	Tali	DNS primer dikonfigurasi dalam sistem.
sekunder	Tali	DNS sekunder dikonfigurasi dalam sistem.

Ubah DNS

Ubah DNS

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/dns

POST /system/dns

Ubah konfigurasi layanan DNS.

Parameter permintaan

Bidang	Tipe	Deskripsi
primer	Tali	DNS primer dikonfigurasi dalam sistem.
sekunder	Tali	DNS sekunder dikonfigurasi dalam sistem.

Contoh respons:

{
   "description" : "Post dns",
   "params" : {
      "primary" : "8.8.4.4",
      "secondary" : "8.8.8.8"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tampilkan SSH

Tampilkan SSH

Contoh permintaan:

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

GET /system/ssh

Tampilkan konfigurasi layanan SSH.

Contoh respons:

{
   "description" : "Get ssh",
   "params" : {
      "listen" : "*",
      "port" : "22"
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
mendengarkan	Tali	IP sistem tempat layanan SSH mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi.
pelabuhan	Tali	Port dikonfigurasikan untuk layanan SSH.

Ubah SSH

Ubah SSH

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"listen":"192.168.100.241","port":"22"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/ssh

POST /system/ssh

Ubah konfigurasi layanan SSH.

Parameter permintaan

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
mendengarkan	Tali	IP sistem tempat layanan SSH mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi.
pelabuhan	Tali	Port dikonfigurasikan untuk layanan SSH.

Contoh respons:

{
   "description" : "Post ssh",
   "params" : {
      "listen" : "192.168.100.241",
      "port" : "22"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tampilkan SNMP

Tampilkan SNMP

Contoh permintaan:

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

GET /system/snmp

Tampilkan konfigurasi layanan SNMP.

Contoh respons:

{
   "description" : "Get snmp",
   "params" : {
      "community" : "public",
      "ip" : "*",
      "port" : "161",
      "scope" : "0.0.0.0/0",
      "status" : "false"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
masyarakat	Tali	Nama komunitas. Baca Hanya Komunitas yang digunakan.
ip	Tali	IP antarmuka tempat layanan SNMP berjalan. Aman untuk mengaktifkan semua antarmuka menggunakan karakter *.
pelabuhan	Tali	Port tempat layanan SNMP berjalan.
cakupan	Tali	IP atau subnet dengan akses (IP / bit). IP klien yang diizinkan mengakses layanan SNMPD, jika Anda ingin mengizinkan hanya satu IP, gunakan bit “/ 32”.
status	Tali	Status layanan SNMP. Nilai yang mungkin adalah: benar, layanan sedang berjalan; atau palsu, layanan dihentikan.

Ubah SNMP

Ubah SNMP

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/snmp

POST /system/snmp

Ubah konfigurasi layanan SNMP.

Parameter permintaan

Bidang	Tipe	Deskripsi
masyarakat	Tali	Nama komunitas. Baca Hanya Komunitas yang digunakan.
ip	Tali	IP antarmuka tempat layanan SNMP berjalan. Aman untuk mengaktifkan semua antarmuka menggunakan karakter *.
pelabuhan	Tali	Port tempat layanan SNMP berjalan.
cakupan	Tali	IP atau subnet dengan akses (IP / bit). IP klien yang diizinkan mengakses layanan SNMPD, jika Anda ingin mengizinkan hanya satu IP, gunakan bit “/ 32”.
status	Tali	Status layanan SNMP. Nilai yang mungkin adalah: benar, layanan sedang berjalan; atau palsu, layanan dihentikan.

Contoh respons:

{
   "description" : "Post snmp",
   "params" : {
      "community" : "public",
      "ip" : "192.168.100.241",
      "port" : "170",
      "scope" : "0.0.0.0/0",
      "status" : "true"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ambil lisensi

Ambil lisensi

Contoh permintaan:

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

GET /system/license/<format>

Tunjukkan lisensi Zevenet dalam format. Tersedia format nilai adalah html or txt.

Tampilkan NTP

Tampilkan NTP

Contoh permintaan:

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

GET /system/ntp

Tampilkan konfigurasi layanan NTP.

Contoh respons:

{
   "description" : "Get ntp",
   "params" : {
      "server" : "pool.ntp.org"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
Server	Tali	Server tempat klien NTP melakukan permintaan.

Ubah NTP

Ubah NTP

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"server":"pool.ntp.org"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/ntp

POST /system/ntp

Ubah konfigurasi layanan NTP.

Parameter permintaan

Bidang	Tipe	Deskripsi
Server	Tali	Server tempat klien NTP melakukan permintaan.

Contoh respons:

{
   "description" : "Post ntp",
   "params" : "pool.ntp.org"
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Tampilkan server HTTP

Tampilkan server HTTP

Contoh permintaan:

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

GET /system/http

Tampilkan konfigurasi layanan HTTP. Di sinilah Zevenet API dan GUI berjalan.

Contoh respons:

{
   "description" : "Get http",
   "params" : {
      "ip" : "*",
      "port" : "444"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan parameter di bawah ini.

Bidang	Tipe	Deskripsi
ip	Tali	IP tempat server HTTP mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi.
pelabuhan	Tali	Port tempat layanan HTTP mendengarkan.

Ubah server HTTP

Ubah server HTTP

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"80"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/http

POST /system/http

Ubah konfigurasi layanan HTTP.

Parameter permintaan

Bidang	Tipe	Deskripsi
ip	Tali	IP tempat server HTTP mendengarkan. Itu karakter * digunakan untuk mendengarkan semua IP yang dikonfigurasi.
pelabuhan	Tali	Port tempat layanan HTTP mendengarkan.

Contoh respons:

{
   "description" : "Post http",
   "params" : {
      "ip" : "192.168.100.241",
      "port" : "80"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ambil pengguna saat ini

Ambil pengguna saat ini

Contoh permintaan:

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

GET /system/users

Tampilkan informasi tentang pengguna saat ini. Pengguna saat ini adalah pengguna dapatkan dari ZAPI_KEY atau pengguna yang login oleh webgui

Contoh respons:

{
   "description" : "Retrieve the user root",
   "params" : {
      "user" : "root",
      "zapi_permissions" : "true"
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan array parameter di bawah ini.

Bidang	Tipe	Deskripsi
pemakai	Tali	Ini adalah pemilik pengguna ZAPI_KEY. Ini bisa menjadi pengguna default root atau pengguna RBAC.
zapi_permissions	Tali	Jika nilainya benar, pengguna dapat menggunakan api Zevenet menggunakan zapikey pengguna; atau jika nilainya palsu, pengguna telah menonaktifkan untuk menggunakan zapi.

Ubah pengguna saat ini

Ubah pengguna saat ini

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"password":"CDe0c3ck","newpassword":"v2mfcvv2","zapi_permissions":"false","zapikey":"vCeH60mQFf2MgH5"}'

https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/users

POST /system/users

Ubah konfigurasi pengguna saat ini. Pengguna saat ini adalah pengguna dapatkan dari ZAPI_KEY atau pengguna yang login oleh webgui.

Parameter permintaan:

Bidang	Tipe	Deskripsi	Wajib
zapikey	Tali	Setiap pengguna dapat memiliki zapikey. Dengan zapikey ini pengguna dapat melakukan tindakan melalui zapikey dengan izin peran pengguna.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.
kata sandi baru	Tali	Kata sandi pengguna baru untuk diakses melalui web gui.
kata sandi	Tali	Kata sandi pengguna saat ini.	Diperlukan saat kata sandi baru terkirim.

Contoh respons:

{
   "description" : "Modify the user Shadi",
   "message" : "Settings was changed successful."
}

Daftar file-file log

Daftar file-file log

Contoh permintaan:

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

GET /system/logs

Buat daftar file log yang tersedia.

Contoh respons:

{
   "description" : "Get logs",
   "params" : [
      {
         "date" : "Mon Jan 30 06:25:02 2017",
         "file" : "syslog.4.gz"
      },
      {
         "date" : "Tue Jan 31 06:25:03 2017",
         "file" : "syslog.3.gz"
      },
      {
         "date" : "Wed Feb  1 06:25:04 2017",
         "file" : "syslog.2.gz"
      },
      {
         "date" : "Thu Feb  2 06:25:03 2017",
         "file" : "syslog.1"
      },
      {
         "date" : "Sun Jan 29 06:25:03 2017",
         "file" : "syslog.5.gz"
      },
      {
         "date" : "Fri Feb  3 04:28:56 2017",
         "file" : "syslog"
      }
   ]
}

Parameter respons

Responsnya akan menjadi JSON dengan array file log. Parameter dari setiap objek adalah:

Bidang	Tipe	Deskripsi
tanggal	Tali	Tanggal modifikasi file terakhir.
fillet	Tali	Nama file file log. Ini digunakan sebagai pengidentifikasi unik log.

Tampilkan baris file log

Tampilkan baris file log

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/logs/kern.log/lines/2

GET /system/logs/<file>/lines/<lines>

Daftar sejumlah baris file log. Param URI fillet adalah file log dari membaca. Garis adalah jumlah baris untuk ditampilkan dari final.

Contoh respons:

{
   "description" : "Show a log file",
   "log" : [
      "Aug 28 09:44:00 maq2 kernel: [258451.740173] Netfilter messages via NETLINK v0.30.\n",
      "Aug 28 09:44:00 maq2 kernel: [258451.775666] ctnetlink v0.93: registering with nfnetlink.\n"
   ]
}

Parameter respons

Responsnya akan menjadi JSON dengan array file log. Kuncinya adalah log dan nilainya adalah array dengan jumlah baris yang diminta.

Unduh file log

Unduh file log

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/logs/syslog.2.gz > log.gz

GET /system/logs/<file>

Unduh file log dari file log yang tersedia yang terdaftar saat MENDAPATKAN permintaan.

fillet adalah pengidentifikasi unik file log.

Sistem - Cadangan

Dengan opsi Cadangan, Anda dapat menyimpan konfigurasi sistem saat ini dan mengunduhnya.

Di bagian ini, Anda dapat membuat, memulihkan, mengunggah, dan mengunduh file cadangan.

Buat daftar cadangan

Buat daftar cadangan

Contoh permintaan:

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

GET /system/backup

Contoh respons:

{
   "description" : "Get backups",
   "params" : [
      {
         "date" : "Fri Feb  3 06:01:04 2017",
         "name" : "newbackup"
      },
      {
         "date" : "Fri Feb  3 05:50:48 2017",
         "name" : "firstConf"
      }
   ]
}

Parameter respons

Responsnya akan menjadi JSON dengan berbagai cadangan. Parameter dari setiap elemen array adalah:

Bidang	Tipe	Deskripsi
tanggal	Tali	Tanggal modifikasi terakhir.
nama	Tali	Ini adalah nama file yang digunakan sebagai pengidentifikasi unik. Ekstensi file adalah .tar.gz.

Buat cadangan

Buat cadangan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"name":"firstConf"}'
 https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/backup

POST /system/backup

Buat cadangan konfigurasi sistem dari konfigurasi saat ini.

Parameter permintaan

Bidang	Tipe	Deskripsi
nama	Tali	Ini adalah nama file yang digunakan sebagai pengidentifikasi unik. Ekstensi file adalah .tar.gz.

Contoh respons:

{
   "description" : "Create a backups",
   "message" : "Backup firstConf was created successful.",
   "params" : "firstConf"
}

Unduh cadangan

Unduh cadangan

Contoh permintaan:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz

File cadangan dalam format TAR GZ.

GET /system/backup/<name>

Unduh cadangan konfigurasi sistem. nama adalah pengidentifikasi unik cadangan.

Unggah cadangan

Unggah cadangan

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: text/plain'
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/backup/newbackup

PUT /system/backup/<name>

Unggah cadangan tersimpan lokal ke Zevenet. nama adalah pengidentifikasi unik cadangan yang akan disimpan di Zevenet.

Parameter permintaan

Anda perlu menggunakan –data-binary untuk mengupload cadangan.

Contoh respons:

{
   "description" : "Upload a backup",
   "message" : "Backup newbackup was created successful.",
   "params" : "newbackup"
}

Hapus cadangan

Hapus cadangan

Contoh permintaan:

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

DELETE /system/backup/<name>

Hapus file cadangan dari sistem Zevenet. nama adalah pengidentifikasi unik cadangan.

Contoh respons:

{
   "description" : "Delete backup firstConf'",
   "message" : "The list firstConf has been deleted successful.",
   "success" : "true"
}

Terapkan cadangan

Terapkan cadangan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"apply"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/backup/firstConf/actions

POST /system/backup/<name>/actions

Kembalikan konfigurasi dari file cadangan. nama adalah pengidentifikasi unik cadangan.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Untuk mengembalikan konfigurasi cadangan, nilainya harus menerapkan.

Contoh respons:

{
   "description" : "Apply a backup to the system",
   "params" : {
      "action" : "apply"
   }
}

Sistem - Pemberitahuan

Notifikasi dibentuk oleh dua elemen: Pengirim metode dan jenis waspada.

Di bagian lansiran Anda akan dapat memilih jenis lansiran yang ingin Anda terima. Sebenarnya, lansiran fokus pada status backend atau klaster, sehingga penyeimbang akan mengirim pemberitahuan jika ada yang beralih.

Di bagian metode Anda akan dapat memilih pengirim mana yang akan digunakan ketika Zevenet harus mengirim pemberitahuan.

Tampilkan status peringatan

Tampilkan status peringatan

Contoh permintaan:

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

GET /system/notifications/alerts

Daftar semua jenis peringatan dengan statusnya.

Contoh respons:

{
   "description" : "Get notifications alert status",
   "params" : [
      {
         "alert" : "backends",
         "status" : "disabled"
      },
      {
         "alert" : "cluster",
         "status" : "disabled"
      }
   ]
}

Parameter respons

Bidang	Tipe	Deskripsi
waspada	Tali	Jenis lansiran, digunakan sebagai pengenal unik lansiran. Lansiran yang tersedia adalah: backend, beri tahu ketika backend perubahan status; atau kelompok, kirim pemberitahuan ketika simpul master klaster beralih ke simpul lain.
status	Tali	Tunjukkan jika peringatan cacat, sistem tidak mengirimkan notifikasi saat ada acara; atau diaktifkan, sistem mengirimkan peringatan ketika terdeteksi perubahan status.

Ambil lansiran pemberitahuan

Ambil lansiran pemberitahuan

Contoh permintaan:

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

GET /system/notifications/alerts/<alert>

Tampilkan konfigurasi tentang jenis peringatan.

waspada adalah pengidentifikasi unik lansiran.

Contoh respons:

{
   "description" : "Get notifications alert backends settings",
   "params" : {
      "avoidflappingtime" : 5,
      "prefix" : "",
      "status" : "disabled"
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
hindari waktu flapping	Jumlah	Kadang-kadang backend tersedia atau tidak dalam waktu singkat, bidang ini memungkinkan untuk mengkonfigurasi periode waktu untuk menghindari pesan notifikasi sementara backend berubah status, setelah periode waktu ini berakhir, jika status backend itu berbeda untuk memulai, maka pemberitahuan dikirim.
awalan	Tali	Ini adalah awalan untuk subjek email, yang dikirim oleh sistem untuk jenis peringatan ini.
status	Tali	Tunjukkan jika peringatan cacat, sistem tidak mengirimkan notifikasi saat ada acara; atau diaktifkan, sistem mengirimkan peringatan ketika terdeteksi perubahan status.

Ubah lansiran pemberitahuan

Ubah pemberitahuan pemberitahuan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"avoidflappingtime":10,"prefix":"[backend alert]"}
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts/backends

POST /system/notifications/alerts/<alert>

waspada adalah pengidentifikasi unik lansiran.

Parameter permintaan

Bidang	Tipe	Deskripsi
hindari waktu flapping	Jumlah	Kadang-kadang backend tersedia atau tidak dalam waktu singkat, bidang ini memungkinkan untuk mengkonfigurasi periode waktu untuk menghindari pesan notifikasi sementara backend berubah status, setelah periode waktu ini berakhir, jika status backend itu berbeda untuk memulai, maka pemberitahuan dikirim. Parameter ini tidak ada dalam peringatan cluster, cluster memiliki waktu swich sendiri.
awalan	Tali	Ini adalah awalan untuk subjek email, yang dikirim oleh sistem untuk jenis peringatan ini.

Contoh respons:

{
   "description" : "Set notifications alert backends",
   "params" : {
      "avoidflappingtime" : 10,
      "prefix" : "[backend alert]"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Aktifkan lansiran

Aktifkan lansiran

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"action":"enable"}
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/alerts/backends/actions

POST /system/notifications/alerts/<alert>/actions

Mengaktifkan atau menonaktifkan notifikasi untuk jenis peringatan.

waspada adalah pengidentifikasi unik lansiran.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Tindakan yang tersedia untuk peringatan adalah menonaktifkan, sistem tidak mengirimkan notifikasi saat ada acara; atau aktif, sistem mengirimkan peringatan ketika terdeteksi perubahan status.

Contoh respons:

{
   "description" : "Set notifications alert backends actions",
   "params" : {
      "action" : "enable"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Ambil konfigurasi email

Ambil konfigurasi email

Contoh permintaan:

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

GET /system/notifications/methods/email

Tampilkan semua konfigurasi pengirim email.

Catatan: Port SMTP yang digunakan untuk mengirim email adalah TCP 25 bahkan jika TLS diaktifkan.

Contoh respons:

{
   "description" : "Get notifications email methods",
   "params" : {
      "from" : "user@zevenet.com",
      "method" : "email",
      "password" : "******",
      "server" : "smtp.gmail.com",
      "tls" : "true",
      "to" : "adminuser@zevenet.net",
      "user" : "user@zevenet.com"
   }
}

Parameter respons

Bidang	Tipe	Deskripsi
dari	Tali	Akun email yang mengirim email, akun ini akan muncul di header SMTP Dari: dan itu akan digunakan jika penerima membalas email.
metode	Tali	Ini adalah metode pengidentifikasi unik. Sebenarnya metode yang tersedia adalah e-mail.
kata sandi	Tali	Kata sandi untuk pemakai Akun SMTP, kata sandi ini diperlukan jika Server memerlukan otentikasi SMTP.
Server	Tali	Server SMTP melalui email dikirim.
tls	Tali	Aktifkan validasi TLS untuk mengirim email, properti ini menggunakan STARTTLS dan fitur ini harus didukung di server SMTP. Beberapa server SMTP harus mengaktifkannya. Nilai yang mungkin adalah: benar, Validasi TLS diaktifkan untuk mengirim email; atau palsu, mengirim email tidak menggunakan validasi TLS.
untuk	Tali	Akun email yang menerima email, akun ini akan muncul di header SMTP Ke.
pemakai	Tali	Akun email diperbolehkan mengirim email, akun ini diperlukan jika server memerlukan otentikasi SMTP.

Ubah konfigurasi email

Ubah konfigurasi email

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json'  -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"from":"user@zevenet.com","password":"verystrongpass","server":"smtp.gmail.com","to":"adminuser@zevenet.net","tls":"true","user":"user@zevenet.com"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/methods/email

POST /system/notifications/methods/email

Ubah konfigurasi metode pengirim email.

Parameter permintaan

Bidang	Tipe	Deskripsi
dari	Tali	Akun email yang mengirim email, akun ini akan muncul di header SMTP Dari: dan itu akan digunakan jika penerima membalas email.
kata sandi	Tali	Kata sandi untuk pemakai Akun SMTP, kata sandi ini diperlukan jika Server memerlukan otentikasi SMTP.
Server	Tali	Server SMTP melalui email dikirim.
tls	Tali	Aktifkan validasi TLS untuk mengirim email, properti ini menggunakan STARTTLS dan fitur ini harus didukung di server SMTP. Beberapa server SMTP harus mengaktifkannya. Nilai yang mungkin adalah: benar, Validasi TLS diaktifkan untuk mengirim email; atau palsu, mengirim email tidak menggunakan validasi TLS.
untuk	Tali	Akun email yang menerima email, akun ini akan muncul di header SMTP Ke.
pemakai	Tali	Akun email diperbolehkan mengirim email, akun ini diperlukan jika server memerlukan otentikasi SMTP.

Contoh respons:

{
   "description" : "Get notifications email methods",
   "params" : {
      "from" : "user@zevenet.com",
      "method" : "email",
      "password" : "verystrongpass",
      "server" : "smtp.gmail.com",
      "tls" : "true",
      "to" : "adminuser@zevenet.net",
      "user" : "user@zevenet.com"
   }
}

Parameter respons

Respons akan menjadi json dengan semua nilai yang diminta diperbarui. Lihat contoh respons untuk informasi lebih lanjut.

Kirim surat uji

Kirim surat uji

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json'  -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"test"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/notifications/methods/email/actions

POST /system/notifications/methods/email/actions

Kirim surat uji dengan konfigurasi email, untuk mengujinya.

Parameter permintaan

Bidang	Tipe	Deskripsi
tindakan	Tali	Nilai untuk mengirim surat uji adalah uji.

Contoh respons:

{
   "description" : "Send test mail",
   "message" : "Test mail sent successful.",
   "success" : "true"
}

Unduh supportave

Unduh supportave

Contoh permintaan:

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

GET /system/supportsave

Dapatkan gambar status sistem dengan semua konfigurasi dan proses berjalan di sistem. Dukungan ini membuat perlu untuk menemukan masalah atau bantuan dukungan.

Sistem - Cluster

Cluster adalah elemen yang dikerjakan oleh master node, yang mengelola koneksi untuk backend, dan sebuah backup node memeriksa master, ia siap untuk swich untuk menguasai node jika ia pergi ke status turun.

Ketika ada status yang diaktifkan, simpul cadangan akan mengembalikan semua status koneksi itu sendiri. Jadi, klien tidak mendeteksi gangguan dalam layanan.

Ini memungkinkan penyeimbang muatan berada dalam ketersediaan tinggi. Jadi jika ada masalah dalam Zevenet, layanan akan terus bekerja dengan konfigurasi yang diunggah.

Tampilkan konfigurasi cluster

Tampilkan konfigurasi cluster

Contoh permintaan:

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

GET /system/cluster

Tampilkan semua konfigurasi tentang kluster.

Respon BODY:

{
   "description" : "Show the cluster configuration",
   "params" : {
      "check_interval" : 5,
      "failback" : "disabled",
      "interface" : "eth0",
      "nodes" : [
         {
            "ip" : "192.168.100.241",
            "name" : "canoDEV4100",
            "node" : "local"
         },
         {
            "ip" : "192.168.100.240",
            "name" : "maqvir",
            "node" : "remote"
         }
      ]
   }
}

Parameter respons

Responsnya akan menjadi objek JSON dengan konfigurasi cluster dan array dengan node di dalamnya.

Objek Cluster:

Bidang	Tipe	Deskripsi
check_interval	Jumlah	Ini adalah waktu tunggu antara dua pemeriksaan status master node.
gagal kembali	Tali	Node mana yang lebih disukai sebagai master. Nilai bisa berupa a nama simpul, untuk memberikan preferensi ke simpul; atau cacat, jika ada simpul yang bisa dikuasai dan tidak ada prioritas untuk satu simpul.
antarmuka	Tali	Antarmuka tempat IP node dikonfigurasikan.
node	Obyek[]	Node cluster.

Objek Simpul:

Bidang	Tipe	Deskripsi
ip	Tali	Ini adalah IP yang dikonfigurasi dalam node untuk memeriksa status node dan melakukan replikasi informasi.
nama	Tali	Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul.
simpul	Tali	Nilai yang mungkin adalah: lokal, jika simpul adalah yang menerima permintaan zapi; atau terpencil, jika node lain dikonfigurasi dalam cluster.

Aktifkan sebuah cluster

Aktifkan sebuah cluster

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"local_ip":"192.168.100.241","remote_ip":"192.168.100.240","remote_password":"admin"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster

POST /system/cluster

Apakah cluster berkomunikasi dua penyeimbang.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
remote_ip	Tali	IP host jarak jauh yang digunakan untuk cluster.	benar
local_ip	Tali	IP host lokal yang digunakan untuk cluster.	benar
kata sandi jarak jauh	Tali	Rooting kata sandi pengguna untuk penyeimbang jarak jauh.	benar

Respon BODY:

{
   "description" : "Enabling cluster",
   "message" : "Cluster enabled successfully",
   "success" : "true"
}

Ubah konfigurasi cluster

Ubah konfigurasi cluster

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"check_interval":4,"failback":"disabled"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster

PUT /system/cluster

Mengkonfigurasi parameter mode kerja untuk cluster.

Parameter permintaan

Bidang	Tipe	Deskripsi
check_interval	Jumlah	Ini adalah waktu tunggu antara dua pemeriksaan status master node.
gagal kembali	Tali	Node mana yang lebih disukai sebagai master. Nilai bisa berupa a nama simpul, untuk memberikan preferensi ke simpul; atau cacat, jika ada simpul yang bisa dikuasai dan tidak ada prioritas untuk satu simpul.

Respon BODY:

{
   "description" : "Modifying the cluster configuration",
   "params" : {
      "check_interval" : "4",
      "failback" : "disabled"
   }
}

Nonaktifkan cluster

Nonaktifkan cluster

Contoh permintaan:

curl -k -X DELETE -H 'Content-Type: application/json' 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster

DELETE /system/cluster

Hapus kluster.

Respon BODY:

{
   "description" : "Disabling cluster",
   "message" : "Cluster disabled successfully",
   "success" : "true"
}

Dalam perawatan

Dalam perawatan

Contoh permintaan:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"action":"maintenance","status":"enable"}' 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/system/cluster/actions

POST /system/cluster/actions

Ubah node cluster lokal ke mode pemeliharaan.

Respon BODY:

{
   "description" : "Setting maintenance mode",
   "message" : "Local cluster node changed to maintenance mode successfully",
   "success" : "true"
}

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
tindakan	Tali	Tindakan untuk diterapkan ke kluster. Tindakan yang tersedia adalah pemeliharaan.	benar
status	Tali	Status untuk meletakkan node, nilai yang mungkin adalah aktif, letakkan di mode pemeliharaan; atau menonaktifkan, letakkan simpul yang tersedia.	benar

Tampilkan status node

Tampilkan status node

Contoh permintaan:

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

GET /system/cluster/nodes

Tampilkan status semua node.

Respon BODY:

{
   "description" : "Cluster nodes status",
   "params" : [
      {
         "ip" : "192.168.100.241",
         "message" : "Node online and active",
         "name" : "canoDEV4100",
         "node" : "local",
         "role" : "master",
         "status" : "ok"
      },
      {
         "ip" : "192.168.100.240",
         "message" : "Node online and passive",
         "name" : "maqvir",
         "node" : "remote",
         "role" : "backup",
         "status" : "ok"
      }
   ]
}

Parameter respons

Respons akan menjadi JSON dengan kunci berhenti dan nilai array objek status simpul.

Objek status simpul

Bidang	Tipe	Deskripsi
ip	Tali	Ini adalah IP yang dikonfigurasi dalam node untuk memeriksa status node dan melakukan replikasi informasi.
nama	Tali	Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul.
simpul	Tali	Nilai yang mungkin adalah: lokal, jika simpul adalah yang menerima permintaan zapi; atau terpencil, jika node lain dikonfigurasi dalam cluster.
pesan	Tali	Pesan deskriptif yang menunjukkan status dan mode kerja node.
peran	Tali	Mode kerja aktual dari simpul ini. Nilai yang mungkin adalah: menguasai, simpul ini mengatur koneksi antara backend dan klien; atau backup, simpul ini telah menjawab koneksi status master dan konfigurasi master, dan sedang memeriksa apakah layanan master berfungsi.
status	Tali	Tunjukkan jika beberapa proses cluster gagal.

Tampilkan status cluster localhost

Tampilkan status cluster localhost

Contoh permintaan:

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

GET /system/cluster/nodes/localhost

Tampilkan status simpul lokal.

Respon BODY:

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

Parameter respons

Bidang	Tipe	Deskripsi
pesan	Tali	Pesan deskriptif yang menunjukkan status dan mode kerja node.
nama	Tali	Ini adalah nama host simpul, dan digunakan sebagai pengidentifikasi unik simpul.
peran	Tali	Mode kerja aktual dari simpul ini. Nilai yang mungkin adalah: menguasai, simpul ini mengatur koneksi antara backend dan klien; atau backup, simpul ini telah menjawab koneksi status master dan konfigurasi master, dan sedang memeriksa apakah layanan master berfungsi.
status	Tali	Tunjukkan jika beberapa proses cluster gagal.

RBAC

RBAC adalah solusi untuk Kontrol Akses Berbasis Peran. Jadi, Zevenet dapat menjadi manajer dan administrasi dengan peran yang berbeda, membatasi akses ke konfigurasi dan sumber daya untuk grup.

Grup dapat melihat sumber daya, pertanian, dan antarmuka virtual, yaitu pemilik. Dimungkinkan untuk menetapkan izin yang berbeda untuk menerapkan tindakan tentang sumber daya, maka misalnya suatu kelompok dapat mengelola sebuah pertanian dan yang lainnya dapat memantaunya.

Tiga elments digunakan untuk bekerja dengan RBAC: peran, rol adalah sekumpulan izin untuk elemen penyeimbang beban yang berbeda. Pengguna, setiap pengguna akan dapat mengakses load balancer untuk api, untuk webgui atau keduanya, dengan peran grup pengguna. kelompok, itu adalah satu set pengguna dan satu set sumber daya (pertanian dan antarmuka virtual). Grup harus memiliki peran yang ditugaskan.

RBAC - Pengguna

Pengguna dapat mengakses penyeimbang beban dengan peran grup pengguna melalui api, dengan zapikey pengguna dan menerapkannya izin zapi, atau melalui web gui dengan nama pengguna dan sandi jika pengguna memiliki izin web gui.

Daftar pengguna

Daftar semua pengguna

Contoh permintaan:

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

GET /rbac/users

Daftar semua pengguna RBAC dan konfigurasi mereka

Contoh respons:

{
   "description" : "List the RBAC users",
   "params" : [
      {
         "group" : "monitor",
         "name" : "sarah",
         "webgui_permissions" : "true",
         "zapi_permissions" : "true"
      },
      {
         "group" : "system-admin",
         "name" : "john",
         "webgui_permissions" : "true",
         "zapi_permissions" : "true"
      },
      {
         "group" : "web-admin",
         "name" : "aaron",
         "webgui_permissions" : "true",
         "zapi_permissions" : "false"
      }
   ]
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array objek pengguna, yang masing-masing berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
kelompok	Tali	Ini adalah nama grup tempat pengguna berada. Pengguna hanya bisa dalam satu grup.
nama	Tali	Nama pengguna, ini mengidentifikasi ke pengguna dan digunakan untuk mengakses melalui web gui.
webgui_permissions	Tali	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.

Ambil pengguna

Ambil pengguna

Contoh permintaan:

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

GET /rbac/users/<name>

Tampilkan konfigurasi pengguna. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Contoh respons:

{
   "description" : "Get the user sarah",
   "params" : {
         "group" : "monitor",
         "name" : "sarah",
         "webgui_permissions" : "true",
         "zapi_permissions" : "true"
      }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array objek pengguna, yang masing-masing berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
kelompok	Tali	Ini adalah nama grup tempat pengguna berada. Pengguna hanya bisa dalam satu grup.
nama	Tali	Nama pengguna, ini mengidentifikasi ke pengguna dan digunakan untuk mengakses melalui web gui.
webgui_permissions	Tali	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.

Buat pengguna

Buat pengguna baru

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"monica","password":"aCX2kl5m9"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users

POST /rbac/users

Buat pengguna, pengguna dibuat tanpa peran dan grup.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama pengguna, ini mengidentifikasi ke pengguna dan digunakan untuk mengakses melalui web gui.	benar
kata sandi	Tali	Ini adalah kata sandi yang digunakan oleh pengguna untuk mengakses melalui web gui.	benar

{
   "description" : "Create the RBAC user, monica",
   "message" : "Added the RBAC user monica",
   "params" : {
      "user" : {
         "group" : "",
         "name" : "monica",
         "webgui_permissions" : "false",
         "zapi_permissions" : "false"
      }
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek dengan kunci Pengguna dengan atribut utama di bawah ini.

Bidang	Tipe	Deskripsi
kelompok	Tali	Ini adalah nama grup tempat pengguna berada. Pengguna hanya bisa dalam satu grup.
nama	Tali	Nama pengguna, ini mengidentifikasi ke pengguna dan digunakan untuk mengakses melalui web gui.
webgui_permissions	Tali	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.

Ubah pengguna

Ubah pengguna

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{ "zapi_permissions":"true","webgui_permissions":"true","newpassword":"8fhM42W1","zapikey":"m3dW2MyYt4Hgv3"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/users/monica

PUT /rbac/users/<name>

Ubah konfigurasi pengguna. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Parameter permintaan:

Bidang	Tipe	Deskripsi	Wajib
zapikey	Tali	Setiap pengguna dapat memiliki zapikey. Dengan zapikey ini, pengguna dapat melakukan aksi melalui zapikey dengan izin peran pengguna. .
webgui_permissions	Tali	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.
kata sandi baru	Tali	Kata sandi pengguna baru untuk diakses melalui web gui.

Contoh respons:

{
   "description" : "Modify the RBAC user monica",
   "message" : "Settings were changed successful.",
   "params" : {
      "group" : "",
      "name" : "monica",
      "webgui_permissions" : "true",
      "zapi_permissions" : "true"
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek pengguna dengan atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
kelompok	Tali	Ini adalah nama grup tempat pengguna berada. Pengguna hanya bisa dalam satu grup.
nama	Tali	Nama pengguna, ini mengidentifikasi ke pengguna dan digunakan untuk mengakses melalui web gui.
webgui_permissions	Tali	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
zapi_permissions	Tali	Nilai yang mungkin adalah: benar, untuk memungkinkan akses ke penyeimbang beban melalui zapi; atau palsu, untuk tidak mengizinkan akses melalui zapi.

Hapus pengguna

Hapus pengguna

Contoh permintaan:

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

DELETE /rbac/users/<name>

Hapus pengguna RBAC. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Contoh respons:

{
   "description" : "Delete the RBAC user john",
   "message" : "The RBAC user john has been deleted successful.",
   "success" : "true"
}

RBAC - Peran

Struktur peran

Contoh peran, ini semua kemungkinan kombinasi objek dan tindakan:

{
   "params" : {
      "activation-certificate" : {
         "delete" : "false",
         "show" : "false",
         "upload" : "false"
      },
      "alias" : {
         "delete" : "false",
         "list" : "false",
         "modify" : "false"         
      },
      "backup" : {
         "apply" : "false",
         "create" : "false",
         "delete" : "false",
         "download" : "false",
         "upload" : "false"
      },
      "certificate" : {
         "create" : "false",
         "delete" : "false",
         "download" : "false",
         "show" : "false",
         "upload" : "false"
      },
      "cluster" : {
         "create" : "false",
         "delete" : "false",
         "maintenance" : "false",
         "modify" : "false"
      },
      "farm" : {
         "action" : "false",
         "create" : "false",
         "delete" : "false",
         "maintenance" : "false",
         "modify" : "false"
      },
      "farmguardian" : {
         "modify" : "false"
      },
      "interface" : {
         "modify" : "false"
      },
      "interface-virtual" : {
         "action" : "false",
         "create" : "false",
         "delete" : "false",
         "modify" : "false"
      },
      "ipds" : {
         "modify" : "false"
      },
      "log" : {
         "download" : "false",
         "show" : "false"
      },
      "notification" : {
         "action" : "false",
         "modify" : "false",
         "show" : "false",
         "test" : "false"
      },
      "rbac-group" : {
         "create" : "false",
         "delete" : "false",
         "list" : "false",
         "modify" : "false",
         "show" : "false"
      },
      "rbac-role" : {
         "create" : "false",
         "delete" : "false",
         "modify" : "false",
         "show" : "false"
      },
      "rbac-user" : {
         "create" : "false",
         "delete" : "false",
         "list" : "false",
         "modify" : "false",
         "show" : "false"
      },
      "supportsave" : {
         "download" : "false"
      },
      "system-service" : {
         "modify" : "false"
      }
   }
}

Peran menentukan sekumpulan izin yang diterapkan ke grup. Semua pengguna grup mewarisi peran grup. Peran adalah sekumpulan objek, setiap objek memiliki tindakan. Suatu tindakan dapat memiliki nilai: "benar", untuk mengizinkan tindakan atau "salah" untuk memblokir tindakan tersebut.

Setiap objek memiliki tindakan yang ditampilkan dalam contoh peran. Misalnya, untuk sebuah tambak, tindakan yang tersedia adalah: "tindakan", "buat", "hapus", "pemeliharaan" dan "modifikasi"; atau untuk objek alias, yaitu: "hapus", "daftar", dan "ubah".

Benda-benda

Bidang	Deskripsi
sertifikat aktivasi	Ini mendefinisikan tindakan yang diterapkan pada sertifikat aktivasi Zevenet.
alias	Ini mendefinisikan tindakan untuk mengelola fitur alias.
backup	Ini mendefinisikan tindakan untuk mengelola cadangan.
sertifikat	Ini mendefinisikan tindakan untuk mengelola sertifikat SSL.
kelompok	Ini mendefinisikan tindakan untuk mengelola cluster.
kebun	Ini mendefinisikan tindakan untuk mengelola pertanian. Pengguna hanya akan dapat mengelola pertanian dari grup pengguna.
penjaga pertanian	Ini mendefinisikan tindakan untuk mengelola pemeriksaan kesehatan pertanian. Untuk menerapkan penjaga pertanian ke sebuah peternakan, objek yang diperlukan adalah kebun.
antarmuka	Ini mendefinisikan tindakan untuk mengelola jaringan menu. Antarmuka virtual adalah pengecualian, mereka dikelola oleh antarmuka virtual obyek.
antarmuka-virtual	Ini mendefinisikan tindakan untuk mengatur antarmuka virtual. Pengguna hanya akan dapat mengelola antarmuka grup pengguna.
ipds	Ini mendefinisikan tindakan untuk mengelola aturan IPDS. Untuk menerapkan aturan ke tambak, objek yang diperlukan adalah kebun.
mencatat	Ini mendefinisikan tindakan untuk mengelola log penyeimbang beban.
pemberitahuan	Ini mendefinisikan tindakan untuk mengelola notifikasi: peringatan dan metode yang dikirim.
rbac-group	Ini mendefinisikan tindakan untuk mengelola grup RBAC.
rbac-role	Ini mendefinisikan tindakan untuk mengelola peran RBAC.
rbac-user	Ini mendefinisikan tindakan untuk mengelola pengguna RBAC.
mendukung	Ini mendefinisikan tindakan untuk mengelola dukungan Zevenet.
layanan sistem	Ini mendefinisikan tindakan untuk mengelola remote dan layanan lokal.

Tindakannya

Bidang	Deskripsi
daftar	Ini daftar elemen yang tersedia dari suatu objek.
Menunjukkan	Itu mengambil objek dan konfigurasinya.
Download	Ini mengunduh objek dari penyeimbang beban.
mengunggah	Itu mengunggah objek ke load balancer.
pemeliharaan	Ini memodifikasi status objek antara pemeliharaan dan atas.
tindakan	Itu berlaku tindakan ke objek. Setiap objek memiliki aksinya.
membuat	Itu menciptakan elemen baru untuk jenis objek.
hapus	Ini menghapus objek secara permanen.
memodifikasi	Ini memodifikasi konfigurasi objek. Terkadang, jika objek tidak memiliki tindakan: membuat, hapus or tindakan tindakan, tindakan ini diterapkan oleh memodifikasi izin.

Daftar peran

Daftar semua peran

Contoh permintaan:

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

GET /rbac/roles

Daftar semua peran RBAC

Contoh respons:

{
   "description" : "List the RBAC roles",
   "params" : [
      "example",
      "admin",
      "monitor"
   ]
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi array nama peran. Setiap nama adalah pengidentifikasi peran

Ambil peran

Ambil peran

Contoh permintaan:

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

GET /rbac/roles/<name>

Tampilkan konfigurasi pengguna. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi peran struct. Kunci adalah objek izin, yang mengidentifikasi di mana mereka akan bertindak dan sebagai parameter objek ini adalah tindakan yang harus dikontrol. Jika tindakan memiliki nilai "benar", ini akan diizinkan untuk peran tersebut; jika tindakan tersebut memiliki nilai "salah", tindakan tersebut akan diblokir.

Buat peran

Buat peran baru

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"web-monitor"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles

POST /rbac/roles

Buat peran akan menghasilkan peran baru dari templat dengan semua izin ditetapkan sebagai palsu secara default

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama peran, digunakan sebagai pengidentifikasi unik.	benar

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi struct dengan izin. Izin adalah kunci, yang mengidentifikasi objek di mana ia akan bertindak dan sebagai parameter dari objek ini adalah tindakan yang harus dikontrol. Jika tindakan memiliki nilai "benar", ini akan diizinkan untuk peran tersebut; jika tindakan tersebut memiliki nilai "salah", tindakan tersebut akan diblokir.

Ubah peran

Ubah peran

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d ''{ "ipds":{"action":"true"}, "farm":{"maintenance":"true", "action":"true"} }'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles/web-monitor

PUT /rbac/users/<name>

Ubah izin peran. nama adalah nama peran dan itu adalah pengidentifikasi unik.

Parameter permintaan:

Bidang	tindakan	Deskripsi
sertifikat aktivasi	hapus, Menunjukkan serta mengunggah	Ini mendefinisikan tindakan yang diterapkan pada sertifikat aktivasi Zevenet.
alias	hapus, daftar serta memodifikasi	Ini mendefinisikan tindakan untuk mengelola fitur alias.
backup	menerapkan, membuat, hapus, Download serta mengunggah	Ini mendefinisikan tindakan untuk mengelola cadangan.
sertifikat	membuat, hapus, Download, Menunjukkan serta mengunggah	Ini mendefinisikan tindakan untuk mengelola sertifikat SSL.
kelompok	membuat, hapus, pemeliharaan serta memodifikasi	Ini mendefinisikan tindakan untuk mengelola cluster.
kebun	tindakan, membuat, hapus, pemeliharaan serta memodifikasi	Ini mendefinisikan tindakan untuk mengelola pertanian. Pengguna hanya akan dapat mengelola pertanian dari grup pengguna.
penjaga pertanian	memodifikasi	Ini mendefinisikan tindakan untuk mengelola pemeriksaan kesehatan pertanian. Untuk menerapkan penjaga pertanian ke sebuah peternakan, objek yang diperlukan adalah kebun.
antarmuka	memodifikasi	Ini mendefinisikan tindakan untuk mengelola jaringan menu. Antarmuka virtual adalah pengecualian, mereka dikelola oleh antarmuka virtual obyek.
antarmuka-virtual	tindakan, membuat, hapus serta memodifikasi	Ini mendefinisikan tindakan untuk mengatur antarmuka virtual. Pengguna hanya akan dapat mengelola antarmuka grup pengguna.
ipds	tindakan serta memodifikasi	Ini mendefinisikan tindakan untuk mengelola aturan IPDS. Untuk menerapkan aturan ke tambak, objek yang diperlukan adalah kebun.
mencatat	Download serta Menunjukkan	Ini mendefinisikan tindakan untuk mengelola log penyeimbang beban.
pemberitahuan	tindakan, memodifikasi, Menunjukkan serta uji	Ini mendefinisikan tindakan untuk mengelola notifikasi: peringatan dan metode yang dikirim.
rbac-group	membuat, hapus, daftar, memodifikasi serta Menunjukkan	Ini mendefinisikan tindakan untuk mengelola grup RBAC.
rbac-role	membuat, hapus, memodifikasi serta Menunjukkan	Ini mendefinisikan tindakan untuk mengelola peran RBAC.
rbac-user	membuat, hapus, daftar, memodifikasi serta Menunjukkan	Ini mendefinisikan tindakan untuk mengelola pengguna RBAC.
mendukung	Download	Ini mendefinisikan tindakan untuk mengelola dukungan Zevenet.
layanan sistem	memodifikasi	Ini mendefinisikan tindakan untuk mengelola remote dan layanan lokal.

    Setiap jenis tindakan dijelaskan di bawah ini:

Tindakan	Deskripsi
daftar	Ini daftar elemen yang tersedia dari suatu objek. benar untuk memberikan izin, palsu untuk menghapus izin.
Menunjukkan	Itu mengambil objek dan konfigurasinya. benar untuk memberikan izin, palsu untuk menghapus izin.
Download	Ini mengunduh objek dari penyeimbang beban. benar untuk memberikan izin, palsu untuk menghapus izin.
mengunggah	Itu mengunggah objek ke load balancer. benar untuk memberikan izin, palsu untuk menghapus izin.
pemeliharaan	Ini memodifikasi status objek antara pemeliharaan dan atas. benar untuk memberikan izin, palsu untuk menghapus izin.
tindakan	Itu berlaku tindakan ke objek. Setiap objek memiliki aksinya. benar untuk memberikan izin, palsu untuk menghapus izin.
membuat	Itu menciptakan elemen baru untuk jenis objek. benar untuk memberikan izin, palsu untuk menghapus izin.
hapus	Ini menghapus objek secara permanen. benar untuk memberikan izin, palsu untuk menghapus izin.
memodifikasi	Ini memodifikasi konfigurasi objek. Terkadang, jika objek tidak memiliki tindakan: membuat, hapus or tindakan tindakan, tindakan ini diterapkan oleh memodifikasi izin. benar untuk memberikan izin, palsu untuk menghapus izin.

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi struct dengan izin. Izin adalah kunci, yang mengidentifikasi objek di mana ia akan bertindak dan sebagai parameter dari objek ini adalah tindakan yang harus dikontrol. Jika tindakan memiliki nilai "benar", ini akan diizinkan untuk peran tersebut; jika tindakan tersebut memiliki nilai "salah", tindakan tersebut akan diblokir.

Hapus peran

Hapus peran

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/roles/web-monitor

DELETE /rbac/roles/<name>

Hapus peran RBAC. nama adalah nama peran dan itu adalah pengidentifikasi unik.

Contoh respons:

{
   "description" : "Delete the RBAC role web-monitor",
   "message" : "The RBAC role web-monitor has been deleted successful.",
   "success" : "true"
}

RBAC - Grup

Grup adalah sekelompok pengguna dengan peran. Pengguna dapat menerapkan tindakan dalam sumber daya (pertanian dan antarmuka virtual) dari grup mereka.

Buat daftar kelompok

Daftar semua grup

Contoh permintaan:

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

GET /rbac/groups

Daftar semua grup RBAC dan pengaturannya

Contoh respons:

{
   "description" : "List the RBAC groups",
   "params" : [
      {
         "name" : "system-admin",
         "resources" : {
            "farms" : [
               "webHTTP",
               "dns"
            ],
            "interfaces" : [
                "eth2:virt",
                "eth2:vip"
            ]
         },
         "role" : "admin",
         "users" : [
            "john",
            "monica"
         ]
      },
      {
         "name" : "monitor",
         "resources" : {
            "farms" : [
               "webHTTP",
               "mailService"
            ],
            "interfaces" : []
         },
         "role" : "monitor",
         "users" : [
            "sarah",
            "kevin"
         ]
      }
   ]
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan berupa array dari objek grup, yang masing-masing berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
nama	Tali	Nama grup, itu mengidentifikasi ke grup.
sumber daya	obyek	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
peran	Tali	Peran diterapkan pada grup. Semua pengguna dalam grup mewarisi peran ini.
Pengguna	Tali[]	Daftar pengguna dalam grup. Nama pengguna adalah pengidentifikasi unik mereka.

The sumber obyek:

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Ini adalah daftar dengan peternakan anggota grup.
interface	Tali[]	Ini adalah daftar dengan antarmuka virtual anggota grup.

Ambil grup

Ambil grup

Contoh permintaan:

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

GET /rbac/groups/<name>

Tampilkan konfigurasi grup. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Contoh respons:

{
   "description" : "Get the group corel7",
   "params" : {
     "name" : "monitor",
     "resources" : {
        "farms" : [
           "webHTTP",
           "mailService"
        ],
        "interfaces" : []
     },
     "role" : "monitor",
     "users" : [
        "sarah",
        "kevin"
     ]
  }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek grup, yang berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
nama	Tali	Nama grup, itu mengidentifikasi ke grup.
sumber daya	obyek	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
peran	Tali	Peran diterapkan pada grup. Semua pengguna dalam grup mewarisi peran ini.
Pengguna	Tali[]	Daftar pengguna dalam grup. Nama pengguna adalah pengidentifikasi unik mereka.

The sumber obyek:

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Ini adalah daftar dengan peternakan anggota grup.
interface	Tali[]	Ini adalah daftar dengan antarmuka virtual anggota grup.

Buat grup

Membuat grup baru

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{ "name":"development"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups

POST /rbac/groups

Buat grup baru di mana pengguna, sumber daya, dan peran terkait.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Nama grup, itu mengidentifikasi ke grup.	benar

{
   "description" : "Create the RBAC group, development",
   "message" : "Added the RBAC group development",
   "params" : {
      "group" : {
         "name" : "development",
         "resources" : {
            "farms" : [],
            "interfaces" : []
         },
         "role" : "",
         "users" : []
      }
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek grup, yang berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
nama	Tali	Nama grup, itu mengidentifikasi ke grup.
sumber daya	obyek	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
peran	Tali	Peran diterapkan pada grup. Semua pengguna dalam grup mewarisi peran ini.
Pengguna	Tali[]	Daftar pengguna dalam grup. Nama pengguna adalah pengidentifikasi unik mereka.

The sumber obyek:

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Ini adalah daftar dengan peternakan anggota grup.
interface	Tali[]	Ini adalah daftar dengan antarmuka virtual anggota grup.

Ubah grup

Ubah grup

Contoh permintaan:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{ "role":"true"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development

PUT /rbac/groups/<name>

Ubah konfigurasi grup. nama adalah nama grup dan itu adalah pengidentifikasi unik.

Parameter permintaan:

Bidang	Tipe	Deskripsi	Wajib
peran	Tali	Ini adalah peran untuk diterapkan ke grup.

Contoh respons:

{
   "description" : "Create the RBAC group, development",
   "message" : "Added the RBAC group development",
   "params" : {
      "group" : {
         "name" : "development",
         "resources" : {
            "farms" : [],
            "interfaces" : []
         },
         "role" : "monitor",
         "users" : []
      }
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek grup, yang berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
nama	Tali	Nama grup, itu mengidentifikasi ke grup.
sumber daya	obyek	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
peran	Tali	Peran diterapkan pada grup. Semua pengguna dalam grup mewarisi peran ini.
Pengguna	Tali[]	Daftar pengguna dalam grup. Nama pengguna adalah pengidentifikasi unik mereka.

The sumber obyek:

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Ini adalah daftar dengan peternakan anggota grup.
interface	Tali[]	Ini adalah daftar dengan antarmuka virtual anggota grup.

Hapus grup

Hapus pengguna

Contoh permintaan:

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

DELETE /rbac/groups/<name>

Hapus pengguna RBAC. nama adalah nama pengguna dan itu adalah pengidentifikasi unik.

Contoh respons:

{
   "description" : "Delete the RBAC group development",
   "message" : "The RBAC group development has been deleted successful.",
   "success" : "true"
}

Tambahkan sumber daya atau pengguna ke grup

Tambahkan sumber daya atau pengguna ke grup

Contoh permintaan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"monica"}'
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development/users

POST /rbac/groups/<name>/(interfaces|farms|users)

Parameter uri nama adalah nama grup.

Pilih Pengguna di uri untuk menambahkan pengguna ke grup. Pilih peternakan di uri untuk menambahkan peternakan ke grup. Pilih interface di uri untuk menambahkan antarmuka virtual ke grup.

Parameter permintaan

Bidang	Tipe	Deskripsi	Wajib
nama	Tali	Ini adalah nama objek yang akan ditambahkan ke grup	benar

Contoh respons:

{
   "description" : "Add the user monica to the group development",
   "message" : "Added the user monica to the group development",
   "params" : {
      "group" : {
         "name" : "development",
         "resources" : {
            "farms" : [],
            "interfaces" : []
         },
         "role" : "monitor",
         "users" : [
            "monica"
         ]
      }
   }
}

Parameter respons

Respons akan berupa objek JSON dengan kunci yang disetel ke params. Nilai ini akan menjadi objek grup, yang berisi atribut kunci di bawah ini.

Bidang	Tipe	Deskripsi
nama	Tali	Nama grup, itu mengidentifikasi ke grup.
sumber daya	obyek	Nilai yang mungkin adalah: benar, untuk mengaktifkan akses ke penyeimbang beban melalui web gui; atau palsu, untuk tidak mengizinkan akses melalui web gui.
peran	Tali	Peran diterapkan pada grup. Semua pengguna dalam grup mewarisi peran ini.
Pengguna	Tali[]	Daftar pengguna dalam grup. Nama pengguna adalah pengidentifikasi unik mereka.

The sumber obyek:

Bidang	Tipe	Deskripsi
peternakan	Tali[]	Ini adalah daftar dengan peternakan anggota grup.
interface	Tali[]	Ini adalah daftar dengan antarmuka virtual anggota grup.

Hapus sumber daya atau pengguna dari grup

Hapus sumber daya atau pengguna dari grup

Contoh permintaan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3.2/zapi.cgi/rbac/groups/development/users/monica

DELETE /rbac/groups/<name>/(interfaces|farms|users)/<name>

Parameter uri pertama nama adalah nama grup. Parameter uri kedua nama adalah sumber daya atau nama pengguna.

Pilih Pengguna di uri untuk menghapus pengguna dari grup. Pilih peternakan di uri untuk menghapus sebuah peternakan dari grup. Pilih interface di uri untuk menghapus antarmuka virtual dari grup.

Contoh respons:

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