NAB Navbar
logo
curl zcli

Rujukan Zevenet API v4.0

ZAPI (Zevenet APujukan Programming Interface) adalah alat untuk pentadbir sistem untuk mengawal kelakuan pengimbang beban Zevenet.

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

Setelah pengguna ZAPI dibuat, ada kemungkinan permintaan menghantar kepada pelayan HTTP. Permintaan URI kelihatan seperti:

HTTP verb https://zevenet_server: 444 / zapi / v4.0 / zapi.cgi /URI_path,

di mana zevenet_server adalah IP di mana perkhidmatan HTTP sedang mendengar, antara muka pengurusan HTTP, dan URI_path mentakrifkan objek yang akan diminta. Cara mengakses dan cara mengubah suai setiap objek Zevenet akan ditakrifkan dalam setiap bahagian dokumentasi.

. HTTP verbs diterima untuk ZAPI adalah:

Parameter ZAPI

Parameter ZAPI

Permintaan contoh:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-H 'Content-Type: application/json' -d ''
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms

A PUT dan SELEPAS permintaan selalu memerlukan hampir parameter walaupun panggilan ZAPI tidak memerlukan parameter yang diperlukan (mandatori). Jika permintaan PUT atau POST dihantar tanpa parameter, ZAPI akan mengembalikan senarai parameter yang diharapkan dan kemungkinan pilihannya.

Contoh tindak balas:

{
   "description" : "No parameter has been sent. Please, try with:",
   "params" : [
      {
         "name" : "profile",
         "options" : [
            "required"
         ],
         "possible_values" : [
            "http",
            "gslb",
            "l4xnat",
            "datalink"
         ]
      },
      {
         "format" : "ip_addr",
         "name" : "vip",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "expects a port",
         "name" : "vport",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "The farm name is required to have alphabet letters, numbers or hypens (-) only.",
         "format" : "farm_name",
         "name" : "farmname",
         "options" : [
            "required"
         ]
      }
   ]
}

Parameter tindak balas

Tanggapan adalah senarai medan yang menerangkan parameter dan kemungkinan konfigurasi:

Penerangan parameter:

Bidang Jenis Deskripsi
nama Rentetan Ia adalah utama kepada nilai yang diterima. Parameter berikut digunakan untuk menentukannya.
Penerangan Rentetan Ia adalah maklumat mengenai nilai yang diharapkan.
selang Rentetan Parameter tersebut perlu mempunyai nilai angka yang menghormati had rendah, tinggi atau kedua-duanya. Nilai yang digunakan sebagai had diambil sebagai sah.
format Rentetan Ia boleh menjadi petunjuk dengan format parameter yang diharapkan, ia boleh menjadi ungkapan biasa atau kunci yang mengenal pasti data.
possibly_values Tali[] Ia adalah senarai nilai-nilai yang mungkin mempunyai parameter yang mungkin.
pilihan Tali[] Ia menunjukkan lebih banyak konfigurasi untuk diingat.

Senarai opsyen:

Bidang Deskripsi
dikehendaki Pilihan ini menunjukkan bahawa parameter itu wajib, ia mesti dihantar dalam permintaan.
non_blank Opsyen ini membenarkan penghantaran tali kosong sebagai nilai parameter. Ia boleh berguna untuk menyetel parameter.

Kod ralat

ZAPI boleh memberi respons salah satu kod ralat berikut:

Kod ralat Ringkas Deskripsi
400 Permintaan buruk Sesetengah parameter permintaan tidak betul.
401 Tidak dibenarkan Kekunci ZAPI anda salah.
402 Sijil tidak sah Pengimbang beban memerlukan sijil yang sah untuk memproses permintaan tersebut.
403 Larangan Pemilik pengguna kunci ZAPI tidak mempunyai keizinan untuk permintaan atau objek yang digunakan di dalamnya.
404 Not Found URI yang digunakan atau satu objek yang digunakan dalam panggilan tidak wujud.
405 Kaedah Tidak Dibenarkan Kata kerja HTTP tidak wujud atau tidak dilaksanakan untuk panggilan ZAPI semasa.
406 Tidak boleh diterima Ciri ini bukan temporal yang tersedia.
409 konflik Permintaan itu sah, tetapi ia tidak dapat diproses, konfigurasi baru mewujudkan konflik dengan yang sekarang. Syslog boleh menawarkan lebih banyak maklumat.
410 Sudah Ciri ini telah dialih keluar.
500 Ralat Pelayan Dalaman Ralat berlaku di pelayan.
504 Timeout Gateway Masa tamat tindak balas pelayan telah dicapai dan permintaan belum selesai pemprosesannya.

Perubahan log

Ini adalah senarai perubahan yang telah dimasukkan dalam setiap versi. Senarai senarai perubahan dalam versi ZAPI sentiasa berkaitan sebelum itu.

API 4.0.1

Versi ZAPI ini adalah lanjutan versi 4.0.1. Sesetengah parameter dan URI ditambah tetapi mana-mana daripada mereka di mana dikeluarkan.

Tambah permintaan untuk menunjukkan pokok dengan semua objek pengimbang beban

Tambah: GET / id

Pilihan untuk menyalin ladang

Diubah suai: POST /farms

Tambah parameter penambah responsif dan removeresponseheader dan memanjangkan parameter kata keterangan:

Diubahsuai GET /farms/<farmname>

Diubahsuai PUT /farms/<farmname>

Tambah POST /farms/<farmname>/addresponseheader|removeresponseheader

Tambah DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>

Tambah permintaan untuk menguruskan sesi statik:

Tambah GET /farms/<farmname>/sessions

Tambah POST /farms/<farmname>/sessions

Tambah DELETE /farms/<farmname>/sessions/<session>

Modul penghalaan baru:

Ditambah GET|POST|PUT|DELETE /routing/*

Farmguardian boleh menggunakan alias backend sebagai nama host untuk cek:

Ditambah GET|PUT /monitoring/fg*/<farmguardian>

Urus fail untuk peraturan WAF:

Ditambah GET|PUT|DELETE /ipds/waf/files

Dapatkan maklumat sistem:

Ditambah: GET /system/info

Tetapan global yang diubahsuaikan:

Ditambah: GET|POST /system/global

Pengesahan menggunakan LDAP:

Ditambah GET|POST /rbac/services

Ditambah GET|POST /rbac/ldap*

Diubahsuai GET|POST /rbac/users

Diubahsuai GET|PUT /rbac/users/<user>

API 4.0

Senaraikan ringkasan ladang dan perkhidmatan yang dikumpulkan untuk modul:

Ditambah: /farms/modules/summary

Tindakan untuk memautkan peraturan WAF yang ditetapkan dengan ladang HTTP:

Ditambah: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*

Diubah suai: GET /farms/<farm>

Pindahkan sijil di ladang HTTPS:

Ditambah: POST /farms/<farm>/certificates/<cert>/actions

Ubah suai panggilan ladang yang berkaitan dengan l4xnat untuk menyokong teras baru:

Diubah suai: GET|POST|PUT|DELETE /farms/<l4farm>

Ditambah DHCP dan MAC ciri-ciri dalam panggilan ZAPI berikut:

diubah suai: PUT /interfaces/nic/<if>

diubah suai: PUT /interfaces/bonding/<if>

diubah suai: POST /interfaces/vlan

diubah suai: PUT /interfaces/vlan/<if>

Namakan semula parameter untuk menyalin penjaga ladang:

Diubah suai: POST /monitoring/fg

Pengurusan pakej IPDS:

Ditambah: GET /ipds/package

Ditambah: POST /ipds/package/actions

Firewall aplikasi web baru, WAF, ciri:

Ditambah: GET|POST|PUT|DELETE /ipds/waf/*

Keluarkan panggilan untuk menyalin peraturan RBL. Kini ia adalah parameter mewujudkan panggilan:

dikeluarkan: POST /ipds/rbl/<name>

diubah suai: POST /ipds/waf/<name>

Ciri-ciri ini tetapan semula kilang, proksi dan semak kemas kini pakej telah ditambah:

Ditambah: POST /system/factory

Ditambah: GET /system/proxy

Ditambah: POST /system/proxy

Ditambah: GET /system/packages

Tambah parameter untuk mengurus menu GUI web:

Ditambah: GET /rbac/menus

Diubah suai: PUT /rbac/roles/<ROLE>

Sijil Pengaktifan

Sijil pengaktifan adalah lesen yang dikeluarkan oleh Zevenet yang membolehkan penggunaan penuh pengimbang beban dalam versi Enterprisenya.

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/v4.0/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.

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/v4.0/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"
}

Padam Sijil pengaktifan

Padam Sijil pengaktifan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/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"
}

Sijil SSL

Zevenet menyokong sijil dalam format PEM untuk menggunakannya dengan ladang HTTP yang ditubuhkan dengan pendengar HTTPS. Jika anda ingin mengetahui lebih lanjut mengenai cara membuatnya pem sijil, 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/v4.0/zapi.cgi/certificates
zcli certificate list

GET /certificates

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

Contoh tindak balas:

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.

{
   "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 Ia adalah 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate download example.pem 

GET /certificates/<file>

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

Header maklum balas:

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

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/v4.0/zapi.cgi/certificates/example.pem/info
zcli certificate get example.pem

GET /certificates/<file>/info

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

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

Padam Sijil

Padam Sijil

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate delete example.pem

DELETE /certificates/<file>

Padam sijil dengan nama fail di kedai sijil.

Contoh tindak balas:

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

Buat sijil CSR

Buat sijil CSR

Permintaan contoh:

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

POST /certificates

Buat Permintaan 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 disetempatkan. 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate upload example.pem /local_path/to/example.pem

POST /certificates/<file>

Muat naik sijil PEM untuk ladang HTTP dengan pendengar HTTPS.

Meminta parameter URI

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

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

Contoh tindak balas:

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

Senarai Ciphers

Senarai Ciphers

Permintaan contoh:

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

GET /ciphers

Senaraikan ciphers yang boleh digunakan oleh ladang HTTPS.

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

Contoh tindak balas:

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.

{
   "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 boleh mengurus lalu lintas dalam tiga cara yang berbeza, setiap cara diuruskan oleh modul yang berbeza, pengimbang beban perkhidmatan tempatan atau modul LSLB, Global Service Load Balancer 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 tertentu dengan trafik rangkaian, adalah penting untuk memahami apa yang boleh dilakukan setiap profil ladang untuk mendapatkan hasil terbaik Zevenet ADC.

Senaraikan ringkasan ladang

Senaraikan ringkasan ladang

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/modules/summary

GET /farms/modules/summary

Senaraikan ringkasan dengan ladang dalam sistem, dikumpulkan oleh modul.

Contoh tindak balas:

{
   "description" : "Farm Modules summary",
   "params" : {
      "dslb" : [],
      "gslb" : [
         {
            "name" : "dnsServ",
            "profile" : "gslb",
            "services" : []
         }
      ],
      "lslb" : [
         {
            "name" : "CatalogueWeb",
            "profile" : "http",
            "services" : [
               "technology",
               "food"
            ]
         },
         {
            "name" : "shopApp",
            "profile" : "http",
            "services" : [
               "provider",
               "clients"
            ]
         },
         {
            "name" : "VirtualApps",
            "profile" : "l4xnat"
         }
      ]
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi pelbagai ladang dengan perkhidmatan mereka.

Objek Ladang:

Bidang Jenis Deskripsi
farmname Rentetan Nama deskriptif ladang. Ia digunakan sebagai pengecam unik untuk ladang.
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
perkhidmatan Tali[] Ia adalah senarai nama perkhidmatan yang terdapat di ladang. Medan ini boleh didapati di ladang jenis http, https, dan gslb.

Senaraikan semua ladang

Senaraikan semua ladang

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm list

GET /farms

Senaraikan semua ladang yang ada

Contoh tindak balas:

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

Parameter tindak balas

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 pengecam unik untuk ladang.
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 itu 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.

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/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm delete FarmHTTP

DELETE /farms/<farmname>

Padam ladang melalui pengenal nama ladangnya.

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/v4.0/zapi.cgi/farms/FarmTCP/actions
zcli farm stop FarmTCP

PUT /farms/<farmname>/actions

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

Minta parameter

Bidang Jenis Deskripsi
tindakan Rentetan Tindakan untuk melaksanakan, kemungkinan adalah: berhenti, ladang itu akan dihentikan, memotong sambungan semasa dan tidak menerima lebih banyak sambungan; permulaan, ladang itu akan dimulakan, menjalankan pendengar dan mengimbangi hubungan baru antara bahagian belakangnya; 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

Sekiranya tidak ada masalah dalam konfigurasi maka ZAPI akan memulangkan tindakan yang diminta.

Ladang HTTP

Profil HTTP adalah pengimbangan beban 7 lapisan lanjutan (atau Penerima Penghantaran Aplikasi) dengan sifat khusus proksi. Profil ini menawarkan beberapa ciri seperti pengimbangan beban HTTPS digabungkan dengan pecutan SSL offload. Profil ini memadai 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 TCP maya pelabuhan 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/v4.0/zapi.cgi/farms/httpFarm
zcli farm get httpFarm

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Contoh tindak balas:

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

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 Objek [] Peraturan hitam yang digunakan untuk ladang.
daripada Objek [] Peraturan DoS diterapkan ke ladang.
rbl Objek [] Peraturan RBL diterapkan ke ladang.
WAF Objek [] Ia adalah objek dengan satu kunci, nama.

Blacklist, DoS dan RBL Objek:

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan.
status Rentetan Status peraturan.

Parameter objek untuk ladang HTTP:

Bidang Jenis Deskripsi
addheader Objek [] Ia adalah senarai objek dengan tajuk untuk ditambah kepada permintaan klien.
penambahbaikan (dari 4.0.1) Objek [] Ia adalah senarai objek dengan tajuk untuk menambah respons backend.
penyertaan Objek [] Hanya jika pendengar adalah HTTPS. Senarai Sijil digunakan oleh ladang, mereka mempunyai dalam format PEM, dibenarkan untuk menambahkan lebih dari satu sijil PEM ke ladang yang sama untuk sokongan SNI. 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 "keamanan keselamatan".
tulisan rahsia Rentetan Hanya jika pendengar adalah HTTPS. Digunakan untuk membina senarai ciphers 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 bertindak balas dengan kod ralat HTTP 414.
error500 Rentetan Mesej peribadi untuk bertindak balas dengan kod ralat HTTP 500.
error501 Rentetan Mesej peribadi untuk bertindak balas dengan kod ralat HTTP 501.
error503 Rentetan Mesej peribadi untuk bertindak balas dengan kod ralat HTTP 503.
headremove Objek [] Ini adalah senarai ungkapan biasa untuk mengalih keluar tajuk dari permintaan pelanggan. Tajuk yang dihapus tidak akan sampai ke belakang.
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 terdahulu ditambah PUT, DELETE. pilihanHTTP (dari 4.0.1), tambah kata kerja OPTIONS kepada yang sebelumnya. standardWebDAV, menerima permintaan HTTP terdahulu termasuk LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPSYEN, TRACE, MIKTIVITI, CHECKOUT, MERGE, REPORT, MSextWebDAV menerima permintaan HTTP terdahulu serta SUBSCRIBE, UNSUBSCRIBE, notis, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan HTTP terdahulu ditambah RPC_IN_DATA, RPC_OUT_DATA. Ambil perhatian bahawa nilai-nilai tersebut adalah sensitif huruf.
ignore_100_continue Rentetan Jika bidang ini mempunyai nilai benar yang 100 teruskan Pengepala HTTP 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.
balak Rentetan Ladang Log mengesan sambungan HTTP. Jika parameter ini mempunyai nilai benar, balak telah diaktifkan; jika ia mempunyai nilai palsu, log dilumpuhkan.
removeresponseheader (dari 4.0.1) Objek [] Ini adalah senarai ungkapan biasa untuk mengalih keluar tajuk dari respons backend. Tajuk yang dihapuskan tidak akan sampai kepada pelanggan.
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, diaktifkan 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 tersebut cocok 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, tiada 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.
tukang ladang Rentetan Ia adalah nama FarmGuardian yang menyemak status backend. FarmGuardian akan berjalan sementara ladang berada dalam keadaan up.
httpsb Rentetan Parameter ini menunjukkan kepada ladang bahawa backends ditetapkan untuk menggunakan bahasa HTTPS dan kemudian data akan dienkripsi 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 imbangan tindak balas yang paling sedikit. benar sering cek profil yang backend mengambil masa kurang untuk bertindak balas untuk menghantar lebih banyak sambungan ke yang ini, yang 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 berkelakuan seperti backend khas, kerana permintaan klien dijawab oleh redirect ke URL baru secara automatik. Jika pengalihan dikonfigurasi maka permintaan itu tidak akan diteruskan ke backend, Redirect akan dijawab kepada klien sebaliknya.
redirect_code nombor Ia adalah kod HTTP yang dikembalikan apabila pengalihan dikonfigurasikan. Nilai yang mungkin adalah 301, 302, 307,
redirecttype Rentetan Bagaimana pengalihan semula akan dilakukan, dua pilihan: lalai, URL diambil sebagai tuan rumah mutlak dan laluan untuk mengarahkan semula, 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 header HTTP dan akan mengurus sesi klien.
sts_status Rentetan Status ketukan Keselamatan Pengangkutan Ketat. Untuk mendayakan ciri ini, perlu menetapkan pendengar lad sebagai HTTPS. Nilai yang mungkin adalah: benar untuk membolehkan arahan STS dalam perkhidmatan; atau palsu untuk mematikan arahan STS dalam perkhidmatan tersebut.
sts_timeout nombor Masa (dalam saat) pelanggan ingat bahawa perkhidmatan hanya tersedia dengan HTTS.
ttl nombor Hanya dengan kegigihan. Nilai ini menunjukkan masa maksimum bagi sesi klien tidak aktif (umur sesi max) dalam saat.
urlp Rentetan Membolehkan penentuan perkhidmatan web berkenaan URL yang diminta oleh klien menerusi corak URL tertentu yang akan diperiksa secara sintaksis. Ungkapan biasa PCRE disokong.
vhost Rentetan Ia menentukan keadaan 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
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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 penyelenggaraan backend; undefined, status backend belum diperiksa.
timeout nombor Ia adalah masa maksimum menunggu sambutan backend sebelum daripada menandakan ia tidak tersedia. Masa ini dalam beberapa saat.
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. Nilai yang mungkin adalah dari 1 kepada 9.
keutamaan (dari 4.0.1) nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa, backend dengan nilai keutamaan yang lebih rendah akan siap menerima sambungan sebelum daripada yang lain dengan keutamaan yang lebih tinggi. Nol nilai lalai, nilai keutamaan 1 digunakan. Nilai mungkin dari 1 kepada 9

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newHTTPfarm -profile http -vip 192.168.100.23 -vport 80

POST /farms

Buat ladang HTTP baru.

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
salin_dari (dari 4.0.1) Rentetan Parameter ini menjangkakan nama ladang yang wujud. Jika parameter ini dihantar, ladang disalin dari ladang yang dinyatakan di dalamnya. The farmname, vip dan vport nilai akan ditimpa semula.

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", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -contimeout 22 -newfarmname FarmHTTP2 -vip 178.62.126.152 -vport 88 -ignore_100_continue true -restimeout 47 -resurrectime 12 -reqtimeout 32 -rewritelocation enabled -httpverb standardHTTP -errorcode414 'Message error 414' -logs true

PUT /farms/<farmname>

Ubah parameter global untuk 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 dalam beberapa saat ialah tempoh untuk mendapatkan backend yang disenarai hitam dan menyemak jika ia 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 diaktifkan; 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 terdahulu ditambah PUT, DELETE. pilihanHTTP (dari 4.0.1), tambah kata kerja OPTIONS kepada yang sebelumnya. standardWebDAV, menerima permintaan HTTP terdahulu termasuk LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPSYEN, TRACE, MIKTIVITI, CHECKOUT, MERGE, REPORT, MSextWebDAV menerima permintaan HTTP terdahulu serta SUBSCRIBE, UNSUBSCRIBE, notis, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, atau MSRPCext, menerima permintaan HTTP terdahulu ditambah RPC_IN_DATA, RPC_OUT_DATA. Ambil perhatian bahawa nilai-nilai tersebut adalah sensitif huruf.
ignore_100_continue Rentetan Jika bidang ini mempunyai nilai benar yang 100 teruskan Pengepala HTTP 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.
balak Rentetan Ladang Log mengesan sambungan HTTP. Jika parameter ini mempunyai nilai benar, balak telah diaktifkan; jika ia mempunyai nilai palsu, log dilumpuhkan.
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 "keamanan keselamatan".
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",
      "logs" : "true",
      "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 Header Khusus untuk Permintaan

Tambah Header Khusus untuk Permintaan

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

POST /farms/<farmname>/addheader

Ladang itu akan menambah tajuk ke belakang.

Minta parameter

Bidang Jenis Deskripsi diperlukan
header Rentetan Ia adalah tali dengan header yang akan dihantar ke backend. benar

Contoh tindak balas:

{
   "description" : "Add addheader directive.",
   "message" : "Added a new item to the addheader list",
   "status" : "needed restart",
   "success" : "true"
}

Padamkan Header Khusus dari Permintaan

Padamkan Header Khusus dari Permintaan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/0
zcli farm-add-request-header remove MyHttpFarm 0

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

indeks adalah indeks array addheader untuk memadam.

Contoh tindak balas:

{
   "description" : "Delete addheader directive.",
   "message" : "The addheader 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tambah Aturan untuk Buang Pengepala dari Permintaan

Tambah Aturan untuk Buang Pengepala dari Permintaan

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

POST /farms/<farmname>/headremove

Alih keluar tajuk tertentu dari permintaan yang masuk. Semua kejadian tajuk yang sepadan yang sepadan akan dialih keluar.

Minta parameter

Bidang Jenis Deskripsi diperlukan
pola Rentetan Ia adalah rentetan dengan regexp untuk mencari dalam permintaan pelanggan. Jika sesetengah header sepadan dengan corak, header akan dikeluarkan benar

Contoh tindak balas:

{
   "description" : "Add headremove directive.",
   "message" : "Added a new item to the headremove list",
   "status" : "needed restart",
   "success" : "true"
}

Padam Peraturan untuk Menghapus Pengepala dari Permintaan

Padam Peraturan untuk Menghapus Pengepala dari Permintaan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/0
zcli farm-remove-request-header remove MyHttpFarm 0

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

indeks adalah indeks array kepala untuk memadam.

Contoh tindak balas:

{
   "description" : "Delete headremove directive.",
   "message" : "The headremove 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tambah Header Khusus untuk Respon

Tambah Header Khusus untuk Respon

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

Panggilan ini tersedia dari versi 4.0.1

POST /farms/<farmname>/addresponseheader

Ladang itu akan menambah tajuk pada tindak balas backend.

Minta parameter

Bidang Jenis Deskripsi diperlukan
header Rentetan Ia adalah tali dengan header yang akan dihantar ke backend. benar

Contoh tindak balas:

{
   "description" : "Add a header to the backend repsonse.",
   "message" : "Added a new header to the backend response",
   "status" : "needed restart",
   "success" : "true"
}

Padamkan Header Khusus dari Response

Padamkan Header Khusus dari Response

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/0
zcli farm-add-response-header remove torta 0

Panggilan ini tersedia dari versi 4.0.1

DELETE /farms/<farmname>/addresponseheader/<index>

indeks adalah indeks tatacara penambahan pengguna untuk memadam.

Contoh tindak balas:

{
   "description" : "Delete a header previously added to the backend response.",
   "message" : "The header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tambah Peraturan untuk Buang Pengepala dari Respons

Tambah Peraturan untuk Buang Pengepala dari Respons

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

Panggilan ini tersedia dari versi 4.0.1

POST /farms/<farmname>/removeresponseheader

Alih keluar tajuk tertentu dari permintaan yang masuk. Semua kejadian tajuk yang sepadan yang sepadan akan dialih keluar.

Minta parameter

Bidang Jenis Deskripsi diperlukan
pola Rentetan Ia adalah rentetan dengan regexp untuk mencari dalam permintaan pelanggan. Jika sesetengah header sepadan dengan corak, header akan dikeluarkan benar

Contoh tindak balas:

{
   "description" : "Remove a header from the backend response.",
   "message" : "Added a patter to remove reponse headers",
   "status" : "needed restart",
   "success" : "true"
}

Padam Peraturan untuk Menghapus Tandukan daripada Maklum Balas

Padam Peraturan untuk Menghapus Tandukan daripada Maklum Balas

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/0
zcli farm-remove-response-header remove torta 0

Panggilan ini tersedia dari versi 4.0.1

DELETE /farms/<farmname>/removeresponseheader/<index>

indeks adalah indeks tatasusunan pengawal penghapus untuk memadam.

Contoh tindak balas:

{
   "description" : "Delete a pattern to remove response headers.",
   "message" : "The pattern 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

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/v4.0/zapi.cgi/farms/httpFarm/certificates
zcli farm-certificate add httpFarm -file example.pem

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

Pindahkan Sijil

Pindahkan Sijil

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/v4.0/zapi.cgi/farms/newfarm/certificates/certif.pem/actions
zcli farm-certificate move newfarm zertif.pem -position 0

POST /farms/<farmname>/certificates/<file>/actions

URI file parameter ialah nama fail sijil yang akan dipindahkan.

Ciri ini membolehkan pemindahan sijil untuk mengubah susunan yang akan diperiksa.

Minta parameter

Bidang Jenis Deskripsi diperlukan
kedudukan Integer Ia adalah kedudukan bahawa sijil akan ada dalam konfigurasi ladang apabila panggilan ZAPI akan diproses benar

Contoh tindak balas:

{
    "description" : "Move service",
    "params" : {
        "position" : 0
    },
    "status" : "needed restart",
    "info" : "There\'re changes that need to be applied, stop and start farm to apply them!",
    "message" : "certif.pem was moved successfully."
}

Padam Sijil

Padam Sijil

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
zcli farm-certificate remove MyHttpFarm example.pem

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

Padam sijil dengan nama fail yang dipilih dari penyertaan di ladang HTTP dengan pendengar HTTPS. Sijil 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/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists
zcli farm-blacklist add httpFarm -name china

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

Memohon senarai hitam, DoS, RBL atau peraturan WAF 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"
}

Pindahkan peraturan IPDS

Pindahkan peraturan IPDS

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2

POST /farms/<farmname>/ipds/<waf>/actions

Langkah IPDS peraturan hanya tersedia untuk peraturan WAF. Dalam peraturan semacam ini adalah penting perintah yang akan diperiksa.

. waf Parameter URI adalah nama peraturan set yang akan dipindahkan.

Minta parameter

Bidang Jenis Deskripsi diperlukan
kedudukan Integer Ia adalah kedudukan yang menetapkan peraturan WAF akan ada dalam konfigurasi ladang apabila panggilan ZAPI akan diproses benar

Contoh tindak balas:

{
    "message" : "The rule was moved properly to the position 2.",
    "description" : "Move a rule in the set test_waf_ori"
}

Keluarkan peraturan IPDS

Keluarkan peraturan IPDS

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists/china
zcli farm-blacklist remove httpFarm china

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

Keluarkan senarai hitam, DoS, RBL atau WAF dari ladang yang diberikan menggunakan penunjuknya 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 di 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.

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/v4.0/zapi.cgi/farms/cookiefarm/services/serv
zcli farm get cookiefarm -filter services

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

Tunjukkan semua konfigurasi mengenai perkhidmatan yang diberikan.

Contoh tindak balas:

{
   "description" : "Get services of a farm",
   "services" : {
      "backends" : [
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : 20,
            "weight" : null,
            "priority" : null
         },
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null,
            "priority" : null
         }
      ],
      "cookiedomain" : "zevenet.cpm",
      "cookieinsert" : "true",
      "cookiename" : "peasocookie",
      "cookiepath" : "/patfh",
      "cookiettl" : 20,
      "farmguardian" : "check_tcp-cut_conns",
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirect_code" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "sts_status" : "false",
      "sts_timeout" : 0,
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : ""
   }
}

Parameter 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 tersebut cocok 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.
tukang ladang Rentetan Ia adalah nama FarmGuardian yang menyemak status backend. FarmGuardian akan berjalan sementara ladang berada dalam keadaan up.
httpsb Rentetan Parameter ini menunjukkan kepada ladang bahawa backends dikonfigurasikan untuk menggunakan HTTPS, maka data akan dienkripsi sebelum dikirim. 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 imbangan tindak balas yang paling sedikit. benar kerap cek 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 berkelakuan seperti backend khas, kerana permintaan klien dijawab oleh redirect ke URL baru secara automatik. Jika pengalihan dikonfigurasi maka permintaan itu tidak akan diteruskan ke backend, Redirect akan dijawab kepada klien sebaliknya.
redirect_code nombor Ia adalah kod HTTP yang dikembalikan apabila pengalihan dikonfigurasikan. Nilai yang mungkin adalah 301, 302, 307.
redirecttype Rentetan Bagaimana pengalihan semula akan dilakukan, dua pilihan: lalai, URL diambil sebagai tuan rumah mutlak dan laluan untuk mengarahkan semula, tambah, laluan permintaan asal atau URI akan ditambahkan pada hos dan laluan yang anda tetapkan dengan pilihan lalai. Sekiranya 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 header HTTP dan akan mengurus sesi klien.
sts_status Rentetan Status ketukan Keselamatan Pengangkutan Ketat. Untuk mendayakan ciri ini, perlu menetapkan pendengar lad sebagai HTTPS. Nilai yang mungkin adalah: benar untuk membolehkan arahan STS dalam perkhidmatan; atau palsu untuk mematikan arahan STS dalam perkhidmatan tersebut.
sts_timeout nombor Masa (dalam saat) pelanggan mengingati bahawa perkhidmatan hanya tersedia dengan HTTS.
ttl nombor Hanya dengan kegigihan. Nilai ini menunjukkan masa maksimum bagi sesi klien tidak aktif (umur sesi max) dalam saat.
urlp Rentetan Membolehkan penentuan perkhidmatan web berkenaan URL yang diminta oleh klien menerusi corak URL tertentu yang akan diperiksa secara sintaksis. Ungkapan biasa PCRE disokong.
vhost Rentetan Ia menentukan keadaan 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
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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 penyelenggaraan backend; undefined, status backend belum diperiksa.
timeout nombor Ia adalah masa maksimum menunggu tindak balas backend sebelum meletakkannya sebagai turun. Masa ini dalam beberapa saat.
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. Nilai yang mungkin adalah dari 1 kepada 9.
keutamaan (dari 4.0.1) nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa, backend dengan nilai keutamaan yang lebih rendah akan siap menerima sambungan sebelum daripada yang lain dengan keutamaan yang lebih tinggi. Nol nilai lalai, nilai keutamaan 1 digunakan. Nilai mungkin dari 1 kepada 9.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
zcli farm-service add FarmHTTP -id newserv

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_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -vhost www.mywebserver.com -urlp ^/myapp1$ -persistence URL -redirect_code 302 -redirect http://zenloadbalancer.com -ttl 125 -sessionid sid -sts_status true -sts_timeout 21600000

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

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

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 penentuan perkhidmatan web berkenaan URL yang diminta oleh klien menerusi corak URL tertentu 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.
redirect_code nombor Ia adalah kod HTTP yang dikembalikan apabila pengalihan dikonfigurasikan. Nilai yang mungkin adalah 301, 302, 307,
redirecttype Rentetan Bagaimana peralihan akan dilakukan, dua pilihan: lalai, URL diambil sebagai tuan rumah mutlak dan laluan untuk mengarahkan semula, 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 tersebut cocok 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 mengurus sesi klien.
sts_status Rentetan Status ketukan Keselamatan Pengangkutan Ketat. Untuk mendayakan ciri ini, perlu menetapkan pendengar lad sebagai HTTPS. Nilai yang mungkin adalah: benar untuk membolehkan arahan STS dalam perkhidmatan; atau palsu untuk mematikan arahan STS dalam perkhidmatan tersebut.
sts_timeout nombor Masa (dalam saat) pelanggan mengingati bahawa perkhidmatan hanya tersedia dengan HTTS.
kurangnya Rentetan Ia membolehkan kaedah imbangan tindak balas yang paling sedikit. benar, kerap profil pemeriksaan yang backend mengambil masa kurang untuk bertindak balas untuk menghantar lebih banyak sambungan ke yang satu ini, palsu, profil tidak memeriksa backend mana yang memerlukan lebih sedikit masa untuk bertindak balas.
httpsb Rentetan Ia menunjukkan kepada ladang bahawa pelayan backends ditetapkan untuk menggunakan HTTPS, maka data akan dienkripsi sebelum dikirim. 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,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirect_code" : 302,
      "redirecttype" : "default",
      "sessionid" : "sid",
      "sts_status" : "true",
      "sts_timeout" : 21600000,
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com"
   },
   "status" : "needed restart"
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan parameter yang diminta dikemas kini dan status bidang dengan status ladang semasa. Jika tindakan Restart perlu diambil untuk memohon perubahan ladang, nilai itu akan perlu dimulakan semula.

Tambah FarmGuardian

Tambah FarmGuardian

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/fg
zcli farm-service-farmguardian add FarmHTTP service1 -name check_tcp-cut_conns

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

Memohon FarmGuardian ke perkhidmatan.

Parameter URI adalah pengecam unik perkhidmatan.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Pengecam unik FarmGuardian. FarmGuardians dicipta dan diubah suai di bahagian pemantauan.

Contoh tindak balas:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the service service1 in the farm FarmHTTP",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the service service1 in the farm FarmHTTP"
}

Keluarkan FarmGuardian

Keluarkan FarmGuardian

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove FarmHTTP service1 check_tcp-cut_conns

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

Keluarkan FarmGuardian dari perkhidmatan di ladang.

Contoh tindak balas:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the service service1 in the farm FarmHTTP",
   "message" : "Sucess, check_tcp-cut_conns was removed from the service service1 in the farm FarmHTTP"
}

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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/actions
zcli farm-service move FarmHTTP service1 -position 0

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

Tindakan ini 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 akan memulakan semula ladang secara automatik.

id adalah pengecam unik perkhidmatan yang akan diubah suai.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1
zcli farm-service remove FarmHTTP service1

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

Padam perkhidmatan yang diberikan oleh 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
zcli farm get httpfarm

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

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

Contoh tindak balas:

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

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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. Nilai yang mungkin adalah dari 1 kepada 9.
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 penyelenggaraan backend; undefined, status backend belum diperiksa.
keutamaan (dari 4.0.1) nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin dari 1 kepada 9

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,"priority":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2

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 membalas permintaan tertentu.
berat badan nombor Ini adalah nilai berat untuk backend semasa. Nilai yang mungkin adalah dari 1 kepada 9.
keutamaan (dari 4.0.1) nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin dari 1 kepada 9

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,
      "priority" : 1
   },
   "status" : "needed restart"
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan parameter yang diminta dikemas kini dan status bidang dengan status ladang semasa. Jika tindakan Restart perlu diambil untuk memohon perubahan ladang, nilai itu akan perlu dimulakan semulaJika ada

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,"weight":1,"priority":1}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1

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

Ubah suai parameter perkhidmatan HTTP backend.

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. Nilai yang mungkin adalah dari 1 kepada 9.
keutamaan (dari 4.0.1) nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin dari 1 kepada 9

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,
      "priority" : 4
   },
   "status" : "needed restart",
   "warning" : "Backends with high priority value (4) will not be used."
}

Parameter tindak balas

Sambutan akan menjadi JSON dengan parameter yang diminta dikemas kini dan status bidang dengan status ladang semasa. Jika tindakan Restart perlu diambil untuk memohon perubahan ladang, nilai itu akan perlu dimulakan semula. Jika parameter Keutamaan dikemas kini dengan nilai tidak konsisten, maka amaran bidang akan menerangkannya.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
zcli farm-service-backend maintenance httpfarm newsrv 0 -mode cut

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

Tetapkan tindakan yang diberikan dalam latar belakang 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 backend tanpa mempengaruhi 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
zcli farm-service-backend remove newfarmHTTP service1 4

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

Padamkan backend yang diberikan dari perkhidmatan 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 mewujudkan ladang keseimbangan beban yang berfungsi di lapisan 4 model OSI, 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 profil 7 lapisan dapat dikendalikan.

Selain itu, ladang L4xNAT dapat mengikat pelbagai port, bukan 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 di 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/v4.0/zapi.cgi/farms/l4farm
zcli farm get l4farm

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Tindak balas BODY:

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

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 Objek [] Peraturan hitam yang digunakan untuk ladang.
daripada Objek [] Peraturan DoS diterapkan ke ladang.
rbl Objek [] Peraturan RBL diterapkan ke ladang.

Blacklist, DoS dan RBL Objek:

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan.
status Rentetan Status peraturan.

Objektif parameter untuk ladang L4xNAT:

Bidang Jenis Deskripsi
algoritma Rentetan Jenis penjadualan keseimbangan beban yang digunakan untuk menghantar lalu lintas antara hujung belakang. Pilihannya ialah: paling tidak meneruskan sambungan selalu ke server sambungan sekurang-kurangnya; berat badan penghantaran linier sambungan bergantung kepada berat belakang; Robin pusingan memilih selekoh antara kolam belakang, setiap backend akan menerima jumlah permintaan yang sama; hash_srcip mengimbangi paket yang sepadan dengan sumber IP yang sama ke backend yang sama; hash_srcip_srcport mengimbangi paket yang sepadan dengan sumber IP yang sama dan port ke backend yang sama; symhash baki paket yang sepadan dengan sumber yang sama IP dan pelabuhan dan destinasi IP dan pelabuhan, supaya ia mungkin mempunyai sambungan dalam kedua-dua cara (semasa masuk dan keluar).
pendengar Rentetan Pendengar menentukan bagaimana ladang akan bermain dengan permintaan dari pelanggan. bidang maklumat, tidak dapat diubah.
balak Rentetan Maklumat Log bungkusan ladang lapisan pengangkutan, tidak ada maklumat lapisan aplikasi. Jika parameter ini mempunyai nilai benar, balak telah diaktifkan; jika ia mempunyai nilai palsu, log dilumpuhkan.
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 pelanggan, pengimbang beban perlu dikonfigurasi sebagai pintu masuk di pelayan belakang; In dsr (Pemulihan Langsung) mod pelanggan menyambung ke VIP, maka pengimbang beban mengubah alamat MAC tujuan untuk alamat MAC backend (pelayan harus berada pada media link yang sama sebagai pengimbang beban); DNAT stateless. In stateless_dnat alamat beralih beban alamat alamat untuk alamat backend dan meneruskannya ke backend sebagai DNAT tidak, tetapi ia tidak menguruskan apa-apa jenis maklumat sambungan.
kegigihan Rentetan Parameter ini meneruskan permintaan masuk ke backend yang sama di dasar pada mod ketekunan yang dipilih. Pilihannya ialah: "" nilai kosong melumpuhkan kegigihan, setiap paket masuk akan diimbangi antara hujung belakang; ip or srcip, IP Sumber, akan memberikan backend yang sama untuk setiap sambungan yang masuk bergantung kepada sumber alamat IP sahaja; Port, Port Sumber, akan memberikan backend yang sama untuk setiap sambungan yang masuk bergantung kepada port sumber sahaja. srcmac, Sumber MAC, Dengan pilihan ini, ladang akan memberikan backend yang sama untuk setiap sambungan masuk bergantung pada alamat MAC-lapisan alamat paket; srcip_srcport, Sumber IP dan Port Sumber, akan memberikan backend yang sama untuk setiap sambungan masuk bergantung kepada kedua-dua, sumber IP dan pelabuhan sumber; srcip_dstport, Sumber IP dan Destination Destination, akan memberikan backend yang sama untuk setiap sambungan masuk bergantung kepada kedua-dua, sumber IP dan pelabuhan destinasi.
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, juga untuk TCP, adalah mungkin untuk menetapkan sekali protokol berikut untuk menguraikan pengepala dan menggunakannya untuk mengedarkan dengan betul: ftp, irc, pptp, Atau waras; udp pengimbang beban hanya akan mengimbangi protokol UDP L4, juga untuk UDP, adalah mungkin untuk menetapkan sekali protokol berikut untuk menguraikan pengepala dan menggunakannya untuk mengedarkan dengan betul: menghirup, tftp, amanda, netbios-ns, Atau snmp; sctp, pengimbang beban hanya akan mengimbangi protokol SCTP L4. Jika h323 dipilih, ladang akan mendengar TCP dan UDP permintaan dan menghuraikan pengepala untuk mengimbangi antara hujung belakang.
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. Port unik boleh ditentukan, port pelbagai boleh ditentukan dengan pemisah : dan beberapa pelabuhan boleh ditentukan dengan pemisah ,.
tukang ladang Rentetan Ia adalah nama FarmGuardian yang menyemak status backend. FarmGuardian akan berjalan sementara ladang berada dalam keadaan up.

Objek backend untuk ladang L4xNAT:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
id nombor ID untuk mengenal pasti backend di kolam belakang 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 penyelenggaraan backend; undefined, status backend belum diperiksa.
keutamaan nombor Ini adalah nilai keutamaan untuk pelayan sebenar semasa. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin adalah dari 1 kepada 9.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan. Nilai yang mungkin adalah dari 1 kepada 9.
max_conns nombor Ia adalah bilangan maksimum sambungan yang backend akan diterima serentak. Sekiranya ia ditetapkan dengan a 0 nilai backend belum menentukan had apa-apa.

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newl4farm -vip 192.168.100.241 -vport 88 -profile l4xnat

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
salin_dari (dari 4.0.1) Rentetan Parameter ini menjangkakan nama ladang yang wujud. Jika parameter ini dihantar, ladang disalin dari ladang yang dinyatakan di dalamnya. The farmname, vip dan vport nilai akan ditimpa semula.

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","logs":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
zcli farm set newfarml4 -algorithm weight -newfarmname l4farm -protocol tcp -nattype nat -ttl 125 -vip 178.62.126.152 -vport 81 -logs true

PUT /farms/<farmname>

Ubah suai konfigurasi ladang L4xNAT.

Minta parameter

Bidang Jenis Deskripsi
newfarmname Rentetan Nama Ladang baru. Ladang mesti dihentikan.
balak Rentetan Maklumat Log bungkusan ladang lapisan pengangkutan, tidak ada maklumat lapisan aplikasi. Jika parameter ini mempunyai nilai benar, balak telah diaktifkan; jika ia mempunyai nilai palsu, log dilumpuhkan.
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. Port unik boleh ditentukan, port pelbagai boleh ditentukan dengan pemisah : dan beberapa pelabuhan boleh ditentukan dengan pemisah ,.
kegigihan Rentetan Parameter ini meneruskan permintaan masuk ke backend yang sama di dasar pada mod ketekunan yang dipilih. Pilihannya ialah: "" nilai kosong melumpuhkan kegigihan, setiap paket masuk akan diimbangi antara hujung belakang; ip or srcip, IP Sumber, akan memberikan backend yang sama untuk setiap sambungan yang masuk bergantung kepada sumber alamat IP sahaja; Port, Port Sumber, akan memberikan backend yang sama untuk setiap sambungan yang masuk bergantung kepada port sumber sahaja. srcmac, Sumber MAC, Dengan pilihan ini, ladang akan memberikan backend yang sama untuk setiap sambungan masuk bergantung pada alamat MAC-lapisan alamat paket; srcip_srcport, Sumber IP dan Port Sumber, akan memberikan backend yang sama untuk setiap sambungan masuk bergantung kepada kedua-dua, sumber IP dan pelabuhan sumber; srcip_dstport, Sumber IP dan Destination Destination, akan memberikan backend yang sama untuk setiap sambungan masuk bergantung kepada kedua-dua, sumber IP dan pelabuhan destinasi.
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 pelanggan, pengimbang beban perlu dikonfigurasi sebagai pintu masuk di pelayan belakang; In dsr (Pemulihan Langsung) mod pelanggan menyambung ke VIP, maka pengimbang beban mengubah alamat MAC tujuan untuk alamat MAC backend (pelayan harus berada pada media link yang sama sebagai pengimbang beban); DNAT stateless. In stateless_dnat alamat beralih beban alamat alamat untuk alamat backend dan meneruskannya ke backend sebagai DNAT tidak, tetapi ia tidak menguruskan apa-apa jenis maklumat sambungan.
algoritma Rentetan Jenis penjadualan keseimbangan beban yang digunakan untuk menghantar lalu lintas antara hujung belakang. Pilihannya ialah: paling tidak meneruskan sambungan selalu ke server sambungan sekurang-kurangnya; berat badan penghantaran linier sambungan bergantung kepada berat belakang; Robin pusingan memilih selekoh antara kolam belakang, setiap backend akan menerima jumlah permintaan yang sama; hash_srcip mengimbangi paket yang sepadan dengan sumber IP yang sama ke backend yang sama; hash_srcip_srcport mengimbangi paket yang sepadan dengan sumber IP yang sama dan port ke backend yang sama; symhash baki paket yang sepadan dengan sumber yang sama IP dan pelabuhan dan destinasi IP dan pelabuhan, supaya ia mungkin mempunyai sambungan dalam kedua-dua cara (semasa masuk dan keluar).
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, juga untuk TCP, adalah mungkin untuk menetapkan sekali protokol berikut untuk menguraikan pengepala dan menggunakannya untuk mengedarkan dengan betul: ftp, irc, pptp, Atau waras; udp pengimbang beban hanya akan mengimbangi protokol UDP L4, juga untuk UDP, adalah mungkin untuk menetapkan sekali protokol berikut untuk menguraikan pengepala dan menggunakannya untuk mengedarkan dengan betul: menghirup, tftp, amanda, netbios-ns, Atau snmp; sctp, pengimbang beban hanya akan mengimbangi protokol SCTP L4. Jika h323 dipilih, ladang akan mendengar TCP dan UDP permintaan dan menghuraikan pengepala untuk mengimbangi antara hujung belakang.

Contoh tindak balas:

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

Parameter tindak balas

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

Tambah FarmGuardian

Tambah FarmGuardian

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg
zcli farm-service-farmguardian add l4Farm default_service -name check_tcp-cut_conns

POST /farms/<farmname>/fg

Memohon FarmGuardian ke ladang.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Pengecam unik FarmGuardian. FarmGuardians dicipta dan diubah suai di bahagian pemantauan.

Contoh tindak balas:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the farm fgl4",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the farm fgl4"
}

Keluarkan FarmGuardian

Keluarkan FarmGuardian

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove l4Farm default_service check_tcp-cut_conns

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

Keluarkan FarmGuardian dari ladang.

Contoh tindak balas:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the farm fgl4",
   "message" : "Sucess, check_tcp-cut_conns was removed from the farm fgl4"
}

Tambah POST /farms/<farmname>/sessions

Tambah DELETE /farms/<farmname>/sessions/<session>

Senaraikan sesi

Senaraikan sesi

Permintaan contoh:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session list farm1

GET /farms/<farmname>/sessions

Dapatkan senarai sesi di ladang.

Contoh tindak balas:

{
   "description" : "Get farm sessions",
   "params": [
      {
         "client": 0,
         "id": "0",
         "session": "10.0.0.2_56",
         "ttl": null,
         "type": "static"
      },
      {
         "client": 1,
         "id": "0",
         "session": "10.0.0.2_54936",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "client": 2,
         "id": "0",
         "session": "10.0.0.2_54968",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

Parameter tindak balas

Permintaan ini mengembalikan senarai objek sesi, setiap objek sesi mengandungi kekunci berikut:

Bidang Jenis Deskripsi
pelanggan nombor Ia adalah pengenal pelanggan.
id nombor ID belakang yang akan menerima sambungan.
Sesi Rentetan Ia adalah pengenal sesi atau sambungan, nilainya bergantung kepada kegigihan parameter ladang. Jika kegigihan adalah 'mac', Sesi harus menjadi MAC, misalnya 02: 8e: 69: 38: 12: 8e; jika kegigihan adalah 'ip' atau 'srcip', Sesi seharusnya IPv4 atau IPv6, misalnya 192.168.42.65; jika kegigihan adalah 'port', Sesi harus menjadi pelabuhan yang sah, misalnya 5445; jika kegigihan adalah 'srcip_srcport' atau 'srcip_dstport'; Sesi mestilah rentetan dengan IP dan port yang digabungkan dengan garis bawah '', contohnya 122.36.54.280.
ttl Rentetan Ia adalah tali dengan masa sesi untuk habis tempoh. The ttl nilai akan menjadi sifar jika sesi itu adalah jenis statik.
jenis Rentetan Terdapat dua jenis sesi: dinamik adalah sambungan yang memuat pin balancer dengan backend menggunakan algoritma pengimbangan beban ladang; statik adalah sambungan yang pin pentadbir balancer beban dengan backend. Sesi statik tidak akan diarahkan ke backend lain jika disokong tidak dapat dicapai.

Tambah sesi

Tambah sesi

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2_56","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session add farm1 -id 0 -session 10.0.0.2_56

POST /farms/<farmname>/sessions

Ia mewujudkan sesi statik dengan backend. Sambungan input yang sepadan dengan Sesi akan dihantar terus ke backend itu.

Minta parameter

Bidang Jenis Deskripsi
id nombor ID belakang yang akan menerima sambungan.
Sesi Rentetan Ia adalah pengenal sesi atau sambungan, nilainya bergantung kepada kegigihan parameter ladang. Jika kegigihan adalah 'mac', Sesi harus menjadi MAC, misalnya 02: 8e: 69: 38: 12: 8e; jika kegigihan adalah 'ip' atau 'srcip', Sesi seharusnya IPv4 atau IPv6, misalnya 192.168.42.65; jika kegigihan adalah 'port', Sesi harus menjadi pelabuhan yang sah, misalnya 5445; jika kegigihan adalah 'srcip_srcport' atau 'srcip_dstport'; Sesi mestilah rentetan dengan IP dan port yang digabungkan dengan garis bawah '', contohnya 122.36.54.280.

Contoh tindak balas:

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "client" : 1,
      "id" : "0",
      "session" : "10.0.0.1_56",
      "ttl" : null,
      "type" : "static"
   }
}

Parameter tindak balas

Permintaan ini mengembalikan objek sesi yang mengandungi kekunci berikut:

Bidang Jenis Deskripsi
pelanggan nombor Ia adalah pengenal pelanggan.
id nombor ID belakang yang akan menerima sambungan.
Sesi Rentetan Ia adalah pengenal sesi atau sambungan, nilainya bergantung kepada kegigihan parameter ladang. Jika kegigihan adalah 'mac', Sesi harus menjadi MAC, misalnya 02: 8e: 69: 38: 12: 8e; jika kegigihan adalah 'ip' atau 'srcip', Sesi seharusnya IPv4 atau IPv6, misalnya 192.168.42.65; jika kegigihan adalah 'port', Sesi harus menjadi pelabuhan yang sah, misalnya 5445; jika kegigihan adalah 'srcip_srcport' atau 'srcip_dstport'; Sesi mestilah rentetan dengan IP dan port yang digabungkan dengan garis bawah '', contohnya 122.36.54.280.
ttl Rentetan Ia adalah tali dengan masa sesi untuk habis tempoh. The ttl nilai akan menjadi sifar jika sesi itu adalah jenis statik.
jenis Rentetan Terdapat dua jenis sesi: dinamik adalah sambungan yang memuat pin balancer dengan backend menggunakan algoritma pengimbangan beban ladang; statik adalah sambungan yang pin pentadbir balancer beban dengan backend. Sesi statik tidak akan diarahkan ke backend lain jika disokong tidak dapat dicapai.

Keluarkan sesi

Keluarkan sesi

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56

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

Ia memadam sesi statik.

Contoh tindak balas:

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists
zcli farm-blacklist add l4Farm -name china

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

Gunakan 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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists/china
zcli farm-blacklist remove l4Farm china

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

Keluarkan modul IPDS, DoS atau RBL modul IPDS dari ladang tertentu menggunakan penunjuknya 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm get l4farm

GET /farms/<farmname>/backends

Dapatkan senarai backends dalam perkhidmatan.

Contoh tindak balas:

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

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
id nombor ID untuk mengenal pasti backend di kolam belakang 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 penyelenggaraan 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 sentiasa keutamaan yang tersedia di mana 1 adalah yang paling utama dan 9 adalah keutamaan.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan. Nilai yang mungkin adalah dari 1 kepada 9.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm-service-backend add l4farm default_service -ip 192.168.5.100 -port 8080 -max_conns 400

POST /farms/<farmname>/backends

Buat Backend baru di 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. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin adalah dari 1 kepada 9.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan. Nilai yang mungkin adalah dari 1 kepada 9.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
zcli farm-service-backend set l4farm default_service 2 -ip 192.168.5.40 -port 8080 -max_conns 220 -priority 4 -weight 7

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

Ubah suai parameter backend dalam untuk 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. Backend dengan nilai keutamaan yang lebih rendah akan bersedia untuk menerima sambungan sebelum dibandingkan dengan yang lain dengan keutamaan yang lebih tinggi. Nilai asal batal, nilai keutamaan 1 digunakan. Nilai mungkin adalah dari 1 kepada 9.
berat badan nombor Ini adalah nilai berat untuk pelayan sebenar semasa. Backend dengan lebih berat akan menerima lebih banyak sambungan. Nilai yang mungkin adalah dari 1 kepada 9.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/1/maintenance
zcli farm-service-backend maintenance l4farm default_service 1 -mode cut

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

Tetapkan tindakan yang diberikan dalam latar belakang 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 backend tanpa mempengaruhi 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/4
zcli farm-service-backend remove l4farm default_service 4

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

Padamkan backend yang diberikan untuk Ladang L4xNAT.

id adalah pengecam unik backend.

Contoh tindak balas:

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

Ladang GSLB

Perkhidmatan Pengimbang Beban Perkhidmatan Global, yang biasanya dipanggil GSLB, membolehkan mewujudkan keseimbangan beban khidmat berdasarkan arsitektur hierarki perkhidmatan DNS. Ladang semacam ini menyediakan DNS hanya berwibawa 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/v4.0/zapi.cgi/farms/gslbfarm
zcli farm get gslbfarm

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang yang diberikan.

Contoh tindak balas:

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

Parameter 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 Objek [] Senarai hitam digunakan untuk ladang.
daripada Objek [] Peraturan DoS diterapkan ke ladang.
rbl Objek [] Peraturan RBL diterapkan ke ladang.

Blacklist, DoS dan RBL Objek:

Bidang Jenis Deskripsi
nama Rentetan Nama peraturan.
status Rentetan Status peraturan.

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.
tukang ladang Rentetan Ia adalah nama FarmGuardian yang menyemak status backend. FarmGuardian akan berjalan sementara ladang berada dalam keadaan up. Log Farmguard tidak tersedia untuk ladang GSLB
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 sambungan di antara hujung belakang, atau prio yang akan menghantar semua sambungan ke backend yang tersedia yang pertama.
deftcpport nombor Pemeriksaan kesihatan port TCP lalai. Ini adalah pelabuhan pemeriksaan kesihatan TCP bahawa perkhidmatan akan memeriksa untuk menentukan bahawa perkhidmatan backend masih hidup. Nilai kosong dinyahdayakan.

Objek backend untuk ladang GSLB:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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 sebagai 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/v4.0/zapi.cgi/farms
zcli farm create -farmname gslbfarm -vip 192.168.100.241 -vport 53 -profile gslb

POST /farms

Buat ladang GSLB baru.

Minta parameter

Bidang Jenis Deskripsi diperlukan
farmname Rentetan Nama ladang digunakan sebagai 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
salin_dari (dari 4.0.1) Rentetan Parameter ini menjangkakan nama ladang yang wujud. Jika parameter ini dihantar, ladang disalin dari ladang yang dinyatakan di dalamnya. The farmname, vip dan vport nilai akan ditimpa semula.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm
zcli farm set gslbfarm -newfarmname gslbnewname -vip 192.168.100.155 -vport 60

PUT /farms/<farmname>

Ubah 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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists
zcli farm farm-blacklist add gslbFarm -name china

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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
zcli farm-blacklist remove gslbFarm china

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

Keluarkan peraturan senarai hitam, DoS atau RBL dari ladang yang diberikan menggunakan pengecamnya 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 masuk, balancer menyerahkan server real robin seterusnya untuk menyampaikan permintaan tersebut.

Keutamaan: sambungan selalu menjadi keutamaan yang tersedia. 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 kluster Aktif-Pasif dengan beberapa pelayan sebenar.

Objek perkhidmatan untuk ladang GSLB

Bidang Jenis Deskripsi
backends Objek [] Backends ditakrifkan dalam perkhidmatan.
tukang ladang Rentetan Ia adalah nama FarmGuardian yang menyemak status backend. FarmGuardian akan berjalan sementara ladang berada dalam keadaan up.
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 sambungan di antara hujung belakang, atau prio yang akan menghantar semua sambungan ke backend yang tersedia yang pertama.
deftcpport Rentetan Pemeriksaan kesihatan port TCP lalai. Ini adalah pelabuhan pemeriksaan kesihatan TCP bahawa perkhidmatan akan memeriksa 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services
zcli farm-service add gslbfarm -id service1 -algorithm roundrobin

POST /farms/<farmname>/services

Buat 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 yang pertama. 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service set  gslbfarm service1 -deftcpport 53

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

Ubah suai parameter perkhidmatan GSLB. id adalah pengecam unik perkhidmatan yang akan diubah suai.

Minta parameter

Bidang Jenis Deskripsi
deftcpport nombor Ini adalah pelabuhan pemeriksaan kesihatan TCP bahawa perkhidmatan akan memeriksa 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.

Tambah FarmGuardian

Tambah FarmGuardian

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"dns-request"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg
zcli farm-service-farmguardian add gslbfarm service1 -name dns-request

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

Memohon FarmGuardian ke perkhidmatan.

Parameter URI adalah pengecam unik perkhidmatan.

Minta parameter

Bidang Jenis Deskripsi
nama Rentetan Pengecam unik FarmGuardian. FarmGuardians dicipta dan diubah suai di bahagian pemantauan. Log FarmGuardia tidak tersedia untuk ladang gslb.

Contoh tindak balas:

{
   "description" : "Add the farm guardian dns-request to the service service1 in the farm gslbfarm",
   "message" : "Success, The farm guardian dns-request was added to the service service1 in the farm gslbfarm"
}

Keluarkan FarmGuardian

Keluarkan FarmGuardian

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
zcli farm-service-farmguardian remove gslbfarm service1 dns-request

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

Keluarkan FarmGuardian dari perkhidmatan GSLB.

Contoh tindak balas:

{
   "description" : "Remove the farm guardian dns-request from the service service1 in the farm gslbfarm",
   "message" : "Sucess, dns-request was removed from the service service1 in the farm gslbfarm"
}

Padam Perkhidmatan

Padam Perkhidmatan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service remove gslbfarm service1

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

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 mengurus 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm get gslbfarm

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

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

Contoh tindak balas:

{
   "description" : "List service backends",
   "params" : [
      {
         "alias" : "localhost",
         "id" : 1,
         "ip" : "127.0.0.1",
         "port":53,
         "status":"up"
      },
      {
         "alias" : "dns-server",
         "id" : 2,
         "ip" : "192.168.55.40",
         "port":53,
         "status":"up"
      }
   ]
}

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm-service-backend add gslbfarm service1 -ip 192.135.10.2

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

Buat Backend baru 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/1
zcli farm-service-backend set gslbfarm service1 1 -ip 192.168.2.30

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

Ubah suai parameter backend untuk perkhidmatan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/3
zcli farm-service-backend remove gslbfarm service1 3

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

Padamkan backend yang diberikan dalam perkhidmatan 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.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones
zcli farm-zone add gslbfarm -id global.com

POST /farms/<farmname>/zones

Buat zon DNS.

Permintaan Parameter

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi diperlukan
id nombor Nama zon digunakan sebagai 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com
zcli farm-zone set gslbfarm global.com -defnamesv ns3

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

Ubah 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/dom.com
zcli farm-zone remove gslbfarm dom.com

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

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, penunjuk kepada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource list gslbfarm global.com

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

Dapatkan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource add gslbfarm global.com -rname resource2 -rdata 192.168.0.9 -ttl 10 -type A

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

Buat sumber 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 Nilai Masa untuk Hidup untuk rekod semasa. Ini adalah jumlah maksimum peranti penghala yang dapat dilakukan oleh permintaan melalui til die. Ia 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
zcli farm-zone-resource set gslbfarm global.com 1 -rname resource2 -rdata 192.168.200.30 -type A

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

Ubah 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 ada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
zcli farm-zone-resource remove gslbfarm global.com 3

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

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

Profil ladang datalink atau DSLB (Datalink Service Load Balancing) membolehkan membuat ladang berasaskan laluan di mana backend adalah penghala atau gateway uplink. Profil ladang jenis ini siap untuk berkongsi beberapa akses router WAN uplink menggunakan load balancer sebagai multiplexor saluran uplink (1 input dan beberapa output garis penghala). Oleh itu, ladang datalink dapat digunakan sebagai pautan komunikasi yang tersedia tinggi dan juga dapat digunakan sebagai peningkatan lebar jalur bergabung dengan jumlah lebar jalur antara pautan backend 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/v4.0/zapi.cgi/farms/dlink
zcli farm get dlink

GET /farms/<farmname>

Tunjukkan semua konfigurasi mengenai ladang.

Contoh tindak balas:

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

Parameter 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 [] Pelayan sebenar yang dibuat di ladang ini dan konfigurasinya.

Objek IPDS:

Bidang Jenis Deskripsi
senarai hitam Tali[] Senarai hitam digunakan untuk ladang.

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
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
id nombor Pengenal pasti unik untuk backend 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 dikonfigurasikan sebagai keutamaan 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 dikonfigurasikan 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/v4.0/zapi.cgi/farms
zcli farm create -profile datalink -farmname dlink -vip 192.168.100.241

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 mewujudkan ladang taip jenis, kunci adalah datalink benar
vip Rentetan IP ladang, di mana perkhidmatan maya sedang mendengar. benar
salin_dari (dari 4.0.1) Rentetan Parameter ini menjangkakan nama ladang yang wujud. Jika parameter ini dihantar, ladang disalin dari ladang yang dinyatakan di dalamnya. The farmname dan vip nilai akan ditimpa semula.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm set dlink -newfarmname dlink2 -vip 192.168.100.199 -algorithm weight

PUT /farms/<farmname>

Ubah suai konfigurasi ladang datalink.

Minta parameter

Bidang Jenis Deskripsi
newfarmname Rentetan Nama ladang baru. Ladang mesti dihentikan untuk mengubah suai bidang ini.
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.

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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists
zcli farm-blacklist add dlink2 -name china

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

Memohon peraturan hitam senarai untuk ladang. Profil datalink hanya menerima peraturan senarai hitam.

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 dlink2.",
   "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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists/china
zcli farm-blacklist remove dlink -name china

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

Keluarkan peraturan hitam senarai modul IPDS dari ladang yang diberikan menggunakan penunjuknya nama.

Contoh tindak balas:

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

Datalink - Backends

Backends di ladang datalink adalah pintu masuk melalui peralihan perkhidmatan. Perkhidmatan ini akan menjadi multiplexor di antara gerbang-gerbang ini dan beberapa 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm get dlink

GET /farms/<farmname>/backends

Dapatkan senarai backends dalam perkhidmatan.

Contoh tindak balas:

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

Parameter tindak balas

Panggilan ini mengembalikan array objek backend dengan parameter di bawah.

Bidang Jenis Deskripsi
alias Rentetan Ia adalah nick untuk membantu mengenalpasti backend. Alias
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 dikonfigurasikan sebagai keutamaan 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 dikonfigurasikan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm-service-backend add dlink default_service -ip 192.168.100.10 -interface eth0 -priority 2 -weight 2

POST /farms/<farmname>/backends

Buat Backend baru di 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 semasa. Ia akan digunakan apabila algoritma medan dikonfigurasikan sebagai keutamaan 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 dikonfigurasikan 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,"priority":1}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/datalink/backends/2
zcli farm-service-backend set datalink default_service 2 -ip 192.168.102.50 -interface eth0 -weight 1 -priority 1

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

Ubah 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 merupakan keutamaan backend untuk menjawab permintaan tertentu.
berat badan nombor Ini adalah nilai berat untuk backend semasa.

Contoh tindak balas:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "interface" : "eth0",
      "ip" : "192.168.102.50",
      "priority" : 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends/4
zcli farm-service-backend remove dlink default_service 4

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

Padamkan backend yang diberikan dari Ladang 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 antara muka rangkaian, ia adalah komponen perkakasan komputer. Selebihnya antara muka adalah berdasarkan NIC.

vlan: atau kad LAN maya adalah sejenis 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: Antara muka jenis ini boleh diwujudkan atas sebarang jenis antara muka yang diterangkan di atas dan mereka menggunakan jadual penghalaan antara muka ibu bapa, jadi ia mesti dikonfigurasikan dalam segmen rangkaian yang sama daripada induknya. Antara muka jenis ini harus digunakan untuk Farms.

Senaraikan semua antara muka

Senaraikan semua antara muka

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network list

GET /interfaces

Dapatkan senarai antara muka dalam sistem dengan konfigurasi mereka.

Contoh tindak balas:

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

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan pelbagai objek antara muka.

Objek antara muka:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
ip Rentetan IP antara muka. IP mestilah berada di segmen rangkaian yang sama dengan antara muka ibu bapa dalam antara muka maya.
has_vlan Rentetan benar, antara muka ia merupakan induk antara muka VLAN; atau palsu, antara muka tidak mempunyai antara muka VLAN yang menambahkannya. Bidang ini hanya untuk antara muka NIC.
netmask Rentetan Netmask antara muka. Nilai ini tidak boleh diubah suai dalam antara muka maya, ia diwarisi dari antara muka ibu bapa.
gerbang Rentetan Gateway antara muka. Nilai ini tidak boleh diubah suai dalam antara muka maya, ia diwarisi dari antara muka 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 terdapat di antara muka NIC, benar, antara muka adalah sebahagian daripada antara muka ikatan, palsu antara muka bukan sebahagian daripada antara muka ikatan.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

Dapatkan gerbang lalai

Dapatkan gerbang lalai

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 get

GET /interfaces/gateway/<ip_version>

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.

Sistem ini telah mengkonfigurasi dua gateway, sekali untuk laluan IPv4 dan yang lain untuk laluan IPv6. URI mengharapkan versi IP ipv4 or ipv6.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 set -interface eth0 -address 192.168.100.5

PUT /interfaces/gateway/<ip_version>

Ubah suai konfigurasi antara muka pintu masuk.

URI mengharapkan versi IP yang digunakan dalam medan alamat. Nilai yang mungkin adalah ipv4 dan ipv6.

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

Padam konfigurasi konfigurasi gerbang lalai.

URI mengharapkan satu versi IP dari gateway lalai untuk memadam. Nilai yang mungkin adalah ipv4 dan ipv6.

Amaran: jika pintu masuk tidak dimeteraikan, 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 delete

Mesej respons

Sekiranya gerbang tidak diset 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network-nic list

Contoh tindak balas:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

Parameter tindak balas

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

Objek antara muka NIC:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
ip Rentetan IP antara muka.
has_vlan Rentetan benar, antara muka ia merupakan induk antara muka VLAN; atau palsu, antara muka tidak mempunyai antara muka VLAN yang menambahkannya.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket ke segmen rangkaian yang berbeza.
mac Rentetan Penyambungan lapisan penyambung 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

Ambil semula antara muka NIC

Ambil semula antara muka NIC

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic get eth1

GET /interfaces/nic/<name>

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

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
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 Penyambungan lapisan penyambung 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic set eth0 -ip 192.168.100.102 -netmask 255.255.255.0 -gateway 192.168.100.5

PUT /interfaces/nic/<name>

Ubah 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.
kekuatan Rentetan Sekiranya ladang menggunakan antara muka, antara muka tidak akan dapat diubah suai. Kemudian, jika parameter ini dihantar dengan nilai benar, antara muka akan dipaksa untuk mengambil konfigurasi baru dan semua ladang menggunakan antara muka akan dimulakan semula.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

Contoh tindak balas:

{
   "description" : "Configure NIC interface",
   "params" : {
      "alias" : null,
      "dhcp" : "false",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "4a:4f:3c:d7:dd:70",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "down"
}

Parameter 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
zcli network-nic unset 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1/actions
zcli network-nic stop eth1

POST /interfaces/nic/<name>/actions

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

nama adalah pengecam unik antara muka.

Minta parameter

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

Contoh tindak balas:

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

Parameter tindak balas

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

Rangkaian - antara muka VLAN

Antara muka VLAN membolehkan antara muka NIC atau bonding berfungsi dalam rangkaian lain, jadi konfigurasi rangkaian (IP, gerbang, dan netmask) harus berada dalam segmen rangkaian yang berbeza. Antara muka VLAN mewarisi alamat MAC dari antara muka ibu bapanya.

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

Senarai antara muka VLAN

Senarai antara muka VLAN

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan list 

GET /interfaces/vlan

Dapatkan semua parameter antara muka VLAN.

Contoh tindak balas:

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

Parameter tindak balas

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

Parameter VLAN adalah:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
ip Rentetan IP antara muka. Ia boleh berbeza daripada antara muka ibu bapa IP.
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 diformat 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

Ambil antara muka VLAN

Ambil antara muka VLAN

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan get eth0.1

GET /interfaces/vlan/<name>

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

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
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 diformat 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

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","mac":"52:98:19:6a:c9:18","dhcp":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan create -name eth0.1 -ip 192.168.120.120 -netmask 255.255.255.0 -gateway 192.168.120.1 -mac 52:98:19:61:c9:18 -dhcp false

POST /interfaces/vlan

Buat 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 daripada IP antara muka 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 diformat oleh nama antara muka induk, watak titik "." dan nombor untuk antara muka rangkaian VLAN. benar
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.
mac Rentetan Menulis semula MAC antara muka.

Contoh tindak balas:

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : "52:98:19:6a:c9:18",
      "name" : "eth0.1",
      "dhcp" : "false",
      "netmask" : "255.255.255.0"
   }
}

Parameter 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","mac":"96:23:25:8b:d4:af"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan set eth0.1 -ip 192.168.131.151 -netmask 255.255.255.0 -gateway 192.168.131.1 -mac 96:23:25:8b:d4:af

PUT /interfaces/vlan/<name>

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

Minta parameter

Bidang Jenis Deskripsi
ip Rentetan IP antara muka. Ia boleh berbeza daripada antara muka ibu bapa IP.
netmask Rentetan Tentukan segmen rangkaian di mana antara muka berfungsi.
gerbang Rentetan IP digunakan untuk menghantar paket segmen rangkaian yang berbeza.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.
mac Rentetan Menulis semula MAC antara muka.
kekuatan Rentetan Sekiranya ladang menggunakan antara muka, antara muka tidak akan dapat diubah suai. Kemudian, jika parameter ini dihantar dengan nilai benar, antara muka akan dipaksa untuk mengambil konfigurasi baru dan semua ladang menggunakan antara muka akan dimulakan semula.

Contoh tindak balas:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0",
      "mac" : "96:23:25:8b:d4:af",
      "dhcp" : "false",
      "force" : "true"
   }
}

Parameter 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
zcli network-vlan stop eth0.1

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 menetapkan antara muka rangkaian lain dalam segmen rangkaian yang sama daripada ibu bapa mereka, 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 identiti 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual list

GET /interfaces/virtual

Dapatkan semua parameter antara muka maya.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama dengan 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 diformat 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual get eth0:vip1

GET /interfaces/virtual/<name>

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

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama dengan 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 diformat 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual create -name eth0:virtiface -ip 192.168.100.41

POST /interfaces/virtual

Buat antara muka maya.

Minta parameter

Bidang Jenis Deskripsi diperlukan
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama dengan antara muka ibu bapa. benar
nama Rentetan Nama antara muka. Ia digunakan sebagai pengecam unik. Nama ini adalah rantai yang diformat 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 dengan 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 diformat oleh antara muka induk, watak titik dua ":" dan rentetan alfanumerik 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual set eth0:virtiface -ip 192.168.131.155

PUT /interfaces/virtual/<name>

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

Minta parameter

Bidang Jenis Deskripsi dikehendaki
ip Rentetan IP antara muka. IP mesti berada dalam segmen rangkaian yang sama dengan antara muka ibu bapa. benar
kekuatan Rentetan Sekiranya ladang menggunakan antara muka, antara muka tidak akan dapat diubah suai. Kemudian, jika parameter ini dihantar dengan nilai benar, antara muka akan dipaksa untuk mengambil konfigurasi baru dan semua ladang menggunakan antara muka akan dimulakan semula.

Contoh tindak balas:

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

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
zcli network-virtual stop eth0:virtiface

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

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

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding list

GET /interfaces/bonding

Dapatkan konfigurasi mengenai semua antara ikatan ikatan dalam sistem.

Contoh tindak balas:

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

Parameter tindak balas

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

Parameter ikatan adalah:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
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 Penyambungan lapisan penyambung 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 antara muka 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding get bondiface

GET /interfaces/bonding/<name>

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

Contoh tindak balas:

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

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan objek antara muka ikatan.

Parameter ikatan adalah:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
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 Penyambungan lapisan penyambung 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 antara muka 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.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding create -slave eth3,eth2 -name bondiface -mode balance-rr

POST /interfaces/bonding

Buat 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 Penyambungan lapisan penyambung 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 antara muka 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","mac":"86:2f:0e:9a:30:14"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding set bondiface -ip 192.168.100.121 -netmask 255.255.255.0 -gateway 192.168.100.1 -mac 86:2f:0e:9a:30:14 

PUT /interfaces/bonding/<name>

Ubah 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.
kekuatan Rentetan Sekiranya ladang menggunakan antara muka, antara muka tidak akan dapat diubah suai. Kemudian, jika parameter ini dihantar dengan nilai benar, antara muka akan dipaksa untuk mengambil konfigurasi baru dan semua ladang menggunakan antara muka akan dimulakan semula.
dhcp Rentetan Membolehkan perkhidmatan DHCP untuk mendapatkan konfigurasi rangkaian untuk antara muka dari pelayan DHCP. Parameter ini menerima: benar, untuk membolehkan perkhidmatan, konfigurasi antara muka akan disekat semasa perkhidmatan DHCP diaktifkan; palsu untuk menghentikan perkhidmatan, antara muka akan kehilangan semua konfigurasi rangkaiannya.
mac Rentetan Menulis semula MAC antara muka.

Contoh tindak balas:

{
   "description" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0",
      "mac" : "86:2f:0e:9a:30:14",
      "dhcp" : "false",
      "force" : "true"
   }
}

Parameter 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/actions
zcli network-bond start bondiface

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 tersebut. Pemandu ikatan kemudian akan memulihkan alamat MAC bahawa antara muka 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves
zcli network-bonding-slave add bondiface -name eth4

POST /interfaces/bonding/<name>/slaves

Tambah antara muka NIC sebagai hamba kepada 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

Tanggapan akan menjadi JSON dengan nilai dikonfigurasikan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
zcli network-bonding-slave remove bondiface eth2

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

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

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 - 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating
zcli network-floating list

GET /interfaces/floating

Tunjukkan semua antara muka yang ada atau dikonfigurasi di mana IP terapung telah dibuat.

Contoh tindak balas:

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

Parameter tindak balas

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

Terapung objek:

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
floating_alias Rentetan Ia adalah alias antara muka maya.
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating get 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 pengecam unik antaramuka yang boleh jenis nic, ikatan atau VLAN.

Contoh tindak balas:

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

Parameter tindak balas

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk membantu mengenal pasti antara muka. Alias
floating_alias Rentetan Ia adalah alias antara muka maya.
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating set eth0 -floating_ip 192.168.100.199

PUT /interfaces/floating/<name>

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

nama adalah pengecam unik antaramuka 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating delete eth0

DELETE /interfaces/floating/<name>

Keluarkan konfigurasi IP terapung dalam antara muka.

nama adalah pengecam unik antaramuka yang boleh jenis nic, ikatan atau VLAN.

Contoh tindak balas:

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

Rangkaian - Aliases

Letakkan alias ke antara muka atau backend untuk mengenal pasti dengan cepat.

Dua jenis alias wujud, antara muka alias boleh digunakan dalam semua jenis antara muka: NIC, ikatan, VLAN atau maya. Ia adalah cara mudah untuk mengaitkan nama antara muka dengan nama yang lebih mesra.

Jenis lain alias adalah untuk backends. Ini mengaitkan IP belakang dengan alias.

Alias ​​adalah hanya maklumat visual, ia tidak menggantikan IP backend atau nama muka dalam permintaan ZAPI.

Senarai alias

Senarai alias

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/backends
zcli network-alias-backend list

GET /aliases/<backends|interfaces>

Senaraikan alias dalam sistem untuk antara muka atau sandaran.

Contoh tindak balas:

{
   "description" : "List the aliases",
   "params" : [
      {
         "id" : "192.168.11.13",
         "alias" : "http-backend"
      },
      {
         "id" : "127.0.0.1",
         "alias" : "localhost"
      }
   ]
}

Parameter tindak balas

ZAPI mengembalikan hash di mana kekunci adalah IP backend atau nama antara muka dan nilai adalah aliasnya.

Buat atau ubah suai alias

Buat atau ubah suai alias

Permintaan contoh:

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

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

Sekiranya objek tersebut mempunyai alias, ia akan diganti, maka alias akan dibuat untuk objek tersebut.

. id Parameter URI ialah IP backend atau nama antara muka.

Minta parameter

Bidang Jenis Deskripsi
alias Rentetan Ia adalah gelaran untuk elemen ini id dihantar dalam URI.

Contoh tindak balas:

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

Parameter tindak balas

ZAPI mengembalikan mesej kejayaan jika proses itu betul.

Padamkan alias

Padamkan alias

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zli network-alias-interface delete eth0

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

Ia memadam alias antara muka atau backend.

. id Parameter URI ialah IP backend atau nama antara muka.

Contoh tindak balas:

{
   "description" : "Delete an alias",
   "message" : "The alias has been deleted.",
   "success" : "true"
}

Parameter tindak balas

ZAPI mengembalikan mesej kejayaan jika proses itu betul.

Rangkaian - Routing

Modul ini boleh didapati daripada zapi versi 4.0.1.

Modul ini menguruskan laluan untuk lalu lintas yang sedang berjalan atau dari pengimbang beban. Proses ini mengira antara muka output bergantung kepada sumber paket dan destinasi paket. Untuk tugas ini, pengimbang beban menggunakan dua jenis objek peraturan dan meja.

Langkah pertama ialah mencari a memerintah di mana sumber paketnya sepadan, sebaik sahaja peraturan ditemui, antara muka paket keluar mencari di dalam meja Bahawa memerintah ditakrifkan. Antara muka adalah tanda laluan yang sepadan dengan destinasi paket.

Senaraikan peraturan laluan

Senaraikan peraturan laluan

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule list

GET /routing/rules

Senaraikan peraturan perundingan pengimbang beban. Peraturan penghalaan digunakan untuk mendapatkan jadual antara muka bergantung kepada paket IP sumber

Contoh tindak balas:

{
    "description" : "List routing rules",
    "params" : [
        {
            "id" : 1024,
            "not" : "true",
            "from" : "10.10.10.0/24",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "local",
            "type" : "system",
            "id" : 0,
            "priority" : 0,
            "from" : "all"
        },
        {
            "id" : 0,
            "priority" : 31000,
            "from" : "10.3.0.0/24",
            "table" : "205",
            "type" : "system"
        },
        {
            "type" : "system",
            "table" : "table_eth1",
            "priority" : 31000,
            "from" : "4.4.4.0/24",
            "id" : 0
        },
        {
            "type" : "system",
            "table" : "main",
            "priority" : 32766,
            "from" : "all",
            "id" : 0
        }
    ]
}

Parameter tindak balas

Tanggapan akan menjadi senarai JSON dengan semua peraturan routing dalam sistem. Setiap peraturan adalah objek dengan parameter berikut:

Bidang Jenis Deskripsi
id nombor Ia adalah pengecam unik yang digunakan untuk peraturan laluan.
tidak Rentetan Medan ini digunakan digabungkan dengan parameter dari untuk menafikan keputusan perlawanan. Parameter ini ialah rentetan boolean dengan nilai benar untuk membolehkannya atau dengan nilai palsu jika keputusan perlawanan tidak ditolak.
dari Rentetan Ia adalah sumber IP atau segmen rangkaian yang digunakan untuk dipadankan dengan sumber IP paket.
keutamaan nombor Ia adalah keutamaan peraturan, nilai keutamaan kecil adalah keutamaan yang tinggi.
meja Rentetan Ia adalah jadual antara muka yang digunakan untuk laluan jika IP sumber paket sepadan dengan parameter dari.
jenis Rentetan Ia adalah jenis peraturan, bidang ini boleh mempunyai nilai-nilai: ladang adalah laluan yang digunakan untuk mengarahkan lalu lintas ladang l4xnat, pengguna adalah peraturan yang dibuat oleh pentadbir pengimbang beban atau sistem adalah peraturan yang dijana secara automatik untuk sistem.

Buat Peraturan Penghalaan

Buat Peraturan Penghalaan

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","not":"true","priority":"30000","from":"192.168.0.0/16"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule -table table_eth1 -not true -priority 30000 -from 192.168.0.0/16

POST /routing/rules

Buat peraturan routing.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tidak Rentetan Medan ini digunakan digabungkan dengan parameter dari untuk menafikan keputusan perlawanan. Parameter ini ialah rentetan boolean dengan nilai benar untuk membolehkannya atau dengan nilai palsu jika keputusan perlawanan tidak ditolak.
dari Rentetan Ia adalah sumber IP atau segmen rangkaian yang digunakan untuk dipadankan dengan sumber IP paket. benar
keutamaan nombor Ia adalah keutamaan peraturan, nilai keutamaan kecil adalah keutamaan yang tinggi. Peraturan yang dibuat mestilah mempunyai nilai antara 29000 dan 30999
meja Rentetan Ia adalah jadual antara muka yang digunakan untuk laluan jika IP sumber paket sepadan dengan parameter dari. benar

Contoh tindak balas:

{
    "description" : "Create a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "from" : "192.168.0.0/16",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "table_eth0",
            "type" : "system",
            "id" : 0,
            "priority" : 32765,
            "from" : "192.168.100.0/24"
        },
        {
            "from" : "all",
            "priority" : 32766,
            "id" : 0,
            "type" : "system",
            "table" : "main"
        },
        {
            "id" : 0,
            "priority" : 32767,
            "from" : "all",
            "table" : "default",
            "type" : "system"
        }
    ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan semua peraturan laluan sistem. Setiap laluan adalah objek dengan parameter:

Bidang Jenis Deskripsi
id nombor Ia adalah pengecam unik yang digunakan untuk peraturan laluan.
tidak Rentetan Medan ini digunakan digabungkan dengan parameter dari untuk menafikan keputusan perlawanan. Parameter ini ialah rentetan boolean dengan nilai benar untuk membolehkannya atau dengan nilai palsu jika keputusan perlawanan tidak ditolak.
dari Rentetan Ia adalah sumber IP atau segmen rangkaian yang digunakan untuk dipadankan dengan sumber IP paket.
keutamaan nombor Ia adalah keutamaan peraturan, nilai keutamaan kecil adalah keutamaan yang tinggi.
meja Rentetan Ia adalah jadual antara muka yang digunakan untuk laluan jika IP sumber paket sepadan dengan parameter dari.
jenis Rentetan Ia adalah jenis peraturan, bidang ini boleh mempunyai nilai-nilai: ladang adalah laluan yang digunakan untuk mengarahkan lalu lintas ladang l4xnat, pengguna adalah peraturan yang dibuat oleh pentadbir pengimbang beban atau sistem adalah peraturan yang dijana secara automatik untuk sistem.

Ubah Suai Peraturan Laluan

Ubah Suai Peraturan Laluan

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","from":"10.10.10.0/24","priority":"30000","not":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule set 1024 -table table_eth1 -from 10.10.10.0/24 -priority 30000 -not false

PUT /routing/rules/<id>

Ubah parameter parameter peralihan.

. id Parameter URI adalah pengenal pasti unik.

Kaedah-kaedah jenis pengguna adalah unik yang boleh diubahsuai

Minta parameter

Bidang Jenis Deskripsi diperlukan
tidak Rentetan Medan ini digunakan digabungkan dengan parameter dari untuk menafikan keputusan perlawanan.
dari Rentetan Ia adalah sumber IP atau segmen rangkaian yang digunakan untuk dipadankan dengan sumber IP paket. Parameter ini ialah rentetan boolean dengan nilai benar untuk membolehkannya atau dengan nilai palsu jika keputusan perlawanan tidak ditolak. benar
keutamaan nombor Ia adalah keutamaan peraturan, nilai keutamaan kecil adalah keutamaan yang tinggi. Peraturan yang dibuat mestilah mempunyai nilai antara 29000 dan 30999
meja Rentetan Ia adalah jadual antara muka yang digunakan untuk laluan jika IP sumber paket sepadan dengan parameter dari. benar

Contoh tindak balas:

{
    "description" : "Modify a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "priority" : 30000,
            "from" : "10.10.10.0/24",
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "id" : 0,
            "from" : "4.4.4.0/24",
            "priority" : 31000,
            "table" : "table_eth1",
            "type" : "system"
        },
        {
            "table" : "table_eth2",
            "type" : "system",
            "id" : 0,
            "from" : "5.5.5.0/24",
            "priority" : 31000
        },
        {
            "type" : "system",
            "table" : "table_eth0",
            "from" : "192.168.100.0/24",
            "priority" : 32765,
            "id" : 0
        },
    ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan semua peraturan laluan sistem. Setiap laluan adalah objek dengan parameter:

Bidang Jenis Deskripsi
id nombor Ia adalah pengecam unik yang digunakan untuk peraturan laluan.
tidak Rentetan Medan ini digunakan digabungkan dengan parameter dari untuk menafikan keputusan perlawanan. Parameter ini ialah rentetan boolean dengan nilai benar untuk membolehkannya atau dengan nilai palsu jika keputusan perlawanan tidak ditolak.
dari Rentetan Ia adalah sumber IP atau segmen rangkaian yang digunakan untuk dipadankan dengan sumber IP paket.
keutamaan nombor Ia adalah keutamaan peraturan, nilai keutamaan kecil adalah keutamaan yang tinggi.
meja Rentetan Ia adalah jadual antara muka yang digunakan untuk laluan jika IP sumber paket sepadan dengan parameter dari.
jenis Rentetan Ia adalah jenis peraturan, bidang ini boleh mempunyai nilai-nilai: ladang adalah laluan yang digunakan untuk mengarahkan lalu lintas ladang l4xnat, pengguna adalah peraturan yang dibuat oleh pentadbir pengimbang beban atau sistem adalah peraturan yang dijana secara automatik untuk sistem.

Padam Peraturan Laluan

Padam Peraturan Laluan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule remove 1024

DELETE /routing/rules/<id>

Padamkan peraturan laluan.

. id Parameter URI adalah pengenal pasti unik.

Contoh tindak balas:

{
    "message" : "The routing rule '1024' has been deleted successfully.",
    "description" : "Delete the routing rule '1024'"
}

Senarai jadual peralihan

Senarai jadual peralihan

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables
zcli network-routing-table list

GET /routing/tables

Senaraikan jadual penghalaan yang menguruskan beban balancer.

Jadual utama adalah global untuk semua antara muka. Ia mengandungi laluan lalai untuk semua antara muka yang akan digunakan jika tiada peraturan yang sepadan dengan paket. Setiap jadual antara muka mengurus laluan untuk trafik yang keluar dari antara muka itu.

Contoh tindak balas:

{
  "description" : "List routing tables",
  "params" : [
                "main",
                "table_eth0",
                "table_eth1",
                "table_eth2",
                "table_eth3"
              ]
}

Parameter tindak balas

Sambutan akan menjadi objek JSON dengan params kunci yang mengandungi senarai dengan jadual yang wujud dalam sistem.

Senarai Laluan jadual

Senaraikan peraturan laluan

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2
zcli network-routing-table get table_eth2

GET /routing/tables/<table>

Senaraikan penyertaan laluan yang dijalankan oleh jadual antara muka. Entri tersebut digunakan untuk sepadan dengan IP destinasi paket. Antara muka yang keluar untuk paket akan menjadi antara muka pertama yang akan sepadan dengan kemasukan jadual.

Contoh tindak balas:

{
    "description" : "Get the routing table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "priority" : 10,
          "raw" : "5.5.5.0/24 dev eth2 scope link src 5.5.5.5 initcwnd 10 initrwnd 10  table table_eth2",
          "interface" : "eth2",
          "source" : "5.5.5.5",
          "type" : "system",
          "to" : "5.5.5.0/24",
          "via" : ""
        },
        {
          "via" : "",
          "to" : "192.168.100.0/24",
          "interface" : "eth0",
          "type" : "system",
          "source" : "192.168.100.241",
          "raw" : "192.168.100.0/24 dev eth0 scope link src 192.168.100.241 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10
        }
    ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan senarai laluan yang mengandungi jadual.

Bidang Jenis Deskripsi
mentah Rentetan Ia adalah kemasukan laluan dengan Laluan IP format.
keutamaan nombor Ia adalah keutamaan di mana laluan akan diperiksa. Nilai yang lebih rendah adalah lebih utama. Bidang ini harus mempunyai nilai antara 1 dan 10.
antara muka Rentetan Ia adalah antara muka yang akan digunakan jika laluan itu sepadan.
sumber Rentetan Ia adalah IP yang digunakan untuk menyamar sebagai paket. Sumber ini perlu wujud dalam pengimbang beban sebagai antara muka maya.
jenis Rentetan Ia adalah jenis laluan. Laluan boleh menjadi jenis sistem yang dibuat dan diurus secara automatik oleh sistem, atau pengguna apabila laluan itu dibuat oleh pengguna balancing beban. Memeriksa tiada pengurusan ciri untuk mengalih keluar a sistem laluan.
kepada Rentetan Ia adalah keadaan perlawanan. Jika IP tujuan paket padanya dengan laluan itu berjaya.
melalui Rentetan Ia adalah hop seterusnya paket. Ia digunakan sebagai pintu masuk. IP ini perlu dihubungi dari segmen rangkaian antara muka.
id nombor Ia adalah pengenal pasti laluan yang unik. Parameter ini digunakan untuk mengubah suai atau memadamkan laluan dan hanya terdapat dalam laluan jenis pengguna.

Buat Kemas Routing

Buat Kemas Routing

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"source":"4.4.4.4","via":"4.4.4.45","interface":"eth1","priority":2,"to":"84.1.21.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes
zcli network-routing-table add table_eth2 -source 4.4.4.4 -via 4.4.4.45 -interface eth1 -priority 2 -to 84.1.21.5

POST /routing/tables/<table>/routes

Buat laluan untuk antara muka.

. meja Parameter URI ialah jadual antaramuka di mana laluan akan ditambah.

Minta parameter

Bidang Jenis Deskripsi diperlukan
mentah Rentetan Ia adalah kemasukan laluan dengan Laluan IP format. Jika parameter ini digunakan, yang lain akan dielakkan.
kepada Rentetan Ia adalah keadaan perlawanan. Jika IP tujuan paket padanya dengan laluan itu berjaya. Ia diperlukan apabila mentah tidak dihantar
keutamaan nombor Ia adalah keutamaan di mana laluan akan diperiksa. Nilai yang lebih rendah adalah lebih utama. Bidang ini harus mempunyai nilai antara 1 dan 10.
antara muka Rentetan Ia adalah antara muka yang akan digunakan jika laluan itu sepadan.
sumber Rentetan Ia adalah IP yang digunakan untuk menyamar sebagai paket. Sumber ini perlu wujud dalam pengimbang beban sebagai antara muka maya.
melalui Rentetan Ia adalah hop seterusnya paket. Ia digunakan sebagai pintu masuk. IP ini perlu dihubungi dari segmen rangkaian antara muka.

Contoh tindak balas:

{
    "description" : "Create a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "source" : "",
          "type" : "system",
          "interface" : "eth2",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2",
          "source" : "4.4.4.4",
          "type" : "system",
          "interface" : "eth1",
          "to" : "4.4.4.0/24",
          "via" : ""
        },
    ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan senarai laluan yang mengandungi jadual.

Bidang Jenis Deskripsi
keutamaan nombor Ia adalah keutamaan di mana laluan akan diperiksa. Nilai yang lebih rendah adalah lebih utama. Bidang ini harus mempunyai nilai antara 1 dan 10.
mentah Rentetan Ia adalah kemasukan laluan dengan Laluan IP format.
antara muka Rentetan Ia adalah antara muka yang akan digunakan jika laluan itu sepadan.
sumber Rentetan Ia adalah IP yang digunakan untuk menyamar sebagai paket. Sumber ini perlu wujud dalam pengimbang beban sebagai antara muka maya.
jenis Rentetan Ia adalah jenis laluan. Laluan boleh menjadi jenis sistem yang dibuat dan diurus secara automatik oleh sistem, atau pengguna apabila laluan itu dibuat oleh pengguna balancing beban. Memeriksa tiada pengurusan ciri untuk mengalih keluar a sistem laluan.
kepada Rentetan Ia adalah keadaan perlawanan. Jika IP tujuan paket padanya dengan laluan itu berjaya.
melalui Rentetan Ia adalah hop seterusnya paket. Ia digunakan sebagai pintu masuk. IP ini perlu dihubungi dari segmen rangkaian antara muka.
id nombor Ia adalah pengenal pasti laluan yang unik. Parameter ini digunakan untuk mengubah suai atau memadamkan laluan dan hanya terdapat dalam laluan jenis pengguna.

Ubah suai kemasukan laluan

Ubah suai kemasukan laluan

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"priority":2,"source":"4.4.4.4","interface":"eth1","to":"71.71.71.0/24","via":"4.4.4.45"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table -id 1024 -priority 2 -source 4.4.4.4 -interface eth1 -to 71.71.71.0/24 -via 4.4.4.45

PUT /routing/tables/<table>/routes/<id>

Ubah suai parameter kemasukan laluan.

. meja Parameter URI ialah jadual antara muka laluan yang akan diubahsuai. The id Parameter URI ialah laluan pengecam unik laluan yang akan diubah suai.

Minta parameter

Bidang Jenis Deskripsi
mentah Rentetan Ia adalah kemasukan laluan dengan Laluan IP format. Jika parameter ini digunakan, yang lain akan dielakkan.
keutamaan nombor Ia adalah keutamaan di mana laluan akan diperiksa. Nilai yang lebih rendah adalah lebih utama. Bidang ini harus mempunyai nilai antara 1 dan 10.
antara muka Rentetan Ia adalah antara muka yang akan digunakan jika laluan itu sepadan.
sumber Rentetan Ia adalah IP yang digunakan untuk menyamar sebagai paket. Sumber ini perlu wujud dalam pengimbang beban sebagai antara muka maya.
kepada Rentetan Ia adalah keadaan perlawanan. Jika IP tujuan paket padanya dengan laluan itu berjaya.
melalui Rentetan Ia adalah hop seterusnya paket. Ia digunakan sebagai pintu masuk. IP ini perlu dihubungi dari segmen rangkaian antara muka.

Contoh tindak balas:

{
    "description" : "Modify a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "71.71.71.0/24",
          "via" : "4.4.4.45",
          "raw" : "71.71.71.0/24 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "priority" : 2,
          "id" : 1024,
          "type" : "user",
          "source" : "4.4.4.4",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "interface" : "eth2",
          "source" : "",
          "type" : "system",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "via" : "",
          "to" : "4.4.4.0/24",
          "interface" : "eth1",
          "source" : "4.4.4.4",
          "type" : "system",
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2"
        },
    ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan senarai laluan yang mengandungi jadual.

Bidang Jenis Deskripsi
keutamaan nombor Ia adalah keutamaan di mana laluan akan diperiksa. Nilai yang lebih rendah adalah lebih utama. Bidang ini harus mempunyai nilai antara 1 dan 10.
mentah Rentetan Ia adalah kemasukan laluan dengan Laluan IP format.
antara muka Rentetan Ia adalah antara muka yang akan digunakan jika laluan itu sepadan.
sumber Rentetan Ia adalah IP yang digunakan untuk menyamar sebagai paket. Sumber ini perlu wujud dalam pengimbang beban sebagai antara muka maya.
jenis Rentetan Ia adalah jenis laluan. Laluan boleh menjadi jenis sistem yang dibuat dan diurus secara automatik oleh sistem, atau pengguna apabila laluan itu dibuat oleh pengguna balancing beban. Memeriksa tiada pengurusan ciri untuk mengalih keluar a sistem laluan.
kepada Rentetan Ia adalah keadaan perlawanan. Jika IP tujuan paket padanya dengan laluan itu berjaya.
melalui Rentetan Ia adalah hop seterusnya paket. Ia digunakan sebagai pintu masuk. IP ini perlu dihubungi dari segmen rangkaian antara muka.
id nombor Ia adalah pengenal pasti laluan yang unik. Parameter ini digunakan untuk mengubah suai atau memadamkan laluan dan hanya terdapat dalam laluan jenis pengguna.

Padamkan Kemasukan Laluan

Padamkan Kemasukan Laluan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table remove table_eth2 1024

DELETE /routing/tables/<table>/routes/<id>

Padamkan laluan jadual antara muka.

. meja Parameter URI ialah jadual antara muka yang mana laluan akan dipadamkan. The id Parameter URI ialah pengenal laluan laluan unik yang akan dihapuskan.

Contoh tindak balas:

{
    "description" : "Delete the routing entry '1024' from the table 'table_eth2'",
    "message" : "The routing rule '1024' has been deleted successfully."
}

Senarai Antaramuka Tidak Diurus dalam Jadual

Senarai Antaramuka Tidak Diurus dalam Jadual

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged get table_eth1

GET /routing/tables/<table>/unmanaged

Ciri ini digunakan untuk mengelakkan trafik dari antara muka yang boleh keluar untuk yang lain.

meja adalah jadual penghalaan antara muka yang masuk.

Senaraikan antara muka dan jika mereka boleh digunakan untuk mengesan lalu lintas.

Contoh tindak balas:

{
    "params" : [
      {
         "unmanaged" : "false",
         "interface" : "eth3"
      },
      {
         "unmanaged" : "false",
         "interface" : "eth0"
      }
    ],
    "description" : "Get the list of interfaces that cannot manage traffic when traffic incoming through the table 'table_eth1'"
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params yang mengandungi senarai objek dengan parameter berikut.

Bidang Jenis Deskripsi
antara muka Rentetan Ia adalah nama antara muka output.
tidak dikendalikan Rentetan Ia adalah status penghalaan antara muka. Sekiranya ia mempunyai nilai palsu, antara muka ini boleh dicapai dari jadual; jika ia mempunyai nilai benar, tidak akan keluar lalu lintas dari jadual.

Tambahkan antara muka ke senarai yang tidak dikendalikan

Tidak mengawal Antarmuka

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged add table_eth1 interface eth0

POST /routing/tables/<table>/unmanaged

Lumpuhkan antara muka untuk trafik yang keluar.

. meja Parameter URI ialah nama jadual penghalaan yang mana laluan tidak dapat diterima. Jika meja mempunyai nilai "*"(Tanda bintang), antara muka tidak boleh diakses dari mana-mana jadual.

Minta parameter

Bidang Jenis Deskripsi diperlukan
antara muka Rentetan Ia adalah antara muka yang tidak dapat membuat laluan dari meja. benar

Contoh tindak balas:

{
    "description" : "Do not route traffic through an interface for the table 'table_eth1'",
    "message" : "The interface 'eth2' is not accesible from the table 'table_eth1'"
}

Keluarkan antara muka dari senarai yang tidak dikendalikan

Mengurus Jadual Penghalaan

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged/eth2
zcli network-routing-table-unmanaged remove table_eth1 eth2

DELETE /routing/tables/<table>/unmanaged/<interface>

Benarkan antara muka akan menjadi penglihatan dari jadual antara muka lain

. meja Parameter URI ialah jadual antara muka yang diubahsuai. Jika meja mempunyai nilai "*"(Tanda bintang), antara muka akan diuruskan dari semua jadual. The antara muka Parameter URI ialah antara muka yang akan dibenarkan untuk meja meja.

Contoh tindak balas:

{
    "description" : "Enable an interface as possible route path from the table 'table_eth1'",
    "message" : "The interface 'eth2' is now accesible from the table 'table_eth1'"
}

Pemantauan - FarmGuardian

FarmGuardian digunakan untuk keadaan pemantauan maju belakang. Apabila masalah dikesan oleh FarmGuardian secara automatik melumpuhkan pelayan sebenar dan akan ditandakan sebagai senarai hitam.

Senarai FarmGuardians

Senarai FarmGuardians

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian list

GET /monitoring/fg

Senaraikan FarmGuardians. Templat dan adat FarmGuardian muncul senarai ini.

Contoh tindak balas:

{
   "description" : "List farm guardian checks and templates",
   "params" : [
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp-cut_conns",
         "template" : "true",
         "backend_alias" : "false"
      },
      {
         "command" : "check_tcp -p 80 -H HOST",
         "cut_conns" : "false",
         "description" : "TCP check to the port 80",
         "farms" : [
                     "web_service",
                     "my_welcome_web"
         ],
         "interval" : 7,
         "log" : "true",
         "name" : "custom-tcp",
         "template" : "false",
         "backend_alias" : "true"
      },
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp",
         "template" : "true",
         "backend_alias" : "false"
      }
   ]
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi
arahan Rentetan Perintah untuk memeriksa status perkhidmatan di backend. Perintah yang ada di dalam laluan libexec.
cut_conns Rentetan Nilai yang mungkin adalah: benar, FarmGuardian memotong sambungan semasa apabila backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
Penerangan Rentetan Penerangan ringkas cek itu.
ladang Tali[ ] Ladang di mana FarmGuardian digunakan.
selang nombor Masa antara cek.
log Rentetan Nilai yang mungkin adalah: benar, FarmGuardian akan log setiap cek; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
nama Rentetan Pengecam unik.
template Rentetan Sekiranya FarmGuardian adalah templat, ia tidak akan digunakan untuk ladang mana pun. Templat berguna untuk membuat FarmGuardian baru.
backend_alias (dari 4.0.1) Rentetan Jika parameter ini mempunyai nilai palsu, hos belakang akan menjadi IP backend. Alias ​​backend akan digunakan sebagai tuan rumah jika parameter ini mempunyai nilai benar, alias harus ditakrifkan dan pengimbang beban harus dapat menyelesaikannya.

Dapatkan FarmGuardian

Dapatkan FarmGuardian

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
zcli farmguardian get check_tcp

GET /monitoring/fg/<name>

Tunjukkan konfigurasi FarmGuardian.

Parameter URI nama adalah pengenal unik FarmGuardian.

Contoh tindak balas:

{
   "description" : "Retrive the farm guardian check_tcp",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 5,
      "log" : "false",
      "name" : "check_tcp",
      "template" : "true",
      "backend_alias" : "false"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi
arahan Rentetan Perintah untuk memeriksa status perkhidmatan di backend. Perintah yang ada di dalam laluan libexec.
cut_conns Rentetan Nilai yang mungkin adalah: benar, FarmGuardian memotong sambungan semasa apabila backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
Penerangan Rentetan Penerangan ringkas cek itu.
ladang Tali[ ] Ladang di mana FarmGuardian digunakan.
selang nombor Masa antara cek.
log Rentetan Nilai yang mungkin adalah: benar, FarmGuardian akan log setiap cek; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
nama Rentetan Pengecam unik.
template Rentetan Sekiranya FarmGuardian adalah templat, ia tidak akan diubah suai. Templat berguna untuk membuat FarmGuardian baru atau digunakan terus ke ladang.
backend_alias (dari 4.0.1) Rentetan Jika parameter ini mempunyai nilai palsu, hos belakang akan menjadi IP backend. Alias ​​backend akan digunakan sebagai tuan rumah jika parameter ini mempunyai nilai benar, alias harus ditakrifkan dan pengimbang beban harus dapat menyelesaikannya.

Buat FarmGuardian

Buat FarmGuardian

Permintaan contoh:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "copy_from":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian create -name check_tcp-cut_conns -copy_from check_tcp

POST /monitoring/fg

Buat FarmGuardian baru.

Minta parameter

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi diperlukan
nama Rentetan Pengecam unik. benar
copy_from Rentetan Ia adalah FarmGuardian yang digunakan sebagai templat untuk membuat FarmGuardian baru. Jika bidang ini tidak dihantar, FarmGuardian baru dibuat tanpa konfigurasi.

Contoh tindak balas:

{
   "description" : "Create a farm guardian check_tcp-cut_conns",
   "message" : "The farm guardian check_tcp-cut_conns has been created successfully",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 5,
      "log" : "false",
      "name" : "check_tcp-cut_conns",
      "template" : "true",
      "backend_alias" : "false"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi
arahan Rentetan Perintah untuk memeriksa status perkhidmatan di backend. Perintah yang ada di dalam laluan libexec.
cut_conns Rentetan Nilai yang mungkin adalah: benar, FarmGuardian memotong sambungan semasa apabila backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
Penerangan Rentetan Penerangan ringkas cek itu.
ladang Tali[ ] Ladang di mana FarmGuardian digunakan.
selang nombor Masa antara cek.
log Rentetan Nilai yang mungkin adalah: benar, FarmGuardian akan log setiap cek; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
nama Rentetan Pengecam unik.
template Rentetan Sekiranya FarmGuardian adalah templat, ia tidak akan diubah suai. Templat berguna untuk membuat FarmGuardian baru atau digunakan terus ke ladang.
backend_alias (dari 4.0.1) Rentetan Jika parameter ini mempunyai nilai palsu, hos belakang akan menjadi IP backend. Alias ​​backend akan digunakan sebagai tuan rumah jika parameter ini mempunyai nilai benar, alias harus ditakrifkan dan pengimbang beban harus dapat menyelesaikannya.

Ubah suai FarmGuardian

Ubah suai FarmGuardian

Permintaan contoh:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian set custom-tcp -interval 7 -log true -description 'TCP check to the port 80' -command 'check_tcp -p 80 -H HOST' -cut_conns false

PUT /monitoring/fg/<name>

Ubah suai FarmGuardian.

Parameter URI nama adalah pengenal unik FarmGuardian.

Minta parameter

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi diperlukan
arahan Rentetan Perintah untuk memeriksa status perkhidmatan di backend. Perintah yang ada di dalam laluan libexec.
cut_conns Rentetan Nilai yang mungkin adalah: benar, FarmGuardian memotong sambungan semasa apabila backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
Penerangan Rentetan Penerangan ringkas cek itu.
selang nombor Masa antara cek.
log Rentetan Nilai yang mungkin adalah: benar, FarmGuardian akan log setiap cek; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
kekuatan Rentetan Sekiranya ladang yang dijalankan menggunakan FarmGuardian, FarmGuardian tidak akan dapat diubah suai. Kemudian, jika parameter ini dihantar dengan nilai benar, FarmGuardian akan dipaksa untuk mengambil konfigurasi baru.
backend_alias (dari 4.0.1) Rentetan Jika parameter ini mempunyai nilai palsu, hos belakang akan menjadi IP backend. Alias ​​backend akan digunakan sebagai tuan rumah jika parameter ini mempunyai nilai benar, alias harus ditakrifkan dan pengimbang beban harus dapat menyelesaikannya.

Contoh tindak balas:

{
   "description" : "Modify farm guardian custom-tcp",
   "message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
   "params" : {
      "command" : "check_tcp -p 80 -H HOST",
      "cut_conns" : "false",
      "description" : "TCP check to the port 80",
      "farms" : [],
      "interval" : 7,
      "log" : "true",
      "name" : "custom-tcp",
      "template" : "false",
      "backend_alias" : "false"
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan kunci params dan format di bawah:

Bidang Jenis Deskripsi
arahan Rentetan Perintah untuk memeriksa status perkhidmatan di backend. Perintah yang ada di dalam laluan libexec.
cut_conns Rentetan Nilai yang mungkin adalah: benar, FarmGuardian memotong sambungan semasa apabila backend tidak tersedia; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
Penerangan Rentetan Penerangan ringkas cek itu.
ladang Tali[ ] Ladang di mana FarmGuardian digunakan.
selang nombor Masa antara cek.
log Rentetan Nilai yang mungkin adalah: benar, FarmGuardian akan log setiap cek; atau palsu, jika backend itu tidak tersedia, ia akan dilumpuhkan tetapi sesi yang masih hidup terus.
nama Rentetan Pengecam unik.
template Rentetan Sekiranya FarmGuardian adalah templat, ia tidak akan digunakan untuk ladang mana pun. Templat berguna untuk membuat FarmGuardian baru.
backend_alias (dari 4.0.1) Rentetan Jika parameter ini mempunyai nilai palsu, hos belakang akan menjadi IP backend. Alias ​​backend akan digunakan sebagai tuan rumah jika parameter ini mempunyai nilai benar, alias harus ditakrifkan dan pengimbang beban harus dapat menyelesaikannya.

Padam FarmGuardian

Padam FarmGuardian

Permintaan contoh:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian delete custom-tcp

DELETE /monitoring/fg/<name>

DELETE a FarmGuardian.

Parameter URI nama adalah pengenal unik FarmGuardian.

Contoh tindak balas:

{
   "description" : "Delete the farm guardian custom-tcp",
   "message" : "custom-tcp has been deleted successful.",
   "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/v4.0/zapi.cgi/stats
zcli statistics-system get

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 gangguan perkakasan.
baik nombor Keutamaan penjadualan CPU.
softirq nombor CPU yang digunakan oleh gangguan 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 peratusan sistem minit terakhir.
Last_5 nombor Muatkan peratusan sistem lima minit yang lalu.
Last_15 nombor Muatkan peratusan sistem 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 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/v4.0/zapi.cgi/stats/system/network
zcli statistic-network get

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 trafik output dalam 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/v4.0/zapi.cgi/stats/system/network/interfaces
zcli statistics-network get

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 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 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/v4.0/zapi.cgi/stats/system/memory
zcli statistics-system get -filter 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 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/v4.0/zapi.cgi/stats/system/load
zcli statistics-system get -filter 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 dalam tempoh lima minit yang lalu.
Last_15 nombor Muatkan penggunaan sistem selama lima belas 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/v4.0/zapi.cgi/stats/system/cpu
zcli statistics-system get -filter 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 gangguan perkakasan.
baik nombor Keutamaan penjadualan CPU.
softirq nombor CPU yang digunakan oleh gangguan 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/v4.0/zapi.cgi/stats/system/connections
zcli statistics-network-connections get

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

Tunjukkan bilangan ladang

Tunjukkan bilangan ladang

Permintaan contoh:

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

GET /stats/farms/total

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/v4.0/zapi.cgi/stats/farms
statistics-farm list

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 yang ditubuhkan pada masa ini.
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/v4.0/zapi.cgi/stats/farms/farmname
zcli statistic-farm list

GET /stats/farms/<farmname>

Menunjukkan status ladang semasa, status backend dan sambungan mereka. Setiap ladang akan bertindak balas dengan objek yang berbeza, 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 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 penyelenggaraan 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" : 1,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
         "id" : 5,
         "session" : "192.168.5.100"
      }
   ]

}

Parameter tindak balas dalam ladang L4xNAT

Sambutan akan menjadi JSON dengan objek backends dan sesi:

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 penyelenggaraan backend; undefined, status backend belum diperiksa.

Objek Sesi:

Bidang Jenis Deskripsi
id nombor Backend identifier unik di mana pelanggan ditugaskan.
Sesi Rentetan Pengecam unik sesi. Ia adalah IP pelanggan.

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/v4.0/zapi.cgi/stats/farms/modules

GET /stats/farms/modules

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

Takrif 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 penyelenggaraan 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/v4.0/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, pengecam 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 diri mereka.
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, RAM, semua antara muka rangkaian yang dikonfigurasi, beban dan penyimpanan cakera keras.

Anda juga boleh mengakses sejarah mingguan, bulanan dan tahunan.

Graf dengan maklumat dijawab 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/v4.0/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 graf ladang yang ada.
antara muka Tali[] Senarai graf antara muka yang tersedia.
sistem Objek [] Senarai graf sistem yang ada. Arahan 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/v4.0/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/v4.0/zapi.cgi/graphs/interfaces/eth3

Mohon contoh untuk cakera:

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

GET /graphs/<graph>

Nilai yang 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 digunakan untuk menghasilkan graf. Nilai yang mungkin adalah: harian, mingguan, bulanan or setiap tahun.
graf Rentetan Grafik dalam format base64.

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/v4.0/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/v4.0/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/v4.0/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 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 base64.

IPDS

Modul ini adalah pelaksanaan 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 dengan memohon peraturan keselamatan kepada sistem yang akan ditakrifkan sebagai objek sifat yang berbeza. Setiap orang menawarkan penyelesaian untuk aktiviti berniat jahat atau mencurigakan luaran. Alat ini membantu pentadbir sistem mengawal ancaman dan serangan.

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

Ambil pakej IPDS

Ambil pakej IPDS

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package
zcli ipds-package get

GET /ipds/package

Dapatkan maklumat pakej zevenet-ipds. Pakej ini mengandungi peraturan yang dikemas kini untuk setiap modul IPDS.

Contoh tindak balas:

{
   "description" : "zevenet-ipds package status info",
   "params" : {
      "frequency" : 0,
      "mode" : "disabled",
      "ruleset_date" : "05-06-2019",
      "scheduled" : "none",
      "status" : "Updates available",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan set kunci kepada params, nilainya akan menjadi maklumat pakej IPDS.

Bidang Jenis Deskripsi
status Rentetan Menunjukkan maklumat status kemas kini mengenai pakej IPDS. Jika pakej dipasang, jika ia dikemas kini dan jika terdapat kemas kini yang belum selesai.
ruleset_date Rentetan Ia adalah tarikh pakej dibina. Ia bukan tarikh yang dipasang.
dijadualkan Rentetan Mesej deskriptif menerangkan konfigurasi jadual.
mod Rentetan Ia menunjukkan kekerapan kemas kini akan berlaku atau untuk mematikan jadual. Nilai yang ada ialah: harian Jadualkan kemas kini yang akan dilakukan setiap hari, ia membolehkan medan Kekerapan untuk menunjukkan berapa jam pengemaskinian akan diulang, dari masa yang ditetapkan; Setiap minggu, Jadual kemas kini dilakukan seminggu sekali, ia membolehkan kekerapan sebagai Hari dalam seminggu untuk menunjukkan hari mana minggu akan kemas kini dijadualkan (dari Isnin hingga Ahad); bulanan, jadilah kemas kini yang akan dilakukan sebulan sekali.
kekerapan nombor If mod setiap hari, kekerapan adalah bilangan jam antara kemas kini pakej dari masa; Jika mod adalah mingguan, nilai yang diharapkan adalah bilangan hari kerja (dari Isnin, 1, hingga Ahad, 7); Jika mod adalah bulanan, nilai yang dijangkakan ialah bilangan bulan (dari 1 kepada 31).
masa Objek Membolehkan untuk menetapkan pada masa mana pembaharuan akan berlaku atau dari masa mana pakej akan dikemas kini jika mod ditetapkan sebagai Harian dan Kekerapan lebih besar daripada 0.

Objek waktu:

Objek ini, jam: minit, adalah jam apabila pakej akan dikemas kini.

Bidang Jenis Deskripsi
jam nombor Adakah jam dalam bentuk format 0 kepada 23.
minit nombor adalah minit dalam bentuk format 0 kepada 59.

Gunakan tindakan untuk pakej IPDS

Gunakan tindakan untuk pakej IPDS

Mohon contoh untuk mengemas kini peraturan IPDS:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"action":"upgrade"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions
zcli ipds-package upgrade

Contoh tindak balas:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "ruleset_date" : "07-06-2019",
      "status" : "Installed and updated"
   }
}

Mohon contoh untuk kemas kini penjadualan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"mode":"daily","frequency":1,"time":{"hour":0,"minute":0},"action":"schedule"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions

Contoh tindak balas:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "frequency" : 1,
      "mode" : "daily",
      "scheduled" : "daily from 0:00 to 23:00 each 1 hours",
      "status" : "Installed and updated",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

POST /ipds/package

Gunakan tindakan mengenai pakej zevenet-ipds.

Minta parameter

Bidang Jenis Deskripsi diperlukan
tindakan Rentetan Ia adalah tindakan untuk memohon mengenai pakej peraturan IPDS. Pilihannya ialah: menaik taraf untuk memaksa peningkatan pakej. jadual untuk mengkonfigurasi sistem menaik taraf pakej dengan berkala.
mod Rentetan Ia menunjukkan kekerapan kemas kini akan berlaku atau untuk mematikan jadual. Nilai yang ada ialah: harian Jadualkan kemas kini yang akan dilakukan setiap hari, ia membolehkan medan Kekerapan untuk menunjukkan berapa jam pengemaskinian akan diulang, dari masa yang ditetapkan; Setiap minggu, Jadual kemas kini dilakukan seminggu sekali, ia membolehkan kekerapan sebagai Hari dalam seminggu untuk menunjukkan hari mana minggu akan kemas kini dijadualkan (dari Isnin hingga Ahad); bulanan, jadilah kemas kini yang akan dilakukan sebulan sekali.
kekerapan nombor If mod setiap hari, kekerapan adalah bilangan jam antara bentuk kemas kini pakej masa; Jika mod adalah mingguan, nilai yang diharapkan adalah bilangan hari kerja (dari Isnin, 1, hingga Ahad, 7); Jika mod adalah bulanan, nilai yang dijangkakan ialah bilangan bulan (dari 1 kepada 31).
masa Objek Membolehkan untuk menetapkan pada masa mana pembaharuan akan berlaku atau dari masa mana pakej akan dikemas kini jika mod ditetapkan sebagai Harian dan Kekerapan lebih besar daripada 0.

Objek waktu:

Objek ini, jam: minit, adalah jam apabila pakej akan dikemas kini.

Bidang Jenis Deskripsi
jam nombor Adakah jam dalam bentuk format 0 kepada 23.
minit nombor adalah minit dalam bentuk format 0 kepada 59.

Parameter tindak balas

Tanggapan akan menjadi objek JSON dengan set kunci kepada params. Nilai ini akan menjadi maklumat mengenai pakej IPDS.

Bidang Jenis Deskripsi
status Rentetan Menunjukkan maklumat status kemas kini mengenai pakej IPDS. Jika pakej dipasang, jika ia dikemas kini dan jika terdapat kemas kini yang belum selesai.
ruleset_date Rentetan Ia adalah tarikh pakej dibina. Ia bukan tarikh yang dipasang.
dijadualkan Rentetan Mesej deskriptif menerangkan konfigurasi jadual.
mod Rentetan Ia menunjukkan kekerapan kemas kini akan berlaku atau untuk mematikan jadual. Nilai yang ada ialah: harian Jadualkan kemas kini yang akan dilakukan setiap hari, ia membolehkan medan Kekerapan untuk menunjukkan berapa jam pengemaskinian akan diulang, dari masa yang ditetapkan; Setiap minggu, Jadual kemas kini dilakukan seminggu sekali, ia membolehkan kekerapan sebagai Hari dalam seminggu untuk menunjukkan hari mana minggu akan kemas kini dijadualkan (dari Isnin hingga Ahad); bulanan, jadilah kemas kini yang akan dilakukan sebulan sekali.
kekerapan nombor If mod setiap hari, kekerapan adalah bilangan jam antara kemas kini pakej dari masa; Jika mod adalah mingguan, nilai yang diharapkan adalah bilangan hari kerja (dari Isnin, 1, hingga Ahad, 7); Jika mod adalah bulanan, nilai yang dijangkakan ialah bilangan bulan (dari 1 kepada 31).
masa Objek Membolehkan untuk menetapkan pada masa mana pembaharuan akan berlaku atau dari masa mana pakej akan dikemas kini jika mod ditetapkan sebagai Harian dan Kekerapan lebih besar daripada 0.

Objek waktu:

Objek ini, jam: minit, adalah jam apabila pakej akan dikemas kini.

Bidang Jenis Deskripsi
jam nombor Adakah jam dalam bentuk format 0 kepada 23.
minit nombor adalah minit dalam bentuk format 0 kepada 59.

Senaraikan semua peraturan IPDS

Senaraikan peraturan ipds

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds
zcli ipds list

GET /ipds

Senaraikan semua peraturan IPDS yang wujud 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 digunakan untuk ladang.

IPDS - Senarai hitam

Senarai hitam membolehkan pengguna menggunakan senarai untuk menapis atau membenarkan trafik mengikut sumber IP (Laluan Masuk).

Terdapat dua jenis senarai:

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

Modul ini termasuk pramuat senarai yang diberikan oleh pasukan Zevenet, senarai itu sudah sedia untuk digunakan untuk ladang. Di samping itu, pengguna boleh membuat senarai peribadi mereka.

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 semula hitam dilakukan kepada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
zcli ipds-blacklist list

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 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/loc
zcli ipds-blacklist get 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 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 tersebut disimpan dalam sistem dan diselenggarakan oleh pentadbir sistem; atau jauh, senarai 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 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.
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 [] IP sumber yang menyenaraikan 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 rangkaian / bitmask 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 kekerapan nilai adalah mingguan or bulanan. Jika kekerapan is mingguan parameter ini mestilah hari dalam seminggu (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 pada 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 itu 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
ipds-blacklist create -name newListLoc -type local -policy allow

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://<zevenet_server>:444/zapi/v4.0/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 dinafikan.
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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/whiteList
zcli ipds-blacklist set whiteList -policy allow 

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 boleh diubah suai 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 hanya sumber sila lihat seksyen dokumentasi IPDS> Senarai Hitam> Ubah sumber senarai hitam. Sumber hanya boleh diubah suai tidak 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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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 tempoh, 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 kerja (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 pada bidang kekerapan.

Objek tempoh masa

Ini adalah bidang apabila tempoh 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 bidang 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 kerja 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/remoteList
zcli ipds-blacklist delete 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"
}

Senarai sumber senarai hitam

Senaraikan sumber dari senarai hitam

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist get localList

GET /ipds/blacklists/<name>/sources

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.

Tambahkan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist-source add localList -source 192.168.3.1

Minta contoh untuk kumpulan:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":["192.168.3.1", "22.2.32.7"]}'
https://<zevenet_server>:444/zapi/v4.1/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist-source add localList -source 192.168.3.1,22.2.32.7

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 atau Rentetan [] Alamat IP atau segmen rangkaian 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources/2
ipds-blacklist-source set localList 2 -source 192.168.3.1

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

Sambutan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources/2
zcli ipds-blacklist-source remove localList 2

Minta contoh untuk kumpulan:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.1/zapi.cgi/ipds/blacklists/localList/sources/65.21.7.2,90.53.0.11/24,5.82.2.64
zcli ipds-blacklist-source remove localList 65.21.7.2,90.53.0.11/24,5.82.2.64

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

Memohon tindakan

Permintaan contoh untuk senarai jauh:

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

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 senarai hitam 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

Sambutan 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

DoS menetapkan had koneksi untuk sumber atau melalui proses masuk yang masuk untuk memastikan perkhidmatan tersebut tersedia dan ia tidak dibebankan. Ia boleh menguatkuasakan protokol TCP, memeriksa lalu lintas adalah koheren dan ia tidak palsu. Sebelum memohon peraturan untuk ladang, buat objek dengan konfigurasi yang dikehendaki. Seterusnya, diterapkan ke semua ladang yang anda perlukan.

Adalah perlu untuk membuat 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 maksimum sambungan semasa dari sumber.

bogustcpflags

Semak protokol TCP dihormati. Peraturan ini tidak mempunyai parameter konfigurasi supaya hanya membuat objek yang anda dapat 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 Ini 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.

Senaraikan semua jenis peraturan DoS

Senaraikan semua jenis peraturan DoS

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos/rules
zcli ipds-dos list

GET /ipds/dos/rules

Tunjukkan senarai peraturan DoS.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos
zcli ipds-dos list

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

Maklum balas akan menjadi pelbagai daripada semua objek DoS yang ada.

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 itu, 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 maksimum 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 Ini 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.

Ambil peraturan DoS

Ambil peraturan DoS

Meminta contoh untuk peraturan ladang:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos/limitConnHttp
zcli ipds-dos get limitConnHttp

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

Parameter tindak balas

Maklum balas akan menjadi pelbagai daripada semua objek DoS yang ada.

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.

Di samping itu, 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 maksimum sambungan semasa sfrom 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 Ini 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.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos
zcli ipds-dos create -name limitUsers -rule limitsec

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

Sambutan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos/ssh_brute_force
zcli ipds-dos set ssh_brute_force -hits 10 -status up -time 100

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 maksimum sambungan semasa dari sumber.

bogustcpflags

Tiada parameter.

limitrst

Bidang Jenis Deskripsi
menghadkan nombor Ini 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.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/dos/limitConnHttp
zcli ipds-dos delete limitConnHttp

DELETE /ipds/dos/<name>

nama adalah kaedah pengecam unik DoS.

Contoh tindak balas:

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

Terapkan tindakan kepada peraturan DoS

Memohon tindakan

Permintaan contoh untuk senarai jauh:

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

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

Contoh tindak balas:

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

Parameter tindak balas

Sekiranya tidak ada masalah dalam konfigurasi maka ZAPI akan memulangkan tindakan yang diminta.

IPDS - RBL

RBL, Senarai blackhole realtime biarkan membuat sistem keselamatan yang mewakilkan, tugas membosankan untuk mengekalkan sistem keselamatan yang dikemas kini, kepada pakar. RBL menyemak beban pengimbang trafik input dalam pangkalan data luar melalui protokol DNS. Pemilik pelayan DNS adalah 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 pembekal tertentu yang menyusun sumber untuk kriteria yang berbeza, sebagai jenis serangan atau keterukan serangan.

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

Terakhir, gunakan 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl
zcli ipds-rbl list

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 Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Ambil peraturan RBL

Ambil peraturan RBL

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/protection_ssh
zcli ipds-rbl get protection_ssh

GET /ipds/rbl/<name>

Tunjukkan konfigurasi RBL dan parameter keterangannya. nama digunakan sebagai pengetua 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 Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl
zcli ipds-rbl create -name all 

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

Contoh tindak balas:

{
   "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 yang akan datang.

Bidang Jenis Deskripsi
cache_size nombor Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/all
zcli ipds-rbl set all -name all_reported -cache_size 16384 -cache_time 180000 -queue_size 32269 -threadmax 500 -local_traffic true -log_level 4 -only_logging true

PUT /ipds/rbl/<name>

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

Minta parameter:

Bidang Jenis Deskripsi
cache_size nombor Ia 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 peraturannya boleh disimpan dalam baris gilir.
threadmax Rentetan Ia adalah bilangan paket yang dapat dipertanyakan oleh peraturan pada serentak pada 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 yang akan datang.

Bidang Jenis Deskripsi
cache_size nombor Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/all_reported
zcli ipds-rbl create -name copied_rule -copy_from all_reported

POST /ipds/rbl/<name>

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

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 yang akan datang.

Bidang Jenis Deskripsi
cache_size nombor Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/sip
zcli ipds-rbl delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/domains
zcli ipds-rbl-domain list

GET /ipds/rbl/domains

Senaraikan semua domain yang ada 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 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/domains
zcli ipds-rbl-domain add -domain web.dnsbl.sorbs.net

POST /ipds/rbl/domains

Tambah domain baru ke senarai domain pengguna.

Minta parameter

Bidang Jenis Deskripsi diperlukan
domain Rentetan Ia adalah zon pembekal RBL di mana peraturan RBL akan membuat 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/domains/2
zcli ipds-rbl-domain 2 -domain ssh.blocklist.de

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

Padamkan domain

Padamkan domain

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/domains/1
zcli ipds-rbl-domain remove 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"
}

Tambah domain kepada peraturan RBL

Tambah domain kepada peraturan RBL

Permintaan contoh:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"domain":"apache.rbl.zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/tstrule/domains
zcli ipds-rbl add tstrule -domain apache.rbl.zevenet.com

POST /ipds/rbl/<name>/domains

Tambah domain yang telah ditambah sebelum ini kepada pengimbang beban kepada peraturan RBL.

Parameter URI nama adalah peraturan pengecilan unik RBL.

Minta parameter

Bidang Jenis Deskripsi diperlukan
domain Rentetan Ia adalah zon pembekal RBL di mana peraturan RBL akan membuat pertanyaan. benar

Contoh tindak balas:

{
   "description" : "Add the domain 'apache.rbl.zevenet.com' to the RBL rule tstrule",
   "message" : "Added apache.rbl.zevenet.com domain successfully.",
   "params" : {
      "cache_size" : 8192,
      "cache_time" : 3600,
      "domains" : [
         {
            "domain" : "apache.rbl.zevenet.com"
         }
      ],
      "farms" : [],
      "local_traffic" : "false",
      "log_level" : 5,
      "name" : "tstrule",
      "only_logging" : "false",
      "queue_size" : 64538,
      "status" : "down",
      "threadmax" : 0
   }
}

Parameter tindak balas

Tanggapan akan menjadi JSON dengan parameter peraturan RBL dikemas kini.

Bidang Jenis Deskripsi
cache_size nombor Ia 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 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 peraturannya boleh disimpan dalam baris gilir.
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 peraturan pada serentak pada pelayan DNS. Nilai maksimumnya ialah 700. Apabila bilangan paket input lebih besar daripada threadmax, paket seterusnya akan diterima secara automatik.

Padamkan domain dari peraturan RBL

Padamkan domain dari peraturan RBL

Permintaan contoh:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/rbl/tstrule/domains/apache.rbl.zevenet.com
zcli ipds-rbl-domain remove all -domain apache.rbl.zevenet.com

DELETE /ipds/rbl/<name>/domains/<domain>

Padamkan domain dari peraturan RBL.

Parameter URI nama adalah pengecam unik RBL. Parameter URI domain adalah salah satu daripada rentetan domain yang disenaraikan dalam domain bidang respons peraturan RBL.

Contoh tindak balas:

{
   "description" : "Delete the domain apache.rbl.zevenet.com from a RBL rule tstrule",
   "message" : "The domain apache.rbl.zevenet.com has been deleted successful from the RBL rule tstrule.",
   "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/v4.0/zapi.cgi/ipds/rbl/<name>/action
zcli ipds-rbl stop <name>

POST /ipds/rbl/<id>/farms/<farmname>/actions

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

id adalah pengecam pengguna domain yang akan dihapuskan. nama adalah peraturan RBL pengecam unik.

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

Sekiranya tidak ada masalah dalam konfigurasi maka ZAPI akan memulangkan tindakan yang diminta.

IPDS - WAF

Firewall Aplikasi Web, WAF, adalah alat khusus untuk mengesan dan menghalang lalu lintas HTTP yang berniat jahat yang akan melalui ladang HTTP (s). WAF berfungsi mencari dan menganalisis corak dengan tujuan menggunakan dasar keselamatan lanjutan.

Zevenet WAF membina dan menguruskan peraturan dengan format SecLang (dipanggil adat dalam penciptaan, dan ditunjukkan di dalam mentah bidang). Bahasa pemformatan ini digunakan oleh perpustakaan libmodsecurity, untuk membuat set peraturan untuk menghubungkan mereka dengan jenis ladang HTTP. Juga, adalah mungkin untuk mengkonfigurasi peraturan WAF tanpa perlu mengetahui sintaks SecLang, hanya menggunakan parameter yang dijangkakan oleh ZAPI. API akan membina tanpa syarat tindakan yang akan melaksanakan hukuman sementara pengurusan permintaan HTTP yang masuk. Juga, tindakan itu boleh dicetuskan menggunakan sepadan dengan syarat untuk melaksanakannya apabila diperlukan

A peraturan adalah satu set peraturan dengan konfigurasi umum. Adalah penting untuk mengetahui bahawa set-set itu berurutan, jadi perintah peraturan akan dihormati. Jika peraturan dengan BLOCK resolusi sepadan dengan permintaan akan ditolak. Cara yang sama, jika peraturan dengan ALLOW resolusi perlawanan, tidak ada peraturan yang akan diperiksa dan permintaan diterima.

Kerana perintah peraturan itu penting, ada pilihan yang tersedia untuk melompat peraturan, sebagai skip parameter atau peraturan jenis penanda untuk menetapkan mata di mana untuk melompat.

Sebaik sahaja peraturan telah dikonfigurasi, ia adalah masanya untuk memohon mereka ke ladang-ladang HTTP. Ladang menerima set peraturan sebanyak yang diperlukan oleh pentadbir keselamatan. Dalam konteks ruleset perintah itu penting juga, jadi set mesti disusun.

Takrif objek WAF:

Objek ruleset:

Objek yang ditetapkan mempunyai dua kekunci:

Kunci konfigurasi adalah tingkah laku global set. Ia menetapkan kelakuan lalai untuk peraturan.

konfigurasi

Bidang Jenis Deskripsi
disable_rules Nombor [] Ia adalah senarai peraturan yang ditetapkan untuk melumpuhkan. Nilai yang dijangkakan ialah rule_id peraturan akan dimatikan.
process_request_body Rentetan Parameter ini membolehkan semakan HTTP permintaan badan. Nilai yang mungkin adalah benar untuk membolehkan pemeriksaan; atau palsu untuk mematikan cek.
process_response_body Rentetan Parameter ini membolehkan semakan HTTP badan tindak balas. Nilai yang mungkin adalah benar untuk membolehkan pemeriksaan; atau palsu untuk mematikan cek.
request_body_limit nombor Tetapkan had kepada badan permintaan HTTP. Nombor ini adalah saiz dalam Bytes. Sekiranya saiz badan lebih besar daripada batas, ia akan dilangkau.
default_action Rentetan Ia adalah nilai lalai kepada parameter peraturan resolusi parameter peraturan. Tindakan ini akan dilaksanakan dalam kes yang dipadankan dengan peraturan dan only_logging parameter tidak didayakan. Nilai yang mungkin adalah: lulus, aturan akan menerapkan pilihan lain yang dikonfigurasi (log, jalankan…) dan permintaan tidak akan dipotong. Peraturan berikut akan diperiksa; menafikan, menamatkan sambungan, peraturan berikut tidak akan dilaksanakan; mengarahkan, pelanggan akan diarahkan ke URL yang dikonfigurasikan dalam parameter redirect_url.
status Rentetan Ia menunjukkan status peraturan yang ditetapkan. Nilai yang dikembalikan mungkin ialah turun, peraturan ditetapkan dilumpuhkan; atau up, peraturan ditetapkan diaktifkan, ia berfungsi menyekat atau membenarkan mengikut resolusi parameter.
only_logging Rentetan Jika parameter ini diaktifkan, resolusi tidak akan dilaksanakan, tidak memotong sambungan dalam mana-mana. Nilai yang mungkin adalah: benar untuk membolehkan mod kerja pembalakan sahaja; atau palsu, WAF akan memotong sambungan jika a resolusi (menafikan or mengarahkan) dilaksanakan.
audit Rentetan Jika parameter ini diaktifkan, WAF melaporkan fail log dilanjutkan dengan hasil setiap analisis permintaan HTTP. Nilai yang mungkin adalah: benar, membolehkan log audit; atau palsu, melumpuhkan pembalakan audit.
default_log Rentetan Ia adalah nilai lalai kepada log parameter peraturan. Jika nilai ditetapkan kepada benar semua peraturan perlawanan akan dilog masuk. Jika nilai ditetapkan kepada palsu perlawanan tidak akan dilog masuk.
default_phase Rentetan Ia adalah nilai lalai kepada fasa parameter peraturan. Tahap mewakili titik permintaan HTTP di mana peraturan akan dilaksanakan. Nilai yang mungkin adalah 1, ia dilaksanakan apabila kepala permintaan diterima; 2, ia dilaksanakan apabila permintaan badan diterima; 3, ia dilaksanakan apabila tajuk respons diterima; 4, ia dilaksanakan apabila badan tindak balas diterima; atau 5, ia dilaksanakan sebelum pembalakan.

peraturan

Kunci peraturan adalah senarai peraturan dan setiap elemen adalah objek peraturan.

peraturan

Peraturan boleh mempunyai salah satu jenis berikut:

Tindakan

Apabila peraturan dilaksanakan, ia akan melaksanakan tindakan yang ditakrifkan.

Untuk mengurus jika peraturan akan dilaksanakan atau tidak bergantung pada permintaan yang masuk, ia menggunakan parameter sepadan dengan. Jika parameter tersebut sepadan dengan tidak ditetapkan, peraturan akan dilaksanakan tanpa syarat, opsyen ini biasanya digunakan untuk menginisialisasi pemboleh ubah atau untuk menetapkan tindakan lalai.

Parameter peraturan tindakan boleh dibahagikan kepada beberapa topik:

Bidang Jenis Deskripsi
mentah Rentetan Bidang ini mengandungi tali dengan peraturan dalam sintaks SecLang.
id nombor Ia adalah pengecam unik untuk peraturan di dalam peraturan. Ia digunakan untuk mengedit dan memindahkan peraturan.
rule_id nombor Ia adalah pengenal peraturan. Ia mesti unik dalam sistem. Ia digunakan untuk menyalin peraturan. Parameter ini hanya untuk peraturan jenis tindakan. Sekiranya dua peraturan mempunyai peraturan yang sama rule_id tidak dapat berhubung dengan ladang yang sama.
jenis Rentetan Ia menunjukkan jenis peraturan. Nilai yang mungkin adalah: tindakan, penanda or adat.
resolusi Rentetan Untuk melaksanakan tindakan ini, perlu mengkonfigurasi parameter peraturan status kepada benar. Parameter ini adalah tindakan untuk memohon apabila peraturan WAF sepadan. Nilai yang mungkin adalah: lulus, aturan akan menerapkan pilihan lain yang dikonfigurasi (log, jalankan…) dan permintaan tidak akan dipotong. Peraturan berikut akan diperiksa; menafikan, menamatkan sambungan, peraturan berikut tidak akan dilaksanakan; mengarahkan, pelanggan akan diarahkan ke URL yang dikonfigurasikan dalam parameter redirect_url; default_action, peraturan akan melaksanakan tindakan yang ditetapkan dalam parameter peraturan default_action.
audit Rentetan Parameter ini ditulis ganti audit tetapkan parameter peraturan untuk peraturan semasa dalam kes yang sesuai dengan peraturan. Sekiranya ia mempunyai nilai benar, peraturan itu akan sentiasa melaporkan dalam log audit; Sekiranya ia mempunyai nilai palsu, dalam hal perlawanan, peraturan itu tidak akan dilaporkan kepada log audit; jika kelakuan lalai diingini, tetapkan sebagai kosong tali.
perlawanan Objek Padanan [] Ia adalah senarai padanan objek. Peraturan akan dilaksanakan dalam kes yang semua objek akan dipadankan.
Penerangan Rentetan Ia adalah mesej deskriptif untuk peraturan ini.
melaksanakan Rentetan Ia adalah laluan kepada skrip LUA. Skrip ini akan dilaksanakan apabila peraturan tersebut sepadan. Skrip mesti wujud sebelum mengkonfigurasi parameter ini.
log Rentetan Jika parameter ini mempunyai nilai benar, peraturan itu akan log masuk dalam perlawanan yang berjaya. Untuk tidak log, parameter harus ditetapkan dengan nilai palsu. Jika nilai ditetapkan kepada kosong parameter peraturan default_log akan dilaksanakan.
log_data Rentetan Parameter ini membenarkan pembalakan maklumat tambahan. Ia boleh digunakan dengan pembolehubah untuk log maklumat transaksi yang menarik.
fasa Rentetan Tahap mewakili titik permintaan HTTP di mana peraturan akan dilaksanakan. Nilai yang mungkin adalah 1, ia dilaksanakan apabila kepala permintaan diterima; 2, ia dilaksanakan apabila permintaan badan diterima; 3, ia dilaksanakan apabila tajuk respons diterima; 4, ia dilaksanakan apabila badan tindak balas diterima; atau 5, ia dilaksanakan sebelum pembalakan.
redirect_url Rentetan Ia adalah URL di mana mengarahkan pelanggan dalam hal bahawa resolusi mengarahkan dilaksanakan. Parameter ini boleh ditetapkan hanya apabila peraturan resolusi mempunyai nilai mengarahkan.
skip nombor Ia adalah bilangan peraturan untuk melangkau apabila peraturan itu sepadan. Peraturan yang dilangkau berada dalam fasa yang sama.
skip_after Rentetan Parameter ini mempunyai dua jenis nilai yang mungkin: a rule_id, dalam perlawanan yang berjaya, WAF melompat ke aturan_id yang dipilih; atau "string", string mestilah tanda yang ada, semua peraturan akan melangkau sehingga mencapai tanda. The skip_after parameter berfungsi hanya melalui peraturan dalam fasa yang sama.
tag Tali[] Tag adalah tanda untuk mengklasifikasikan lalu lintas yang dipadankan.
diubahsuai Rentetan Ia menunjukkan sama ada peraturan telah diedit oleh pengguna. Dalam kes lain, peraturan itu telah dimuat naik oleh pakej zevenet-ipds.

Sepadan dengan

Objek perlawanan membina keadaan perlawanan. Sekiranya ini berjaya, peraturan akan dilaksanakan. Untuk menilai perlawanan, WAF akan melaksanakan operasi (parameter operator dan beroperasi) terhadap a pembolehubah senarai. Sekiranya terdapat beberapa pertandingan operasi dengan beberapa pembolehubah senarai, perlawanan itu diambil sebagai satu kejayaan. Sebagai contoh, untuk mencari regexp dalam tajuk permintaan dan nama hos, ia boleh dinilai dengan konfigurasi berikut.

{“Variables”: [“REQUEST_HEADERS”, “SERVER_NAME”], “operator”: “strRegexp”, “operasi”: “localhost”}

Bidang Jenis Deskripsi
match_index nombor Ia adalah indeks objek perlawanan. Ia digunakan sebagai pengecam unik di dalam senarai perlawanan peraturan.
tidak padan Rentetan Ia digunakan untuk menunjukkan bahawa peraturan itu tidak sepadan dengan keadaan itu.
menangkap Rentetan Parameter ini membolehkan ciri menangkap nilai yang diperoleh dari ungkapan biasa. Untuk menggunakan parameter ini dengan rasa, ia harus digunakan dengan operator strRegexp. Nilai yang mungkin adalah benar or palsu.
multi_match Rentetan Parameter ini digunakan apabila lebih daripada satu transformasi dikonfigurasikan. Peraturan ini akan mencuba perlawanan pembolehubah, yang operator dan juga beroperasi untuk setiap nilai transformasi. Nilai yang mungkin adalah: benar, membolehkan pelbagai perlawanan; atau palsu, melumpuhkan ciri multi padanan.
transformasi Tali[] Transformasi mengubah pembolehubah sebelum menggunakannya kepada pengendali dan operasi. Di sini terdapat senarai nama transformasi. Parameter ini berguna untuk menghapuskan teknik anti-mengelakkan atau mengeluarkan data kodifikasi.
pembolehubah Tali[] Ia bertentangan dengan mana bahagian transaksi HTTP peraturan akan mencuba perlawanan. Nilai-nilai yang mungkin ada dalam ini meja.
operator Rentetan Ini adalah bagaimana peraturan cuba perlawanan. Parameter ini digunakan digabungkan dengan beroperasi. Jenis nilai yang dijangka bergantung kepada operator meja.
beroperasi Rentetan Inilah peraturan yang cuba dicuba. Parameter ini digunakan digabungkan dengan operator.

Menandakan

Tanda-tanda berguna untuk mengubah suai peraturan, dan mengehadkan set yang berbeza. Ia digunakan oleh parameter skip_after peraturan tindakan.

Bidang Jenis Deskripsi
mentah Rentetan Bidang ini mengandungi peraturan dalam sintaks SecLang.
id nombor Ia adalah pengenal unik di dalam peraturan. Ia digunakan untuk mengubah suai dan memindahkan peraturan.
jenis Rentetan Ia menunjukkan jenis peraturan, tindakan, penanda or adat.
tanda Rentetan Ia adalah nama untuk tanda itu.

Adat

Jika sebelum cara membuat peraturan tidak cukup untuk pentadbir pengimbang beban dan mereka dengan sintaks SecLang, adalah mungkin untuk membuat peraturan atau kumpulan peraturan melalui pilihan tersuai. Bidang ini menerima sebarang arahan jika arahan dan parameter disokong oleh sintaks SecLang.

Bidang Jenis Deskripsi
mentah Rentetan Bidang ini mengandungi peraturan dalam sintaks SecLang.
id nombor Ia adalah pengenal unik di dalam peraturan. Ia digunakan untuk mengubah suai dan memindahkan peraturan.
jenis Rentetan Ia menunjukkan jenis peraturan, tindakan, penanda or adat.

Senarai data untuk pertandingan bangunan

Operator

operator Deskripsi
strBegins Peraturan ini akan dipadankan jika mana-mana pembolehubah bermula dengan nilai beroperasi.
strContains Peraturan ini akan dipadankan jika mana-mana pembolehubah mengandungi nilai beroperasi.
strContainsWord Peraturan ini akan dipadankan jika mana-mana pembolehubah mengandungi perkataan nilai beroperasi.
strEnds Peraturan ini akan dipadankan jika mana-mana pembolehubah berakhir dengan nilai beroperasi.
strWithin Peraturan ini akan dipadankan jika mana-mana pembolehubah bermula dengan nilai beroperasi.
strMatch Peraturan ini akan dipadankan jika mana-mana pembolehubah padan dengan nilai beroperasi. Operasi ini boleh menjadi senarai rentetan yang dibahagikan dengan aksara **
strEq Peraturan ini akan dipadankan jika mana-mana pembolehubah adalah sama dengan nilai beroperasi.
strRegex Peraturan ini akan dipadankan jika mana-mana pembolehubah perlawanan dalam ungkapan biasa yang digunakan dalam beroperasi.
Struktur Peraturan ini akan dipadankan jika mana-mana pembolehubah perlawanan dalam mana-mana nilai senarai beroperasi.
strPhrasesFromFile Ia sama dengan pengendali Struktur tetapi beroperasi adalah fail di mana ia ditakrifkan sebagai senarai frasa.
intEQ Peraturan ini akan dipadankan jika mana-mana pembolehubah sama dengan nombor yang digunakan dalam beroperasi.
intGE Peraturan ini akan dipadankan jika mana-mana pembolehubah adalah lebih besar atau sama dengan nombor yang digunakan dalam beroperasi.
intGT Peraturan ini akan dipadankan jika mana-mana pembolehubah adalah lebih besar daripada nombor yang digunakan beroperasi.
intLE Peraturan ini akan dipadankan jika mana-mana pembolehubah adalah lebih rendah atau sama dengan nombor yang digunakan beroperasi.
intlt Peraturan ini akan dipadankan jika mana-mana pembolehubah adalah lebih rendah daripada nombor yang digunakan beroperasi.
detectSQLi Ia menggunakan pengesanan suntikan SQL ke senarai pembolehubah. Pengendali ini tidak mengharapkan apa-apa beroperasi.
detectXSS Ia menggunakan pengesanan suntikan XSS ke dalam senarai pembolehubah. Pengendali ini tidak mengharapkan apa-apa beroperasi.
ipMatch Cuba sepadan dengan segmen IP atau rangkaian beroperasi dengan senarai pembolehubah.
ipMatchFromFile Ia adalah sama dengan operator ipMatch, tetapi ini cuba perlawanan dari pembolehubah terhadap fail dengan senarai IP dan segmen rangkaian.
validateByteRange Ia memeriksa bahawa bilangan bait daripada pembolehubah berada dalam salah satu beroperasi nilai-nilai. Contoh untuk beroperasi adalah "10, 13, 32-126".
validateUrlEncoding Ia mengesahkan data yang dikodkan. Pengendali ini mesti digunakan hanya untuk data yang tidak menyandikan data biasa atau untuk data dikodkan beberapa kali.
validateUtf8Encoding Ia mengesahkan itu pembolehubah adalah UTF-8. Pengendali ini tidak mengharapkan apa-apa beroperasi.
sahkanCreditCard Ia mengesahkan jika pembolehubah adalah nombor kad kredit. Parameter ini menerima ungkapan biasa sebagai beroperasi, jika ia padanya maka ia menggunakan pengesahan kad kredit.
verifikasiSSN Ia mengesahkan jika pembolehubah adalah Nombor Keselamatan Sosial AS. Parameter ini menerima ungkapan biasa sebagai beroperasi, jika ia padanya maka ia terpakai mengesahkan SSN.
matchAllways Ia kembali selalu, memaksa perlawanan.
matchNever Ia kembali palsu selalu, memaksa perlawanan.

Transformasi

Transformasi digunakan untuk pembolehubah sebelum menyemak operator.

Transformasi diterapkan dalam susunan yang sama apabila ia muncul.

Urus niaga yang ada ialah:

base64Decode, sqlHexDecode, base64DecodeExt, base64Encode, CmdLine, compressWhitespace, cssDecode, escapeSeqDecode, hexDecode, hexEncode, htmlEntityDecode, jsDecode, panjang, huruf kecil, md5, none, normalisePath, normalizePath, normalisePathWin, normalizePathWin, parityEven7bit, parityOdd7bit, parityZero7bit, removeNulls, removeWhitespace, menggantikanComments, removeCommentsChar, removeComments, replaceNulls, urlDecode, huruf besar, urlDecodeUni, urlEncode, utf8toUnicode, sha1, trimLeft, trimRight dan trim

Pembolehubah

Pembolehubah boleh menyimpan satu set pemboleh ubah yang berkaitan, contohnya, ARGS boleh diperluas dan mendapatkan pemboleh ubah tertentu. Adalah mungkin untuk menggunakan, sebagai contoh, ARGS: parameter, untuk mengembangkan ARGS berubah dan mendapatkan nilai parameter yang ditetapkan oleh ARGS.

Menggunakan pengendali & dengan pembolehubah, pembolehubah akan mengembalikan bilangan parameter yang telah disimpan.

Menggunakan pengendali !, pembolehubah ini dikecualikan untuk perlawanan.

Pembolehubah Deskripsi
ARGS Ia adalah koleksi dengan nilai-nilai hujah dalam permintaan.
ARGS_JSON Ia adalah koleksi dengan nilai hujah dalam permintaan JSON. Pembolehubah ini akan tersedia dalam kes yang WAF memaparkan hujah-hujah JSON, untuk itu, peraturan ditetapkan PERMINTAAN-901-INITIALISASI perlu diaktifkan.
ARGS_COMBINED_SIZE jumlah saiz parameter permintaan. Fail dikecualikan.
ARGS_NAMES Ia adalah koleksi dengan nama-nama hujah dalam permintaan.
FILES Ia mengandungi nama fail dalam sistem fail pengguna. Hanya apabila data adalah berbilang / data bentuk.
FILES_COMBINED_SIZE Ia adalah jumlah saiz fail dalam permintaan. Hanya apabila data adalah berbilang / data bentuk.
FILES_NAMES Ia adalah senarai nama fail yang digunakan untuk memuat naik fail. Hanya apabila data adalah berbilang / data bentuk.
FILES_SIZES Ia mengandungi senarai saiz fail individu. Hanya apabila data adalah berbilang / data bentuk.
REQBODY_ERROR Pembolehubah ini adalah 1 jika format badan permintaan tidak betul untuk JSON atau XML, tetapi ia mempunyai nilai 0.
REQUEST_BODY Ia adalah permintaan badan mentah. Jika permintaan itu tidak mempunyai header "aplikasi / x-www-form-urlencoded", adalah perlu menggunakan "ctl: forceRequestBodyVariable" dalam fasa REQUEST_HEADER.
REQUEST_BODY_LENGTH Ia adalah bilangan bait dari badan permintaan.
REQUEST_COOKIES Ia adalah senarai semua nilai kuki permintaan.
REQUEST_COOKIES_NAMES Ia adalah senarai dengan semua nama kuki permintaan.
REQUEST_HEADERS Pembolehubah ini mempunyai semua tajuk permintaan.
REQUEST_HEADERS_NAMES Pembolehubah ini mempunyai senarai dengan nama tajuk permintaan.
REQUEST_METHOD Ia adalah kaedah permintaan.
REQUEST_PROTOCOL Pembolehubah ini memegang protokol versi HTTP permintaan.
REQUEST_URI Ini adalah laluan permintaan URI. Hos maya dikecualikan.
PATH_INFO Ia adalah maklumat sebelum laluan URI.
FULL_REQUEST Ia adalah permintaan penuh.
FULL_REQUEST_LENGTH Ia adalah bilangan bait yang boleh dipenuhi.
RESPONSE_BODY Ia adalah tindak balas badan mentah.
RESPONSE_CONTENT_LENGTH Ia adalah bilangan bait badan tindak balas.
RESPONSE_HEADERS Pembolehubah ini mempunyai semua tajuk tindak balas.
RESPONSE_HEADERS_NAMES Pembolehubah ini mempunyai senarai dengan nama tajuk tindak balas.
RESPONSE_PROTOCOL Pembolehubah ini memegang protokol versi HTTP respon.
RESPONSE_STATUS Ia adalah kod HTTP tindak balas.
REMOTE_ADDR Ia adalah alamat IP pelanggan.
REMOTE_PORT Ia adalah pelabuhan di mana pelanggan memulakan sambungan.
REMOTE_USER Ia adalah nama pengguna yang disahkan.
MASA Ia adalah masa pelayan. Formatnya ialah jam: minit: saat.
DURATION Ia adalah bilangan milisaat sejak permulaan transaksi semasa.
MULTIPART_FILENAME Ia adalah nama fail medan dalam permintaan berbilang.
MULTIPART_NAME Ia adalah nama medan dalam permintaan berbilang.
MATCHED_VAR Ia adalah nilai yang sepadan dalam operasi perlawanan terakhir. Nilai ini tidak memerlukan menangkap pilihan tetapi ia digantikan dalam setiap operasi perlawanan.
MATCHED_VARS Ia adalah senarai semua nilai yang dipadankan.
SERVER_ADDR Ia adalah alamat IP pelayan.
SERVER_NAME Ia adalah tuan rumah maya, ia mendapat dari permintaan URI.
ENV Ia adalah pembolehubah persekitaran WAF.
TX Ia adalah kumpulan pembolehubah bagi transaksi semasa. Pembolehubah ini akan dikeluarkan apabila transaksi berakhir. Pembolehubah TX: 0-TX: 9 menyimpan nilai yang ditangkap dengan operator strRegex atau strPhrases.

Senaraikan set peraturan WAF

Senaraikan set peraturan WAF

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf
zcli ipds-waf list

GET /ipds/waf

Dapatkan senarai peraturan WAF dari pengimbang beban.

Contoh tindak balas:

{
          "params" : [
                        {
                          "farms" : [],
                          "status" : "down",
                          "name" : "REQUEST-901-INITIALIZATION"
                        },
                        {
                          "name" : "REQUEST-903-9001-DRUPAL-EXCLUSION-RULES",
                          "status" : "down",
                          "farms" : []
                        },
                        {
                          "status" : "down",
                          "name" : "REQUEST-903-9002-WORDPRESS-EXCLUSION-RULES",
                          "farms" : []
                        },
                        {
                          "name" : "REQUEST-903-9003-NEXTCLOUD-EXCLUSION-RULES",
                          "status" : "down",
                          "farms" : []
                        }
                      ],
          "description" : "List the WAF sets"
}

Parameter tindak balas

Bidang Jenis Deskripsi
nama Rentetan Ia adalah nama peraturan, ia digunakan sebagai pengecam set peraturan yang unik.
status Rentetan Ia menunjukkan status peraturan yang ditetapkan. Nilai yang dikembalikan mungkin ialah turun, peraturan ditetapkan dilumpuhkan; atau up, peraturan ditetapkan diaktifkan, ia berfungsi menyekat atau membenarkan mengikut resolusi parameter.
ladang Tali[] Ia adalah senarai nama ladang. Mereka semua ladang dikaitkan dengan peraturan.

Mendapatkan peraturan WAF

Ambil peraturan peraturan WAF

Permintaan contoh:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori
zcli ipds-waf get test_waf_ori

GET /ipds/waf/<name>

Tunjukkan konfigurasi WAF dan peraturannya.

. nama Parameter URI adalah pengecam unik WAF.

Contoh tindak balas:

{
          "params" : {
                        "rules" : [
                                     {
                                       "audit" : "",
                                       "id" : "0",
                                       "log" : "",
                                       "modified" : "yes",
                                       "resolution" : "pass",
                                       "description" : "The ID is 0",
                                       "phase" : 1,
                                       "raw" : "SecRule TX:sampling_rnd100 \"@rx ^0([0-9])\" \"id:1003,phase:1,pass\"",
                                       "tag" : [],
                                       "rule_id" : "1003",
                                       "execute" : "",
                                       "matches" : [
                                                      {
                                                        "transformations" : [],
                                                        "capture" : "false",
                                                        "match_index" : 0,
                                                        "multi_match" : "false",
                                                        "not_match" : "false",
                                                        "operator" : "strRegex",
                                                        "operating" : "^0([0-9])",
                                                        "variables" : [
                                                                         "TX:sampling_rnd100"
                                                                       ]
                                                      }
                                                    ],
                                       "redirect_url" : "",
                                       "skip" : 0,
                                       "type" : "action",
                                       "skip_after" : ""
                                     },
                                     {
                                       "skip_after" : "",
                                       "type" : "action",
                                       "skip" : 0,
                                       "redirect_url" : "",
                                       "matches" : [
                                                      {
                                                        "transformations" : [
                                                                               "none"
                                                                             ],
                                                        "capture" : "false",
                                                        "match_index" : 0,
                                                        "multi_match" : "false",
                                                        "not_match" : "false",
                                                        "operating" : "GET",
                                                        "operator" : "strEq",
                                                        "variables" : [
                                                                         "REQUEST_METHOD"
                                                                       ]
                                                      }
                                                    ],
                                       "execute" : "",
                                       "rule_id" : "9001185",
                                       "tag" : [],
                                       "raw" : "SecRule REQUEST_METHOD \"@streq GET\" \"id:9001185,phase:1,t:none,pass,nolog,noauditlog\"",
                                       "phase" : 1,
                                       "description" : "The ID is 1",
                                       "resolution" : "pass",
                                       "modified" : "yes",
                                       "id" : "1",
                                       "log" : "false",
                                       "audit" : "false"
                                     },
                                     {
                                       "skip_after" : "12",
                                       "type" : "action",
                                       "skip" : "1",
                                       "redirect_url" : "",
                                       "matches" : [],
                                       "execute" : "",
                                       "rule_id" : "200",
                                       "raw" : "SecAction \"\\
    id:200,\\
    msg:\'Rule to modify the another one\',\\
    tag:testing 2,\\
    tag:Api tests 2,\\
    phase:4,\\
    deny,\\
    noauditlog,\\
    skip:1,\\
    skipAfter:12\"",
                                       "tag" : [
                                                  "testing 2",
                                                  "Api tests 2"
                                                ],
                                       "phase" : 4,
                                       "description" : "Rule to modify the another one",
                                       "resolution" : "deny",
                                       "modified" : "yes",
                                       "id" : 2,
                                       "log" : "",
                                       "audit" : "false"
                                     },
                                     {
                                       "type" : "action",
                                       "skip_after" : "",
                                       "matches" : [
                                                      {
                                                        "not_match" : "false",
                                                        "multi_match" : "false",
                                                        "operator" : "strRegex",
                                                        "operating" : "@ ",
                                                        "variables" : [
                                                                         "REQUEST_COOKIES:/S?SESS[a-f0-9]+/"
                                                                       ],
                                                        "transformations" : [],
                                                        "capture" : "false",
                                                        "match_index" : 0
                                                      }
                                                    ],
                                       "redirect_url" : "",
                                       "skip" : 0,
                                       "rule_id" : "9001187",
                                       "execute" : "",
                                       "raw