NAB Navbar
logo
shell

API Komuniti Zevenet Community v3.1

ZAPI (Zevenet Application Programming Interface) adalah alat untuk pentadbir sistem untuk mengawal penimbang beban loader Zevenet.

Ia perlu aktif pengguna zapi dari antara muka web sebelum menggunakannya, Sistem / Pengguna.

Setelah pengguna zapi dibuat, ada kemungkinan permintaan mengirim ke URL, https: // (zevenet_server): 444 / zapi / v3.1 / zapi.cgi / (URI_path), di mana zevenet_server adalah IP di mana perkhidmatan HTTP sedang mendengar.

URI_path mentakrifkan objek atau tindakan untuk bertindak. Tingkah laku dan parameternya akan ditakrifkan dalam setiap bahagian dokumentasi.

Kata kerja yang digunakan dalam API ini akan menjadi GET, SELEPAS, PUT or DELETE. Permintaan PUT atau POST selalu memerlukan hampir parameter walaupun ini tidak memerlukan parameter yang diperlukan.

sijil

Zevenet menyokong cetificates dalam format PEM untuk menggunakannya dengan ladang HTTP anda dengan pendengar HTTPS. Sekiranya anda ingin mengetahui lebih lanjut mengenai cara membuat sij sertifikat, sila lawati artikel berikut: GENERATE SERVICES IN PEM FORMAT

Senaraikan semua Sijil

Senaraikan semua Sijil

Permintaan contoh:

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

GET /certificates

Senaraikan semua sijil CSR dan PEM di kedai sijil, sijil tersebut boleh digunakan dengan ladang HTTPS.

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi pelbagai objek sijil, yang masing-masing mengandungi atribut utama di bawah.

Contoh tindak balas:

{
   "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 tindak balas

Bidang Jenis Deskripsi
params Objek [] Senarai objek sijil.

Objek Sijil

Bidang Jenis Deskripsi
CN Rentetan Nama umum domain.
penciptaan Rentetan Tarikh penciptaan.
tamat Rentetan Tarikh luput.
fail Rentetan Nama fail sijil, ID unik.
penerbit Rentetan Pihak Berkuasa Bersertifikat yang menandatangani sijil.
jenis Rentetan CSR atau Sijil.

muat turun Sijil

muat turun Sijil

Permintaan contoh:

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

GET /certificates/<file>

Muat turun sijil yang dipasang di kedai sijil, gunakan nama fail dalam permintaan untuk mengenal pasti.

Maklum balas akan termasuk tajuk yang ditunjukkan di bawah dengan maklumat mengenai fail tersebut. Tubuh respons akan menjadi kandungan fail.

Header maklum balas:

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

Padam Sijil

Padam Sijil

Permintaan contoh:

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

DELETE /certificates/<file>

Padam sijil dengan nama fail di kedai sijil.

Contoh tindak balas:

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

Buat sijil CSR

Buat sijil CSR

Permintaan contoh:

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.1/zapi.cgi/certificates

POST /certificates

Buat Permintaan Menandatangani Sijil (fail CSR).

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Nama ID sijil. benar
fqdn Rentetan Nama domain yang lengkap bagi pelayan anda. benar
bahagian Rentetan Pembahagian organisasi anda yang mengendalikan sijil. benar
organisasi Rentetan Nama undang-undang organisasi anda. benar
Tempatan Rentetan Bandar tempat organisasi anda berada. benar
adalah Rentetan Negeri / kawasan di mana organisasi anda berada. benar
negara Rentetan Kod ISO dua huruf untuk negara tempat organisasi anda berada. benar
mel Rentetan Alamat e-mel yang digunakan untuk menghubungi organisasi anda. benar

Contoh tindak balas:

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

Muat naik Sijil

Muat naik Sijil

Permintaan contoh:

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.1/zapi.cgi/certificates/example.pem

POST /certificates/<file>

Muat naik sijil PEM untuk ladang HTTP dengan pendengar HTTPS.

Memerlukan parameter --tcp-nodelay, dan --data-binary untuk memuat naik fail dalam mod binari.

Meminta parameter URI

Bidang Jenis Deskripsi diperlukan
fail Rentetan Nama fail sijil untuk memuat naik dan menyimpan di kedai sijil. benar

Contoh tindak balas:

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

Senarai Ciphers

Senarai Ciphers

Permintaan contoh:

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

GET /ciphers

Senaraikan ciphers yang boleh digunakan oleh ladang HTTPS.

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi pelbagai objek sijil, yang masing-masing mengandungi atribut utama di bawah.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
params Objek [] Senarai objek sijil.

Objek Sijil

Bidang Jenis Deskripsi
tulisan rahsia Rentetan Ia digunakan sebagai pengecam unik.
Penerangan Rentetan Nama mesra.

Farms

Zevenet dapat menguruskan lalu lintas dalam tiga cara yang berbeza, setiap cara diuruskan oleh modul yang berbeza, pengimbang beban perkhidmatan tempatan atau modul LSLB dan modul Datalink Load Balancer atau DSLB.

Semua modul bekerja dengan konsep profil Ladang, profil Ladang adalah kumpulan parameter yang sedia untuk melakukan tindakan spesifik dengan trafik rangkaian, adalah penting untuk memahami apa yang dapat dilakukan setiap profil ladang untuk mendapatkan hasil terbaik dari Zevenet ADC.

Senaraikan semua ladang

Senaraikan semua ladang

Permintaan contoh:

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

GET /farms

Senaraikan semua ladang yang ada

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi pelbagai objek resume ladang, yang masing-masing mengandungi atribut utama di bawah.

Objek Ladang

Bidang Jenis Deskripsi
farmname Rentetan Nama deskriptif ladang. Ia digunakan sebagai pengenal unik.
profil Rentetan Jenis profil, profil nilai yang tersedia adalah: http, https or l4xnat untuk modul LSLB dan datalink untuk modul DSLB
status Rentetan Status ladang. Nilai status yang tersedia ialah: turun, ladang tidak berjalan; perlu dimulakan semula, ladang itu sudah selesai tetapi menunggu tindakan restart; kritikal, ladang itu habis dan semua backend tidak terjangkau atau penyelenggaraan; masalah, ladang itu ada dan terdapat beberapa backend yang tidak dapat dijangkau, tetapi hampir backend berada dalam kedudukan status; penyelenggaraan, ladang itu ada dan ada backends dalam status, tetapi hampir backend dalam mod penyelenggaraan; up, ladang itu habis dan semua hujungnya berjaya.
vip Rentetan IP maya di mana ladang menerima lalu lintas
vport Rentetan Pelabuhan Maya di mana ladang menerima lalu lintas, nilai pelabuhan yang tersedia adalah: nombor port untuk http [s] dan l4xnat, sekumpulan port yang dipisahkan oleh "," atau julat port yang dipisahkan oleh ":" untuk profil l4xnat, di l4xnat kedua-dua pemisah nilai ("," dan ":") dapat digunakan di medan yang sama.

Contoh tindak balas:

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

Padamkan Ladang

Padamkan Ladang

Permintaan contoh:

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

DELETE /farms/<farmname>

Padam ladang melalui identitinya nama ladang.

Contoh tindak balas:

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

Tetapkan tindakan di Ladang

Tetapkan tindakan di Ladang

Permintaan contoh:

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

PUT /farms/<farmname>/actions

Memohon tindakan ke ladang, lihat jadual parameter Permintaan untuk tindakan.

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Tetapkan tindakan yang dikehendaki. Tindakannya adalah: berhenti, ladang itu akan dihentikan. permulaan, ladang akan dimulakan dan restart, ladang itu akan dihentikan dan dimulakan secara automatik.

Contoh tindak balas:

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

Parameter tindak balas

Jika tiada masalah dalam konfigurasi maka zapi akan memulangkan tindakan yang diminta.

Ladang HTTP

Profil HTTP adalah keseimbangan beban 7 lapisan lanjutan (atau Penerima Penghantaran Aplikasi) dengan sifat khusus proksi. Profil ini menawarkan beberapa ciri seperti keseimbangan beban lapisan HTTPS 7. Profil ini diisi untuk perkhidmatan web (termasuk pelayan aplikasi web) dan semua protokol aplikasi berdasarkan protokol HTTP dan HTTPS seperti WebDav, RDP melalui HTTP, ICA melalui HTTP, dan sebagainya. Untuk mengkonfigurasi profil ladang ini, alamat IP maya dan port TCP maya akan diperlukan.

Dapatkan ladang dengan nama

Dapatkan ladang dengan nama

Permintaan contoh:

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

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Contoh tindak balas:

{
   "description" : "List farm httpFarm",
   "params" : {
      "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.",
      "httpverb" : "MSRPCext",
      "listener" : "https",
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
      {
         "backends" : [
            {
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null
            }
         ],
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "tcp_check",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek Ladang:

Bidang Jenis Deskripsi
params Objek Parameter konfigurasi ladang.
perkhidmatan Objek [] Array dengan semua perkhidmatan yang dibuat di ladang ini dan konfigurasinya.

Parameter objek untuk ladang HTTP:

Bidang Jenis Deskripsi
penyertaan Objek [] Hanya dalam profil https. Sijil yang aktif di ladang, dalam format pem, dibenarkan menambah hanya satu sij siji ke ladang yang sama. pendengar dengan nilai https diperlukan. Mana-mana sijil pemilang di kedai sijil boleh digunakan di sini.
cipherc Rentetan Hanya dalam pendengar https. Ini adalah senarai ciphers yang diperibadikan yang akan diterima oleh sambungan SSL, yang merupakan rentetan dalam format yang sama seperti dalam cip OpenSSL. Atribut ini digunakan hanya apabila tulisan rahsia bidang mempunyai nilai sutomsecurity.
tulisan rahsia Rentetan Hanya dalam pendengar dengan nilai https. Digunakan untuk membina senarai cipher yang diterima oleh sambungan SSL untuk mengeras sambungan SSL. Pilihannya ialah: semua, semua ciphers akan diterima; keselamatan tinggi, ciphers hanya untuk keselamatan yang tinggi akan diterima; atau keselamatan, ciphers hanya dimuatkan cipherc bidang akan diterima.
contimeout nombor Berapa lama ladang akan menunggu sambungan TCP ke belakang dalam beberapa saat.
disable_sslv2 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan SSL dengan versi 2 tidak dibenarkan; atau palsu jika protokol SSLv2 dibenarkan.
disable_sslv3 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan SSL dengan versi 3 tidak dibenarkan; atau palsu jika protokol SSLv3 dibenarkan.
disable_tlsv1 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1 tidak dibenarkan; atau palsu jika protokol TLSv1 dibenarkan.
disable_tlsv1_1 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1.1 tidak dibenarkan; atau palsu jika protokol TLSv1.1 dibenarkan.
disable_tlsv1_2 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1.2 tidak dibenarkan; atau palsu jika protokol TLSv1.2 dibenarkan.
error414 Rentetan Mesej peribadi untuk respons dengan kod ralat HTTP 414.
error500 Rentetan Mesej peribadi untuk respons dengan kod ralat HTTP 500.
error501 Rentetan Mesej peribadi untuk respons dengan kod ralat HTTP 501.
error503 Rentetan Mesej peribadi untuk respons dengan kod ralat HTTP 503.
kata keterangan Rentetan Bidang ini menunjukkan operasi yang akan dibenarkan kepada permintaan klien HTTP. nilai yang ada ialah: standardHTTP, permintaan http tidak diterima GET, POST, HEAD. extendedHTTP, menerima permintaan http sebelumnya ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya ditambah LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPSYEN, TRACE, KARAKTER, CHECKOUT, MERGE, REPORT, MSextWebDAV menerima permintaan http sebelumnya ditambah SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahawa nilai-nilai tersebut adalah sensitiviti kes.
pendengar Rentetan Pendengar mendefinisikan bagaimana ladang akan bermain dengan permintaan daripada pelanggan. Pilihannya ialah: http kerana protokol tidak selamat atau https untuk protokol yang selamat.
reqtimeout nombor Berapa lama ladang akan menunggu permintaan pelanggan dalam beberapa saat.
restimeout nombor Berapa lama ladang akan menunggu sambutan dari belakang dalam beberapa saat.
resurrectime nombor Masa untuk keluar pelayan sebenar yang jatuh, selepas tempoh ini pengimbang beban memeriksa jika pelayan sebenar masih hidup, dalam hitungan detik.
rewritelocation Rentetan Sekiranya ia diaktifkan, ladang terpaksa mengubahsuai Lokasi: dan Lokasi Kandungan: tajuk dalam respons kepada klien dengan hos maya. Pilihannya ialah: membolehkan, aktif orang kurang upaya, tidak aktif atau back-enabled hanya alamat backend yang dibandingkan.
status Rentetan Status ladang. Nilai status yang tersedia ialah: turun, ladang tidak berjalan; perlu dimulakan semula, ladang itu sudah selesai tetapi menunggu tindakan restart; kritikal, ladang itu habis dan semua backend tidak terjangkau atau penyelenggaraan; masalah, ladang itu ada dan terdapat beberapa backend yang tidak dapat dijangkau, tetapi hampir backend berada dalam kedudukan status; penyelenggaraan, ladang itu ada dan ada backends dalam status, tetapi hampir backend dalam mod penyelenggaraan; up, ladang itu habis dan semua hujungnya berjaya.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.
vport nombor Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar.

Objek Pembekal:

Bidang Jenis Deskripsi
fail Rentetan Nama sijil, rujukan kepada sijil di kedai sijil.
id nombor ID Sijil.

Objek perkhidmatan untuk ladang HTTP:

Bidang Jenis Deskripsi
backends Objek [] Backends ditakrifkan dalam perkhidmatan.
fgenabled Rentetan Membolehkan penggunaan penjaga ladang. benar penjaga ladang diaktifkan dan menyemak status backend, palsu penjaga ladang dilumpuhkan dan tidak memeriksa status backends. Dalam profil HTTP check_tcp dilaksanakan secara lalai walaupun penjaga ladang dimatikan.
fglog Rentetan Membolehkan penggunaan log di penjaga ladang. benar didayakan, palsu, kurang upaya. fgenabled adalah diperlukan.
fgscript Rentetan Perintah penjaga ladang akan digunakan untuk memeriksa kesihatan belakang. benar didayakan, palsu, kurang upaya. fgenabled adalah diperlukan.
fgtimecheck nombor penjaga ladang akan memeriksa setiap 'timetocheck' detik status kesihatan backend. fgenabled adalah diperlukan.
httpsb Rentetan Parameter ini menunjukkan kepada ladang bahawa pelayan belakang yang ditakrifkan dalam perkhidmatan semasa menggunakan bahasa HTTPS dan kemudian data akan disulitkan sebelum dihantar. benar, profil menghantar lalu lintas dalam protokol HTTPS ke belakang, palsu, profil menghantar lalu lintas dalam protokol HTTP ke belakang.
id Rentetan Nama perkhidmatan, tidak dapat diubah setelah perkhidmatan dibuat.
kurangnya Rentetan Ia membolehkan kaedah mengimbangi yang paling kurang. benar dengan mudah pemeriksaan profil yang backend mengambil masa kurang untuk bertindak balas untuk menghantar lebih banyak sambungan ke yang ini, palsu profil tidak memeriksa backend mana yang memerlukan lebih sedikit masa untuk bertindak balas.
kegigihan Rentetan Parameter ini menentukan bagaimana perkhidmatan HTTP akan menguruskan sesi klien. Pilihannya ialah: "" rentetan kosong, tiada tindakan diambil, IP sesi ketekunan dilakukan di dasar IP pelanggan, ASAS sesi ketekunan dilakukan di pangkalan header BASIC, URL sesi ketekunan dilakukan di pangkalan lapangan di URI, PARM sesi ketekunan dilakukan berdasarkan nilai pada akhir URI, COOKIE sesi ketekunan dilakukan di dasar nama cookie, cookie ini harus dibuat oleh backends, dan KEPALA, sesi ketekunan dilakukan di bawah nama Header.
mengarahkan Rentetan Ia berperanan sebagai backend khas, kerana permintaan pelanggan dijawab dengan mengarahkan ke URL baru secara automatik. Sekiranya pengalihan dikonfigurasi maka permintaan itu tidak akan diteruskan ke backend, Redirect akan dijawab kepada klien sebaliknya.
redirecttype Rentetan Bagaimana pengalihan semula akan dilakukan, dua pilihan: lalai, url diambil sebagai hos mutlak dan laluan untuk mengalihkan, tambah, jalan permintaan asal atau URI akan ditambahkan pada hos dan jalan yang anda tentukan dengan pilihan lalai. Jika mengarahkan medan tidak dikonfigurasi, medan ini akan menjadi tali kosong.
sessionid Rentetan Ia boleh didapati jika kegigihan medan adalah URL, COOKIE atau HEADER, nilai parameter akan dicari oleh ladang di http header dan akan menguruskan sesi klien.
ttl nombor Hanya dengan kegigihan. Nilai ini menunjukkan masa maksimum bagi sesi klien tidak aktif (umur sesi max) dalam saat.
urlp Rentetan Membolehkan untuk menentukan perkhidmatan web berkenaan URL yang diminta pelanggan melalui corak URL khusus yang akan diperiksa secara sintaksis. Ungkapan biasa PCRE disokong.
vhost Rentetan Ia menentukan syarat yang ditentukan oleh nama domain melalui IP dan port maya yang sama yang ditakrifkan oleh ladang HTTP. Ungkapan biasa PCRE disokong.

Objek backend untuk ladang HTTP:

Bidang Jenis Deskripsi
id nombor Pengenalpastian backend di dalam perkhidmatan yang diberikan.
ip Rentetan Backend's IP tempat perkhidmatan sebenar dijalankan.
pelabuhan nombor Pelabuhan backend tempat perkhidmatan sebenar dijalankan.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu, dalam beberapa saat. Jika sistem null akan menggunakan parameter masa akhir Backends.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa, backend dengan nilai berat yang lebih tinggi akan menerima lebih banyak sambungan. Nol nilai lalai, bukan berat khas yang digunakan untuk backend ini.

Buat Farm baru

Buat Farm baru

Permintaan contoh:

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.1/zapi.cgi/farms

POST /farms

Buat ladang HTTP baru.

Minta parameter

Bidang Jenis Deskripsi diperlukan
farmname Rentetan Nama deskriptif ladang. Ia digunakan sebagai pengecam unik. benar
profil Rentetan Profil Ladang yang dicipta. Untuk ladang http ialah http. benar
vip Rentetan IP ladang, di mana perkhidmatan maya akan dijalankan. IP yang dinyatakan harus dikonfigurasi dalam sistem dan UP benar
vport nombor Pelabuhan ladang, di mana perkhidmatan maya akan mendengar. Pelabuhan maya yang sama dan IP maya tidak boleh digunakan oleh ladang lain. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah Suai Ladang

Ubah Suai Ladang

Permintaan contoh:

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",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP 

PUT /farms/<farmname>

Ubah parameter global untuk ladang HTTP yang diberikan.

Minta parameter

Bidang Jenis Deskripsi
contimeout nombor Berapa lama ladang akan menunggu sambungan ke belakang dalam beberapa saat.
restimeout nombor Berapa lama ladang akan menunggu sambutan dari belakang dalam beberapa saat.
resurrectime nombor Nilai ini dalam beberapa saat adalah tempoh untuk mendapatkan backend yang disenarai hitam dan memeriksa jika masih hidup.
reqtimeout nombor Berapa lama ladang akan menunggu permintaan pelanggan dalam beberapa saat.
disable_sslv2 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan SSL dengan versi 2 tidak dibenarkan; atau palsu jika protokol SSLv2 dibenarkan.
disable_sslv3 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan SSL dengan versi 3 tidak dibenarkan; atau palsu jika protokol SSLv3 dibenarkan.
disable_tlsv1 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1 tidak dibenarkan; atau palsu jika protokol TLSv1 dibenarkan.
disable_tlsv1_1 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1.1 tidak dibenarkan; atau palsu jika protokol TLSv1.1 dibenarkan.
disable_tlsv1_2 Rentetan Hanya dalam pendengar https. Jika bidang ini mempunyai nilai benar sambungan menggunakan protokol keselamatan TLS dengan versi 1.2 tidak dibenarkan; atau palsu jika
rewritelocation Rentetan Sekiranya ia diaktifkan, ladang terpaksa mengubahsuai Lokasi: dan Lokasi Kandungan: tajuk dalam respons kepada klien dengan hos maya. Pilihannya ialah: membolehkan, aktif orang kurang upaya, tidak aktif atau back-enabled hanya alamat backend yang dibandingkan.
kata keterangan Rentetan Bidang ini menunjukkan operasi yang akan dibenarkan kepada permintaan klien HTTP. nilai yang ada ialah: standardHTTP, permintaan http tidak diterima GET, POST, HEAD. extendedHTTP, menerima permintaan http sebelumnya ditambah PUT, DELETE. standardWebDAV, menerima permintaan http sebelumnya ditambah LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPSYEN, TRACE, KARAKTER, CHECKOUT, MERGE, REPORT, MSextWebDAV menerima permintaan http sebelumnya ditambah SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan http sebelumnya ditambah RPC_IN_DATA, RPC_OUT_DATA. Perhatikan bahawa nilai-nilai tersebut adalah sensitiviti kes.
error414 Rentetan Ralat mesej peribadi 414.
error500 Rentetan Ralat mesej peribadi 500.
error501 Rentetan Ralat mesej peribadi 501.
error503 Rentetan Ralat mesej peribadi 503.
pendengar Rentetan Pendengar mendefinisikan bagaimana ladang akan bermain dengan permintaan daripada pelanggan. Pilihannya ialah: http kerana protokol tidak selamat atau https untuk protokol yang selamat.
tulisan rahsia Rentetan Hanya dalam pendengar dengan nilai https. Digunakan untuk membina senarai cipher yang diterima oleh sambungan SSL untuk mengeras sambungan SSL. Pilihannya ialah: semua, semua ciphers akan diterima; keselamatan tinggi, ciphers hanya untuk keselamatan yang tinggi akan diterima; atau keselamatan, ciphers hanya dimuatkan cipherc bidang akan diterima.
cipherc Rentetan Hanya dalam pendengar https. Ini adalah senarai ciphers yang diperibadikan yang akan diterima oleh sambungan SSL, yang merupakan rentetan dalam format yang sama seperti dalam cip OpenSSL. Atribut ini digunakan hanya apabila tulisan rahsia bidang mempunyai nilai sutomsecurity.
newfarmname Rentetan Nama Ladang baru. Ladang mesti dihentikan.
vport nombor Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar, IP ini mesti dikonfigurasi dan di dalam sistem.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Tambah Sijil

Tambah Sijil

Permintaan contoh:

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.1/zapi.cgi/farms/httpFarm/certificates

POST /farms/<farmname>/certificates

Tukar Sijil PEM ladang HTTP dengan pendengar HTTPS. Sijil yang digunakan perlu dimuat naik dalam sistem, lihat Sijil> Senaraikan semua Sijil untuk senarai sijil yang tersedia.

Minta parameter

Bidang Jenis Deskripsi diperlukan
fail Rentetan nama fail sijil, sebelum ini sijil perlu dimuat naik dalam sistem. benar

Contoh tindak balas:

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

HTTP - Perkhidmatan

Perkhidmatan dalam ladang profil HTTP menyediakan kaedah pensuisan kandungan untuk menyampaikan beberapa perkhidmatan web dengan ciri-ciri, backends atau kaedah ketekunan yang berlainan, melalui beberapa syarat deterministik yang digunakan oleh teras ladang untuk memadankan perkhidmatan yang betul untuk setiap permintaan klien. Takrif perkhidmatan ini akan digunakan oleh ladang untuk menentukan pelayan sokongan yang dapat memberikan respons kepada klien.

Objek perkhidmatan di dalamnya terdapat dua jenis nilai: berkaitan perkhidmatan dan berkaitan dengan petani.

Farmguardian digunakan untuk pemantauan maju latar belakang dan benar-benar diperibadikan untuk skrip anda sendiri untuk perkhidmatan semasa. Apabila masalah dikesan oleh tukang ladang secara automatik melumpuhkan pelayan sebenar dan akan ditandakan sebagai senarai hitam.

Dapatkan perkhidmatan dengan ID

Dapatkan perkhidmatan dengan ID

Permintaan contoh:

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

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

Tunjukkan semua konfigurasi mengenai perkhidmatan yang diberikan.

Contoh tindak balas:

{
   "description" : "Get services of a farm",
   "services" : {
      "backends" : [
         {
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : 20,
            "weight" : null
         },
         {
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null
         }
      ],
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "check_tcp -H HOST -p PORT",
      "fgtimecheck" : 5,
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : ""
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek perkhidmatan untuk ladang HTTP:

Bidang Jenis Deskripsi
backends Objek [] Backends ditakrifkan dalam perkhidmatan.
fgenabled Rentetan Membolehkan penggunaan penjaga ladang. benar penjaga ladang diaktifkan dan menyemak status backend, palsu penjaga ladang dilumpuhkan dan tidak memeriksa status backends. Dalam profil HTTP check_tcp dilaksanakan secara lalai walaupun penjaga ladang dimatikan.
fglog Rentetan Membolehkan penggunaan log di penjaga ladang. benar didayakan, palsu, kurang upaya. fgenabled adalah diperlukan.
fgscript Rentetan Perintah penjaga ladang akan digunakan untuk memeriksa kesihatan belakang. benar didayakan, palsu, kurang upaya. fgenabled adalah diperlukan.
fgtimecheck nombor penjaga ladang akan memeriksa setiap 'timetocheck' detik status kesihatan backend. fgenabled adalah diperlukan.
httpsb Rentetan Parameter ini menunjukkan kepada ladang bahawa pelayan belakang yang ditakrifkan dalam perkhidmatan semasa menggunakan bahasa HTTPS dan kemudian data akan disulitkan sebelum dihantar. benar, profil menghantar lalu lintas dalam protokol HTTPS ke belakang, palsu, profil menghantar lalu lintas dalam protokol HTTP ke belakang.
id Rentetan Nama perkhidmatan, tidak dapat diubah setelah perkhidmatan dibuat.
kurangnya Rentetan Ia membolehkan kaedah mengimbangi yang paling kurang. benar dengan mudah pemeriksaan profil yang backend mengambil masa kurang untuk bertindak balas untuk menghantar lebih banyak sambungan ke yang ini, palsu profil tidak memeriksa backend mana yang memerlukan lebih sedikit masa untuk bertindak balas.
kegigihan Rentetan Parameter ini menentukan bagaimana perkhidmatan HTTP akan menguruskan sesi klien. Pilihannya ialah: "" rentetan kosong, tiada tindakan diambil, IP sesi ketekunan dilakukan di dasar IP pelanggan, ASAS sesi ketekunan dilakukan di pangkalan header BASIC, URL sesi ketekunan dilakukan di pangkalan lapangan di URI, PARM sesi ketekunan dilakukan berdasarkan nilai pada akhir URI, COOKIE sesi ketekunan dilakukan di dasar nama cookie, cookie ini harus dibuat oleh backends, dan KEPALA, sesi ketekunan dilakukan di bawah nama Header.
mengarahkan Rentetan Ia berperanan sebagai backend khas, kerana permintaan pelanggan dijawab dengan mengarahkan ke URL baru secara automatik. Sekiranya pengalihan dikonfigurasi maka permintaan itu tidak akan diteruskan ke backend, Redirect akan dijawab kepada klien sebaliknya.
redirecttype Rentetan Bagaimana pengalihan semula akan dilakukan, dua pilihan: lalai, url diambil sebagai hos mutlak dan laluan untuk mengalihkan, tambah, jalan permintaan asal atau URI akan ditambahkan pada hos dan jalan yang anda tentukan dengan pilihan lalai. Jika mengarahkan medan tidak dikonfigurasi, medan ini akan menjadi tali kosong.
sessionid Rentetan Ia boleh didapati jika kegigihan medan adalah URL, COOKIE atau HEADER, nilai parameter akan dicari oleh ladang di http header dan akan menguruskan sesi klien.
ttl nombor Hanya dengan kegigihan. Nilai ini menunjukkan masa maksimum bagi sesi klien tidak aktif (umur sesi max) dalam saat.
urlp Rentetan Membolehkan untuk menentukan perkhidmatan web berkenaan URL yang diminta pelanggan melalui corak URL khusus yang akan diperiksa secara sintaksis. Ungkapan biasa PCRE disokong.
vhost Rentetan Ia menentukan syarat yang ditentukan oleh nama domain melalui IP dan port maya yang sama yang ditakrifkan oleh ladang HTTP. Ungkapan biasa PCRE disokong.

Objek backend untuk ladang HTTP:

Bidang Jenis Deskripsi
id nombor Pengenalpastian backend di dalam perkhidmatan yang diberikan.
ip Rentetan Backend's IP tempat perkhidmatan sebenar dijalankan.
pelabuhan nombor Pelabuhan backend tempat perkhidmatan sebenar dijalankan.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu, dalam beberapa saat. Jika sistem null akan menggunakan parameter masa akhir Backends.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa, backend dengan nilai berat yang lebih tinggi akan menerima lebih banyak sambungan. Nol nilai lalai, bukan berat khas yang digunakan untuk backend ini.

Buat Perkhidmatan baru

Buat Perkhidmatan baru

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services

POST /farms/<farmname>/services

Buat perkhidmatan di ladang profil HTTP yang diberikan. Ladang memerlukan tindakan restart untuk menerapkan perubahan ini.

Minta parameter

Bidang Jenis Deskripsi diperlukan
id Rentetan Nama perkhidmatan yang digunakan sebagai pengecam unik. Hanya nilai abjad angka yang dibenarkan. benar

Contoh tindak balas:

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

Ubah Suai Perkhidmatan

Ubah Suai Perkhidmatan

Permintaan contoh:

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

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

Ubah suai parameter perkhidmatan dalam profil HTTP. id adalah pengecam unik perkhidmatan yang akan diubahsuai.

Minta parameter

Bidang Jenis Deskripsi
vhost Rentetan Menentukan keadaan yang ditentukan oleh nama domain melalui IP dan port maya yang sama yang ditentukan oleh ladang profil HTTP. Ungkapan biasa PCRE disokong.
urlp Rentetan Membolehkan untuk menentukan perkhidmatan web berkenaan URL yang diminta pelanggan melalui corak URL khusus yang akan diperiksa secara sintaksis. Ungkapan biasa PCRE disokong.
mengarahkan Rentetan Ia berfungsi sebagai backend khas, permintaan klien dijawab dengan mengarahkan ke URL baru secara automatik.
redirecttype Rentetan Bagaimana peralihan akan dilakukan, dua pilihan: lalai, url diambil sebagai hos mutlak dan laluan untuk mengalihkan, tambah, laluan permintaan asal atau URI akan ditambahkan pada hos dan laluan yang anda tentukan mengarahkan bidang. Tingkah laku ini hanya akan terpakai jika mengarahkan bukan nilai kosong.
kegigihan Rentetan Parameter ini menentukan bagaimana perkhidmatan HTTP akan menguruskan sesi klien. Pilihannya ialah: "" rentetan kosong, tiada tindakan diambil, IP sesi ketekunan dilakukan di dasar IP pelanggan, ASAS sesi ketekunan dilakukan di pangkalan header BASIC, URL sesi ketekunan dilakukan di pangkalan lapangan di URI, PARM sesi kegigihan dilakukan berdasarkan nilai yang dipisahkan dengan “;” pada akhir URI, COOKIE sesi ketekunan dilakukan di dasar nama cookie, cookie ini harus dibuat oleh backends, dan KEPALA, sesi ketekunan dilakukan di bawah nama Header.
ttl nombor Hanya dengan kegigihan. Waktu maksimum untuk sesi klien tidak aktif (umur sesi max) dalam beberapa saat.
sessionid Rentetan Ia boleh didapati jika kegigihan bidang adalah URL, COOKIE or KEPALA, nilai parameter akan dicari oleh profil dalam header http dan akan menguruskan sesi klien.
kurangnya Rentetan Ia membolehkan kaedah mengimbangi yang paling kurang. benar, dengan pantas pemeriksaan profil yang backend mengambil masa kurang untuk bertindak balas untuk menghantar lebih banyak sambungan ke ini, palsu, profil tidak memeriksa backend mana yang memerlukan lebih sedikit masa untuk bertindak balas.
httpsb Rentetan Ia menunjukkan kepada ladang bahawa pelayan belakang yang ditakrifkan dalam perkhidmatan semasa menggunakan bahasa HTTPS dan kemudian data akan disulitkan sebelum dihantar. benar, profil menghantar lalu lintas dalam protokol HTTPS ke belakang, palsu, profil menghantar lalu lintas dalam protokol HTTP ke belakang.

Contoh tindak balas:

{
   "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" : [],
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "",
      "fgtimecheck" : 5,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirecttype" : "default",
      "sessionid" : "sid",
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com"
   },
   "status" : "needed restart"
}

Parameter tindak balas

Sambutan akan menjadi json dengan parameter yang diminta dikemas kini dan status bidang dengan perlu dimulakan semula nilai. Mulakan semula tindakan perlu diambil untuk menerapkan perubahan.

Ubah suai penjaga ladang

Ubah suai penjaga ladang

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"check_tcp","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/fg

Farmguardian digunakan untuk pemantauan maju latar belakang dan benar-benar diperibadikan untuk skrip anda sendiri untuk perkhidmatan semasa. Apabila masalah dikesan oleh tukang ladang secara automatik melumpuhkan pelayan sebenar dan akan ditandakan sebagai senarai hitam.

PUT /farms/<farmname>/fg

Ubah suai parameter penjaga ladang dalam profil HTTP yang diberikan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
fgtimecheck nombor Penjaga ladang akan memeriksa status kesihatan backend setiap 'timetocheck' saat.
fgscript Rentetan Perintah penjaga ladang akan dijalankan untuk memeriksa status kesihatan belakang
fgenabled Rentetan Ia membolehkan penjaga ladang dalam perkhidmatan yang ditunjukkan. benar penjaga ladang akan digunakan untuk menyemak status backend, palsu penjaga ladang akan dilumpuhkan
fglog Rentetan Membolehkan penggunaan log di penjaga ladang. benar penjaga ladang akan log apa-apa tindakan, palsu penjaga ladang tidak akan log apa-apa tindakan, adalah disyorkan untuk membolehkan fglog hanya untuk menyelesaikan masalah.
perkhidmatan Rentetan Nama perkhidmatan digunakan sebagai pengecam unik. benar

Contoh tindak balas:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "fgenabled" : "true",
      "fglog" : "true",
      "fgscript" : "checktcp",
      "fgtimecheck" : 5,
      "service" : "service1"
   }
}

Padam Perkhidmatan

Padam Perkhidmatan

Permintaan contoh:

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

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

Padamkan perkhidmatan yang diberikan profil http. id adalah pengecam unik perkhidmatan yang akan dipadamkan.

Contoh tindak balas:

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

HTTP - Perkhidmatan - Backends

Senaraikan bahagian belakang

Senaraikan bahagian belakang

Permintaan contoh:

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

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

Dapatkan senarai backends dalam perkhidmatan. id adalah pengecam unik perkhidmatan.

Contoh tindak balas:

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

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
id nombor Pengenal pasti unik untuk backend dalam perkhidmatan. Pengenal ini dihasilkan oleh sistem.
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar.
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu, dalam beberapa saat.
berat badan nombor Ini adalah nilai berat untuk backend semasa.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.

Buat Backend baru

Buat Backend baru

Permintaan contoh:

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

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

Buat Backend baru dalam profil HTTP yang diberikan. id adalah pengecam unik perkhidmatan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar. benar
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar. benar
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu.
berat badan nombor Ini adalah nilai berat untuk backend semasa.

Contoh tindak balas:

{
   "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 tindak balas

Sambutan akan menjadi json dengan parameter yang diminta dikemas kini dan status bidang dengan perlu dimulakan semula nilai jika ladang mesti dimulakan semula. Mulakan semula tindakan perlu diambil untuk menerapkan perubahan.

Ubah suai Backend

Ubah suai Backend

Permintaan contoh:

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

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

Ubah suai parameter backend dalam perkhidmatan profil HTTP.

pertama id adalah pengecam unik perkhidmatan, seterusnya id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar.
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu, dalam beberapa saat.
berat badan nombor Ini adalah nilai berat untuk backend semasa.

Contoh tindak balas:

{
   "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 tindak balas

Sambutan akan menjadi json dengan parameter yang diminta dikemas kini dan status bidang dengan perlu dimulakan semula nilai jika ladang mesti dimulakan semula. Mulakan semula tindakan perlu diambil untuk menerapkan perubahan.

Backend dalam penyelenggaraan

Backend dalam penyelenggaraan

Permintaan contoh:

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

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

Tetapkan tindakan yang diberikan dalam backend ladang HTTP, tindakan yang tersedia diterangkan di bawah.

pertama id adalah pengecam unik perkhidmatan, seterusnya id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tetapkan tindakan yang dikehendaki. Tindakannya adalah: up backend bersedia untuk menerima permintaan pelanggan, penyelenggaraan backend tidak bersedia menerima permintaan pelanggan, tindakan ini berguna untuk menghentikan pelayan belakang tanpa menjejaskan klien. benar
mod Rentetan Pilih mod penyelenggaraan. Pilihan yang tersedia ialah: longkang, backend tidak menerima sambungan baru, tetapi ia akan terus mengendalikan sambungan semasa; atau memotong, sambungan semasa akan ditutup. Jika bidang ini tidak ditentukan, mod lalai akan menjadi longkang.

Contoh tindak balas:

{
   "description" : "Set service backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

Padamkan sandaran belakang

Padamkan sandaran belakang

Permintaan contoh:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4

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

Padamkan backend yang diberikan dalam perkhidmatan profil HTTP.

pertama id adalah pengecam unik perkhidmatan, seterusnya id adalah pengecam unik backend.

Contoh tindak balas:

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

L4xNAT Farms

Ladang profil L4xNAT membolehkan untuk mewujudkan ladang L4 dengan prestasi yang sangat tinggi dan sambungan yang lebih serentak daripada teras pengimbangan beban dalam lapisan 7 seperti profil ladang HTTP. Peningkatan prestasi lapisan 4 ini mengatasi pengendalian kandungan lanjutan yang dapat dikendalikan profil lapisan 7.

Di samping itu, ladang L4xNAT boleh mengikat pelbagai port, bukan hanya satu port maya seperti yang digunakan dengan profil 7 lapisan lain. Untuk dapat memilih pelbagai port maya atau port maya tertentu dalam ladang L4xNAT, wajib untuk memilih jenis protokol. Dalam kes lain, ladang akan mendengar semua port dari IP maya (ditandakan dengan aksara ''). Sebaik sahaja protokol TCP atau UDP dipilih, ia akan tersedia untuk menentukan pelabuhan, beberapa port antara ',', julat port antara ':' atau semua pelabuhan dengan ''. Gabungan kesemuanya juga sah.

Dapatkan ladang dengan nama

Dapatkan ladang dengan nama

Permintaan contoh:

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

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Tindak balas BODY:

{
   "backends" : [
      {
         "id" : 0,
         "ip" : "192.168.55.40",
         "max_conns" : 0,
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.168.55.41",
         "max_conns" : 0,
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "",
      "fgtimecheck" : 5,
      "listener" : "l4xnat",
      "nattype" : "nat",
      "persistence" : "",
      "protocol" : "tcp",
      "status" : "down",
      "ttl" : 120,
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek Ladang:

Bidang Jenis Deskripsi
params Objek Parameter konfigurasi ladang.
backends Objek [] Semua pelayan sejati yang dibuat di ladang ini dan konfigurasinya.

Objektif parameter untuk ladang L4xNAT:

Bidang Jenis Deskripsi
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan di Ladang. Pilihannya ialah: paling tidak sambungan sentiasa ke pelayan sambungan sekurang-kurangnya, berat badan penghantaran lurus mengikut berat, prio Sambungan selalu menjadi yang paling penting.
pendengar Rentetan Pendengar menentukan bagaimana ladang akan bermain dengan permintaan dari pelanggan. bidang maklumat, tidak dapat diubah.
nattype Rentetan Bagaimana lapisan pengimbangan beban 4 teras akan beroperasi. Pilihannya ialah: nat juga dipanggil mod sNAT, backend bertindak balas kepada balancer beban untuk menghantar respons kepada klien, dnat backend akan bertindak balas terus kepada klien, pengimbang beban perlu dikonfigurasi sebagai pintu masuk di pelayan belakang.
kegigihan Rentetan Alamat ip yang sama akan disambungkan ke pelayan yang sama. Pilihannya ialah: "" nilai kosong, kegigihan dilumpuhkan, ip Kegigihan didayakan melalui, IP asal digunakan seperti ID unik dalam sesi.
protokol Rentetan Protokol hendaklah seimbang di lapisan 4. Pilihannya ialah: semua profil akan memuatkan kira-kira sebarang protokol L4, tcp pengimbang beban hanya akan mengimbangi protokol TCP L4, udp pengimbang beban hanya akan mengimbangi protokol UDP L4, menghirup pengimbang beban hanya akan mengimbangi protokol SIP atau VoIP L7, ftp pengimbang beban hanya akan mengimbangi protokol FTP L7, tftp pengimbang beban hanya akan mengimbangi protokol TFTP L7.
status Rentetan Status ladang. Nilai status yang tersedia ialah: turun, ladang tidak berjalan; perlu dimulakan semula, ladang itu sudah selesai tetapi menunggu tindakan restart; kritikal, ladang itu habis dan semua backend tidak terjangkau atau penyelenggaraan; masalah, ladang itu ada dan terdapat beberapa backend yang tidak dapat dijangkau, tetapi hampir backend berada dalam kedudukan status; penyelenggaraan, ladang itu ada dan ada backends dalam status, tetapi hampir backend dalam mod penyelenggaraan; up, ladang itu habis dan semua hujungnya berjaya.
ttl nombor Nilai medan ini menunjukkan bilangan detik yang berterusan di antara sumber klien dan backend sedang diberikan, dalam beberapa saat. Kegigihan mesti dikonfigurasikan.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.
vport Rentetan Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar. Pelabuhan yang unik boleh dibezakan, pelabuhan pelbagai boleh dibezakan dengan pemisah : dan beberapa pelabuhan boleh dibezakan dengan pemisah ,.
fgenabled Rentetan Membolehkan penggunaan penjaga ladang. benar penjaga ladang diaktifkan, palsu penjaga ladang dilumpuhkan.
fglog Rentetan Membolehkan penggunaan log di penjaga ladang. fgenabled mesti diaktifkan.
fgscript Rentetan Perintah penjaga ladang akan diperiksa. Perintah yang ada di dalam laluan libexec. fgenabled mesti diaktifkan.
fgtimecheck nombor Penjaga ladang akan memeriksa setiap 'timetocheck' detik. fgenabled mesti diaktifkan.

Objek backend untuk ladang L4xNAT:

Bidang Jenis Deskripsi
id nombor ID untuk mengenal pasti backend di ladang.
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar.
max_conns nombor Ini adalah bilangan maksimum sambungan serentak untuk backend. Sekiranya bidang ini mempunyai nilai 0, backend tidak mengkonfigurasi had sambungan.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar. Nilai kosong diterima dan ia akan menggunakan konfigurasi yang sama dengan port maya.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Sambungan selalu kepada yang paling utama yang tersedia di mana 1 adalah yang paling utama.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan.

Buat Farm baru

Buat Farm baru

Permintaan contoh:

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.1/zapi.cgi/farms

POST /farms

Buat ladang L4xNAT baru.

Minta parameter

Bidang Jenis Deskripsi diperlukan
farmname Rentetan Nama ladang, pengecam unik. benar
profil Rentetan Profil Ladang yang dicipta. Untuk ladang L4xNAT adalah l4xnat, mesej maklumat, nilai ini tidak dapat diubah benar
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar. benar
vport Rentetan Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar. Ladang L4xNAT membenarkan multipport dipisahkan oleh , atau port pelbagai dipisahkan oleh :. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah Suai Ladang

Ubah Suai Ladang

Permintaan contoh:

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

PUT /farms/<farmname>

Ubah suai konfigurasi ladang L4xNAT.

Minta parameter

Bidang Jenis Deskripsi
newfarmname Rentetan Nama Ladang baru. Ladang mesti dihentikannya.
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan di Ladang. Pilihannya ialah: paling tidak sambungan sentiasa ke pelayan sambungan sekurang-kurangnya, berat badan penghantaran lurus mengikut berat, prio Sambungan selalu menjadi yang paling penting.
nattype Rentetan Bagaimana lapisan pengimbangan beban 4 teras akan beroperasi. Pilihannya ialah: nat juga dipanggil mod sNAT, backend bertindak balas kepada balancer beban untuk menghantar respons kepada klien, dnat backend akan bertindak balas terus kepada klien, pengimbang beban perlu dikonfigurasi sebagai pintu masuk di pelayan belakang.
kegigihan Rentetan Alamat ip yang sama akan disambungkan ke pelayan yang sama. Pilihannya ialah: "" nilai kosong, kegigihan dilumpuhkan, ip Kegigihan didayakan melalui, IP asal digunakan seperti ID unik dalam sesi.
protokol Rentetan Protokol hendaklah seimbang di lapisan 4. Pilihannya ialah: semua profil akan memuatkan kira-kira sebarang protokol L4, tcp pengimbang beban hanya akan mengimbangi protokol TCP L4, udp pengimbang beban hanya akan mengimbangi protokol UDP L4, menghirup pengimbang beban hanya akan mengimbangi protokol SIP atau VoIP L7, ftp pengimbang beban hanya akan mengimbangi protokol FTP L7, tftp pengimbang beban hanya akan mengimbangi protokol TFTP L7.
ttl nombor Nilai medan ini menunjukkan bilangan detik yang berterusan di antara sumber klien dan backend sedang diberikan, dalam beberapa saat. Kegigihan mesti dikonfigurasikan.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.
vport Rentetan Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar. Pelabuhan yang unik boleh dibezakan, pelabuhan pelbagai boleh dibezakan dengan pemisah : dan beberapa pelabuhan boleh dibezakan dengan pemisah ,.

Contoh tindak balas:

{
   "description" : "Modify farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "nattype" : "nat",
      "newfarmname" : "l4farm",
      "persistence" : "",
      "protocol" : "tcp",
      "ttl" : 125,
      "vip" : "178.62.126.152",
      "vport" : "81"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai penjaga ladang

Ubah suai penjaga ladang

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"Command of Farm Guardian","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/fg

Farmguardian digunakan untuk pemantauan maju latar belakang dan benar-benar diperibadikan untuk skrip anda sendiri untuk perkhidmatan semasa. Apabila masalah dikesan oleh tukang ladang secara automatik melumpuhkan pelayan sebenar dan akan ditandakan sebagai senarai hitam.

PUT /farms/<farmname>/fg

Ubah suai parameter penjaga ladang dalam perkhidmatan L4xNAT.

Minta parameter

Bidang Jenis Deskripsi
fgenabled Rentetan Membolehkan penggunaan penjaga ladang. benar penjaga ladang diaktifkan, palsu penjaga ladang dilumpuhkan.
fglog Rentetan Membolehkan penggunaan log di penjaga ladang. fgenabled mesti diaktifkan.
fgscript Rentetan Perintah penjaga ladang akan diperiksa. Perintah yang ada di dalam laluan libexec. fgenabled mesti diaktifkan.
fgtimecheck nombor Penjaga ladang akan memeriksa setiap 'timetocheck' detik. fgenabled mesti diaktifkan.

Contoh tindak balas:

{
   "description" : "Modify farm guardian",
   "message" : "Success, some parameters have been changed in farm guardian in farm l4farm.",
   "params" : {
      "fgenabled" : "true",
      "fglog" : "true",
      "fgscript" : "check_tcp",
      "fgtimecheck" : 5
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

L4xNAT - Backends

Senaraikan bahagian belakang

Senaraikan bahagian belakang

Permintaan contoh:

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

GET /farms/<farmname>/backends

Dapatkan senarai backends dalam perkhidmatan.

Contoh tindak balas:

{
   "description" : "List backends",
   "params" : [
      {
         "id" : 0,
         "ip" : "192.5.1.1",
         "max_conns" : 400,
         "port" : 787,
         "priority" : 1,
         "status" : "up",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.5.1.3",
         "max_conns" : 200,
         "port" : 787,
         "priority" : 2,
         "status" : "up",
         "weight" : 1
      },
   ]
}

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
id nombor ID untuk mengenal pasti backend di ladang.
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar. Nilai kosong diterima dan ia akan menggunakan konfigurasi yang sama dengan port maya.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.
max_conns nombor Ini adalah bilangan maksimum sambungan serentak untuk backend. Sekiranya bidang ini mempunyai nilai 0, backend tidak mengkonfigurasi had sambungan.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Sambungan selalu kepada yang paling utama yang tersedia di mana 1 adalah yang paling utama.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan.

Buat Backend baru

Buat Backend baru

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends

POST /farms/<farmname>/backends

Buat Backend baru di Ladang L4xNAT yang diberikan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar. benar
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar. Nilai kosong diterima dan ia akan menggunakan konfigurasi yang sama dengan port maya.
max_conns nombor Ini adalah bilangan maksimum sambungan serentak untuk backend. Sekiranya bidang ini mempunyai nilai 0, backend tidak mengkonfigurasi had sambungan.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Sambungan selalu kepada yang paling utama yang tersedia di mana 1 adalah yang paling utama. Nilai lalai adalah 1.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan. Nilai lalai adalah 1.

Contoh tindak balas:

{
   "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 tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai Backend

Ubah suai Backend

Permintaan contoh:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.5.40","port":8080,"max_conns":220,"priority":4,"weight":7}' 
  https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/2

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

Ubah suai parameter backend dalam perkhidmatan Ladang L4xNAT. id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan Backend IP di mana perkhidmatan sebenar mendengar.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar. Nilai kosong diterima dan ia akan menggunakan konfigurasi yang sama dengan port maya.
max_conns nombor Ini adalah bilangan maksimum sambungan serentak untuk backend. Sekiranya bidang ini mempunyai nilai 0, backend tidak mengkonfigurasi had sambungan.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Sambungan selalu kepada yang paling utama yang tersedia di mana 1 adalah yang paling utama.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan.

Contoh tindak balas:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.5.40",
      "port" : 8080,
      "max_conns" : 220,
      "priority" : 4,
      "weight" : 7
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Backend dalam penyelenggaraan

Backend dalam penyelenggaraan

Permintaan contoh:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/1/maintenance

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

Tetapkan tindakan yang diberikan dalam backend ladang L4xNAT. id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tetapkan tindakan yang dikehendaki. Tindakannya adalah: up backend bersedia untuk menerima permintaan pelanggan, penyelenggaraan backend tidak bersedia menerima permintaan pelanggan, tindakan ini berguna untuk menghentikan pelayan belakang tanpa menjejaskan klien. benar
mod Rentetan Pilih mod penyelenggaraan. Pilihan yang tersedia ialah: longkang, backend tidak menerima sambungan baru, tetapi ia akan terus mengendalikan sambungan semasa; atau memotong, sambungan semasa akan ditutup. Jika bidang ini tidak ditentukan, mod lalai akan menjadi longkang.

Contoh tindak balas:

{
   "description" : "Set backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padamkan sandaran belakang

Padamkan sandaran belakang

Permintaan contoh:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/4

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

Padamkan backend yang diberikan dalam perkhidmatan ladang L4xNAT.

id adalah pengecam unik backend.

Contoh tindak balas:

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

Datalink Farms

Profail ladang datalink membolehkan untuk mewujudkan ladang berasaskan laluan di mana backends adalah router uplink atau gateways. Profil ladang jenis ini bersedia untuk berkongsi beberapa laluan penghala WAN uplink menggunakan penyeimbang beban sebagai multiplexer saluran uplink (input 1 dan beberapa output baris penghala). Oleh itu, ladang datalink boleh digunakan sebagai pautan komunikasi yang boleh didapati dan tambahan boleh digunakan sebagai peningkatan bandwidth yang menghubungkan jumlah jalur lebar antara pautan penghubung penghala.

Dapatkan ladang dengan nama

Dapatkan ladang dengan nama

Permintaan contoh:

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

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang.

Contoh tindak balas:

{
   "backends" : [
      {
         "id" : 0,
         "interface" : "eth0",
         "ip" : "192.168.100.10",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 2
      },
      {
         "id" : 1,
         "interface" : "eth0",
         "ip" : "192.168.100.11",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      }
   ],
   "description" : "List farm dlink",
   "params" : {
      "algorithm" : "weight",
      "status" : "down",
      "vip" : "192.168.100.199"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek Ladang:

Bidang Jenis Deskripsi
params Objek Parameter konfigurasi ladang.
backends Objek [] Pelayan sebenar yang dibuat di ladang ini dan konfigurasinya.

Parameter objek untuk ladang datalink:

Bidang Jenis Deskripsi
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan di Ladang. Pilihannya ialah: berat badan, penyeimbang mengedarkan di antara semua backend yang ada yang diberikan lebih banyak backends caj dengan atribut berat yang lebih tinggi atau prio, yang menghantar semua sambungan ke backend dengan nilai kecil keutamaan.
status Rentetan Status ladang. Nilai status yang tersedia ialah: turun, ladang tidak berjalan; perlu dimulakan semula, ladang itu sudah selesai tetapi menunggu tindakan restart; kritikal, ladang itu sudah habis dan semua backend tidak dapat dicapai; masalah, ladang itu ada dan terdapat beberapa backend yang tidak dapat dijangkau, tetapi hampir backend berada dalam kedudukan status; up, ladang itu habis dan semua hujungnya berjaya.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.

Objek backend untuk ladang datalink:

Bidang Jenis Deskripsi
id nombor Pengenal pasti unik untuk backend di ladang.
ip Rentetan IP backend, di mana perkhidmatan sebenar sedang didengar.
antara muka Rentetan Ia antara muka rangkaian tempatan di mana backend disambungkan ke.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Ia akan digunakan apabila algoritma medan adalah konfigurasi sebagai prio dan keutamaan yang lebih rendah akan mempunyai keutamaan
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; undefined, status backend belum diperiksa.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Ia akan digunakan bila algoritma medan adalah konfigurasi sebagai berat.

Buat Farm baru

Buat Farm baru

Permintaan contoh:

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.1/zapi.cgi/farms

POST /farms

Buat ladang datalink baru.

Minta parameter

Bidang Jenis Deskripsi diperlukan
farmname Rentetan Nama ladang, pengecam unik. benar
profil Rentetan Profil Ladang yang dicipta. Untuk ladang datalink adalah datalink benar
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah Suai Ladang

Ubah Suai Ladang

Permintaan contoh:

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

PUT /farms/<farmname>

Ubah suai konfigurasi ladang datalink.

Minta parameter

Bidang Jenis Deskripsi
newfarmname Rentetan Nama ladang baru. Ladang mesti dihentikan.
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan di Ladang. Pilihannya ialah: berat badan, penyeimbang mengedarkan di antara semua backend yang ada yang diberikan lebih banyak backends caj dengan atribut berat yang lebih tinggi atau prio, yang menghantar semua sambungan ke backend dengan nilai kecil keutamaan.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Datalink - Backends

Backends di ladang datalink adalah pintu masuk melalui peralihan perkhidmatan. Perkhidmatan ini akan menjadi multiplexor di antara gerbang ini, dan sebahagian daripadanya tidak tersedia, perkhidmatan tersebut menggunakan yang lain.

Senaraikan bahagian belakang

Senaraikan bahagian belakang

Permintaan contoh:

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

GET /farms/<farmname>/backends

Dapatkan senarai backends dalam perkhidmatan.

Contoh tindak balas:

[
   {
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 2
   },
   {
      "id" : 7,
      "interface" : "eth0",
      "ip" : "192.168.100.11",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 1
   }
]

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
id nombor Pengenal pasti unik untuk backend di ladang. Pengenal ini dihasilkan oleh sistem.
antara muka Rentetan Ia antara muka rangkaian tempatan di mana backend disambungkan ke.
ip Rentetan IP backend, di mana perkhidmatan sebenar sedang didengar.
keutamaan nombor Ini adalah nilai keutamaan untuk backend semasa. Ia akan digunakan apabila algoritma medan adalah konfigurasi sebagai prio dan keutamaan yang lebih rendah akan mempunyai keutamaan.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; undefined, status backend belum diperiksa.
berat badan nombor Ini adalah nilai berat untuk backend semasa. Ia akan digunakan bila algoritma medan adalah konfigurasi sebagai berat.

Buat Backend baru

Buat Backend baru

Permintaan contoh:

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

POST /farms/<farmname>/backends

Buat Backend baru di Ladang datalink yang diberikan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan IP backend, di mana perkhidmatan sebenar sedang didengar. benar
antara muka Rentetan Ia antara muka rangkaian tempatan di mana backend disambungkan ke. benar
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar yang sebenar.Ia akan digunakan apabila algoritma medan adalah konfigurasi sebagai prio dan keutamaan yang lebih rendah akan mempunyai keutamaan. Nilai lalai adalah 1.
berat badan nombor Ini adalah nilai berat untuk backend semasa. Ia akan digunakan bila algoritma medan adalah konfigurasi sebagai berat. Nilai lalai adalah 1.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai Backend

Ubah suai Backend

Permintaan contoh:

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

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

Ubah suai parameter backend dalam perkhidmatan Farmasi datalink. id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi
Rentetan ip IP backend, di mana perkhidmatan sebenar sedang didengar.
antara muka Rentetan Ia antara muka rangkaian tempatan di mana backend disambungkan ke.
timeout nombor Ia adalah masa tamat belakang untuk menjawab permintaan tertentu.
berat badan nombor Ini adalah nilai berat untuk backend semasa.

Contoh tindak balas:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "interface" : "eth0",
      "ip" : "192.168.102.50",
      "timeout" : 1,
      "weight" : 1
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padamkan sandaran belakang

Padamkan sandaran belakang

Permintaan contoh:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends/4

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

Padamkan backend yang diberikan dalam perkhidmatan Farmasi datalink. id adalah pengecam unik backend.

Contoh tindak balas:

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

rangkaian

Zevenet boleh bekerja dengan pelbagai jenis antara muka rangkaian.

Dalam bahagian ini, anda boleh menyenaraikan, membuat, mengkonfigurasi, memadam dan menetapkan tindakan dalam NIC, VLAN dan antara muka maya.

Nic: atau kad antaramuka rangkaian, ia adalah komponen perkakasan komputer dan antara jenis antara muka adalah pangkalan untuk antara muka yang berikut yang boleh ditakrifkan dan diuruskan di Zevenet.

vlan: atau maya lan kad adalah jenis atau antara muka rangkaian yang menyediakan perkhidmatan segmentasi rangkaian. Lebih daripada satu vlan boleh diwujudkan melalui antara muka nic.

maya: Antaramuka jenis ini boleh dibuat melalui sebarang jenis antara muka yang dipaparkan di atas. Antara muka jenis ini harus digunakan untuk Farms dan diperlukan bahawa antara muka maya ditakrifkan dalam subnet yang sama daripada ibu bapa.

Senaraikan semua antara muka

Senaraikan semua antara muka

Permintaan contoh:

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

GET /interfaces

Dapatkan senarai antara muka dalam sistem dengan konfigurasi mereka.

Contoh tindak balas:

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic"
      },
      {
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "type" : "vlan"
      },
      {
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "virtual"
      },
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic"
      }
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan pelbagai objek antara muka.

Objek antara muka:

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa dalam antara muka maya.
has_vlan Rentetan Medan ini menunjukkan jika antara muka ini adalah ibu bapa antara muka VLAN. Bidang ini hanya untuk antara muka NIC.
netmask Rentetan Netmask antara muka. Nilai ini tidak boleh diubah suai dalam antara muka maya, ia diwarisi dari inteface ibu bapa.
gerbang Rentetan Gateway antara muka. Nilai ini tidak boleh diubah suai dalam antara muka maya, ia diwarisi dari inteface ibu bapa.
mac Rentetan MAC antara muka. Nilai ini diwarisi daripada antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik.
status Rentetan Nilai-nilai boleh up, antara muka boleh menerima paket; turun, antara muka tidak dapat menerima paket.
jenis Rentetan Antara jenis antaramuka yang berbeza adalah: Nic, vlan or maya.

Dapatkan gerbang lalai

Dapatkan gerbang lalai

Permintaan contoh:

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

GET /interfaces/gateway

Gerbang lalai adalah nod yang menghantar semua lalu lintas destinasi yang tidak dapat dicapai secara tempatan dari mana-mana antara muka dalam pengimbang beban.

Dapatkan parameter antaramuka pintu masuk lalai.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alamat Rentetan Ia adalah IP pintu masuk.
antara muka Rentetan Nama antara muka untuk pintu masuk.

Ubah suai pintu masuk lalai

Ubah suai pintu masuk lalai

Permintaan contoh:

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

PUT /interfaces/gateway

Ubah suai konfigurasi antara muka pintu masuk.

Contoh tindak balas:

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

Minta parameter

Bidang Jenis Deskripsi
alamat Rentetan Ia adalah IP pintu masuk.
antara muka Rentetan Nama antara muka untuk pintu masuk.

Padam konfigurasi pintu masuk

DELETE /interfaces/gateway

Padam konfigurasi konfigurasi gerbang lalai.

Amaran: jika pintu masuk disusun semula, Zevenet tidak akan dapat dicapai dari segmen rangkaian luar.

Padam konfigurasi pintu masuk

Permintaan contoh:

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

Mesej respons

Sekiranya gerbang disusun dari segmen rangkaian yang sama, mesej ini akan muncul, maka sambungan akan hilang.

Contoh tindak balas:

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

Rangkaian - Antara muka NIC

Antara muka NIC adalah antara muka fizikal yang disambungkan kepada pengimbang beban Zevenet anda.

Sistem ini mengiktiraf antara muka baharu secara automatik sebaik sahaja ia disambungkan.

Menggunakan antara muka NIC sebagai ibu bapa, jenis lain antara muka dengan ciri-ciri yang berbeza boleh dibuat. Antara muka yang ada ialah: VLAN dan maya.

Senaraikan antara muka NIC

GET /interfaces/nic

Dapatkan semua parameter antara muka NIC.

Senaraikan antara muka NIC

Permintaan contoh:

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

Contoh tindak balas:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up"
      }
   ]
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan pelbagai objek antara muka NIC.

Objek antara muka NIC:

Bidang Jenis Deskripsi
ip Rentetan IP antara muka.
has_vlan Rentetan Medan ini menunjukkan jika antara muka ini adalah ibu bapa antara muka VLAN. Bidang ini hanya untuk antara muka NIC.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket ke segmen rangkaian yang berbeza.
mac Rentetan Layer layer indentifier unik. Ia tidak dapat diubah.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengenal unik antara muka.
status Rentetan Nilai-nilai boleh up, antara muka boleh menerima paket; turun, antara muka tidak dapat menerima paket.

Ambil semula antara muka NIC

Ambil semula antara muka NIC

Permintaan contoh:

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

GET /interfaces/nic/<name>

Dapatkan semua parameter antara muka NIC. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
ip Rentetan IP antara muka.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket ke segmen rangkaian yang berbeza.
mac Rentetan Layer layer indentifier unik. Ia tidak dapat diubah.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengenal unik antara muka.
status Rentetan Nilai-nilai boleh up, antara muka boleh menerima paket; turun, antara muka tidak dapat menerima paket.

Ubah suai antara muka NIC

Ubah suai antara muka NIC

Permintaan contoh:

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

PUT /interfaces/nic/<name>

Ubah suai parameter antara muka NIC. nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP antara muka.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza.

Contoh tindak balas:

{
   "description" : "Configure nic interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "netmask" : "255.255.255.0"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padam konfigurasi NIC

Padam konfigurasi NIC

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth3

DELETE /interfaces/nic/<name>

Padam konfigurasi untuk antara muka NIC. Selepas tindakan ini, antara muka akan menjadi sia-sia, dan bersedia untuk dikonfigurasikan semula. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Tetapkan tindakan antara muka NIC

Tetapkan tindakan antara muka NIC

Permintaan contoh:

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

POST /interfaces/nic/<name>/actions

Guna tindakan ke antara muka NIC. Panggilan ini membolehkan membolehkan atau melumpuhkan antara muka rangkaian.

nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan untuk memohon kepada antara muka. Nilai yang ada ialah: up, membolehkan antara muka dan menyediakannya untuk digunakan; turun, lumpuhkan antara muka untuk tidak menerima atau tidak menghantar paket. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Rangkaian - antara muka VLAN

Antara muka VLAN membolehkan antara muka NIC berfungsi dalam rangkaian lain, jadi IP, gerbang dan netmask bidang mungkin berbeza antara muka ibu bapa. Antara muka VLAN mewarisi alamat MAC dari antara muka ibu bapanya.

Medan antara muka VLAN nama akan muncul dengan huruf "." yang akan digunakan untuk menubuhkan tag pengecam untuk antara muka VLAN.

Senarai antara muka VLAN

Senarai antara muka VLAN

Permintaan contoh:

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

GET /interfaces/vlan

Dapatkan semua parameter antara muka VLAN.

Contoh tindak balas:

{
   "description" : "List VLAN interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan pelbagai objek antara muka VLAN.

Parameter VLAN adalah:

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. Ia boleh berbeza dengan IP inteface ibu bapa.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza.
mac Rentetan MAC antara muka. Nilai ini diwarisi dari antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh nama antara muka induk, watak titik "." dan nombor untuk antara muka rangkaian vlan atau tag vlan.
ibu bapa Rentetan Ia adalah Antara Muka yang digunakan untuk mencipta satu ini.
status Rentetan Nilai-nilai boleh up antara muka boleh menerima paket, turun antara muka tidak dapat menerima paket.

Ambil antara muka VLAN

Ambil antara muka VLAN

Permintaan contoh:

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

GET /interfaces/vlan/<name>

Dapatkan semua parameter antara muka VLAN. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
ip Rentetan IP antara muka.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza.
mac Rentetan MAC antara muka. Nilai ini diwarisi dari antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh nama antara muka induk, watak titik "." dan nombor untuk antara muka rangkaian vlan.
status Rentetan Nilai-nilai boleh up antara muka boleh menerima paket, turun antara muka tidak dapat menerima paket.

Buat antara muka VLAN

Buat antara muka VLAN

Permintaan contoh:

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

POST /interfaces/vlan

Buat antara muka VLAN dari antara muka NIC. Antara muka VLAN baru akan berkongsi MAC, walaupun parameter rangkaian berikut mestilah berbeza: ip, dan yang berikut boleh berubah: gerbang, netmask.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan IP antara muka. Ia mestilah berbeza dengan IP inteface ibu bapa. benar
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi. benar
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza. benar
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh nama antara muka induk, watak titik "." dan nombor untuk antara muka rangkaian vlan. benar

Contoh tindak balas:

{
   "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 tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai antara muka VLAN

Ubah suai antara muka VLAN

Permintaan contoh:

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

PUT /interfaces/vlan/<name>

Ubah suai parameter antara muka VLAN. nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. Ia boleh berbeza dengan IP inteface ibu bapa.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza.

Contoh tindak balas:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padam antara muka VLAN

Padam antara muka VLAN

Permintaan contoh:

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

DELETE /interfaces/vlan/<name>

Padam antara muka VLAN. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Tetapkan tindakan antara muka VLAN

Tetapkan tindakan antara muka VLAN

Permintaan contoh:

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

POST /interfaces/vlan/<name>/actions

Memohon tindakan ke antara muka VLAN. Panggilan ini membolehkan membolehkan atau melumpuhkan antara muka rangkaian.

nama adalah pengenal unik nama.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan untuk memohon kepada antara muka. Nilai yang ada ialah: up, membolehkan antara muka dan menyediakannya untuk digunakan; turun, lumpuhkan antara muka untuk tidak menerima atau tidak menghantar paket. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Rangkaian - Antara muka Maya

Antara muka rangkaian membolehkan pengguna mempunyai antara muka rangkaian lain dalam segmen rangkaian yang sama daripada ibu bapa, jadi antara muka maya sentiasa mewarisi konfigurasi rangkaian dari ibu bapanya. Parameter yang berbeza akan menjadi ip. Antara muka maya boleh dibuat dari NIC atau VLAN. Mewujudkan antara muka maya yang baru akan muncul medan dengan aksara ":" yang akan digunakan untuk menubuhkan pengenalan untuk antara muka maya.

Senaraikan antara muka Maya

Senaraikan antara muka Maya

Permintaan contoh:

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

GET /interfaces/virtual

Dapatkan semua parameter antara muka maya.

Contoh tindak balas:

{
   "description" : "List virtual interfaces",
   "interfaces" : [
      {
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "up"
      },
      {
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.41",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virtiface",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

Parameter tindak balas

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi. Ia mewarisi daripada antara muka ibu bapa.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza. Ia mewarisi daripada antara muka ibu bapa.
mac Rentetan MAC antara muka. Ia mewarisi daripada antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh antara muka induk, watak titik dua ":" dan nama untuk antara muka rangkaian maya, watak alfanumerik dibenarkan.
ibu bapa Rentetan Ia adalah Antara Muka yang digunakan untuk mencipta satu ini.
status Rentetan Nilai-nilai boleh up, antara muka boleh menerima paket; turun, antara muka tidak dapat menerima paket.

Ambil semula antara muka maya

Ambil semula antara muka maya

Permintaan contoh:

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

GET /interfaces/virtual/<name>

Dapatkan semua parameter antara muka maya. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi. Ia mewarisi daripada antara muka ibu bapa.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza. Ia mewarisi daripada antara muka ibu bapa.
mac Rentetan MAC antara muka. Ia mewarisi daripada antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh antara muka induk, watak titik dua ":" dan rentetan alfanumerik untuk antara muka rangkaian maya.
status Rentetan Nilai-nilai boleh up, antara muka boleh menerima paket; turun, antara muka tidak dapat menerima paket.

Buat antara muka maya

Buat antara muka maya

Permintaan contoh:

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

POST /interfaces/virtual

Buat antara muka maya.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa. benar
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh antara muka induk, watak titik dua ":" dan rentetan alfanumerik untuk antara muka rangkaian maya. benar

Contoh tindak balas:

{
   "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 tindak balas

Sambutan akan menjadi json dengan konfigurasi antara muka. Lihat contoh tindak balas untuk maklumat lanjut.

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi. Ia mewarisi daripada antara muka ibu bapa.
gerbang Rentetan IP digunakan untuk menghantar paket ke segmen rangkaian yang berbeza. Ia mewarisi daripada antara muka ibu bapa.
mac Rentetan MAC antara muka. Ia mewarisi daripada antara muka ibu bapa.
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang dibentuk oleh antara muka induk, watak titik dua ":" dan rentetan alpahnumerik untuk antara muka rangkaian maya.

Ubah suai antara muka maya

Ubah suai antara muka maya

Permintaan contoh:

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

PUT /interfaces/virtual/<name>

Ubah suai parameter antara muka maya. nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama daripada antara muka ibu bapa.

Contoh tindak balas:

{
   "description" : "Modify virtual interface",
   "params" : {
      "ip" : "192.168.100.10"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padam antara muka maya

Padam antara muka maya

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface

DELETE /interfaces/virtual/<name>

Padamkan antara muka maya. nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Tetapkan tindakan antara muka Maya

Tetapkan tindakan antara muka Maya

Permintaan contoh:

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

POST /interfaces/virtual/<name>/actions

Guna tindakan ke antara muka maya. Panggilan ini membolehkan membolehkan atau melumpuhkan antara muka rangkaian.

nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan untuk memohon kepada antara muka. Nilai yang ada ialah: up, membolehkan antara muka dan menyediakannya untuk digunakan; turun, lumpuhkan antara muka untuk tidak menerima atau tidak menghantar paket. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Pemantauan - Statistik

Tunjukkan maklumat mengenai sistem dan ladang. Maklumat ini berguna untuk memantau status pengimbang beban Zevenet.

Tunjukkan statistik sistem

Tunjukkan statistik sistem

Permintaan contoh:

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

GET /stats

Dapatkan statistik sistem global.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
cpu Objek Statistik CPU.
tarikh Rentetan Tarikh sistem.
nama hos Rentetan Nama hos.
memuatkan Objek Statistik beban teras.
memori Objek Statistik ingatan yang digunakan.
rangkaian Objek Statistik trafik rangkaian.

Objek CPU:

Bidang Jenis Deskripsi
teras nombor Bilangan teras dalam pemproses.
terbiar nombor CPU tidak digunakan oleh mana-mana program.
iowait nombor CPU yang digunakan oleh proses input atau output.
irq nombor CPU yang digunakan oleh interrrupcions perkakasan.
baik nombor Keutamaan penjadualan CPU.
softirq nombor CPU yang digunakan oleh interpolcione perisian.
sys nombor CPU yang digunakan oleh sistem.
penggunaan nombor Jumlah CPU yang digunakan.
pengguna nombor CPU yang digunakan oleh pengguna.

Beban objek:

Bidang Jenis Deskripsi
Last_1 nombor Muatkan sistem poros pada minit terakhir.
Last_5 nombor Muatkan sistem poros lima minit yang lalu.
Last_15 nombor Muatkan sistem poros lima belas minit yang lalu.

Objek memori.

Bidang Jenis Deskripsi
Buffer nombor Ia adalah memori yang digunakan oleh penampan. Jumlah ini ditunjukkan dalam Mb.
Cached nombor Ia adalah jumlah memori yang di-cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemFree nombor Ia adalah jumlah memori bebas yang tidak di cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
MemTotal nombor Ia adalah jumlah memori ram pada sistem. Jumlah ini ditunjukkan dalam Mb.
MemUsed nombor Ia adalah memori yang digunakan oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapCached nombor Ini jumlah memori cache yang dikhaskan.
SwapFree nombor Ia adalah jumlah memori bebas yang tidak di cache oleh sistem. Jumlah ini ditunjukkan dalam Mb.
SwapTotal nombor Ia adalah jumlah memori swap yang dikhaskan.
SwapUsed nombor Ia adalah memori yang digunakan swap oleh sistem, pada sistem yang optimum harus 0.

Objek rangkaian:

Bidang Jenis Deskripsi
masuk dalam nombor Trafik input untuk ini antara muka.
keluar keluar nombor Trafik output untuk ini antara muka.

Tunjukkan statistik rangkaian

Tunjukkan statistik rangkaian

Permintaan contoh:

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

GET /stats/system/network

Dapatkan ringkasan jumlah trafik input dan output melalui antara muka rangkaian.

Contoh tindak balas:

{
   "description" : "Network interfaces usage",
   "params" : {
      "date" : "Fri Jan 27 11:58:05 2017",
      "hostname" : "api3",
      "interfaces" : [
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "eth0.1",
            "out" : "4300.38"
        }
      ]
   }
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kekunci berikut:

Bidang Jenis Deskripsi
tarikh Rentetan Tarikh sistem.
nama hos Rentetan Nama hos.
antara muka Objek [] Statistik trafik rangkaian.

Objek antara objek

Bidang Jenis Deskripsi
in Rentetan Jumlah trafik input dalam MB.
antara muka Rentetan Nama antara muka.
keluar Rentetan Jumlah output trafficin MB.

Tunjukkan statistik ladang

Tunjukkan statistik ladang

Permintaan contoh:

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

GET /stats/farms

Dapatkan ringkasan sambungan dan konfigurasi untuk semua ladang dalam sistem.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
ditubuhkan nombor Jumlah bilangan sambungan semasa yang ditubuhkan.
farmname Rentetan Nama ladang, pengecam unik.
menunggu nombor Bilangan sambungan yang belum selesai.
profil Rentetan Jenis ladang. Nilai yang mungkin adalah: datalink, l4xnat, http or https. Setiap profil ditakrifkan dalam bahagiannya.
status Rentetan Status ladang. Nilai status yang tersedia ialah: turun, ladang tidak berjalan; perlu dimulakan semula, ladang itu sudah selesai tetapi menunggu tindakan restart; kritikal, ladang itu habis dan semua backend tidak terjangkau atau penyelenggaraan; masalah, ladang itu ada dan terdapat beberapa backend yang tidak dapat dijangkau, tetapi hampir backend berada dalam kedudukan status; penyelenggaraan, ladang itu ada dan ada backends dalam status, tetapi hampir backend dalam mod penyelenggaraan; up, ladang itu habis dan semua hujungnya berjaya.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.
vport Rentetan Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar.

Tunjukkan statistik ladang

Tunjukkan statistik ladang

Permintaan contoh:

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

GET /stats/farms/<farmname>

Menunjukkan status ladang semasa, status backend dan sambungan mereka. Setiap ladang akan bertindak balas dengan objek yang berlainan, bergantung kepada profil.

Contoh tindak balas untuk ladang 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 tindak balas di ladang HTTP

Bidang Jenis Deskripsi
backends Objek [] Tunjukkan maklumat mengenai backends.
sesi Objek [] Tunjukkan maklumat mengenai sesi.

Objek Backend

Bidang Jenis Deskripsi
ditubuhkan nombor Jumlah bilangan sambungan yang ditubuhkan.
id nombor Pengenalan unik backend.
ip Rentetan IP di mana perkhidmatan sebenar sedang didengar.
menunggu nombor Bilangan sambungan yang belum selesai.
pelabuhan nombor Pelabuhan di mana perkhidmatan sebenar sedang didengar.
perkhidmatan Rentetan Nama perkhidmatan digunakan sebagai pengecam unik.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.

Objek Sesi

Bidang Jenis Deskripsi
pelanggan Rentetan Pengenal pasti unik pelanggan.
id Rentetan Pengecam unik backend yang diberikan kepada pelanggan.
perkhidmatan Rentetan Pengecam unik perkhidmatan yang diberikan kepada pelanggan.
Sesi Rentetan Pengecam unik sesi. Nilai ini bergantung kepada jenis ketekunan.

Contoh tindak balas untuk ladang 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" : null,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats"
}

Parameter tindak balas dalam ladang L4xNAT

Sambutan akan menjadi JSON dengan kunci backends dan nilai objek objek dengan parameter di bawah.

Objek belakang:

Bidang Jenis Deskripsi
ditubuhkan nombor Jumlah bilangan sambungan semasa yang ditubuhkan.
id nombor Pengenalan unik backend.
ip Rentetan IP di mana perkhidmatan sebenar sedang didengar.
menunggu nombor Bilangan sambungan yang belum selesai.
pelabuhan nombor Pelabuhan di mana perkhidmatan sebenar sedang didengar.
status Rentetan Status belakang. Nilai yang mungkin adalah: up, ladang sedang berjalan dan backend bersedia untuk menerima sambungan; turun, ladang sedang berjalan dan perkhidmatan telah mengesan bahawa backend tidak berfungsi; penyelenggaraan, backend ditandai sebagai tidak bersedia untuk menerima sambungan oleh pentadbir, pilihan ini berguna untuk tugas main backend; undefined, status backend belum diperiksa.

Statistik ladang Datalink tidak tersedia sebenarnya.

Pemantauan - Grafik

Bahagian ini berguna untuk memantau sistem pengimbang beban dalaman untuk mengesan masalah melalui parameter penggunaan CPU, memori swap, memori ram, semua antara muka baru yang dikonfigurasi, beban dan penyimpanan cakera keras.

Anda juga boleh mengakses sejarah mingguan, mingguan dan tahunan.

Grafik dengan maklumat ditanggapi dalam format base64.

Senaraikan graf yang ada

Senaraikan graf yang ada

Permintaan contoh:

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

GET /graphs

Tunjukkan objek dengan semua graf yang ada dalam sistem. Ia menunjukkan permintaan yang boleh dibuat.

Contoh tindak balas:

{
   "description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
   "farms" : [
      "l4farm",
      "newfarm",
      "nwl4farm",
      "httpweb"
   ],
   "interfaces" : [
      "eth0.1",
      "eth1",
      "eth0"
   ],
   "system" : [
      "cpu",
      "load",
      "ram",
      "swap",
      {
         "disk" : [
            "root/",
            "root/boot",
            "root/usr/local/zenloadbalancer/config",
            "root/var/log"
         ]
      }
   ]
}

Parameter tindak balas

Tanggapan ini akan menjadi tiga jenis graf JSON, ladang, antara muka dan sistem.

Bidang Jenis Deskripsi
ladang Tali[] Senarai availables geran ladang.
antara muka Tali[] Senarai antara muka graf availables.
sistem Objek [] Senarai ganjaran availables sistem. Array mempunyai objek dengan array yang menunjukkan titik mount disk.

Objek sistem:

Objek sistem mengandungi senarai array yang berkaitan dengan sistem, dan objek cakera dengan format seterusnya.

Bidang Jenis Deskripsi
cakera Tali[] Nilai-nilai array ini semuanya ada titik pelekap dalam sistem, masing-masing mempunyai graf yang tersedia.

Tunjukkan graf

Tunjukkan graf

Mohon contoh untuk ladang:

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

Meminta contoh untuk antara muka:

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

Mohon contoh untuk cakera:

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

GET /graphs/<graph>

Nilai yang ada untuk graf ialah:

nilai Deskripsi
farms/<farmname> farmname, pengenal unik ladang.
interfaces/<interface> antara muka, pengenal unik antara muka.
system/<system> sistem, kemungkinan graf sistem adalah: cpu, memuatkan, ram or swap.
system/disk/<mount point> titik pelekap, adalah nilai cakera objek, dikembalikan dengan panggilan 'GET / grafik'.

Contoh tindak balas:

{
   "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 tindak balas

Bidang Jenis Deskripsi
kekerapan Rentetan Tempoh masa yang digunakan untuk menghasilkan graf. Nilai yang mungkin adalah: harian, mingguan, bulanan or setiap tahun.
graf Rentetan Grafik dalam format 64 asas.

Tunjukkan graf frekuensi

Tunjukkan graf frekuensi

Mohon contoh untuk ladang:

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

Meminta contoh untuk antara muka:

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

Mohon contoh untuk cakera:

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

GET /graphs/<graph>/<frequency>

Nilai yang ada untuk graf ialah:

nilai Deskripsi
farms/<farmname> farmname, pengenal unik ladang.
interfaces/<interface> antara muka, pengenal unik antara muka.
system/<system> sistem, kemungkinan graf sistem adalah: cpu, memuatkan, ram or swap.
system/disk/<mount point> titik pelekap, adalah nilai cakera objek, dikembalikan dengan panggilan 'GET / grafik'.

Nilai yang ada untuk kekerapan ialah:

Bidang Jenis Deskripsi
kekerapan Rentetan Tempoh masa yang digunakan untuk menghasilkan graf. Nilai yang mungkin adalah: harian, mingguan, bulanan or setiap tahun.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
graf Rentetan Grafik dalam format 64 asas.

sistem

Pilihan sistem menawarkan kemungkinan mempersonalisasikan perkhidmatan yang berjalan dalam pengimbang dan parameter global.

Tunjukkan versi

Tunjukkan versi

Permintaan contoh:

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

GET /system/version

Tunjukkan informacion mengenai versi produk.

Contoh tindak balas:

{
   "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 tindak balas

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
applance_version Rentetan Versi pemohon. Tunjukkan juga hypervisor jika mesin maya.
nama hos Rentetan Nama hos.
kernel_version Rentetan Versi kernel Linux.
system_date Rentetan Tarikh sistem.
zevenet_version Rentetan Versi Edisi Komuniti Zevenet.

Tunjukkan DNS

Tunjukkan DNS

Permintaan contoh:

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

GET /system/dns

Tunjukkan konfigurasi perkhidmatan DNS.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
utama Rentetan DNS utama disusun dalam sistem.
menengah Rentetan DNS sekunder disusun dalam sistem.

Ubah suai DNS

Ubah suai DNS

Permintaan contoh:

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.1/zapi.cgi/system/dns

POST /system/dns

Ubah suai konfigurasi perkhidmatan DNS.

Minta parameter

Bidang Jenis Deskripsi
utama Rentetan DNS utama disusun dalam sistem.
menengah Rentetan DNS sekunder disusun dalam sistem.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Tunjukkan SNMP

Tunjukkan SNMP

Permintaan contoh:

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

GET /system/snmp

Tunjukkan konfigurasi perkhidmatan SNMP.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
komuniti Rentetan Nama komuniti. Baca Hanya Komuniti yang digunakan.
ip Rentetan Antara Muka IP di mana perkhidmatan SNMP sedang dijalankan. Ia selamat untuk memastikan semua antara muka diaktifkan dengan menggunakan watak *.
pelabuhan Rentetan Port di mana perkhidmatan SNMP sedang berjalan.
skop Rentetan IP atau subnet dengan akses (IP / bit). IP pelanggan yang dibenarkan untuk mengakses perkhidmatan SNMPD, sekiranya anda mahu membenarkan akses hanya satu IP sila gunakan bit "/ 32".
status Rentetan Status perkhidmatan SNMP. Nilai yang mungkin adalah: benar, perkhidmatan berjalan; atau palsu, perkhidmatan itu dihentikan.

Ubah suai SNMP

Ubah suai SNMP

Permintaan contoh:

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.1/zapi.cgi/system/snmp

POST /system/snmp

Ubah suai konfigurasi perkhidmatan SNMP.

Minta parameter

Bidang Jenis Deskripsi
komuniti Rentetan Nama komuniti. Baca Hanya Komuniti yang digunakan.
ip Rentetan Antara Muka IP di mana perkhidmatan SNMP sedang dijalankan. Ia selamat untuk memastikan semua antara muka diaktifkan dengan menggunakan watak *.
pelabuhan Rentetan Port di mana perkhidmatan SNMP sedang berjalan.
skop Rentetan IP atau subnet dengan akses (IP / bit). IP pelanggan yang dibenarkan untuk mengakses perkhidmatan SNMPD, sekiranya anda mahu membenarkan akses hanya satu IP sila gunakan bit "/ 32".
status Rentetan Status perkhidmatan SNMP. Nilai yang mungkin adalah: benar, perkhidmatan berjalan; atau palsu, perkhidmatan itu dihentikan.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Dapatkan lesen

Dapatkan lesen

Permintaan contoh:

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

GET /system/license/<format>

Tunjukkan lesen Zevenet dalam format. Yang ada format nilai adalah html or txt.

Tunjukkan NTP

Tunjukkan NTP

Permintaan contoh:

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

GET /system/ntp

Tunjukkan konfigurasi perkhidmatan NTP.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
server Rentetan Server di mana pelanggan NTP melakukan permintaan.

Ubah suai NTP

Ubah suai NTP

Permintaan contoh:

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.1/zapi.cgi/system/ntp

POST /system/ntp

Ubah suai konfigurasi perkhidmatan NTP.

Minta parameter

Bidang Jenis Deskripsi
server Rentetan Server di mana pelanggan NTP melakukan permintaan.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Senaraikan semua pengguna

Senaraikan semua pengguna

Permintaan contoh:

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

GET /system/users

Senaraikan pengguna yang ada dalam sistem.

Contoh tindak balas:

{
   "description" : "Get users",
   "params" : [
      {
         "status" : "true",
         "user" : "root"
      },
      {
         "status" : "true",
         "user" : "zapi"
      }
   ]
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan pelbagai parameter di bawah.

Bidang Jenis Deskripsi
status Rentetan Status pengguna. Nilai yang mungkin adalah: benar, pengguna diaktifkan; atau tidak palsu, pengguna dinyahaktifkan.
pengguna Rentetan Nama pengguna.

Ambil pengguna zapi

Ambil pengguna zapi

Permintaan contoh:

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

GET /system/users/zapi

Tunjukkan konfigurasi pengguna zapi. Parameter ini diperlukan untuk mengakses perkhidmatan Zevenet melalui zapi.

Contoh tindak balas:

{
   "description" : "Zapi user configuration.",
   "params" : {
      "key" : "root",
      "status" : "true"
   }
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan pelbagai parameter di bawah.

Bidang Jenis Deskripsi
utama Rentetan Kunci untuk mengesahkan zapi. Ini ialah parameter ZAPI_KEY digunakan dalam panggilan ke zapi.
status Rentetan Status pengguna Zapi. Sekiranya nilainya adalah benar, adalah mungkin untuk menggunakan zapi; atau tidak palsu, zapi itu dinyahaktifkan dan tidak mungkin menghantar permintaan.

Ubah suai konfigurasi pengguna zapi

Ubah suai konfigurasi pengguna zapi

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
 -d '{"key":"newzapikey","status":"enable","newpassword":"password1234"}' 
 https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi

POST /system/users/zapi

Ubah suai konfigurasi pengguna zapi. Parameter ini diperlukan untuk mengakses perkhidmatan Zevenet melalui zapi.

Minta parameter

Bidang Jenis Deskripsi
utama Rentetan Kunci untuk mengesahkan zapi. Ini ialah parameter ZAPI_KEY digunakan dalam panggilan ke zapi.
kata laluan baharu Rentetan Kata laluan baru untuk pengguna zapi.
status Rentetan Status pengguna Zapi. Nilai yang mungkin adalah: membolehkan untuk membolehkan pengguna zapi atau melumpuhkan untuk melumpuhkan pengguna zapi. Sekiranya pengguna zapi dilumpuhkan, anda tidak akan dapat menghantar permintaan.

Contoh tindak balas:

{
   "description" : "Zapi user settings.",
   "message" : "Settings was changed successful.",
   "params" : {
      "key" : "newzapikey",
      "newpassword" : "password1234",
      "status" : "enable"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai kata laluan root

Ubah suai kata laluan root

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
{"password":"admin","newpassword":"alwaysisbetterastrongpass"} 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/root

POST /system/users/root

Ubah suai kata laluan root. Pengguna ini digunakan untuk mengakses perkhidmatan zevenet melalui GUI

Minta parameter

Bidang Jenis Deskripsi diperlukan
kata laluan Rentetan Kata laluan pengguna root semasa. benar
kata laluan baharu Rentetan Kata laluan baru untuk pengguna root. benar

Contoh tindak balas:

{
   "description" : "User settings.",
   "message" : "Settings was changed succesful.",
   "params" : {
      "newpassword" : "alwaysisbetterastrongpass",
      "password" : "admin"
   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan semua nilai yang diminta dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Senarai fail log

Senarai fail log

Permintaan contoh:

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

GET /system/logs

Senaraikan fail log yang tersedia.

Contoh tindak balas:

{
   "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 tindak balas

Tanggapan akan menjadi JSON dengan pelbagai fail log. Parameter setiap objek adalah:

Bidang Jenis Deskripsi
tarikh Rentetan Tarikh pengubahsuaian fail terakhir.
fail Rentetan Nama fail fail log. Ia digunakan sebagai pengecam unik log.

Tunjukkan baris fail log

Tunjukkan baris fail log

Permintaan contoh:

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

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

Senaraikan beberapa baris fail log. Parameter URI fail adalah fail log daripada membaca. Talian adalah bilangan garisan untuk dipaparkan dari muktamad.

Contoh tindak balas:

{
   "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 tindak balas

Tanggapan akan menjadi JSON dengan pelbagai fail log. Kuncinya adalah log dan nilainya adalah array dengan bilangan baris yang diminta.

Muat turun fail log

Muat turun fail log

Permintaan contoh:

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

GET /system/logs/<file>

Muat turun fail log fail log avaiable yang disenaraikan semasa permintaan GET.

fail adalah fail pengenal unik log.

Sistem - Backup

Dengan pilihan Backup, anda boleh menyimpan konfigurasi sistem semasa dan memuat turunnya.

Dalam bahagian ini, anda akan dapat membuat, memulihkan, memuat naik dan memuat turun fail sandaran.

Senarai sandaran

Senarai sandaran

Permintaan contoh:

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

GET /system/backup

Contoh tindak balas:

{
   "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 tindak balas

Sambutan akan menjadi JSON dengan pelbagai sandaran. Parameter setiap elemen array adalah:

Bidang Jenis Deskripsi
tarikh Rentetan Tarikh pengubahsuaian terakhir.
nama Rentetan Ia adalah nama fail yang digunakan sebagai pengecam unik. Pelanjutan fail adalah .tar.gz.

Buat sandaran

Buat sandaran

Permintaan contoh:

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

POST /system/backup

Buat sandaran konfigurasi sistem konfigurasi semasa.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Ia adalah nama fail yang digunakan sebagai pengecam unik. Pelanjutan fail adalah .tar.gz.

Contoh tindak balas:

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

Muat turun sandaran

Muat turun sandaran

Permintaan contoh:

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

Fail sandaran dalam format TAR GZ.

GET /system/backup/<name>

Muat turun sandaran konfigurasi sistem. nama adalah pengecam pengecaman unik.

Muat naik sandaran

Muat naik sandaran

Permintaan contoh:

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.1/zapi.cgi/system/backup/newbackup

PUT /system/backup/<name>

Muat naik sandaran tersimpan setempat kepada Zevenet. nama adalah pengenalan unik sandaran yang akan disimpan di Zevenet.

Minta parameter

Anda perlu menggunakan –data-binary untuk memuat naik sandaran.

Contoh tindak balas:

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

Padam sandaran

Padam sandaran

Permintaan contoh:

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

DELETE /system/backup/<name>

Padam fail sandaran dari sistem Zevenet. nama adalah pengecam pengecaman unik.

Contoh tindak balas:

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

Memohon sandaran

Memohon sandaran

Permintaan contoh:

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

POST /system/backup/<name>/actions

Pulihkan konfigurasi dari fail sandaran. nama adalah pengecam pengecaman unik.

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Untuk memulihkan konfigurasi sandaran, nilai mestilah memohon.

Contoh tindak balas:

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

Muat turun sokongan

Muat turun sokongan

Permintaan contoh:

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

GET /system/supportsave

Dapatkan imej status sistem dengan semua konfigurasi dan proses yang berjalan dalam sistem. Sokongan ini adalah perlu untuk mencari isu-isu atau bantuan sokongan.