NAB Navbar
logo
shell

Rujukan Zevenet API 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

Tunjukkan butiran Sijil

Tunjukkan butiran 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/info

GET /certificates/<file>/info

Tunjukkan semua maklumat yang disertakan dalam sijil yang diberikan di kedai sijil, termasuk tandatangan, diperlukan nama fail untuk membuat rujukan.

Contoh tindak balas:

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

Tunjukkan pengaktifan butiran Sijil

Tunjukkan pengaktifan butiran Sijil

Permintaan contoh:

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

GET /certificates/activation

Tunjukkan semua maklumat yang disertakan dalam sijil pengaktifan, termasuk tanda tangan, sijil ini disimpan di kedai sijil. Jika sijil pengaktifan dipadam maka produk akan dinyahaktifkan.

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

Padam Sijil pengaktifan

Padam Sijil pengaktifan

Permintaan contoh:

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

DELETE /certificates/activation

Padam sijil pengaktifan yang dipasang di kedai sijil. Jika sijil ini dipadam maka Load Balancer dinyahaktifkan.

Contoh tindak balas:

{
   "description" : "Delete activation certificate",
   "message" : "The activation certificate 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"
}

Muat naik Sijil pengaktifan

Muat naik Sijil pengaktifan

Permintaan contoh:

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

POST /certificates/activation

Muat naik sijil pengaktifan dengan format PEM, sijil ini diperlukan untuk membolehkan semua fungsi. Sijil ini disimpan di kedai sijil, jika sijil pengaktifan wujud di kedai sijil maka sijil terdahulu ditindih.

Contoh tindak balas:

{
   "description" : "Upload activation certificate",
   "message" : "Activation 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.

. SSL offloading chiper akan tersedia hanya jika ia disokong oleh pemproses.

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"
      },
      {
         "ciphers" : "ssloffloading",
         "description" : "SSL offloading"
      }
   ]
}

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, Load Balancer Service Global atau modul GSLB 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, gslb untuk modul GLSB 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 port yang tersedia adalah: nombor port untuk profil http [s], l4xnat dan gslb, sekumpulan port yang dipisahkan oleh "," atau julat port yang dipisahkan oleh ":" untuk profil l4xnat, di l4xnat kedua-dua nilai pemisah ("," dan ":") dapat digunakan pada 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 yang bergabung dengan pecutan SSL offload. 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 lain-lain. 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",
   "ipds" : {
      "blacklists" : [
         "rem"
      ],
      "dos" : [],
      "rbl" : [
         "protection_ssh"
      ]
   },
   "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",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
      {
         "backends" : [
            {
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null
            }
         ],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "fgenabled" : "false",
         "fglog" : "false",
         "fgscript" : "tcp_check",
         "fgtimecheck" : 5,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "ttl" : 0,
         "urlp" : "",
         "vhost" : ""
      },
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek Ladang:

Bidang Jenis Deskripsi
ipds Objek Senarai peraturan IPDS yang digunakan untuk ladang ini.
params Objek Parameter konfigurasi ladang.
perkhidmatan Objek [] Array dengan semua perkhidmatan yang dibuat di ladang ini dan konfigurasinya.

Objek IPDS:

Bidang Jenis Deskripsi
senarai hitam Tali[] Peraturan hitam yang digunakan untuk ladang.
daripada Tali[] Peraturan DoS diterapkan ke ladang.
rbl Tali[] Peraturan RBL diterapkan ke ladang.

Parameter objek untuk ladang HTTP:

Bidang Jenis Deskripsi
penyertaan Objek [] Hanya dalam profil https. Senarai sijil yang aktif di ladang, dalam format pem, dibenarkan menambah lebih daripada satu sijil ke ladang yang sama untuk sokongan SNI. pendengar dengan nilai https diperlukan. Sebarang sijil 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; keselamatan, ciphers hanya dimuatkan cipherc medan akan diterima; atau ssloffloading, ia menyerahkan kerja penyulitan kepada proses, cipher ini bergantung pada pemproses.
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, menerima permintaan http 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.
ignore_100_continue Rentetan Jika bidang ini mempunyai nilai benar yang 100 teruskan HTTP heade akan diabaikan; jika nilai itu palsu, yang 100 teruskan pengepala akan diproses.
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, Urutan dalam senarai, yang pertama akan digunakan secara lalai jika header host maya tidak sesuai dengan medan CN dalam sijil. Digunakan untuk SNI.

Objek perkhidmatan untuk ladang HTTP:

Bidang Jenis Deskripsi
backends Objek [] Backends ditakrifkan dalam perkhidmatan.
cookiedomain Rentetan Penyisipan cookie akan dijalankan jika domain sepadan dengan kandungan cookie. Dayakan cookieinsert bidang diperlukan.
cookieinsert Rentetan Ia membolehkan penyisipan cookie untuk menyokong sesi melekit. Pilihannya adalah benar, profil akan mencari kuki yang diberikan dalam medan cookiename, jika tidak ada maka kuki ini akan ditambahkan, palsu, bukan tindakan diambil.
cookiename Rentetan Nama cookie (ID sesi) akan digunakan untuk mengenal pasti proses melekat pada backends. Dayakan cookieinsert bidang diperlukan.
cookiepath Rentetan Ia menguruskan nilai laluan cookie untuk cookie yang diberikan. Dayakan cookieinsert bidang diperlukan.
cookiettl nombor Ia adalah masa maksimum untuk kuki, dalam beberapa saat. Dayakan cookieinsert bidang diperlukan.
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" : {
      "interface" : "eth0.2",
      "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, menerima permintaan http 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.
ignore_100_continue Rentetan Jika bidang ini mempunyai nilai benar yang 100 teruskan HTTP heade akan diabaikan; jika nilai itu palsu, yang 100 teruskan pengepala akan diproses.
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; keselamatan, ciphers hanya dimuatkan cipherc medan akan diterima; atau ssloffloading, ia menyerahkan kerja penyulitan kepada proses, cipher ini bergantung pada pemproses.
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",
      "ignore_100_continue" : "true",
      "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

Sertakan Sijil PEM yang tersedia ke senarai SNI atau certlist pelbagai 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 SNI list of farm httpFarm, you need restart the farm to apply",
   "success" : "true",
   "status": "needed restart"
}

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/farms/MyHttpFarm/certificates/example.pem

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

Padam sijil dengan nama fail yang dipilih dari penyertaan di ladang HTTP dengan pendengar HTTPS. Sijil ini tidak akan dipadamkan dari kedai sijil.

Contoh tindak balas:

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

Tambah peraturan IPDS

Tambah peraturan IPDS

Permintaan contoh:

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

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

Memohon senarai hitam, peraturan DoS atau RBL ke ladang.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan IPDS digunakan sebagai pengecam unik.

Contoh tindak balas:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm httpFarm.",
   "success" : "true"
}

Keluarkan peraturan IPDS

Keluarkan peraturan IPDS

Permintaan contoh:

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

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

Keluarkan senarai hitam, peraturan DoS atau RBL dari ladang yang diberikan menggunakan pengenal nama.

Contoh tindak balas:

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

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
         }
      ],
      "cookiedomain" : "zevenet.cpm",
      "cookieinsert" : "true",
      "cookiename" : "peasocookie",
      "cookiepath" : "/patfh",
      "cookiettl" : 20,
      "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.
cookiedomain Rentetan Penyisipan cookie akan dijalankan jika domain sepadan dengan kandungan cookie. Dayakan cookieinsert bidang diperlukan.
cookieinsert Rentetan Ia membolehkan penyisipan cookie untuk menyokong sesi melekit. Pilihannya adalah benar, profil akan mencari kuki yang diberikan dalam medan cookiename, jika tidak ada maka kuki ini akan ditambahkan, palsu, bukan tindakan diambil.
cookiename Rentetan Nama cookie (ID sesi) akan digunakan untuk mengenal pasti proses melekat pada backends. Dayakan cookieinsert bidang diperlukan.
cookiepath Rentetan Ia menguruskan nilai laluan cookie untuk cookie yang diberikan. Dayakan cookieinsert bidang diperlukan.
cookiettl nombor Ia adalah masa maksimum untuk kuki, dalam beberapa saat. Dayakan cookieinsert bidang diperlukan.
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.
cookieinsert Rentetan Ia membolehkan penyisipan cookie untuk menyokong sesi melekit. Pilihannya adalah benar, profil akan mencari kuki yang diberikan dalam medan cookiename, jika tidak ada maka kuki ini akan ditambahkan, palsu, kuki pemasukan dilumpuhkan.
cookiename Rentetan Nama cookie (ID sesi) akan digunakan untuk mengenal pasti proses melekat pada backends. Dayakan cookieinsert bidang diperlukan.
cookiedomain Rentetan Penyisipan cookie akan dijalankan jika domain sepadan dengan kandungan cookie. Dayakan cookieinsert bidang diperlukan.
cookiepath Rentetan Ini menguruskan nilai jalur kuki untuk kuki yang diberikan, jika URI dalam permintaan pelanggan atau respons backend tidak sesuai dengan cookiepath maka kaedah ketekunan penyisipan kuki tidak digunakan. Aktifkan cookieinsert bidang diperlukan.
cookiettl nombor Ia adalah masa maksimum untuk kuki, dalam beberapa saat. Dayakan cookieinsert bidang diperlukan.
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" : [],
      "cookiedomain" : "",
      "cookieinsert" : "false",
      "cookiename" : "",
      "cookiepath" : "",
      "cookiettl" : 0,
      "fgenabled" : "false",
      "fglog" : "false",
      "fgscript" : "",
      "fgtimecheck" : 5,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirecttype" : "default",
      "sessionid" : "sid",
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com"
   },
   "status" : "needed restart"
}

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

Bergerak perkhidmatan

Bergerak perkhidmatan

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/service1/actions

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

Tindakan ini menggerakkan perkhidmatan Atas atau Bawah dalam Senarai Perkhidmatan, pilihan ini bermanfaat jika diperlukan untuk mengubah urutan keutamaan, perhatikan bahawa perkhidmatan dinilai dengan urutan yang sama yang ditunjukkan. tindakan ini memulakan semula ladang secara automatik.

id adalah pengecam unik perkhidmatan yang akan diubahsuai.

Permintaan Parameter

Bidang Jenis Deskripsi diperlukan
kedudukan nombor Kedudukan di mana akan menjadi perkhidmatan. Kedudukan pertama mempunyai indeks 0. benar

Contoh tindak balas:

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

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 pengecam 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>/services/<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.
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.

Selain itu, ladang L4xNAT dapat mengikat pelbagai port, tidak hanya satu port maya seperti yang digunakan dengan profil lapisan 7 yang lain. Untuk dapat memilih rangkaian port maya atau port maya tertentu di ladang L4xNAT, wajib memilih jenis protokol. Dalam kes lain, ladang akan mendengar semua port dari IP maya (ditunjukkan dengan watak '*'). Setelah protokol TCP atau UDP dipilih, akan tersedia untuk menentukan port, beberapa port antara ',', port berkisar antara ':' atau semua port dengan '*'. Gabungan kesemuanya akan berlaku juga.

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",
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.168.55.41",
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "ipds" : {
      "blacklists" : [],
      "dos" : [],
      "rbl" : [
         "protection_ssh"
      ]
   },
   "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
ipds Objek Senarai peraturan IPDS yang digunakan untuk ladang ini.
params Objek Parameter konfigurasi ladang.
backends Objek [] Semua pelayan sejati yang dibuat di ladang ini dan konfigurasinya.

Objek IPDS:

Bidang Jenis Deskripsi
senarai hitam Tali[] Peraturan senarai hitam digunakan untuk ladang.
daripada Tali[] Peraturan DoS diterapkan ke ladang.
rbl Tali[] Peraturan RBL diterapkan ke ladang.

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

Tambah peraturan IPDS

Tambah peraturan IPDS

Permintaan contoh:

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

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

Memohon senarai hitam, peraturan DoS atau RBL ke ladang.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan IPDS digunakan sebagai pengecam unik.

Contoh tindak balas:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm l4Farm.",
   "success" : "true"
}

Keluarkan peraturan IPDS

Keluarkan peraturan IPDS

Permintaan contoh:

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

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

Keluarkan modul IPDS, DoS atau RBL modul IPDS dari ladang yang diberikan menggunakan pengenal pasti nama.

Contoh tindak balas:

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

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

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

Ladang GSLB

Load Balancing Service Global, biasanya dipanggil GSLB, membolehkan untuk membuat perkhidmatan mengimbangi beban berdasarkan kepada arsitektur hierarki perkhidmatan DNS. Ladang semacam ini menyediakan DNS yang berwibawa sahaja dengan algoritma pengimbangan beban dan pengesanan keadaan perkhidmatan di lapisan aplikasi DNS.

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/gslbfarm

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Contoh tindak balas:

{
   "description" : "List farm gslbfarm",
   "ipds" : {
      "blacklists" : [],
      "dos" : [],
      "rbl" : [
         "protection_ssh"
      ]
   },
   "params" : {
      "status" : "needed restart",
      "vip" : "192.168.100.155",
      "vport" : 60
   },
   "services" : [
      {
         "algorithm" : "roundrobin",
         "backends" : [
            {
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 53,
               "status" : "up"
            },
            {
               "id" : 2,
               "ip" : "192.168.55.40",
               "port" : 53,
               "status" : "up"
            },
            {
               "id" : 4,
               "ip" : "192.135.10.2",
               "port" : 53,
               "status" : "up"
            }
         ],
         "deftcpport" : 53,
         "fgenabled" : "true",
         "fgscript" : "check_tcp",
         "fgtimecheck" : 5,
         "id" : "service1"
      },
      {
         "algorithm" : "prio",
         "backends" : [
            {
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            },
            {
               "id" : 2,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            }
         ],
         "deftcpport" : 80,
         "fgenabled" : "false",
         "fgscript" : "",
         "fgtimecheck" : 5,
         "id" : "prioServ"
      }
   ],
   "zones" : [
      {
         "defnamesv" : "ns3",
         "id" : "global.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns3",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns3",
               "ttl" : null,
               "type" : "A"
            },
            {
               "id" : 3,
               "rdata" : "resource2",
               "rname" : "ns2",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 4,
               "rdata" : "192.168.200.30",
               "rname" : "resource2",
               "ttl" : null,
               "type" : "A"
            }
         ]
      },
      {
         "defnamesv" : "ns1",
         "id" : "DOM.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns1",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns1",
               "ttl" : null,
               "type" : "A"
            }
         ]
      }
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan format di bawah.

Objek Ladang:

Bidang Jenis Deskripsi
ipds Objek Senarai peraturan IPDS yang digunakan untuk ladang ini.
params Objek Parameter konfigurasi ladang.
perkhidmatan Objek [] Array dengan semua perkhidmatan yang dibuat di ladang ini dan konfigurasinya.
zon Objek [] Array dengan semua zon yang dicipta di ladang ini dan konfigurasinya.

Objek IPDS:

Bidang Jenis Deskripsi
senarai hitam Tali[] Senarai hitam digunakan untuk ladang.
daripada Tali[] Peraturan DoS diterapkan ke ladang.
rbl Tali[] Peraturan RBL diterapkan ke ladang.

Objek parameter untuk ladang GSLB:

Bidang Jenis Deskripsi
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.
vport nombor Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar.
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.

Objek perkhidmatan untuk ladang GSLB:

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 GSLB cek tcp dilaksanakan secara lalai walaupun penjaga ladang dimatikan.
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.
id Rentetan Nama perkhidmatan yang digunakan sebagai pengecam unik.
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan dalam perkhidmatan. Pilihannya ialah: Robin pusingan, yang akan mengimbangi hubungan sama ada di belakang, atau prio yang akan menghantar semua sambungan ke backend yang tersedia terlebih dahulu.
deftcpport nombor Pemeriksaan kesihatan port TCP lalai. Ini adalah cek TCP pelabuhan kesihatan bahawa perkhidmatan akan diperiksa untuk menentukan bahawa perkhidmatan backend masih hidup. Nilai kosong dinyahdayakan.

Objek backend untuk ladang GSLB:

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

Objek zon:

Bidang Jenis Deskripsi
id nombor Nama zon digunakan seperti penentu unik.
defnamesv Rentetan Ini akan menjadi pelayan nama root masuk yang akan tersedia sebagai rekod DNS Permulaan (SOA) DNS.
sumber Objek [] sumber ditakrifkan dalam zon.

Objek sumber:

Bidang Jenis Deskripsi
id nombor Pengenal unik untuk sumber di zon.
rname Rentetan Nama sumber adalah nick yang perkhidmatan DNS akan diterjemahkan untuk data sebenar yang diperlukan dalam bidang rdata.
ttl nombor Nilai Masa untuk Live (opsyen) untuk rekod semasa yang diperlukan untuk menentukan tempoh masa yang nama semasa akan di-cache.
jenis Rentetan Jenis rekod DNS. Pilihannya ialah: NS, A, aaaa, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk maklumat lanjut, lihat GSLB - Zon - Sumber bawah seksyen ini.
rdata Rentetan Ia adalah data sebenar yang diperlukan oleh jenis rekod, nilai input bergantung kepada jenis Nama Sumber, rname dan jenis sumber, jenis.

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":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms

POST /farms

Buat ladang GSLB baru.

Minta parameter

Bidang Jenis Deskripsi diperlukan
farmname Rentetan Nama ladang, pengenal unik untuk ladang. benar
profil Rentetan Profil Ladang yang dicipta. Untuk ladang GSLB adalah gslb. benar
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar. benar
vport nombor Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar. benar

Contoh tindak balas:

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

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":"gslbnewname","vip":"192.168.100.155","vport":60}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm

PUT /farms/<farmname>

Ubah suai konfigurasi ladang GSLB.

Minta parameter

Bidang Jenis Deskripsi
newfarmname Rentetan Nama Ladang baru. Ladang mesti dihentikan untuk melakukan perubahan ini.
vport nombor Pelabuhan ladang, di mana perkhidmatan maya sedang mendengar.
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar.

Contoh tindak balas:

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

Parameter tindak balas

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

Tambah peraturan IPDS

Tambah peraturan IPDS

Permintaan contoh:

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

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

Memohon senarai hitam, peraturan DoS atau RBL ke ladang.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan IPDS digunakan sebagai pengecam unik.

Contoh tindak balas:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
   "success" : "true"
}

Keluarkan peraturan IPDS

Keluarkan peraturan IPDS

Permintaan contoh:

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

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

Keluarkan senarai hitam, peraturan DoS atau RBL dari ladang yang diberikan menggunakan pengenal nama.

Contoh tindak balas:

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

GSLB - Perkhidmatan

Perkhidmatan GSLB mewakili sekumpulan pelayan sebenar dan algoritma yang berkaitan untuk digunakan untuk mereka. Untuk membuat perkhidmatan baru, anda perlu menetapkan nama pengenalan yang sah dan algoritma yang dikehendaki untuk digunakan.

Perkhidmatan yang tersedia ialah:

Round Robin: perkongsian yang sama. Keseimbangan lalu lintas yang sama ke semua pelayan sebenar yang aktif. Bagi setiap sambungan yang masuk, balancer menyerahkan pelayan sebenar pusingan seterusnya untuk menyampaikan permintaan tersebut.

Keutamaan: Sambungan selalu menjadi yang paling penting. Keseimbangan semua sambungan ke pelayan keutamaan tertinggi yang sama. Jika pelayan ini turun, sambungan akan beralih ke pelayan tertinggi seterusnya. Dengan algoritma ini anda boleh membina perkhidmatan cluster Active-Pasive dengan beberapa pelayan sebenar.

Objek perkhidmatan untuk ladang GSLB

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 GSLB cek tcp dilaksanakan secara lalai walaupun penjaga ladang dimatikan.
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.
id Rentetan Nama perkhidmatan yang digunakan sebagai pengecam unik.
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan dalam perkhidmatan. Pilihannya ialah: Robin pusingan, yang akan mengimbangi hubungan sama ada di belakang, atau prio yang akan menghantar semua sambungan ke backend yang tersedia terlebih dahulu.
deftcpport Rentetan Pemeriksaan kesihatan port TCP lalai. Ini adalah cek TCP pelabuhan kesihatan bahawa perkhidmatan akan diperiksa untuk menentukan bahawa perkhidmatan backend masih hidup. Nilai kosong dinyahdayakan.

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":"service1","algorithm":"roundrobin"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/services

POST /farms/<farmname>/services

Buat perkhidmatan di Ladang GSLB yang diberikan. Ladang mesti dimulakan semula untuk menggunakan perubahan ini.

Minta parameter

Bidang Jenis Deskripsi diperlukan
id Rentetan Nama perkhidmatan yang digunakan sebagai pengecam unik. benar
algoritma Rentetan Jenis algoritma pengimbangan beban yang digunakan dalam perkhidmatan. Pilihannya ialah: Robin pusingan, yang akan mengimbangi hubungan sama ada di belakang, atau prio yang akan menghantar semua sambungan ke backend yang tersedia terlebih dahulu. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Ubah Suai Perkhidmatan

Ubah Suai Perkhidmatan

Permintaan contoh:

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

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

Ubah suai parameter perkhidmatan di Ladang GSLB. id adalah pengecam unik perkhidmatan yang akan diubahsuai.

Minta parameter

Bidang Jenis Deskripsi
deftcpport nombor Ini adalah cek TCP pelabuhan kesihatan bahawa perkhidmatan akan diperiksa untuk menentukan bahawa perkhidmatan backend masih hidup.

Contoh tindak balas:

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

Parameter 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":"check_tcp","fgenabled":"true",
"service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/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 parameter pengawal ladang dalam perkhidmatan GSLB.

Minta parameter

Bidang Jenis Deskripsi diperlukan
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 GSLB cek tcp dijalankan secara lalai walaupun fgenabled dilumpuhkan.
fgscript Rentetan Perintah penjaga ladang akan digunakan untuk memeriksa kesihatan belakang. benar didayakan, palsu, kurang upaya. benar jika fgenabled Didayakan.
fgtimecheck nombor Penjaga ladang akan memeriksa setiap 'timetocheck' detik status kesihatan backend. fgenabled adalah diperlukan.
perkhidmatan Rentetan Pengenal perkhidmatan, id, yang penjaga ladang akan mengubah suai. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Padam Perkhidmatan

Padam Perkhidmatan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/services/service1

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

Padamkan perkhidmatan yang diberikan Ladang GSLB. id adalah pengecam unik perkhidmatan yang akan dipadamkan.

Contoh tindak balas:

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

GSLB - Perkhidmatan - Backends

Bahagian ini akan menguruskan senarai perkhidmatan sebenar yang berkaitan dengan perkhidmatan.

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/gslbfarm/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" : 1,
         "ip" : "127.0.0.1",
         "port":53,
         "status":"up"
      },
      {
         "id" : 2,
         "ip" : "192.168.55.40",
         "port":53,
         "status":"up"
      }
   ]
}

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 IP backend, di mana perkhidmatan sebenar sedang didengar.
pelabuhan nombor Pelabuhan Backend di mana perkhidmatan sebenar mendengar.
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.

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.135.10.2"}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/services/service1/backends

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

Buat Backend baru dalam perkhidmatan tertentu di Ladang GSLB. id adalah pengecam unik perkhidmatan di mana backend akan ditambah.

Perkhidmatan prioritas mempunyai backend 2 sebagai maximun, host aktif dan host pasif.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan IP backend, di mana perkhidmatan sebenar sedang didengar. benar

Contoh tindak balas:

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

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.2.30"}' 
  https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/services/service1/backends/1

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

Ubah suai parameter backend dalam perkhidmatan ladang GSLB.

Nota dalam PUT di atas yang pertama id adalah pengecam unik perkhidmatan dan seterusnya id adalah pengecam unik backend.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP backend, di mana perkhidmatan sebenar sedang didengar.

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.2.30"
   },
   "status" : "needed restart"
}

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/gslbfarm/services/service1/backends/3

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

Padamkan backend yang diberikan dalam perkhidmatan ladang GSLB

Contoh tindak balas:

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

GSLB - Zon

Seksi zon GSLB akan menggambarkan nama domain DNS, subdomain, alias, dan sebagainya, yang akan diperlukan untuk menghasilkan zon DNS lengkap dengan catatan imbangan beban tambahan menggunakan perkhidmatan yang ditentukan.

Buat zon

Buat zon

Permintaan contoh:

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

POST /farms/<farmname>/zones

Buat zon DNS.

Permintaan Parameter

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi diperlukan
id nombor Nama zon digunakan seperti penentu unik. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Ubah suai zon

Ubah suai zon

Permintaan contoh:

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

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

Ubah suai parameter zon. id adalah zon pengenal unik yang akan diubah suai.

Permintaan Parameter

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
defnamesv Rentetan Ini akan menjadi pelayan nama root masuk yang akan tersedia sebagai rekod DNS Permulaan (SOA) DNS.

Contoh tindak balas:

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

Parameter tindak balas

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

Padamkan Zon

Padamkan Zon

Permintaan contoh:

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

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

Padamkan zon tertentu Ladang GSLB.

Contoh tindak balas:

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

GSLB - Zon - Sumber

Sumber yang ditakrifkan sebagai perkhidmatan DNS menyelesaikan permintaan. Sumber DNS yang mungkin dalam baki beban Zevenet ialah:

  1. NS. Nama rekod jenis pelayan, ia mewakilkan zon DNS untuk menggunakan pelayan nama berwibawa yang diberikan.
  2. A. Rekod jenis alamat, ia mengembalikan alamat IPv4 bagi tuan rumah.
  3. CNAME. Rekod jenis nama bersejarah, ia mewakili alias nama tertentu.
  4. DYNA. Rekod jenis alamat dinamik, ia mengembalikan alamat dinamik yang dinyatakan oleh perkhidmatan GSLB yang telah dibuat dalam konfigurasi ladang menurut algoritma yang dipilih untuk perkhidmatan tersebut.
  5. aaaa. Rekod jenis alamat, ia mengembalikan alamat IPv6 bagi tuan rumah.
  6. MX. Rekod jenis pertukaran mel, peta nama domain ke senarai agen pemindahan mesej untuk domain itu.
  7. SRV. Rekod jenis pencari perkhidmatan, Rekod lokasi perkhidmatan umum, digunakan untuk protokol baru dan bukannya mencipta rekod khusus protokol seperti MX.
  8. TXT. Rekod jenis teks, ia digunakan untuk menyimpan apa-apa maklumat berasaskan teks yang boleh direbut apabila perlu. Kami biasanya melihat rekod TXT yang digunakan untuk memegang data SPF dan mengesahkan pemilikan domain.
  9. PTR. Rekod penunjuk, penuding ke nama kanonik. Tidak seperti CNAME, pemprosesan DNS berhenti dan hanya nama yang dikembalikan. Penggunaan yang paling umum adalah untuk melaksanakan pencarian DNS terbalik.
  10. NAPTR. Menamakan Petunjuk Pihak Berkuasa, Membolehkan menulis semula berasaskan ekspresi berdasarkan nama domain yang kemudiannya dapat digunakan sebagai URI, nama domain lebih lanjut untuk mencari, dll.

Senaraikan sumber

Senaraikan sumber

Permintaan contoh:

curl  -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/gslbfarm/zones/global.com/resources

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

Dapatkan senarai sumber dalam zon. id adalah pengenal zon unik.

Contoh tindak balas:

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

Parameter tindak balas

Panggilan ini mengembalikan pelbagai objek sumber dengan parameter di bawah.

Bidang Jenis Deskripsi
id nombor Pengenal unik untuk sumber di zon.
rname Rentetan Nama sumber adalah nick yang perkhidmatan DNS akan diterjemahkan untuk data sebenar yang diperlukan dalam bidang rdata.
ttl nombor Nilai Masa untuk Live (opsyen) untuk rekod semasa yang diperlukan untuk menentukan tempoh masa yang nama semasa akan di-cache.
jenis Rentetan Jenis rekod DNS. Pilihannya ialah: NS, A, aaaa, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk maklumat lanjut, lihat GSLB - Zon - Sumber bawah seksyen ini.
rdata Rentetan Ia adalah data sebenar yang diperlukan oleh jenis rekod, nilai input bergantung kepada jenis Nama Sumber, rname dan jenis sumber, jenis.

Buat sumber baru

Buat sumber baru

Permintaan contoh:

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

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

Buat sumber baru di zon tertentu di ladang GSLB. id adalah zon pengenal unik yang akan diubah suai di mana sumber akan ditambah.

Minta parameter

Bidang Jenis Deskripsi diperlukan
rname Rentetan Nama sumber adalah nick yang perkhidmatan DNS akan diterjemahkan untuk data sebenar yang diperlukan dalam bidang rdata. benar
ttl nombor Masa untuk Nilai Live untuk rekod semasa. Ia adalah jumlah maksimum peranti penghala yang permintaannya dapat melalui til mati. Yang berguna adalah bahawa paket tidak dimasukkan dalam gelung bersih.
jenis Rentetan Jenis rekod DNS. Pilihannya ialah: NS, A, aaaa, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk maklumat lanjut, lihat GSLB - Zon - Sumber bawah seksyen ini. benar
rdata Rentetan Ia adalah data sebenar yang diperlukan oleh jenis rekod, nilai input bergantung kepada jenis Nama Sumber, rname dan jenis sumber, jenis. Jika DYNA dipilih dalam jenis maka nilai rdata harus menjadi salah satu yang dikonfigurasikan perkhidmatan di zon ini. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Ubah suai sumber

Ubah suai sumber

Permintaan contoh:

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

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

Ubah suai parameter resouce di zon Ladang GSLB.

pertama id adalah pengenal unik zon, seterusnya id adalah pengenal unik sumber.

Minta parameter

Bidang Jenis Deskripsi
rname Rentetan Nama sumber adalah nick yang perkhidmatan DNS akan diterjemahkan untuk data sebenar yang diperlukan dalam bidang rdata.
ttl nombor Nilai Masa untuk Live (opsyen) untuk rekod semasa yang diperlukan untuk menentukan tempoh masa yang nama semasa akan di-cache.
jenis Rentetan Jenis rekod DNS. Pilihannya ialah: NS, A, aaaa, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Untuk maklumat lanjut, lihat GSLB - Zon - Sumber bawah seksyen ini.
rdata Rentetan Ia adalah data sebenar yang diperlukan oleh jenis rekod, nilai input bergantung kepada jenis Nama Sumber, rname dan jenis sumber, jenis. Jika jenis dimuatkan dengan nilai DYNA kemudian rdata mesti dimuatkan dengan yang tersedia perkhidmatan nama

Contoh tindak balas:

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

Parameter tindak balas

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

Padamkan sumber

Padamkan sumber

Permintaan contoh:

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

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

Padam resouce yang diberikan dalam zon ladang GSLB

Perhatikan bahawa dalam DELETE URI di atas yang pertama id adalah zon pengenal unik dan seterusnya id adalah pengenal unik sumber.

Contoh tindak balas:

{
   "description" : "Delete zone resource",
   "message" : "Resource 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
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 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.

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 antara muka NIC, VLAN, maya dan ikatan.

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.

ikatan: Juga dipanggil oleh vendor lain sebagai antara muka batang, nic jenis ini boleh dibuat dengan lebih daripada satu antara muka nic. Zevenet menyokong pelbagai jenis hubungan antara 7.

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

Parameter 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.
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 hamba NIC yang pertama dalam hubungan antaramuka. Dalam antara muka maya dan VLAN ia 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, maya or bon.
is_slave Rentetan Hanya disediakan di antara muka NIC, benar, antara muka adalah sebahagian daripada antara muka ikatan, palsu antara muka bukan sebahagian daripada antara muka ikatan.

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,maya dan ikatan.

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",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "gateway" : "",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "down"
      }
   ]
}

Parameter 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.
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.
is_slave Rentetan benar antara muka adalah sebahagian daripada antara muka ikatan, palsu antara muka bukan sebahagian daripada antara muka ikatan.

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",
      "is_slave" : "false",
      "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.
jenis Rentetan Antara jenis antaramuka yang berbeza adalah: Nic, vlan, maya or bon. Setiap satu ditakrifkan dalam submenu rangkaian mereka.
is_slave Rentetan benar antara muka adalah sebahagian daripada antara muka ikatan, palsu antara muka bukan sebahagian daripada antara muka ikatan.

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 - Ikatan antara muka

Antara muka ikatan Linux atau juga dipanggil oleh vendor lain sebagai Trunk menyediakan kaedah untuk mengagregasikan pelbagai antara muka rangkaian ke dalam satu "logik" antara muka yang logik. Tingkah laku antaramuka terikat bergantung kepada mod, Zevenet Load Balancer menyokong kaedah berikut:

Dasar pusingan: Menghantar paket dalam urutan berurutan dari hamba pertama yang pertama melalui yang terakhir. Mod ini menyediakan pengimbangan beban dan toleransi kesalahan.

Dasar sandaran aktif: Hanya satu budak dalam ikatan yang aktif. Seorang hamba yang berlainan menjadi aktif jika, dan hanya jika hamba aktif gagal. Alamat MAC bon berada di luar hanya satu port (penyesuai rangkaian) untuk mengelakkan mengelirukan suis. Mod ini memberikan toleransi kesalahan. Pilihan utama mempengaruhi kelakuan mod ini.

Dasar XOR: Menghantar berdasarkan alamat MAC sumber XOR'd dengan alamat MAC destinasi. Ini memilih hamba yang sama untuk setiap alamat MAC destinasi. Mod ini menyediakan pengimbangan beban dan toleransi kesalahan.

Dasar penyiaran: Menghantar segala-galanya pada semua pelayan hamba. Mod ini memberikan toleransi kesalahan.

IEEE 802.3ad LACP: Mencipta kumpulan agregat yang berkongsi tetapan kelajuan dan dupleks yang sama. Menggunakan semua budak dalam agregator aktif mengikut spesifikasi 802.3ad.

Pra-syarat:

  1. Sokongan antara muka rangkaian di pemandu asas untuk mendapatkan kelajuan dan dupleks setiap hamba.

  2. Suis yang menyokong pengagregatan pautan Dinamik IEEE 802.3ad. Kebanyakan suis akan memerlukan beberapa jenis konfigurasi untuk membolehkan mod 802.3ad.

Mengimbangi beban penghantaran penyesuaian: Ikatan saluran yang tidak memerlukan sebarang sokongan suis khas. Lalu lintas keluar diedarkan mengikut beban semasa (dikira relatif terhadap kelajuan) pada setiap hamba. Trafik masuk diterima oleh hamba semasa. Sekiranya hamba menerima gagal, hamba lain mengambil alih alamat MAC hamba yang gagal menerima.

Pra-syarat:

Sokongan pemandu asas untuk mendapatkan kelajuan setiap hamba.

Pengimbangan beban penyesuaian: Termasuk mengimbangi beban penghantaran penyesuaian ditambah imbangan beban menerima untuk trafik IPV4, dan tidak memerlukan sebarang sokongan suis khas. Pengimbangan beban yang diterima dicapai oleh perundingan ARP. Pemandu ikatan memintas ARP Balasan yang dihantar oleh sistem tempatan di jalan keluar dan menimpa alamat perkakasan sumber dengan alamat perkakasan unik salah satu hamba dalam ikatan tersebut supaya rakan sebaya yang berbeza menggunakan alamat perkakasan yang berbeza untuk pelayan.

Senarai antara muka Ikatan

Senarai antara muka Ikatan

Permintaan contoh:

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

GET /interfaces/bonding

Dapatkan konfigurasi mengenai semua antara ikatan ikatan dalam sistem.

Contoh tindak balas:

{
   "description" : "List bonding interfaces",
   "interfaces" : [
      {
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "mode" : "broadcast",
         "name" : "bond2",
         "netmask" : "",
         "slaves" : [
            {
               "name" : "eth2"
            }
         ],
         "status" : "down"
      },
      {
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "mode" : "balance-rr",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "slaves" : [
            {
               "name" : "eth3"
            },
            {
               "name" : "eth4"
            }
         ],
         "status" : "up"
      }
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan tatasusunan antara muka objek ikatan.

Parameter ikatan adalah:

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 Layer layer indentifier unik. Ia adalah mac daripada hamba antara muka NIC yang pertama.
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.
hamba Objek [] Ahli-ahli antaramuka NIC dari inteface ikatan.
mod Rentetan Ia adalah mod kerja untuk antara muka ikatan. Pilihannya ialah: keseimbangan-rr, Dasar pusingan robin; sandaran aktif, Dasar sandaran aktif; keseimbangan-xor, Dasar XOR; menyiarkan, Dasar penyiaran; 802.3ad, IEEE 802.3ad LACP; keseimbangan-tlb, Penyaluran beban penghantaran penyesuaian; keseimbangan-alb, Pengimbangan beban penyesuaian. Nilai-nilai tersebut ditakrifkan dalam bahagian Rangkaian - Ikatan antara muka.

Objek budak:

Bidang Jenis Deskripsi
nama Rentetan Nama adalah penghubung unik antara hamba NIC.

Ambil antara muka Ikatan

Ambil antara muka Ikatan

Permintaan contoh:

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

GET /interfaces/bonding/<name>

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

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan objek antara muka ikatan.

Parameter ikatan adalah:

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 Layer layer indentifier unik. Ia adalah mac daripada hamba antara muka NIC yang pertama.
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.
hamba Objek [] Ahli-ahli antaramuka NIC dari inteface ikatan.
mod Rentetan Ia adalah mod kerja untuk antara muka ikatan. Pilihannya ialah: keseimbangan-rr, Dasar pusingan robin; sandaran aktif, Dasar sandaran aktif; keseimbangan-xor, Dasar XOR; menyiarkan, Dasar penyiaran; 802.3ad, IEEE 802.3ad LACP; keseimbangan-tlb, Penyaluran beban penghantaran penyesuaian; keseimbangan-alb, Pengimbangan beban penyesuaian. Nilai-nilai tersebut ditakrifkan dalam Rangkaian> Antara muka ikatan.

Hamba objek:

Bidang Jenis Deskripsi
nama Rentetan Nama adalah penghubung unik antara hamba NIC.

Buat antara muka Ikatan

Buat antara muka Ikatan

Permintaan contoh:

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

POST /interfaces/bonding

Buat antara muka ikatan yang menyertai antara muka NIC.

Alamat MAC ikatan akan diambil dari antara muka NIC yang pertama. Mod ikatan tidak boleh diubah apabila antara muka ikatan dibuat, tetapi antara muka pengguna boleh ditambah atau dipadam dalam antara muka ikatan seperti yang diperlukan. Antara muka NIC akan dikunci jika ia merupakan sebahagian daripada antara muka ikatan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Nama antara muka. Ia digunakan sebagai pengenal unik antara muka. benar
hamba Tali[] Semua antara muka NIC yang membina ikatan tersebut. Ia memerlukan parameter NIC nama. benar
mod Rentetan Ia adalah mod kerja untuk antara muka ikatan. Pilihannya ialah: keseimbangan-rr, Dasar pusingan robin; sandaran aktif, Dasar sandaran aktif; keseimbangan-xor, Dasar XOR; menyiarkan, Dasar penyiaran; 802.3ad, IEEE 802.3ad LACP; keseimbangan-tlb, Penyaluran beban penghantaran penyesuaian; keseimbangan-alb, Pengimbangan beban penyesuaian. Nilai-nilai tersebut ditakrifkan dalam Rangkaian> Antara muka ikatan. benar

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan parameter konfigurasi ikatan.

Bidang Jenis Deskripsi
mac Rentetan Layer layer indentifier unik. Ia adalah mac daripada hamba antara muka NIC yang pertama.
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.
hamba Objek [] Antara muka NIC yang membina inteface ikatan.
mod Rentetan Ia adalah mod kerja untuk antara muka ikatan. Pilihannya ialah: keseimbangan-rr, Dasar pusingan robin; sandaran aktif, Dasar sandaran aktif; keseimbangan-xor, Dasar XOR; menyiarkan, Dasar penyiaran; 802.3ad, IEEE 802.3ad LACP; keseimbangan-tlb, Penyaluran beban penghantaran penyesuaian; keseimbangan-alb, Pengimbangan beban penyesuaian. Nilai-nilai tersebut ditakrifkan dalam Rangkaian> Antara muka ikatan.

Hamba objek:

Bidang Jenis Deskripsi
nama Rentetan Nama adalah penghubung unik antara hamba NIC.

Ubah suai antara muka ikatan

Ubah suai antara muka ikatan

Permintaan contoh:

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

PUT /interfaces/bonding/<name>

Ubah suai parameter antara muka ikatan. 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" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "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 ikatan

Padam konfigurasi ikatan

Permintaan contoh:

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

DELETE /interfaces/bonding/<name>

Padam konfigurasi antara muka ikatan. Parameter konfigurasi ialah: gerbang, ip dan netmask.

nama adalah pengecam unik antara muka.

Contoh tindak balas:

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

Tetapkan tindakan antara Bonding

Tetapkan tindakan antara Bonding

Permintaan contoh:

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

POST /interfaces/bonding/<name>/actions

Memohon tindakan ke antara muka ikatan. Panggilan ini membolehkan memadam antara muka ikatan dan membolehkan atau menyahdayakannya.

Ia diperlukan untuk memadam antara muka ikatan menggunakan memusnahkan tindakan jika anda ingin membuka kunci antara muka NIC yang digunakan dalam ikatan Pemandu ikatan itu kemudian akan memulihkan alamat MAC yang antaramuka ahli sebelum mereka ditambahkan ke antara muka ikatan.

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, memusnahkan memadamkan ikatan dan memulihkan antara muka hamba NIC. benar

Contoh tindak balas:

{
   "description" : "Action on bond 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.

Tambah antara muka hamba Bonding

Tambah antara muka hamba Bonding

Permintaan contoh:

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

POST /interfaces/bonding/<name>/slaves

Tambah antara muka NIC sebagai hamba ke antara muka ikatan sedia ada.

nama adalah pengecam unik antara muka.

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Antaramuka NIC nama untuk menambah kepada antara muka ikatan. benar

Contoh tindak balas:

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

Parameter tindak balas

Maklum balas akan menjadi json dengan nilai yang dikemaskini dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Keluarkan antara muka hamba Bonding

Keluarkan antara muka hamba Bonding

Permintaan contoh:

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

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

Padam antara muka hamba NIC dari antara muka ikatan. Antara muka ikatan mestilah mempunyai hampir satu penghantar hamba NIC.

pertama nama adalah DELETE panggilan adalah pengenal unik pengikat nama, seterusnya nama dalam DELETE panggilan ialah nama antara muka pengenalan unik NIC.

Contoh tindak balas:

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

Rangkaian - antara muka VLAN

Antara muka VLAN membolehkan antara muka NIC atau bonding 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 tanda pengenal 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 atau ikatan. 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, ikatan 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.
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.

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.

Rangkaian - Terapung antara muka

Antara muka jenis ini menggunakan antara muka maya yang jelas dan topeng lalu lintas keluar a Nic, ikatan or VLAN antara muka dengan kanak-kanak maya antara muka. Antara muka ini digunakan untuk tingkah laku failover yang menyatakan dalam profil l4xnat jika kluster dikonfigurasikan.

Senaraikan Terapung antara muka

Senaraikan Terapung antara muka

Permintaan contoh:

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

GET /interfaces/floating

Tunjukkan semua availables atau interface yang dikonfigurasi di mana IP terapung telah dibuat.

Contoh tindak balas:

{
   "description" : "List floating interfaces",
   "params" : [
      {
         "floating_ip" : null,
         "interface" : "bondiface",
         "interface_virtual" : null
      },
      {
         "floating_ip" : "192.168.100.41",
         "interface" : "eth0",
         "interface_virtual" : "eth0:virtiface"
      },
      {
         "floating_ip" : null,
         "interface" : "eth0.1",
         "interface_virtual" : null
      },
      {
         "floating_ip" : null,
         "interface" : "eth1",
         "interface_virtual" : null
      }
   ]
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan pelbagai objek antara muka terapung:

Terapung objek:

Bidang Jenis Deskripsi
floating_ip Rentetan IP Terapung digunakan antara muka. floating_ip mesti wujud sebagai kanak-kanak antara muka maya antara muka.
antara muka Rentetan Antara muka yang diliputi oleh IP terapung.
interface_virtual Rentetan Ia adalah nama antara muka maya IP terapung yang digunakan untuk menutup muka.

Ambil antara muka Terapung

Ambil antara muka Terapung

Permintaan contoh:

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

GET /interfaces/floating/<name>

Menunjukkan jika antara muka mempunyai IP terapung yang dikonfigurasikan. Jika ia mempunyai satu konfigurasi, ia akan ditunjukkan di sini.

nama adalah pengenal antara muka unik yang boleh jenis nic, ikatan atau vlan.

Contoh tindak balas:

{
   "description" : "Show floating interface",
   "params" : {
      "floating_ip" : "192.168.100.41",
      "interface" : "eth0",
      "interface_virtual" : "eth0:virtiface"
   }
}

Parameter tindak balas

Bidang Jenis Deskripsi
floating_ip Rentetan IP Terapung digunakan antara muka. floating_ip mesti wujud sebagai kanak-kanak antara muka maya antara muka.
antara muka Rentetan Antara muka yang diliputi oleh IP terapung.
interface_virtual Rentetan Ia adalah nama antara muka maya IP terapung yang digunakan untuk menutup muka.

Ubah suai antara muka Terapung

Ubah suai antara muka Terapung

Permintaan contoh:

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

PUT /interfaces/floating/<name>

Konfigurasikan IP terapung untuk antara muka NIC, ikatan atau VLAN.

nama adalah pengenal antara muka unik yang boleh jenis nic, ikatan atau vlan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
floating_ip Rentetan IP Terapung digunakan antara muka. floating_ip mesti wujud sebagai kanak-kanak antara muka maya antara muka. benar

Contoh tindak balas:

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

Padam konfigurasi Terapung

Padam konfigurasi Terapung

Permintaan contoh:

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

DELETE /interfaces/floating/<name>

Keluarkan konfigurasi IP terapung dalam antara muka.

nama adalah pengenal antara muka unik yang boleh jenis nic, ikatan atau vlan.

Contoh tindak balas:

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

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" : {
         "bond0 in in" : 234.72,
         "bond0 out out" : 0,
         "bond0.10 in in" : 0,
         "bond0.10 out out" : 0,
         "bond1 in in" : 234.72,
         "bond1 out out" : 0,
         "bond3 in in" : 815.69,
         "bond3 out out" : 4300.38,
         "eth0 in in" : 2702.29,
         "eth0 out out" : 50701.95,
         "eth0.2 in in" : 0,
         "eth0.2 out out" : 0,
         "eth1 in in" : 234.72,
         "eth1 out out" : 0,
         "eth2 in in" : 234.72,
         "eth2 out out" : 0,
         "eth3 in in" : 0,
         "eth3 out out" : 0,
         "eth4 in in" : 436.89,
         "eth4 out out" : 4300.38,
         "eth4.6 in in" : 0,
         "eth4.6 out out" : 0,
         "eth5 in in" : 301.39,
         "eth5 out out" : 0,
         "eth5.5 in in" : 0,
         "eth5.5 out out" : 0,
         "eth6 in in" : 77.42,
         "eth6 out out" : 0
      }
   }
}

Parameter 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" : "234.72",
            "interface" : "bond1",
            "out" : "0.00"
         },
         {
            "in" : "77.42",
            "interface" : "eth6",
            "out" : "0.00"
         },
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "bond2",
            "out" : "4300.38"
        }
      ]
   }
}

Parameter 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 antara muka

Tunjukkan statistik antara muka

Permintaan contoh:

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

GET /stats/system/network/interfaces

Dapatkan ringkasan setiap antara muka rangkaian.

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi JSON dengan kunci params yang nilainya adalah objek dengan kunci bon dan Nic.

Bidang Jenis Deskripsi
bon Objek [] Statistik antara muka bon.
Nic Objek [] Statistik antara muka NIC.

Objek bon:

Bidang Jenis Deskripsi
in Rentetan Jumlah trafik input dalam MB.
antara muka Rentetan Nama antara muka yang digunakan sebagai pengecam unik.
ip Rentetan IP antara muka.
mac Rentetan MAC antara muka.
keluar Rentetan Jumlah trafik output dalam MB.
hamba Tali [] Senarai budak yang membina antara muka bon.
status Rentetan Status antara muka. Nilai boleh turun, antara muka dilumpuhkan; up, antara muka diaktifkan.
maya Tali [] Antara muka maya yang mewarisi dari antara muka ini.
vlan Tali [] Antara muka VLAN yang mewarisi dari antara muka ini.

Objek Nic:

Bidang Jenis Deskripsi
in Rentetan Jumlah trafik input dalam MB.
antara muka Rentetan Nama antara muka yang digunakan sebagai pengecam unik.
ip Rentetan IP antara muka.
mac Rentetan MAC antara muka.
keluar Rentetan Jumlah trafik output dalam MB.
status Rentetan Status antara muka. Nilai boleh turun, antara muka dilumpuhkan; up, antara muka diaktifkan.
maya Tali [] Antara muka maya yang mewarisi dari antara muka ini.
vlan Tali [] Antara muka VLAN yang mewarisi dari antara muka ini.

Tunjukkan statistik memori

Tunjukkan statistik memori

Permintaan contoh:

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

GET /stats/system/memory

Dapatkan ringkasan memori sistem.

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi JSON dengan kunci params yang nilainya adalah objek ingatan.

Memori objek.

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.
tarikh Rentetan Tarikh sistem.
nama hos Rentetan Nama hos.

Tunjukkan statistik beban

Tunjukkan statistik beban

Permintaan contoh:

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

GET /stats/system/load

Dapatkan ringkasan beban sistem CPU.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
Last_1 nombor Muatkan penggunaan sistem yang terakhir.
Last_5 nombor Muatkan penggunaan sistem lima minit terakhir.
Last_15 nombor Muatkan penggunaan sistem minit terakhir.
tarikh Rentetan Tarikh sistem.
nama hos Rentetan Nama hos.

Tunjukkan statistik CPU

Tunjukkan statistik CPU

Permintaan contoh:

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

GET /stats/system/cpu

Contoh tindak balas:

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

Parameter tindak balas

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.
tarikh Rentetan Tarikh sistem.
nama hos Rentetan Nama hos.

Tunjukkan statistik sambungan

Tunjukkan statistik sambungan

Permintaan contoh:

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

GET /stats/system/connections

Dapatkan jumlah sambungan semasa dalam sistem. Kaunter menjumlahkan semua jenis sambungan yang dijejaki: DIJAMIN, DITETAPKAN, SYN_SENT, TIME_WAIT, DAFTAR…

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
sambungan nombor Jumlah sambungan dijejaki sebenarnya.

Tunjukkan bilangan ladang

Tunjukkan bilangan ladang

Permintaan contoh:

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

GET /stats/farms/total

Tunjukkan jumlah ladang yang dibuat dalam sistem.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
nombor nombor Ia adalah bilangan ladang yang ada di dalam sistem.

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"
      },
      {
         "established" : 0,
         "farmname" : "testGSLB",
         "pending" : 0,
         "profile" : "gslb",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "53"
      }
   ]
}

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, https or gslb. 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/farmname

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 GSLB:

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

Parameter tindak balas di ladang GSLB

Bidang Jenis Deskripsi
backends Objek [] Tunjukkan maklumat mengenai latar belakang.
pelanggan Objek Statistik berkaitan dengan pelanggan.
dilanjutkan Objek Maklumat yang diperluaskan mengenai perkhidmatan ini.
server Objek Statistik yang berkaitan dengan pelayan.

Objek belakang

Bidang Jenis Deskripsi
id nombor Pengenalan unik backend.
ip Rentetan IP di mana perkhidmatan sebenar sedang didengar.
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; undefined, status backend belum diperiksa.

Objek pelanggan

Bidang Jenis Deskripsi
edns_big nombor Maklum balas yang lebih besar daripada bait 512.
edns_tc nombor Ukuran buffer dns diperpanjang yang ditentukan pelanggan terlalu kecil untuk data yang diminta.
recvfail nombor Bilangan kesilapan UDP, di mana OS menunjukkan bahawa sesuatu yang buruk berlaku semasa menerima.
reqs nombor Jumlah permintaan UDP yang dikendalikan oleh pelayan.
sendfail nombor Bilangan kesilapan UDP, di mana OS menunjukkan bahawa sesuatu yang buruk berlaku semasa penghantaran.
tc nombor Tanggapan yang dipotong dengan set bit TC.

Objek diperpanjang

Bidang Jenis Deskripsi
badvers nombor Permintaan yang mempunyai EDNS OPT-RR dengan versi yang tidak disokong.
jatuh nombor Permintaan menurun untuk format yang salah.
edns nombor Permintaan mengandungi EDNS-RR EDNS.
edns_clientsub nombor Subset permintaan edns yang menentukan pilihan edns_client_subnet.
bekas nombor Permintaan telah terformat dengan teruk, tetapi cukup waras bahawa kami telah menghantar respons dengan roman FORMERR.
noerror nombor Permintaan yang berjaya.
notimp nombor Perkhidmatan yang diminta tidak dilaksanakan oleh daemon ini, seperti permintaan transfer zona.
nxdomain nombor Meminta nama domain yang tidak wujud.
menolak nombor Permintaan telah ditolak oleh pelayan kerana pelayan tidak berwibawa untuk nama yang diminta.
v6 nombor Permintaan dari klien IPv6.

Objek pelayan

Bidang Jenis Deskripsi
recvfail nombor Bilangan kesilapan TCP, di mana OS menunjukkan bahawa sesuatu yang buruk berlaku semasa menerima.
reqs nombor Jumlah permintaan TCP yang dikendalikan oleh pelayan.
sendfail nombor Bilangan kesilapan TCP, di mana OS menunjukkan bahawa sesuatu yang buruk berlaku semasa penghantaran.

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.

Tunjukkan status modul

Tunjukkan status modul

Permintaan contoh:

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

GET /stats/farms/modules

Dapatkan ringkasan statistik modul. Panggilan ini menunjukkan setiap status modul, bilangan dikonfigurasikan, bilangan ladang meletakkan dan naik.

Takrif mengenai modul ada Farms bawah seksyen ini.

Contoh tindak balas:

{
   "description" : "Module status",
   "params" : {
      "dslb" : {
         "critical" : 0,
         "down" : 1,
         "problem" : 0,
         "total" : 2,
         "up" : 1
      },
      "gslb" : {
         "critical" : 0,
         "down" : 0,
         "problem" : 0,
         "total" : 1,
         "up" : 1
      },
      "lslb" : {
         "critical" : 0,
         "down" : 2,
         "problem" : 0,
         "total" : 4,
         "up" : 2
      }
   }
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan tiga kekunci: dslb, gslb dan lslb.

Bidang Jenis Deskripsi
kritikal nombor Bilangan ladang dalam status kritikal. Ladang sangat kritikal apabila ia tersumbat dan semua backend tidak terjangkau (bawah atau penyelenggaraan).
turun nombor Bilangan ladang berhenti. Ladang dihentikan oleh pentadbir sistem.
masalah nombor Bilangan ladang dalam status masalah. Ladang itu adalah masalah apabila ia sudah selesai dan hampir backend berada di bawah status.
jumlah nombor Bilangan keseluruhan ladang.
up nombor Bilangan ladang yang berjalan. Di sini dipaparkan dikekalkan dan perlu memulakan semula status ladang.

Tunjukkan statistik modul

Tunjukkan statistik modul

Permintaan contoh:

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

GET /stats/farms/modules/<module>

Tunjukkan statistik ladang modul tertentu.

Nilai yang ada untuk modul parameter ialah: lslb, gslb or dslb.

Contoh tindak balas:

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

Parameter tindak balas

Maklum balas akan menjadi objek JSON dengan maklumat mengenai ladang dalam modul.

Bidang Jenis Deskripsi
ditubuhkan nombor Jumlah bilangan sambungan semasa yang ditubuhkan.
farmname Rentetan Nama ladang, pengenal unik untuk ladang.
menunggu nombor Bilangan sambungan yang belum selesai.
profil Rentetan Jenis ladang. Nilai yang mungkin adalah: datalink, l4xnat, http, https or gslb. Setiap profil menentukan bahagian mereka sendiri.
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.

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",
      "gslbfarm",
      "nwl4farm",
      "httpweb"
   ],
   "interfaces" : [
      "eth0.1",
      "eth2",
      "eth1",
      "eth3",
      "bondiface",
      "eth0"
   ],
   "system" : [
      "cpu",
      "load",
      "ram",
      "swap",
      {
         "disk" : [
            "root/",
            "root/boot",
            "root/usr/local/zenloadbalancer/config",
            "root/var/log"
         ]
      }
   ]
}

Parameter 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/eth3

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/eth3/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.

IPDS

Modul ini adalah pelaksanaan a IPS (Sistem Pencegahan Pencerobohan) dan IDS (Sistem Pengesanan Pencerobohan) untuk menawarkan kepada pengguna lapisan keselamatan. Modul IPDS memeriksa lalu lintas sebelum mencapai modul Load Balancing LSLB or GSLB, jika lalu lintas dikesan sebagai berniat jahat maka ia akan ditolak.

Ia berfungsi memohon peraturan keselamatan kepada sistem yang akan ditakrifkan sebagai objek yang berlainan sifatnya. Setiap orang menawarkan penyelesaian untuk tindakan berniat jahat atau mencurigakan luar. Alat ini membantu pentadbir sistem mengawal ancaman dan serangan.

Peraturan yang ada untuk memohon kepada Zevenet boleh senarai hitam, DoS or RBL.

Senaraikan semua peraturan ipds

Senaraikan peraturan ipds

Permintaan contoh:

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

GET /ipds

Senaraikan semua peraturan ipds yang keluar dalam sistem.

Contoh tindak balas:

{
   "description" : "List the available IPDS rules.",
   "params" : [
      {
         "name" : "dosrst",
         "rule" : "dos",
         "type" : "farm"
      },
      {
         "name" : "ssh_brute_force",
         "rule" : "dos",
         "type" : "system"
      },
      {
         "name" : "geo_IL_israel",
         "rule" : "blacklist"
      },
      {
         "name" : "geo_ME_montenegro",
         "rule" : "blacklist"
      },
      {
         "name" : "sip",
         "rule" : "rbl"
      },
      {
         "name" : "ssh",
         "rule" : "rbl"
      }
   ]
}

Parameter tindak balas

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

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan IPDS. Ia digunakan sebagai pengecam unik.
memerintah Rentetan Ia adalah sifat peraturan ipds. Ia boleh menjadi menyenaraihitamkan, daripada or rbl.
jenis Rentetan Bidang ini muncul dalam peraturan dos dan ia menentukan jika peraturannya sistem, ia terpakai untuk pengimbang; atau ladang, peraturan itu terpakai kepada ladang.

IPDS - Senarai hitam

Senarai hitam membolehkan pengguna menggunakan senarai untuk menapis atau membenarkan trafik mengikut sumber IP (lalu lintas Incomming).

Terdapat dua jenis senarai:

  1. Ralat: Senarai diperoleh dari URL, senarai tersebut tidak boleh diubah dan boleh diturunkan untuk dimuat turun.
  2. Lokal: Pengguna boleh membuat senarai mereka sendiri dengan dasar yang diberikan, menafikan jika padanan IP yang tidak berfungsi maka trafik akan ditolak atau membenarkan jika padanan IP yang diikuti maka lalu lintas akan dibenarkan.

Modul ini termasuk pramuat Senarai yang disediakan oleh pasukan Zevenet, senarai itu sudah bersedia untuk digunakan untuk ladang. Secara konsisten, pengguna boleh membuat senarai peribadi mereka sendiri.

Beberapa senarai boleh digunakan untuk ladang yang sama, jika sumber IP sepadan dalam beberapa senarai lalu lintas akan dibenarkan atau dinafikan bergantung pada dasar senarai hitam. Pada masa ini IP matches maka tidak ada pemeriksaan senarai hitam yang dilakukan ke sumber IP.

Jika sumber IP berada dalam dua senarai yang berlainan, satu jenis menafikan dan jenis lain membenarkan, maka selalu dasar yang dibenarkan dinilai terlebih dahulu.

Senaraikan semua peraturan senarai hitam

Senaraikan semua senarai hitam

Permintaan contoh:

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

GET /ipds/blacklists

Senaraikan semua senarai hitam yang dibuat oleh pengguna atau pramuat dalam sistem yang boleh digunakan untuk ladang-ladang.

Contoh tindak balas:

{
   "description" : "Get black lists",
   "params" : [
      {
         "farms" : [],
         "name" : "china",
         "policy" : "deny",
         "preload" : "true",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "russia",
         "policy" : "deny",
         "preload" : "true",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "northkorea",
         "policy" : "deny",
         "preload" : "true",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [
            "FarmHttp1",
            "FarmGslb1",
         ],
         "name" : "remoteList",
         "policy" : "deny",
         "preload" : "false",
         "status" : "up",
         "type" : "remote"
      },
      {
         "farms" : [],
         "name" : "myWhiteList",
         "policy" : "allow",
         "preload" : "false",
         "status" : "down",
         "type" : "local"
      },
   ]
}

Parameter tindak balas

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

Bidang Jenis Deskripsi
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
Pramuat Rentetan Nilai yang mungkin adalah: benar, senarai hitam itu telah dimuatkan dalam sistem; atau palsu, senarai hitam telah dibuat oleh pentadbir sistem.
status Rentetan Nilai yang mungkin adalah: up, senarai hitam diaktifkan dan menyekat (atau membenarkan) lalu lintas sumber membentuk senarai; atau turun, sebenarnya peraturannya tidak berjalan dan tidak menyaring trafik.
jenis Rentetan Di mana senarai disimpan dan siapa yang mengekalkannya. Nilai-nilai tersebut ialah: tempatan, senarai itu disimpan dalam sistem tempatan dan boleh diubah suai secara tempatan, atau jauh, senarai itu dimuat turun dari sumber jauh melalui a url, Ia tidak dapat diubah secara tempatan jadi pengubahsuaian harus dilakukan di sumber jauh.

Ambil peraturan hitam senarai

Ambil senarai hitam

Permintaan contoh:

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

GET /ipds/blacklists/<name>

Tunjukkan konfigurasi dan parameter penerangan hitam senarai hitam. nama adalah pengecam unik senarai hitam.

Parameter tindak balas

Maklumkan contoh senarai tempatan:

{
   "description" : "Get list loc",
   "params" : {
      "farms" : [],
      "name" : "loc",
      "policy" : "deny",
      "preload" : "false",
      "sources" : [
         {
            "id" : 0,
            "source" : "192.168.0.167"
         },
         {
            "id" : 1,
            "source" : "192.168.0.186"
         }
      ],
      "status" : "up",
      "type" : "local"
   }
}

Objek senarai hitam setempat:

Bidang Jenis Deskripsi
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
Pramuat Rentetan Nilai yang mungkin adalah: benar, senarai hitam itu telah dimuatkan dalam sistem; atau palsu, senarai hitam telah diwujudkan oleh pentadbir sistem.
status Rentetan Nilai yang mungkin adalah: up, senarai hitam diaktifkan dan menyekat (atau membenarkan) lalu lintas sumber membentuk senarai; atau turun, sebenarnya peraturannya tidak berjalan dan tidak menyaring trafik.
jenis Rentetan Di mana senarai disimpan dan siapa yang mengekalkannya. Nilai-nilai tersebut ialah: tempatan, senarai tersebut disimpan dalam sistem dan diselenggarakan oleh pentadbir sistem; atau jauh, senarai itu dimuat turun dari url jauh.
sumber Objek [] Senarai IP yang disemak oleh senarai. Format rangkaian sumber yang diterima: Alamat rangkaian / topeng bit atau IP

Contoh senarai remote yang respons:

{
   "description" : "Get list remoteList",
   "params" : {
      "day" : "thursday",
      "farms" : [
         "FarmHttp1",
         "FarmGslb1",
      ],
      "frequency" : "weekly",
      "name" : "remoteList",
      "policy" : "deny",
      "sources" : [
         {
            "id" : 0,
            "source" : "78.12.0.4"
         },
         {
            "id" : 1,
            "source" : "68.100.15.5"
         },
         {
            "id" : 2,
            "source" : "65.12.12.95"
         }
      ],
      "time" : {
         "hour" : 0,
         "minutes" : 0
      },
      "status" : "up",
      "update_status" : "This list isn't downloaded yet.",
      "type" : "remote",
      "url" : "http://192.168.10.10/lists/test.txt"
   }
}

Objek senarai hitam jauh:

Bidang Jenis Deskripsi
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
nama Rentetan Nama senarai hitam. Ia digunakan sebagai pengecam unik.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
Pramuat Rentetan Nilai yang mungkin adalah: benar, senarai hitam itu telah dimuatkan dalam sistem; atau palsu, senarai hitam telah diwujudkan oleh pentadbir sistem.
jenis Rentetan Di mana senarai disimpan dan siapa yang mengekalkannya. Nilai-nilai tersebut ialah: tempatan, senarai tersebut disimpan dalam sistem dan diselenggarakan oleh pentadbir sistem; atau jauh, senarai dimuat turun dari jauh url.
sumber Objek [] Ssource IP senarai cek. Jika senarai adalah jenis jauh maka kandungan senarai tidak dipaparkan sehingga unduhan pertama.
kemaskini status Rentetan Status muat turun terakhir senarai dan tarikh kemas kini terakhir yang berjaya dalam sistem setempat.
url Rentetan Di mana senarai jauh dimuat turun dari. Format jauh mestilah senarai satu sumber topeng rangkaian / bit atau IP setiap baris.
kekerapan Rentetan Kekerapan kemas kini senarai jauh. Pilihannya ialah: harian, kemas kini semua hari, sekali atau secara berkala, ini ditunjukkan dalam frekuensi_tipe bidang; mingguan, kemas kini sekali dalam seminggu; atau bulanan, kemas kini sekali dalam sebulan.
frekuensi_tipe Rentetan Parameter ini melengkapkan kekerapan setiap hari apabila nilainya adalah setiap hari. Nilai yang mungkin adalah: tepat. menentukan satu jam dalam sehari; atau tempoh, tentukan masa tempoh untuk mengemaskini pada siang hari.
hari String atau Nombor Parameter ini melengkapkan parameter kekerapan apabila frecuency nilai adalah mingguan or bulanan. Jika frecuency is mingguan parameter ini mesti berlaku pada minggu ini (Isnin, masanya, Rabu, khamis, jumaat, sabtu or Ahad) jika kekerapan nilai adalah bulanan maka parameter ini mestilah hari bulan (nombor antara 1 dan 31).
masa Objek Ini adalah struktur yang bergantung kepada bidang kekerapan.
status Rentetan Nilai yang mungkin adalah: up, senarai hitam diaktifkan dan menyekat (atau membenarkan) lalu lintas sumber membentuk senarai; atau turun, sebenarnya peraturannya tidak berjalan dan tidak menyaring trafik.

Objek waktu untuk frekuensi harian dan kekerapan frekuensi tempoh

Bidang Jenis Deskripsi
tempoh nombor Berapa kerap senarai dikemas kini.
unit Rentetan Unit berkala. Pilihannya ialah: minit, nyatakan senarai itu akan dikemas kini setiap minit yang dikonfigurasikan; atau jam, senarai akan dikemas kini setiap jam yang dikonfigurasikan.

Objek waktu untuk frekuensi lain

Bidang Jenis Deskripsi
jam nombor Jam untuk mengemas kini senarai. Nilai mestilah nombor antara 0 dan 23.
minit nombor Minit untuk mengemas kini senarai. Nilai mestilah nombor antara 0 dan 59.

Sumber objek

Bidang Jenis Deskripsi
id nombor Pengenal unik sumber dalam senarai.
sumber Rentetan Alamat IP atau segmen bersih yang disemak oleh senarai itu.

Buat peraturan hitam senarai

Buat senarai hitam baharu

Mohon contoh untuk senarai setempat:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListLoc", "type":"local", "policy":"allow"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/ipds/blacklists

Permintaan contoh untuk senarai jauh:

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

POST /ipds/blacklists

Buat senarai hitam untuk digunakan di ladang. Senarai hitam boleh terdiri daripada dua jenis:

  1. Lokal: Sumber ditambahkan oleh pengguna. Senarai ini disimpan di dalam negara.
  2. Jauh: Sumber diperoleh dari lokasi terpencil. Lokasi ini ditunjukkan oleh URL. Format senarai jauh yang disokong adalah satu Alamat rangkaian / bit mask or IP baris setiap baris.

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik. benar
jenis Rentetan Di mana senarai diselamatkan dan siapa yang menyelenggarakannya. Nilai-nilai tersebut ialah: tempatan, senarai disimpan dalam sistem dan penyelenggaraan sistem pentadbiran; atau jauh, senarai itu diambil dari perkhidmatan keluar melalui a url dan perkhidmatan pentadbir akan mengekalkan senarai. benar
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai. Nilai lalai adalah menafikan.
url Rentetan Di mana senarai jauh dimuat turun dari. Format jauh mestilah senarai satu sumber setiap baris dalam format Alamat rangkaian / bit mask or IP. benar untuk senarai jauh
{
   "description" : "Post list list1",
   "params" : {
      "farms" : [],
      "name" : "newListLoc",
      "policy" : "deny",
      "preload" : "false",
      "type" : "local"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi pelbagai objek senarai hitam, yang masing-masing mengandungi atribut utama yang akan datang.

Bidang Jenis Deskripsi
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
Pramuat Rentetan Nilai yang mungkin adalah: benar, senarai hitam itu telah dimuatkan dalam sistem; atau palsu, senarai hitam telah dibuat untuk pentadbir sistem.
jenis Rentetan Di mana senarai diselamatkan dan siapa yang menyelenggarakannya. Nilai-nilai tersebut ialah: tempatan, senarai disimpan dalam sistem dan penyelenggaraan sistem pentadbiran; atau jauh, senarai itu diambil dari perkhidmatan keluar melalui a url dan perkhidmatan pentadbir akan mengekalkan senarai.

Ubah suai peraturan hitam senarai

Ubah suai senarai hitam

Mohon contoh untuk senarai setempat:

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

PUT /ipds/blacklists/<name>

Ubah suai konfigurasi peraturan senarai hitam. nama adalah pengecam unik senarai hitam.

Minta parameter untuk senarai setempat:

Bidang Jenis Deskripsi
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik. Hanya ia dimodifikasi semula tidak Pramuat senarai.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
sumber Tali[] Ia adalah senarai alamat IP atau segmen bersih yang disemak oleh senarai itu. Untuk menukar perubahan hanya sumber, sila lihat bahagian dokumentasi IPDS> Senarai Hitam> Ubah sumber senarai hitam. Sumber hanya dimodifikasi tanpa pada Pramuat senarai.

Contoh tindak balas:

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

Parameter tindak balas

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

Permintaan contoh untuk senarai jauh:

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

Mohon contoh untuk mengemas kini senarai setiap jam 2:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"daily","frequency_type":"period","time":{"period":2,"units":"hours"}}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/ipds/blacklists/newListRem

Mohon contoh untuk mengemas kini senarai sepanjang hari di 2: 00 AM:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"daily","frequency_type":"exact","time":{"hour":2,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/ipds/blacklists/newListRem

Mohon contoh untuk mengemas kini semua hari Isnin di 0: 00 AM:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"weekly","day":"monday","time":{"hour":0,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/ipds/blacklists/newListRem

Mohon contoh untuk mengemas kini hari 1 bulan di 12: PM 00:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"monthly","day":"1","time":{"hour":12,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/ipds/blacklists/newListRem

Minta parameter untuk senarai jauh

Bidang Jenis Deskripsi
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
nama Rentetan Nama hitam. Ia digunakan sebagai pengecam unik.
dasar Rentetan Tindakan untuk memohon kepada sumber. Pilihannya ialah: menafikan, menyekat trafik masukan dari sumber senarai; atau membenarkan terima lalu lintas dari sumber senarai.
url Rentetan Di mana senarai jauh dimuat turun dari.
kekerapan Rentetan Kekerapan kemas kini senarai jauh. Pilihannya ialah: harian, kemas kini semua hari, sekali atau secara bersamaan, ini ditunjukkan dalam frekuensi_tipe bidang; mingguan, kemas kini sekali dalam seminggu; atau bulanan, kemas kini sekali dalam sebulan.
frekuensi_tipe Rentetan Parameter ini melengkapkan kekerapan setiap hari apabila nilainya adalah setiap hari. Nilai yang mungkin adalah: tepat. menentukan satu jam dalam sehari; atau tempoh, tentukan masa tempoh untuk mengemaskini pada siang hari.
hari String atau Nombor Parameter ini melengkapkan kekerapan apabila nilainya adalah mingguan atau bulanan. Jika mingguan parameter ini mestilah hari minggu (Isnin, masanya, Rabu, khamis, jumaat, sabtu or Ahad) lain jika kekerapan adalah bulanan maka parameter ini mestilah sebulan (nombor antara 1 dan 31).
masa Objek Ini adalah struktur yang bergantung kepada bidang kekerapan.

Objek tempoh masa

Ini adalah bidang apabila tempoh masa akan dikonfigurasikan.

Ia perlu dikonfigurasikan kekerapan dengan nilai itu harian, dan frekuensi_tipe dengan nilai itu tempoh.

Bidang Jenis Deskripsi
tempoh nombor Berapa kerap untuk mengemaskini senarai.
unit Rentetan Unit berkala. Pilihannya ialah: minit or jam, nyatakan unit ukuran bagi kemas kini senarai.

Objek tepat jam masa

Ini adalah medan apabila masa jam tepat akan dikonfigurasikan.

Objek ini digunakan dengan konfigurasi seterusnya:

kekerapan bidang mempunyai nilai harian dan frekuensi_tipe is tepat.

kekerapan bidang mempunyai nilai mingguan dan hari adalah hari minggu apabila senarai dikemas kini.

kekerapan bidang mempunyai nilai bulanan dan hari adalah bilangan hari bulan apabila senarai dikemas kini.

Bidang Jenis Deskripsi
jam nombor Jam untuk mengemas kini senarai. Nilai mestilah nombor antara 0 dan 23.
minit nombor Minit untuk mengemas kini senarai. Nilai mestilah nombor antara 0 dan 59.

Contoh tindak balas:

{
   "description" : "Modify list newListRem.",
   "params" : {
      "day": 1,
      "frequency" : "monthly",
      "name" : "newListRem",
      "policy" : "deny",
      "preload" : "false",
      "time" : {
         "hour" : 12,
         "minutes" : 0
      },
      "type" : "remote",
      "update_status" : "Sync fail. Last update: 2017-02-16 14:23:00",
      "url" : "https://192.168.10.12/lists/test.txt"
   }
}

Parameter tindak balas

Sambutan akan menjadi json dengan semua konfigurasi senarai. Lihat contoh tindak balas untuk maklumat lanjut.

Padam peraturan blacklist

Padamkan senarai senarai hitam

Permintaan contoh:

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

DELETE /ipds/blacklists/<name>

Padamkan senarai hitam yang diberikan. nama adalah pengecam unik senarai hitam.

Contoh tindak balas:

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

Senaraikan sumber dari senarai hitam

Senaraikan sumber dari senarai hitam

Permintaan contoh:

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

GET /ipds/blacklists/<name>/sources

Senaraikan sumber senarai hitam. nama adalah pengecam unik senarai hitam.

Contoh tindak balas:

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

Parameter tindak balas

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

Objek sumber:

Bidang Jenis Deskripsi
id nombor Pengenal unik sumber dalam senarai.
sumber Tali[] Alamat IP atau segmen bersih yang disemak oleh senarai itu.

Tambah sumber ke senarai hitam

Tambah sumber ke senarai hitam

Permintaan contoh:

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

POST /ipds/blacklists/<name>/sources

Tolak sumber baru ke senarai hitam. Hanya tersedia untuk senarai setempat dan senarai tidak diprapelokan. nama adalah pengecam unik senarai hitam.

Minta parameter

Bidang Jenis Deskripsi diperlukan
sumber Rentetan Alamat IP atau segmen bersih yang disemak oleh senarai itu. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Ubah suai sumber senarai hitam

Ubah suai sumber senarai hitam

Permintaan contoh:

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

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

Ubah suai sumber senarai hitam.

nama adalah pengecam unik senarai hitam. id adalah sumber pengenal unik.

Minta parameter

Bidang Jenis Deskripsi diperlukan
sumber Rentetan Alamat IP atau segmen bersih yang disemak oleh senarai itu. benar

Contoh tindak balas:

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

Parameter tindak balas

Maklum balas akan menjadi json dengan sumber dikemas kini. Lihat contoh tindak balas untuk maklumat lanjut.

Padam sumber senarai hitam

Padam sumber senarai hitam

Permintaan contoh:

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

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

Keluarkan sumber dari senarai hitam.

nama adalah pengecam unik senarai hitam. id adalah sumber pengenal unik.

Contoh tindak balas:

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

Memohon tindakan ke peraturan senarai hitam

Sapukan desakan

Permintaan contoh untuk senarai jauh:

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

POST /ipds/blacklists/<name>/actions

Memohon tindakan ke senarai hitam. nama adalah pengecam unik senarai hitam.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan yang diinginkan untuk memohon kepada peraturan senarai hitam. Nilai yang ada ialah: permulaan, ia bertindak sebagai pencabar di semua ladang di mana ia digunakan; berhenti, ia menghentikan senarai hitam untuk semua ladang di mana peraturan senarai hitam diterapkan, lalu lintas tidak akan disekat atau dibenarkan; maklumat, tindakan ini hanya boleh digunakan untuk jauh senarai hitam, tindakan ini mengemas kini senarai sumber dari jauh URL. benar

Contoh tindak balas:

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

Parameter tindak balas

Maklum balas akan menjadi json dengan status muat turun. Lihat contoh tindak balas untuk maklumat lanjut.

Bidang Jenis Deskripsi diperlukan
maklumat Rentetan Status memuat turun senarai dan tarikh kemaskini terakhir yang berjaya.

IPDS - DoS

Perlindungan DoS mempunyai jenis peraturan yang berbeza, bergantung kepada peraturan perlindungan, ia digunakan untuk bahagian pengimbang yang berbeza. Jadi ada sistem peraturan bahawa ia menggunakan semua pengimbang. Peraturan berorientasikan sambungan, khusus untuk ladang bekerja dengan protokol TCP. Sebelum memohon peraturan kepada a ladang, buat objek dengan konfigurasi yang dikehendaki. Seterusnya, diterapkan ke semua ladang yang anda perlukan. The sistem peraturan mempunyai objek yang telah dibuat dan hanya mempunyai satu konfigurasi yang mungkin. Setelah dikonfigurasikan, aktifkannya.

Peraturan DOS Farm

Ia perlu mencipta objek sebelum memohon peraturan untuk ladang.

limitec

Had sambungan baru sesaat dan sumbernya. Hanya terdapat di ladang yang berfungsi dengan protokol TCP.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.
menghadkan nombor Ia adalah bilangan maksimum sambungan baru sesaat untuk sumber.
limit_burst nombor Ini adalah puncak sambungan baru yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

limitconns

Hadkan jumlah sambungan semasa bagi setiap sumber. Hanya terdapat di ladang yang berfungsi dengan protokol TCP.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.
limit_conns nombor Ia adalah bilangan maksimun sambungan semasa dari sumber.

bogustcpflags

Semak protokol TCP dihormati. Peraturan ini tidak mempunyai parameter tatarajah jadi hanya membuat objek yang anda boleh gunakan di semua ladang. Hanya terdapat di ladang yang berfungsi dengan protokol TCP.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.

limitrst

Hadkan bilangan permintaan sambungan semula setiap saat. Hanya terdapat di ladang yang berfungsi dengan protokol TCP.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.
menghadkan nombor Ia adalah bilangan maksimum permintaan set semula sesa untuk sumber.
limit_burst nombor Permintaan penetapan semula puncak yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

Peraturan sistem DoS

Dalam sistem peraturan DoS, objek tidak dibuat.

sshbruteforce

Had sambungan ssh baru.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik. Pengenal pasti telah ditakrifkan sebagai ssh_brute_force.
hits nombor Bilangan hits untuk sumber sebelum daripada sambungan disekat.
masa nombor Masa dalam beberapa saat untuk menetapkan semula hits kaunter.
status Rentetan Nilai yang mungkin adalah: up, peraturan DoS diaktifkan dan menapis trafik; atau turun, peraturan tidak berjalan dan ia tidak menapis trafik.

Senaraikan semua jenis peraturan DoS

Senaraikan semua jenis peraturan DoS

Permintaan contoh:

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

GET /ipds/dos/rules

Tunjukkan senarai peraturan DoS. Mereka bukan objek tetapi jenis untuk menentukannya.

Setiap peraturan mempunyai parameter konfigurasi yang berbeza

Contoh tindak balas:

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

Parameter tindak balas

Sambutan JSON mempunyai dua tatasusunan ladang dan sistem. Setiap item pelbagai adalah jenis peraturan untuk memohon kepada ladang o sistem.

Bidang Jenis Deskripsi
Penerangan Rentetan Keterangan ringkas peraturan ini.
memerintah Rentetan ketik pengenal pasti unik.

Senaraikan semua peraturan DoS

Senaraikan semua objek DoS

Permintaan contoh:

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

GET /ipds/dos

Tunjukkan konfigurasi mengenai semua objek DoS yang sedia ada.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi array dengan semua objek DoS yang tersedia.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.
memerintah Rentetan Ia adalah pengenal peraturan jenis.
jenis Rentetan Nilai yang mungkin adalah: ladang, peraturan itu terpakai kepada ladang; atau sistem, peraturan itu terpakai kepada sistem.
status Rentetan Nilai yang mungkin adalah: up, peraturan DoS diaktifkan dan menapis trafik; atau turun, peraturan tidak berjalan dan ia tidak menapis trafik.

Selain bergantung kepada peraturan, objek itu mengandungi parameter seterusnya

limitec

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
menghadkan nombor Ia adalah bilangan maksimum sambungan baru sesaat untuk sumber.
limit_burst nombor Ini adalah puncak sambungan baru yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

limitconns

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
limit_conns nombor Ia adalah bilangan maksimun sambungan semasa dari sumber.

bogustcpflags

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.

limitrst

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
menghadkan nombor Ia adalah bilangan maksimum permintaan set semula sesa untuk sumber.
limit_burst nombor Permintaan penetapan semula puncak yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

sshbruteforce

Bidang Jenis Deskripsi
hits nombor Bilangan hits untuk sumber sebelum daripada sambungan disekat.
masa nombor Masa dalam beberapa saat untuk menetapkan semula hits kaunter.

Ambil peraturan DoS

Ambil peraturan DoS

Meminta contoh untuk peraturan ladang:

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

Mohon contoh untuk peraturan sistem:

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

GET /ipds/dos/<name>

Setiap objek DoS boleh mempunyai konfigurasi yang berbeza. nama adalah kaedah pengecam unik DoS.

Contoh tindak balas untuk peraturan ladang:

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

Contoh tindak balas untuk peraturan sistem:

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

Parameter tindak balas

Tanggapan akan menjadi array dengan semua objek DoS yang tersedia.

Bidang Jenis Deskripsi
nama Rentetan Ia adalah aturan objek pengecam unik.
memerintah Rentetan Ia adalah pengenal peraturan jenis.
jenis Rentetan Nilai yang mungkin adalah: ladang, peraturan itu terpakai kepada ladang; atau sistem, peraturan itu terpakai kepada sistem.
status Rentetan Nilai yang mungkin adalah: up, peraturan DoS diaktifkan dan menapis trafik; atau turun, peraturan tidak berjalan dan ia tidak menapis trafik.

Selain bergantung kepada peraturan, objek itu mengandungi parameter seterusnya

limitec

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
menghadkan nombor Ia adalah bilangan maksimum sambungan baru sesaat untuk sumber.
limit_burst nombor Ini adalah puncak sambungan baru yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

limitconns

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
limit_conns nombor Ia adalah bilangan maksimun sambungan semasa dari sumber.

bogustcpflags

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.

limitrst

Bidang Jenis Deskripsi
ladang Tali[] Ladang di mana peraturannya digunakan.
menghadkan nombor Ia adalah bilangan maksimum permintaan set semula sesa untuk sumber.
limit_burst nombor Permintaan penetapan semula puncak yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

sshbruteforce

Bidang Jenis Deskripsi
hits nombor Bilangan hits untuk sumber sebelum daripada sambungan disekat.
masa nombor Masa dalam beberapa saat untuk menetapkan semula hits kaunter.

Buat peraturan DoS

Buat peraturan DoS

Permintaan contoh:

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

POST /ipds/dos

Buat objek DOS untuk menggunakannya sebagai ladang seperti yang diperlukan.

Setiap objek DoS boleh mempunyai konfigurasi yang berbeza.

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Ia adalah aturan objek pengecam unik. benar
memerintah Rentetan Ia adalah pengenal peraturan jenis. Pilihannya ialah: limitconns, limitec, limitrst or bogustcpflags. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan konfigurasi lalai untuk peraturan yang dibuat. Lihat contoh tindak balas untuk maklumat lanjut.

Ubah suai peraturan DoS

Ubah suai peraturan DoS

Permintaan contoh:

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

PUT /ipds/dos/<name>

Ubah suai peraturan DoS. nama adalah kaedah pengecam unik DoS.

Minta parameter

Setiap jenis peraturan boleh menjadi parameter yang berbeza. Parameter yang boleh diubah adalah seterusnya:

limitec

Bidang Jenis Deskripsi
menghadkan nombor Ia adalah bilangan maksimum sambungan baru sesaat untuk sumber.
limit_burst nombor Ini adalah puncak sambungan baru yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

limitconns

Bidang Jenis Deskripsi
limit_conns nombor Ia adalah bilangan maksimun sambungan semasa dari sumber.

bogustcpflags

Tiada parameter.

limitrst

Bidang Jenis Deskripsi
menghadkan nombor Ia adalah bilangan maksimum permintaan set semula sesa untuk sumber.
limit_burst nombor Permintaan penetapan semula puncak yang dibenarkan. Unit pecah tumbuh semula apabila detik "had" akan berlalu.

sshbruteforce

Bidang Jenis Deskripsi
hits nombor Bilangan hits untuk sumber sebelum daripada sambungan disekat.
masa nombor Masa dalam beberapa saat untuk menetapkan semula hits kaunter.

Contoh tindak balas:

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

Parameter tindak balas

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

Padam peraturan DoS

Padam peraturan DoS

Permintaan contoh:

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

DELETE /ipds/dos/<name>

Peraturan sistem tidak boleh memadamkannya. Untuk mematikannya, letakkan status itu turun. nama adalah kaedah pengecam unik DoS.

Contoh tindak balas:

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

Terangkan sesuatu kepada peraturan DoS

Sapukan desakan

Permintaan contoh untuk senarai jauh:

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

POST /ipds/dos/<name>/actions

Memohon tindakan kepada peraturan dos. nama adalah peraturan dos pengenal unik.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan yang diinginkan untuk memohon kepada peraturan DoS. Nilai yang ada ialah: permulaan, ia bertindak sebagai peraturan DoS di semua ladang di mana ia digunakan; berhenti, ia mematikan DoS untuk semua ladang di mana peraturan DoS diterapkan, lalu lintas tidak akan disekat atau dibenarkan; restart, menetapkan semula peraturan DoS untuk semua ladangnya. benar

Contoh tindak balas:

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

Parameter tindak balas

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

IPDS - RBL

RBL, Senarai blackhole realtime membolehkan mewujudkan sistem keselamatan yang mewakilkan, tugas membosankan penyelenggaraan sistem keselamatan yang dikemas kini, kepada pakar speclialist. RBL menyemak beban pengimbang trafik input dalam pangkalan data ekstern melalui protokol DNS. Pemilik pelayan DNS bertanggungjawab mengemas kini dan menyediakan sumber yang berkualiti. Trafik input dari sumber IP yang berada dalam pangkalan data DNS akan dijatuhkan.

Untuk berfungsi dengan perkhidmatan RBL, domain DNS pertama akan ditambah, setiap domain DNS mengandungi senarai providor tertentu yang menyusun sumber untuk kriteria yang berlainan sebagai jenis serangan yang menyedari atau keterukan serangan.

Apabila domain DNS telah dibuat, perlu membuat peraturan RBL dengan konfigurasi peraturan. Kemudian menghubungkan domain DNS dengan peraturan RBL. Setiap peraturan boleh memeriksa domain yang berbeza.

Terakhir memohon peraturan RBL untuk semua ladang yang dikehendaki.

Senaraikan semua peraturan RBL

Senaraikan semua peraturan RBL

Permintaan contoh:

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

GET /ipds/rbl

Senaraikan semua peraturan RBL yang terdapat dalam pengimbang beban.

Contoh tindak balas:

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

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

Parameter tindak balas

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

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
domain Tali[] Ia adalah senarai dengan semua domain yang diperiksa oleh peraturan.
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
status Rentetan Tunjukkan status peraturan RBL. Nilainya boleh turun, jika peraturan itu tidak berfungsi; atau up peraturan itu berfungsi.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Mendapatkan peraturan RBL

Ambil peraturan RBL

Permintaan contoh:

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

GET /ipds/rbl/<name>

Tunjukkan konfigurasi RBL dan parameter keterangannya. nama adalah peraturan pengecilan unik RBL.

Parameter tindak balas

Contoh tindak balas:

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

Objek aturan RBL:

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
domain Tali[] Ia adalah senarai dengan semua domain yang diperiksa oleh peraturan.
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
status Rentetan Tunjukkan status peraturan RBL. Nilainya boleh turun, jika peraturan itu tidak berfungsi; atau up peraturan itu berfungsi.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Buat peraturan RBL

Buat peraturan RBL baru

Permintaan contoh:

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

POST /ipds/rbl

Buat peraturan RBL untuk digunakan di ladang.

Minta parameter

Bidang Jenis Deskripsi diperlukan
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik. benar
{
   "description" : "Create a RBL rule.",
   "params" : {
      "cache_size" : 8192,
      "cache_time" : 3600,
      "domains" : [],
      "farms" : [],
      "local_traffic" : "false",
      "log_level" : 4,
      "name" : "all",
      "only_logging" : "true",
      "queue_size" : 64538,
      "status" : "down",
      "threadmax" : 700
   }
}

Parameter tindak balas

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

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
domain Tali[] Ia adalah senarai dengan semua domain yang diperiksa oleh peraturan.
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
status Rentetan Tunjukkan status peraturan RBL. Nilainya boleh turun, jika peraturan itu tidak berfungsi; atau up peraturan itu berfungsi.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Ubah suai peraturan RBL

Ubah suai peraturan RBL

Permintaan contoh:

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

PUT /ipds/rule/<name>

Ubah suai konfigurasi peraturan RBL. nama adalah peraturan pengecilan unik RBL.

Minta parameter:

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Contoh tindak balas:

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

Parameter tindak balas

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

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
domain Tali[] Ia adalah senarai dengan semua domain yang diperiksa oleh peraturan.
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
status Rentetan Tunjukkan status peraturan RBL. Nilainya boleh turun, jika peraturan itu tidak berfungsi; atau up peraturan itu berfungsi.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Salin peraturan RBL

Salin peraturan RBL

Permintaan contoh:

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

POST /ipds/rule/<name>

Salin peraturan RBL untuk membuat peraturan baru. nama adalah peraturan pengecilan unik RBL.

Minta parameter:

Bidang Jenis Deskripsi dikehendaki
nama Rentetan Nama peraturan RBL untuk peraturan baru. Ia digunakan sebagai pengecam unik. benar

Contoh tindak balas:

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

Parameter tindak balas

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

Bidang Jenis Deskripsi
cache_size nombor Ini adalah bilangan sumber IP yang boleh dikesan oleh peraturan RBL.
cache_time nombor Ia adalah masa (dalam saat) bahawa sumber IP akan disekat.
domain Tali[] Ia adalah senarai dengan semua domain yang diperiksa oleh peraturan.
ladang Tali[] Senarai ladang di mana senarai hitam digunakan.
local_traffic Rentetan Jika bidang ini mempunyai nilai benar, peraturan RBL akan memeriksa lalu lintas dari segmen rangkaian persendirian; atau jika nilainya adalah palsu Peraturan RBL akan mengabaikan trafik dari segmen rangkaian peribadi. Trafik tempatan tidak akan disekat oleh DNS awam.
log_level nombor Ia adalah tahap log keterukan. Ia boleh mempunyai nilai antara 0 dan 7, menjadi kecemasan 0 dan debug 7.
nama Rentetan Nama peraturan RBL. Ia digunakan sebagai pengecam unik.
only_logging Rentetan Sekiranya nilai itu benar, apabila IP sepadan dalam domain, ia akan dicatat; atau jika bidang ini mempunyai nilai palsu, apabila IP sepadan dalam domain, IP akan dilog dan paket akan dijatuhkan.
queue_size nombor Ia adalah bilangan paket yang boleh dikekalkan dalam barisan.
status Rentetan Tunjukkan status peraturan RBL. Nilainya boleh turun, jika peraturan itu tidak berfungsi; atau up peraturan itu berfungsi.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh simulasi secara serentak ke pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Padam peraturan RBL

Padamkan RBL

Permintaan contoh:

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

DELETE /ipds/rbl/<name>

Padamkan peraturan RBL yang diberikan. nama adalah peraturan pengecilan unik RBL.

Contoh tindak balas:

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

Senaraikan semua domain RBL

Senaraikan semua domain RBL

Permintaan contoh:

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

GET /ipds/rbl/domains

Senaraikan semua domain availabled untuk dihubungkan dengan peraturan RBL.

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi JSON dengan kunci params dan dua jenis senarai domain sebagai nilai.

Objek sumber:

Bidang Jenis Deskripsi
pramuat Objek [] Ia adalah senarai dengan domain yang ditambah oleh pasukan Zevenet.
pengguna Objek [] Ia adalah senarai dengan domain yang ditambahkan oleh pentadbir balancer beban.

objek pramuat dan pengguna:

Bidang Jenis Deskripsi
id Nombor [] Ia adalah id yang mengenal pasti domain.
domain Tali[] Ia adalah domain di mana peraturan rbl itu melakukan pertanyaan.

Tambah domain

Tambah domain

Permintaan contoh:

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

POST /ipds/rbl/domains

Tambah domain baru ke senarai domain pengguna.

Minta parameter

Bidang Jenis Deskripsi diperlukan
domain Rentetan Ia adalah satu zon dari provinsi RBL di mana peraturan RBL akan melakukan pertanyaan. benar

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi json dengan senarai semua domain yang ditambahkan oleh pentadbir balancer beban.

Bidang Jenis Deskripsi
domain Tali[] Ia adalah senarai dengan domain yang ditambahkan oleh pentadbir balancer beban.

Ubah suai domain

Ubah suai domain

Permintaan contoh:

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

PUT /ipds/rbl/domains/<id>

Ubah suai domain atau senarai domain pengguna oleh yang lain yang dihantar sebagai parameter.

id adalah pengecam pengguna domain.

Minta parameter

Bidang Jenis Deskripsi
domain Rentetan Ia adalah domain yang menggantikan domain yang dihantar dalam URI.

Contoh tindak balas:

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

   }
}

Parameter tindak balas

Tanggapan akan menjadi json dengan senarai semua domain yang ditambahkan oleh pentadbir balancer beban.

Objek domain pengguna:

Bidang Jenis Deskripsi
id Nombor [] Ia adalah id yang mengenal pasti domain.
domain Tali[] Ia adalah domain di mana peraturan rbl itu melakukan pertanyaan.

Padamkan domain

Padamkan domain

Permintaan contoh:

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

DELETE /ipds/rbl/domains/<id>

Padamkan domain dari senarai domain pengguna.

id adalah pengecam pengguna domain yang akan dihapuskan.

Contoh tindak balas:

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

Memohon tindakan dalam peraturan RBL

Memohon tindakan

Permintaan contoh:

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

POST ipds/rbl/<name>/actions

Memohon tindakan ke ladang RBL, lihat jadual parameter Permintaan untuk tindakan. Untuk memohon tindakan untuk memerintah, peraturan itu diperlukan hampir satu ladang.

nama adalah peraturan pengecilan unik RBL.

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Terapkan tindakan yang dikehendaki. Tindakannya adalah: berhenti, peraturan RBL akan dihentikan dan ladang ke hadapan lalu lintas di mana ia digunakan peraturan tidak akan dijatuhkan. permulaan, peraturan RBL akan dimulakan dan semua lalu lintas ke depan ladang-ladang di mana peraturan ini digunakan akan dijatuhkan.

Contoh tindak balas:

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

Parameter tindak balas

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

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 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 SSH

Tunjukkan SSH

Permintaan contoh:

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

GET /system/ssh

Tunjukkan konfigurasi perkhidmatan SSH.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
mendengar Rentetan IP sistem di mana perkhidmatan SSH sedang didengar. The watak * digunakan untuk mendengar di semua IP yang dikonfigurasi. <$
pelabuhan Rentetan Port konfigurasi untuk perkhidmatan SSH.

Ubah suai SSH

Ubah suai SSH

Permintaan contoh:

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

POST /system/ssh

Ubah suai konfigurasi perkhidmatan SSH.

Minta parameter

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
mendengar Rentetan IP sistem di mana perkhidmatan SSH sedang didengar. The watak * digunakan untuk mendengar di semua IP yang dikonfigurasikan.
pelabuhan Rentetan Port konfigurasi untuk perkhidmatan SSH.

Contoh tindak balas:

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

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.

Tunjukkan pelayan HTTP

Tunjukkan pelayan HTTP

Permintaan contoh:

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

GET /system/http

Tunjukkan konfigurasi perkhidmatan HTTP. Di sinilah Zevenet API dan GUI sedang berjalan.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan parameter di bawah.

Bidang Jenis Deskripsi
ip Rentetan IP di mana pelayan HTTP sedang mendengar. The watak * digunakan untuk mendengar di semua IP yang dikonfigurasikan.
pelabuhan Rentetan Port di mana perkhidmatan HTTP sedang mendengar.

Ubah suai pelayan HTTP

Ubah suai pelayan HTTP

Permintaan contoh:

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

POST /system/http

Ubah suai konfigurasi perkhidmatan HTTP.

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP di mana pelayan HTTP sedang mendengar. The watak * digunakan untuk mendengar di semua IP yang dikonfigurasikan.
pelabuhan Rentetan Port di mana perkhidmatan HTTP sedang mendengar.

Contoh tindak balas:

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

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. Sekiranya nilainya adalah benar, adalah mungkin untuk menggunakan zapi; atau tidak palsu, zapi itu dinyahaktifkan dan tidak mungkin 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 yang tersedia 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"
   }
}

Sistem - Pemberitahuan

Pemberitahuan dibentuk oleh dua unsur: Pengguna kaedah dan jenis berjaga-jaga.

Dalam bahagian amaran, anda akan dapat memilih jenis peringatan yang anda ingin terima. Sebenarnya, amaran adalah tumpuan dalam status backend atau cluster, jadi pengimbang akan menghantar pemberitahuan jika ada suis.

Dalam bahagian kaedah, anda akan dapat memilih penghantar yang akan digunakan apabila Zevenet menghantar pemberitahuan.

Tunjukkan status amaran

Tunjukkan status amaran

Permintaan contoh:

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

GET /system/notifications/alerts

Senaraikan semua jenis peringatan dengan status mereka.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
berjaga-jaga Rentetan Jenis amaran, ia digunakan sebagai pengenal unik amaran. Perhatian yang ada ialah: backend, maklumkan apabila perubahan belakang status; atau kelompok, hantar pemberitahuan apabila nod induk kluster beralih ke nod lain.
status Rentetan Tunjukkan jika amaran orang kurang upaya, sistem tidak menghantar pemberitahuan apabila ada acara; atau membolehkan, sistem menghantar amaran apabila ia mengesan perubahan status.

Ambil semula makluman pemberitahuan

Ambil semula makluman pemberitahuan

Permintaan contoh:

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

GET /system/notifications/alerts/<alert>

Tunjukkan tatarajah mengenai jenis amaran.

berjaga-jaga adalah pengenal unik amaran.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
mengelakkannya nombor Kadang-kadang backends boleh didapati atau tidak dalam masa yang singkat, bidang ini membolehkan untuk mengkonfigurasi tempoh masa untuk mengelakkan mesej pemberitahuan manakala backend berubah status, sekali tempoh masa ini menyimpulkan, jika backend status ia berbeza untuk memulakan, maka pemberitahuan dihantar.
awalan Rentetan Ia adalah awalan untuk subjek e-mel, yang dihantar oleh sistem untuk jenis amaran ini.
status Rentetan Tunjukkan jika amaran orang kurang upaya, sistem tidak menghantar pemberitahuan apabila ada acara; atau membolehkan, sistem menghantar amaran apabila ia mengesan perubahan status.

Ubah suai pemberitahuan pemberitahuan

Ubah suai notifikasi pemberitahuan

Permintaan contoh:

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

POST /system/notifications/alerts/<alert>

berjaga-jaga adalah pengenal unik amaran.

Minta parameter

Bidang Jenis Deskripsi
mengelakkannya nombor Kadang-kadang backends boleh didapati atau tidak dalam masa yang singkat, bidang ini membolehkan untuk mengkonfigurasi tempoh masa untuk mengelakkan mesej pemberitahuan manakala backend berubah status, sekali tempoh masa ini menyimpulkan, jika backend status ia berbeza untuk memulakan, maka pemberitahuan dihantar. Parameter ini tidak ada dalam isyarat cluster, cluster mempunyai waktu sendiri.
awalan Rentetan Ia adalah awalan untuk subjek e-mel, yang dihantar oleh sistem untuk jenis amaran ini.

Contoh tindak balas:

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

Parameter tindak balas

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

Dayakan makluman

Dayakan makluman

Permintaan contoh:

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

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

Membolehkan atau menyahdayakan pemberitahuan untuk jenis amaran.

berjaga-jaga adalah pengenal unik amaran.

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Tindakan yang tersedia untuk isyarat adalah disabld, sistem tidak menghantar pemberitahuan apabila ada acara; atau membolehkan, sistem menghantar amaran apabila ia mengesan perubahan status.

Contoh tindak balas:

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

Parameter tindak balas

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

Dapatkan konfigurasi e-mel

Dapatkan konfigurasi e-mel

Permintaan contoh:

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

GET /system/notifications/methods/email

Tunjukkan semua konfigurasi penghantar e-mel.

Nota: Port SMTP yang digunakan untuk menghantar e-mel adalah TCP 25 walaupun TLS diaktifkan.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
dari Rentetan Akaun e-mel yang menghantar e-mel, akaun ini akan muncul di pengepala SMTP Daripada: dan ia akan digunakan jika penerima balasan membalas e-mel tersebut.
kaedah Rentetan Ia adalah kaedah pengecam unik. Sebenarnya kaedah yang ada ialah e-mel.
kata laluan Rentetan Kata laluan untuk pengguna Akaun SMTP, kata laluan ini diperlukan jika Server memerlukan pengesahan SMTP.
server Rentetan Pelayan SMTP melalui e-mel dihantar.
tls Rentetan Dayakan pengesahan TLS untuk menghantar e-mel, harta ini menggunakan STARTTLS dan ciri ini harus disokong dalam pelayan SMTP. Sesetengah pelayan SMTP memerlukannya. Nilai yang mungkin adalah: benar, Pengesahan TLS didayakan untuk menghantar e-mel; atau palsu, menghantar e-mel tidak menggunakan pengesahan TLS.
kepada Rentetan Akaun e-mel yang menerima e-mel, akaun ini akan muncul dalam pengepala SMTP Ke.
pengguna Rentetan Akaun e-mel dibenarkan untuk menghantar e-mel, akaun ini diperlukan jika pelayan memerlukan pengesahan SMTP.

Ubah suai konfigurasi e-mel

Ubah suai konfigurasi e-mel

Permintaan contoh:

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

POST /system/notifications/methods/email

Ubah cara konfigurasi kaedah pengirim e-mel.

Minta parameter

Bidang Jenis Deskripsi
dari Rentetan Akaun e-mel yang menghantar e-mel, akaun ini akan muncul di pengepala SMTP Daripada: dan ia akan digunakan jika penerima balasan membalas e-mel tersebut.
kata laluan Rentetan Kata laluan untuk pengguna Akaun SMTP, kata laluan ini diperlukan jika Server memerlukan pengesahan SMTP.
server Rentetan Pelayan SMTP melalui e-mel dihantar.
tls Rentetan Dayakan pengesahan TLS untuk menghantar e-mel, harta ini menggunakan STARTTLS dan ciri ini harus disokong dalam pelayan SMTP. Sesetengah pelayan SMTP memerlukannya. Nilai yang mungkin adalah: benar, Pengesahan TLS didayakan untuk menghantar e-mel; atau palsu, menghantar e-mel tidak menggunakan pengesahan TLS.
kepada Rentetan Akaun e-mel yang menerima e-mel, akaun ini akan muncul dalam pengepala SMTP Ke.
pengguna Rentetan Akaun e-mel dibenarkan untuk menghantar e-mel, akaun ini diperlukan jika pelayan memerlukan pengesahan SMTP.

Contoh tindak balas:

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

Parameter tindak balas

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

Hantar e-mel ujian

Hantar e-mel ujian

Permintaan contoh:

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

POST /system/notifications/methods/email/actions

Hantar mel uji dengan konfigurasi e-mel, untuk mengujinya.

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Nilai untuk menghantar mel ujian ialah ujian.

Contoh tindak balas:

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

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.

Sistem - Kluster

Kelompok adalah elemen yang dilakukan oleh nod induk, bahawa ia menguruskan sambungan ke belakang backends, dan nod backup memeriksa tuan, ia bersedia untuk swich untuk menguasai nod jika turun ke status.

Apabila status dihidupkan, nod sandaran akan memulihkan semua status sambungan dengan sendirinya. Oleh itu, klien tidak mengesan gangguan dalam perkhidmatan.

Ini boleh meletakkan pengimbang beban dalam ketersediaan tinggi. Jadi jika terdapat sebarang masalah dalam Zevenet, perkhidmatan akan terus berfungsi dengan konfigurasi yang dimuat naik.

Tunjukkan konfigurasi kluster

Tunjukkan konfigurasi kluster

Permintaan contoh:

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

GET /system/cluster

Tunjukkan semua konfigurasi tentang kluster.

Tindak balas BODY:

{
   "description" : "Show the cluster configuration",
   "params" : {
      "check_interval" : 5,
      "failback" : "disabled",
      "interface" : "eth0",
      "nodes" : [
         {
            "ip" : "192.168.100.241",
            "name" : "canoDEV4100",
            "node" : "local"
         },
         {
            "ip" : "192.168.100.240",
            "name" : "maqvir",
            "node" : "remote"
         }
      ]
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan konfigurasi kluster dan array dengan nod di dalamnya.

Objek Kluster:

Bidang Jenis Deskripsi
check_interval nombor Ia adalah masa menunggu di antara dua cek status nod master.
kegagalan Rentetan Nod yang mempunyai keutamaan untuk menjadi tuan. Nilai-nilai boleh menjadi a nama nod, untuk memberi keutamaan kepada nod; atau orang kurang upaya, jika mana-mana nod boleh menguasai dan tidak menjadi keutamaan untuk satu.
antara muka Rentetan Antara muka di mana IP nod dikonfigurasikan.
nod Objek [] Node kluster.

Objek Nod:

Bidang Jenis Deskripsi
ip Rentetan Ia adalah IP yang disusun dalam nod untuk memeriksa status nod dan melakukan replikasi maklumat.
nama Rentetan Ia adalah nama hos nod, dan ia digunakan sebagai pengenal unik nod.
nod Rentetan Nilai yang mungkin adalah: tempatan, jika nod adalah yang menerima permintaan zapi; atau jauh, jika nod lain dikonfigurasikan dalam kluster.

Membolehkan kluster

Membolehkan kluster

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"local_ip":"192.168.100.241","remote_ip":"192.168.100.240","remote_password":"admin"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/cluster

POST /system/cluster

Buat kumpulan yang berkomunikasi dua pengimbang.

Minta parameter

Bidang Jenis Deskripsi diperlukan
remote_ip Rentetan IP hos jauh digunakan untuk cluster. benar
local_ip Rentetan IP hos tempatan yang digunakan untuk cluster. benar
remote_password Rentetan Kata laluan pengguna root untuk pengimbang jauh. benar

Tindak balas BODY:

{
   "description" : "Enabling cluster",
   "message" : "Cluster enabled successfully",
   "success" : "true"
}

Ubah suai konfigurasi kluster

Ubah suai konfigurasi kluster

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"check_interval":4,"failback":"disabled"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/cluster

PUT /system/cluster

Konfigurasikan parameter mod kerja untuk kluster.

Minta parameter

Bidang Jenis Deskripsi
check_interval nombor Ia adalah masa menunggu di antara dua cek status nod master.
kegagalan Rentetan Nod yang mempunyai keutamaan untuk menjadi tuan. Nilai-nilai boleh menjadi a nama nod, untuk memberi keutamaan kepada nod; atau orang kurang upaya, jika mana-mana nod boleh menguasai dan tidak menjadi keutamaan untuk satu.

Tindak balas BODY:

{
   "description" : "Modifying the cluster configuration",
   "params" : {
      "check_interval" : "4",
      "failback" : "disabled"
   }
}

Lumpuhkan kumpulan

Lumpuhkan kumpulan

Permintaan contoh:

curl -k -X DELETE -H 'Content-Type: application/json' 
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/cluster

DELETE /system/cluster

Keluarkan kluster.

Tindak balas BODY:

{
   "description" : "Disabling cluster",
   "message" : "Cluster disabled successfully",
   "success" : "true"
}

Mod penyelenggaraan

Mod penyelenggaraan

Permintaan contoh:

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

POST /system/cluster/actions

Tukar nod kluster setempat kepada mod penyelenggaraan.

Tindak balas BODY:

{
   "description" : "Setting maintenance mode",
   "message" : "Local cluster node changed to maintenance mode successfully",
   "success" : "true"
}

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Tindakan untuk memohon kepada kumpulan. Tindakan yang ada ialah penyelenggaraan. benar
status Rentetan Status untuk meletakkan nod, nilai mungkin membolehkan, masukkannya dalam mod penyelenggaraan; atau melumpuhkan, simpan nod itu. benar

Tunjukkan status nod

Tunjukkan status nod

Permintaan contoh:

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

GET /system/cluster/nodes

Tunjukkan status semua nod.

Tindak balas BODY:

{
   "description" : "Cluster nodes status",
   "params" : [
      {
         "ip" : "192.168.100.241",
         "message" : "Node online and active",
         "name" : "canoDEV4100",
         "node" : "local",
         "role" : "master",
         "status" : "ok"
      },
      {
         "ip" : "192.168.100.240",
         "message" : "Node online and passive",
         "name" : "maqvir",
         "node" : "remote",
         "role" : "backup",
         "status" : "ok"
      }
   ]
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan kunci param dan nilai pelbagai objek status nod.

Objek status nod

Bidang Jenis Deskripsi
ip Rentetan Ia adalah IP yang disusun dalam nod untuk memeriksa status nod dan melakukan replikasi maklumat.
nama Rentetan Ia adalah nama hos nod, dan ia digunakan sebagai pengenal unik nod.
nod Rentetan Nilai yang mungkin adalah: tempatan, jika nod adalah yang menerima permintaan zapi; atau jauh, jika nod lain dikonfigurasikan dalam kluster.
mesej Rentetan Mesej deskriptif yang menunjukkan status dan mod kerja nod.
peranan Rentetan Mod kerja sebenar nod ini. Nilai yang mungkin adalah: master, nod ini menguruskan sambungan di antara backend dan pelanggan; atau sandaran, nod ini telah menjawab sambungan status induk dan konfigurasi induk, dan ia memeriksa bahawa perkhidmatan induk berfungsi.
status Rentetan Nyatakan jika beberapa proses kluster gagal.

Tunjukkan status kluster localhost

Tunjukkan status kluster localhost

Permintaan contoh:

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

GET /system/cluster/nodes/localhost

Tunjukkan status nod tempatan.

Tindak balas BODY:

{
   "description" : "Cluster status for localhost",
   "params" : {
      "message" : "Node online and active",
      "name" : "canoDEV4100",
      "role" : "master",
      "status" : "ok"
   }
}

Parameter tindak balas

Bidang Jenis Deskripsi
mesej Rentetan Mesej deskriptif yang menunjukkan status dan mod kerja nod.
nama Rentetan Ia adalah nama hos nod, dan ia digunakan sebagai pengenal unik nod.
peranan Rentetan Mod kerja sebenar nod ini. Nilai yang mungkin adalah: master, nod ini menguruskan sambungan di antara backend dan pelanggan; atau sandaran, nod ini telah menjawab sambungan status induk dan konfigurasi induk, dan ia memeriksa bahawa perkhidmatan induk berfungsi.
status Rentetan Nyatakan jika beberapa proses kluster gagal.