Zevenet API v4.0 viide
ZAPI (Zisegi APplication Pprogrammeerimine Interface) on süsteemi administraatorite tööriist Zevenet'i koormuse tasakaalustaja käitumise juhtimiseks.
Enne selle kasutamist on vaja root zapi kasutaja aktiivne aktiveerida, Süsteem> Kasutajad.
Kui ZAPI kasutaja on loodud, on võimalik saata päringuid HTTP-serverisse. URI-päring näeb välja:
HTTP verb https://zevenet_server: 444 / zapi / v4.0 / zapi.cgi /URI_path,
kus zevenet_server on IP, kus HTTP teenus kuulab, HTTP hallata liides ja URI_path määratleb soovitud objekti. Iga dokumentatsiooni sektsioonis määratletakse, kuidas iga Zevenet objekti pääseda ja kuidas seda muuta.
. HTTP verbs ZAPI jaoks aktsepteeritud on:
GET, kasutatakse elementide loendi saamiseks või objekti allalaadimiseks.
POST, kasutatakse uute objektide loomiseks, süsteemi objekti muutmiseks (objektid, mida admin ei ole loonud) ja tegevuste rakendamiseks.
PUT, kasutatakse administraatori loodud olemasoleva objekti muutmiseks.
Kustuta, kasutatakse administraatori loodud objekti eemaldamiseks ja mõnel juhul konfiguratsiooni (liideste puhul) lähtestamiseks.
ZAPI parameetrid
ZAPI parameetrid
Päringu näide:
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 ja POST taotlused vajavad alati peaaegu parameetrit, kuigi ZAPI-kõne ei vaja (kohustuslikku) parameetrit. Kui PUT- või POST-päring saadetakse ilma parameetriteta, tagastab ZAPI eeldatavate parameetrite nimekirja ja nende võimalikud valikud.
Vastuse näide:
{
"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"
]
}
]
}
Vastuse parameetrid
Vastus on väljade loend, mis kirjeldab parameetrit ja võimalikke seadistusvõimalusi:
Parameetri kirjeldus:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | On võti aktsepteeritud väärtuseni. Selle määratlemiseks kasutatakse järgmisi parameetreid. |
| kirjeldus | nöör | See on teave eeldatava väärtuse kohta. |
| intervall | nöör | Parameetril peab olema arvuline väärtus, mis vastab madalale, kõrgele või mõlemale piirile. Piiridena kasutatavad väärtused loetakse kehtivateks. |
| formaat | nöör | See võib olla aimatav parameetri eeldatava formaadiga, see võib olla regulaaravaldis või võti, mis identifitseerib andmeid. |
| võimalikud väärtused | String [] | See on võimalike väärtuste loend, mis parameetril peab olema. |
| valikuid | String [] | See näitab rohkem konfiguratsiooni, mida meeles pidada. |
Valikute loend:
| Väli | Kirjeldus |
|---|---|
| nõutav | See valik näitab, et parameeter on kohustuslik, see tuleb saata taotluses. |
| mitte_blank | See valik võimaldab saata tühi string parameetri väärtuseks. Parameetri tühistamine võib olla kasulik. |
Veakoodid
ZAPI võib vastata ühele järgmistest veakoodidest:
| Veakood | Lühike | Kirjeldus |
|---|---|---|
| 400 | Halb päring | Mõned päringu parameetrid on valed. |
| 401 | Loata | Teie ZAPI võti on vale. |
| 402 | Sertifikaat ei kehti | Koormuse tasakaalustaja vajab taotluse töötlemiseks kehtivat sertifikaati. |
| 403 | Keelatud | ZAPI-klahvi kasutaja omanik ei oma päringu või selles kasutatava objekti õigusi. |
| 404 | ei leitud | Kasutatav URI või üks kõnes kasutatud objekt ei ole olemas. |
| 405 | Meetod ei ole lubatud | HTTP verbi ei eksisteeri või seda ei rakendata praeguse ZAPI kõne jaoks. |
| 406 | Ei ole vastuvõetav | See funktsioon ei ole ajaliselt kättesaadav. |
| 409 | Konflikt | Taotlus on kehtiv, kuid seda ei saanud töödelda, kuna uus konfiguratsioon tekitas vastuolu praeguse konfiguratsiooniga. Syslog võib pakkuda rohkem teavet. |
| 410 | Möödas | See funktsioon on eemaldatud. |
| 500 | Sisemine serveri viga | Serveris ilmnes viga. |
| 504 | Gateway Timeout | Serveri vastuse ajalõpp on saavutatud ja päringut ei ole töödeldud. |
Muudab logi
See on igas versioonis sisalduvate muudatuste loend. ZAPI versioonis olevate muudatuste loend on alati varem mainitud.
API 4.0.2
See ZAPI versioon on versiooni 4.0.1 laiendus. Mõni parameeter ja URI lisati, kuid mõni neist eemaldati.
- VPN
Uus VPN-moodul:
Lisatud GET|POST|PUT|DELETE /vpns/*
- HTTP/S-farmid
Uued parameetrid:
errorWAF, asukoha ümberkirjutamine (lisatud uued valikud ainult zproxy jaoks), ümberkirjutamine, kinnitatud ühendus, marsruutimise poliitika, ühenduse_piirang:
Muudetud: GET|PUT /farms/<farmname>. Muudetud: GET|PUT /farms/<farmname>/services/<id>.
Uued API-d ümberkirjutamise URL-i lisamiseks:
Lisatud ADD|DELETE /farms/<farmname>/service/<servicename>/rewriteurl/*
Uued API-d päiste ümberkirjutamise reeglite lisamiseks:
Lisatud ADD|DELETE /farms/MyHttpFarm/replacerequestheader/*
Lisatud ADD|DELETE /farms/MyHttpFarm/replaceresponseheader/*
Lisatud taotlused staatiliste seansside haldamiseks (ainult zproxy):
Lisatud GET|POST|DELETE /farms/<farmname>/services/<servicename>/sessions/*
- Farmguardian
Lisatud parameeter timeout:
Muudetud: GET /monitoring/fg/<name>. Muudetud: POST|PUT /monitoring/fg.
- SSH
Konfigureerige mitu IP-d ja porti:
Uuendatud ADD|POST /system/ssh, aktsepteerige kuulamis- ja pordiparameetrites massiive.
- HTTP server:
Konfigureerige cherokee serveri jaoks mitu IP-d ja porti:
Uuendatud ADD|POST /system/http, aktsepteerige nüüd IP- ja pordiparameetrite massiive.
Seadistage serveri sertifikaat:
Lisatud GET|POST /system/https/certificate.
- Statistika:
Lisatud parameetrid kokku_seansse ja ttl:
Muudetud: GET /stats/farms/<farmname>
- Globaalne konfiguratsioon:
Lisatud parameeter waf_assistent:
Uuendatud GET|POST /system/global
- rsyslog
Uued rsyslogi API-d logide konfigureerimiseks nende kaugserverisse saatmiseks:
Lisatud: GET|POST|DELETE /system/rsyslog.
- Klaster:
Lisatud parameeter raja_liides:
Muudetud: GET|PUT /system/cluster.
API 4.0.1
See ZAPI versioon on versiooni 4.0 laiendus. Mõni parameeter ja URI lisati, kuid mõni neist eemaldati.
- ID-d
Lisage taotlus puu näitamiseks koos kõigi koormusbalansi objektidega
Lisage: GET / id
- Põllumajandusettevõtted
Võimalus talu kopeerida
Muudetud: POST /farms
- HTTP talud
Lisage parameetrid lisavastuspea ja eemalda vastajaotsik ja laiendage parameetrit httpverb:
Uuendatud GET /farms/<farmname>
Uuendatud PUT /farms/<farmname>
lisama POST /farms/<farmname>/addresponseheader|removeresponseheader
lisama DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>
- L4xNAT Talud
Lisage staatiliste seansside haldamise taotlusi:
lisama GET /farms/<farmname>/sessions
lisama POST /farms/<farmname>/sessions
lisama DELETE /farms/<farmname>/sessions/<session>
- Networking
Uus suunamismoodul:
Lisatud GET|POST|PUT|DELETE /routing/*
- Järelevalve
Farmguardian saab kontrollimiseks hostinimena kasutada taustaprogrammi pseudonüümi:
Lisatud GET|PUT /monitoring/fg*/<farmguardian>
- IPDS
WAF-i reeglite failide haldamine:
Lisatud GET|PUT|DELETE /ipds/waf/files
- süsteem
Hankige süsteemiteavet:
Lisatud: GET /system/info
Muudetud globaalsed seaded:
Lisatud: GET|POST /system/global
- RBAC
Autentimine LDAP-i abil:
Lisatud GET|POST /rbac/services
Lisatud GET|POST /rbac/ldap*
Uuendatud GET|POST /rbac/users
Uuendatud GET|PUT /rbac/users/<user>
API 4.0
- HTTP talud
Loetlege moodulile rühmitatud talude ja teenuste kokkuvõte:
Lisatud: /farms/modules/summary
Toimingud WAF-reeglite kogumi sidumiseks HTTP-taludega:
Lisatud: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*
Muudetud: GET /farms/<farm>
Sertifikaatide teisaldamine HTTPSi taludes:
Lisatud: POST /farms/<farm>/certificates/<cert>/actions
- L4xNAT Talud
Muuda l4xnat'iga seotud põllumajandusettevõtete kõnet uue tuuma toetamiseks:
Muudetud: GET|POST|PUT|DELETE /farms/<l4farm>
- võrk
Lisatud on DHCP ja MAC ZAPI-kõnede funktsioonid:
muudetud: PUT /interfaces/nic/<if>
muudetud: PUT /interfaces/bonding/<if>
muudetud: POST /interfaces/vlan
muudetud: PUT /interfaces/vlan/<if>
- Järelevalve
Parameetri ümbernimetamine talu eestkostja kopeerimiseks:
Muudetud: POST /monitoring/fg
- IPDS
IPDS-paketi haldamine:
Lisatud: GET /ipds/package
Lisatud: POST /ipds/package/actions
Uus veebirakenduse tulemüür, WAF, funktsioon:
Lisatud: GET|POST|PUT|DELETE /ipds/waf/*
Eemaldage kõne RBL-reeglite kopeerimiseks. Nüüd on see loomise kõne parameeter:
eemaldatud: POST /ipds/rbl/<name>
muudetud: POST /ipds/waf/<name>
- süsteem
Funktsioonid tehaseseadete taastamine, volikiri ja kontrollige pakettide värskendusi on lisatud:
Lisatud: POST /system/factory
Lisatud: GET /system/proxy
Lisatud: POST /system/proxy
Lisatud: GET /system/packages
- RBAC
Lisage parameeter veebi GUI menüüde haldamiseks:
Lisatud: GET /rbac/menus
Muudetud: PUT /rbac/roles/<ROLE>
Aktiveerimissertifikaadid
Aktiveerimissertifikaat on Zevenet'i väljastatud litsents, mis võimaldab koormuse tasakaalustaja täielikku kasutamist oma ettevõtte versioonis.
Kuva aktiveerimissertifikaadi andmed
Kuva aktiveerimissertifikaadi andmed
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation
GET /certificates/activation
Näita kõiki aktiveerimissertifikaadis sisalduvaid andmeid, sealhulgas allkirju, see sertifikaat salvestatakse sertifikaatide salvestisse. Kui aktiveerimissertifikaat kustutatakse, lülitub toode välja.
Laadige aktiveerimissertifikaat üles
Laadige aktiveerimissertifikaat üles
Päringu näide:
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
Laadige PEM-vormingus aktiveerimissertifikaat üles, see sertifikaat on vajalik kõigi funktsioonide lubamiseks. See sertifikaat salvestatakse sertifikaatide salvestisse, kui sertifikaatide poes on aktiveerimissertifikaat, siis eelmine sertifikaat kirjutatakse üle.
Vastuse näide:
{
"description" : "Upload activation certificate",
"message" : "Activation certificate uploaded",
"success" : "true"
}
Aktiveerimissertifikaadi kustutamine
Aktiveerimissertifikaadi kustutamine
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation
DELETE /certificates/activation
Kustutage sertifikaatide kauplusesse installitud aktiveerimissertifikaat. Kui see sertifikaat kustutatakse, lülitatakse koormuse tasakaalustaja välja.
Vastuse näide:
{
"description" : "Delete activation certificate",
"message" : "The activation certificate has been deleted",
"success" : "true"
}
SSL sertifikaadid
Zevenet toetab PEM-vormingus sertifikaate, et kasutada neid HTTPS-kuulajaga loodud HTTP-taludega. Kui soovite rohkem luua, kuidas luua Pem sertifikaadid, külastage järgmist artiklit: PEM FORMATIS TUNNISTATUD SERTIFIKAADID
Loetlege kõik sertifikaadid
Loetlege kõik sertifikaadid
Päringu näide:
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
Loetlege sertifikaatide poes kõik CSR- ja PEM-sertifikaadid, neid sertifikaate saab kasutada HTTPS-i põllumajandusettevõtetega.
Vastuse näide:
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on sertifikaatobjektide massiiv, millest igaüks sisaldab allpool toodud võtmes atribuute.
{
"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"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| CN | nöör | Domeeni tavapärane nimi. |
| loomine | nöör | Loomise kuupäev. |
| aegumine | nöör | Aegumiskuupäev. |
| fail | nöör | See on sertifikaadi failinimi, unikaalne ID. |
| emitent | nöör | Sertifitseeritud asutus, kes allkirjastab sertifikaadi. |
| tüüp | nöör | CSR või sertifikaat. |
Lae sertifikaadi
Lae sertifikaadi
Päringu näide:
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>
Laadige sertifikaatide kauplusesse installitud sertifikaat alla, kasutage failinime selle identifitseerimiseks.
Vastuse päised:
Vastus sisaldab allpool toodud päiseid koos teabega faili kohta. Vastuse sisu on faili sisu.
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
Näita sertifikaadi üksikasju
Näita sertifikaadi üksikasju
Päringu näide:
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
Näita kogu sertifikaadi talletuses olevas sertifikaadis sisalduvat teavet, sealhulgas allkirju, on vaja viidata failinimele.
Vastuse näide:
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:
...
Sertifikaadi kustutamine
Sertifikaadi kustutamine
Päringu näide:
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>
Sertifikaatide poes kustutage sertifikaat failinime järgi.
Vastuse näide:
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
Looge PEM-sertifikaat
Looge PEM-sertifikaat
Päringu näide:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"host.domain.com","key":"-----BEGIN PRIVATE KEY-----\nRTQwew...",
"ca","-----BEGIN CERTIFICATE-----\nFQOEW...","intermediates":"-----BEGIN CERTIFICATE-----\nQWESw..."}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/pem
zcli certificate-pem create -name host.domain.com -key "-----BEGIN PRIVATE KEY..." -ca "-----BEGIN CERTIFICATE..." -intermediates "-----BEGIN CERTIFICATE..."
"
POST /certificates/pem
Looge PEM-sertifikaat (PEM-fail).
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | Sertifikaadi ID nimi. | tõsi |
| võti | nöör | Krüpteeritud privaatvõti puudub | tõsi |
| ca | nöör | Serveri sertifikaat või täisahela sertifikaat | tõsi |
| vaheained | nöör | Vajadusel kesktaseme tunnistused | vale |
Vastuse näide:
{
"description" : "Create certificate",
"message" : "Certificate host.domain.com created",
"success" : "true"
}
Looge CSR-sertifikaat
Looge CSR-sertifikaat
Päringu näide:
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
Loo sertifikaadi allkirjastamise taotlus (CSR-fail).
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | Sertifikaadi ID nimi. | tõsi |
| fqdn | nöör | Teie serveri täielikult kvalifitseeritud domeeninimi. | tõsi |
| jaotus | nöör | Sertifikaadiga tegelev organisatsiooni jaotus. | tõsi |
| organisatsioon | nöör | Teie organisatsiooni juriidiline nimi. | tõsi |
| asukoht | nöör | Linn, kus asub teie organisatsioon. | tõsi |
| riik | nöör | Riik / piirkond, kus teie organisatsioon asub. | tõsi |
| riik | nöör | Selle riigi kahekohaline ISO kood, kus teie organisatsioon on lokaliseeritud. | tõsi |
| post | nöör | E-posti aadress, mida kasutatakse teie organisatsiooni poole pöördumiseks. | tõsi |
Vastuse näide:
{
"description" : "Create CSR",
"message" : "Certificate NewCSR created",
"success" : "true"
}
Laadige sertifikaat üles
Laadige sertifikaat üles
Päringu näide:
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>
Laadige üles HTMPS-kuulajaga HTTP-põllumajandusettevõtete PEM-sertifikaat.
URI parameetrite taotlemine
Nõuab parameetrit --tcp-nodelayja --data-binary faili üleslaadimiseks binaarrežiimis.
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| fail | nöör | Sertifikaadi salvestamiseks sertifikaadifaili nimi. | tõsi |
Vastuse näide:
{
"description" : "Upload PEM certificate",
"message" : "Certificate uploaded",
"success" : "true"
}
Nimekiri Ciphers
Nimekiri Ciphers
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ciphers
GET /ciphers
Loetlege HTTPSi talu poolt kasutatavad šifrid.
. SSL-i mahalaadimine Sümbol on saadaval ainult siis, kui protsessor seda toetab.
Vastuse näide:
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on sertifikaatobjektide massiiv, millest igaüks sisaldab allpool toodud võtmes atribuute.
{
"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"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaadi objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| salakirjad | nöör | Seda kasutatakse kordumatu identifikaatorina. |
| kirjeldus | nöör | Sõbralik nimi. |
Letsencrypt SSL-sertifikaadid
Zevenet toetab Letsencrypti sertifikaatide genereerimist ja uuendamist. Viimane sertifikaat on ZEVENET PEM sertifikaat, mida saab kasutada HTTPS Farmidega. . Kui soovite luua lisateavet Pem sertifikaadid, külastage järgmist artiklit: PEM FORMATIS TUNNISTATUD SERTIFIKAADID
Näita Letsencrypt Config
Näita Letsencrypt Config
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificate-le-config list
GET /certificates/letsencryptz/config
Näita Letsencrypti konfiguratsiooni.
Vastuse näide:
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
{
"description" : "Get LetsEncrypt Config",
"params" : {
"email" : "test_le@zevenet.com"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nöör | Letsencrypti e-kiri |
Muutke Letsencrypt Config
Muutke Letsencrypt Config
Päringu näide:
curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"email":"test_le@zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificates-le-config set -email test_le@zevenet.com
PUT /certificates/letsencryptz/config
Muutke Letsencrypti konfiguratsiooni.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nöör | Meil Letsencrypti kontaktina kasutamiseks | tõsi |
Vastuse näide:
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
{
"description" : "Modify LetsEncrypt Config",
"message" : "The Letsencrypt Config has been updated successfully.",
"params" : {
"email" : "test_le@zevenet.com"
},
"success" : "true"
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nöör | Letsencrypti e-kiri |
Loetlege kõik Letsencrypti sertifikaadid
Loetlege kõik Letsencrypti sertifikaadid
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le list
GET /certificates/letsencryptz
Loetlege kõik loodud Letsencrypti sertifikaadid.
Vastuse näide:
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on letsencrypti sertifikaadiobjektide massiiv, millest igaüks sisaldab allolevaid võtmeatribuute.
{
"description" : "List LetsEncrypt certificates",
"params" : [
{
"CN" : "*.wildcard.test.zevenet.com",
"creation" : "May 31 05:51:49 2021 GMT",
"domains" : [
"*.wildcard.test.zevenet.com"
],
"expiration" : "Aug 29 05:51:49 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/acme/*.wildcard.test.zevenet.com/fullchain.cer",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "true"
},
{
"CN" : "*.test1.wildcard.test.zevenet.io",
"creation" : "",
"dnstxt" : [
{
"domain" : "*.test1.wildcard.test.zevenet.io",
"txt" : "QpbOLzMrJapoQmcbrA5_dr6ciwLzNF-y3z5XR5i-I2c"
}
],
"domains" : [
"*.test1.wildcard.test.zevenet.io"
],
"expiration" : "",
"file" : null,
"issuer" : "",
"status" : "not issued",
"type" : "LE Certificate",
"wildcard" : "true"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| CN | nöör | Domeeni tavapärane nimi. |
| loomine | nöör | Loomise kuupäev. |
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. |
| aegumine | nöör | Aegumiskuupäev. |
| dnstxt | Objekt [] | Iga domeeni DNS-i TXT-kirjete loend, mida tuleb kontrollida, kui sertifikaati pole veel välja antud. |
| fail | nöör | See on sertifikaadi failinimi, unikaalne ID. |
| emitent | nöör | Sertifitseeritud asutus, kes allkirjastab sertifikaadi. |
| staatus | nöör | Sertifikaadi olek.kehtiv,sertifikaat kehtib.aegumas, sertifikaat hakkab aeguma.lõppenud, sertifikaat on aegunud.välja andmata, ootab tunnistuse väljastamist.tundmatu, sertifikaat ei kehti. |
| tüüp | nöör | LE sertifikaat. |
| metamärk | nöör | tõsi, on sertifikaat metamärkide domeenide jaoks. vale, on sertifikaat mitte metamärke sisaldavate domeenide jaoks. |
dnstxt objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| domeen | nöör | Domeeninimi |
| txt | nöör | DNS-i txt-kirje LetsEncrypt peab kinnitamiseks. DNS-i TXT-kirjele pääseb juurde domeenis _acme-challenge.domain. |
Krüpteerime SSL metamärgi sertifikaadid
Metamärgi krüptimise sertifikaadid on sertifikaadid, mis kehtivad ainult metamärgi domeenide jaoks.
Looge uus Let's Encrypt Wildcardi sertifikaat
Looge uus Let's Encrypt Wildcardi sertifikaat
Päringu näide:
url -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"domains":["*.wildcard.test.zevenet.com"],"test":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard
zcli certificate-le-wildcard create -wildcard true
POST /certificates/letsencryptz-wildcard
Looge uus Let's Encrypt metamärgisertifikaat.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. | tõsi |
| test | nöör | tõsi, sertifikaadi väljastab LetsEncrypt Staging Server. vale, sertifikaadi väljastab LetsEncrypt Server ja see kehtib tootmiskeskkonnas. | tõsi |
Vastuse näide:
{
"description" : "Create Let's Encrypt Wildcard certificate",
"params" : [
{
"CN" : "*.wildcard.test.zevenet.com",
"creation" : "",
"dnstxt" : [
{
"domain" : "*.wildcard.test.zevenet.com",
"txt" : "jtt2WBHXl0cRw33mgoHUo1hbFGLipNbeb2EtTWpRORM"
}
],
"domains" : [
"*.wildcard.test.zevenet.com"
],
"expiration" : "",
"file" : null,
"issuer" : "",
"status" : "not issued",
"type" : "LE Certificate",
"wildcard" : "true"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| CN | nöör | Domeeni tavapärane nimi. |
| loomine | nöör | Loomise kuupäev. |
| dnstxt | Objekt [] | Iga domeeni DNS-i TXT-kirjete loend, mida tuleb kontrollida, kui sertifikaati pole veel välja antud. |
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. |
| aegumine | nöör | Aegumiskuupäev. |
| fail | nöör | See on sertifikaadi failinimi, unikaalne ID. |
| emitent | nöör | Sertifitseeritud asutus, kes allkirjastab sertifikaadi. |
| staatus | nöör | Sertifikaadi olek.kehtiv,sertifikaat kehtib.aegumas, sertifikaat hakkab aeguma.lõppenud, sertifikaat on aegunud.välja andmata, ootab tunnistuse väljastamist.tundmatu, sertifikaat ei kehti. |
| tüüp | nöör | LE sertifikaat. |
| metamärk | nöör | tõsi, on sertifikaat metamärkide domeenide jaoks. vale, on sertifikaat mitte metamärke sisaldavate domeenide jaoks. |
dnstxt objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| domeen | nöör | Domeeninimi |
| txt | nöör | DNS-i txt-kirje LetsEncrypt peab kinnitamiseks. DNS-i TXT-kirjele pääseb juurde domeenis _acme-challenge.domain. |
Määrake toiming krüptime metamärgi sertifikaadis
Määrake toiming krüptime metamärgi sertifikaadis
Päringu näide:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com/actions
zcli certificate-le-wildcard renew *.example.domain.com
POST /certificates/letsencryptz-wildcard/<domain>/actions
Rakendage toiming sertifikaadile Let's Encrypt, vaadake toimingute kohta parameetrite taotlemise tabelit.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| meetmete | nöör | Rakendatav tegevus, võimalused on järgmised: uuendama, sertifikaat uuendatakse; test dns-i txt-kirjeid kontrollitakse dns-päringu kaudu. | |
| jõu_uuendamine | nöör | (Ainult "uuendamise" toimingu jaoks) tõsi, sunnib sertifikaati uuendama, isegi kui see ei ole aegunud, vale, sertifikaati uuendatakse, kui seda tuleb uuendada (kehtivusaeg on vähem kui 30 päeva). | |
| restart | nöör | (Ainult "uuendamise" toimingu jaoks) tõsi, taaskäivitatakse kõik sertifikaati kasutavad farmid. vale, ei taaskäivitata ühtegi sertifikaati kasutavat talu. | |
| DNS | nöör | (Ainult "test" toimingu jaoks) DNS-server, mida kasutatakse DNS-i TXT-kirje _acme-challenge.domain testimiseks. |
Vastuse näide:
{
"description" : "Let's Encrypt wildcard certificate actions",
"message" : "The action renew has been performed in Let's Encrypt certificate *.test1.wildcard.test.zevenet.io.",
"params" : {
"action" : "renew",
"status" : "valid"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tegevus | nöör | Loomise kuupäev. |
| staatus | nöör | Sertifikaadi olek.kehtiv,sertifikaat kehtib.aegumas, sertifikaat hakkab aeguma.lõppenud, sertifikaat on aegunud.välja andmata, ootab tunnistuse väljastamist.tundmatu, sertifikaat ei kehti. |
| dnstxt | Objekt [] | (Ainult "test" toimingu jaoks) Iga domeeni DNS-i TXT-kirjete loend ja nende DNS-päringu tulemused DNS-serveri kaudu. |
dnstxt objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| DNS | nöör | Kasutatav DNS-server. "tühi" tähendab süsteemis konfigureeritud andmete kasutamist. |
| domeen | nöör | Domeeninimi |
| ressurss | objekt | Kontrollitav DNS-ressurss. |
| staatus | nöör | DNS-i TXT-kirje kontrollimise tulemus DNS-serveri kaudu. alla kui DNS TXT re |
juhet ei leitud DNS-serverit. up kui leitakse DNS TXT kirje.
ressursi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| rname | nöör | DNS-i ressursi nimi. Let's Encrypt nõuab _acme-väljakutse |
| tüüp | nöör | DNS-kirje tüüp. Let's Encrypt nõuab TXT |
| rdata | nöör | DNS-i kirje väärtus. |
Kustutage metamärk Krüptigem sertifikaat
Kustutage metamärk Krüptigem sertifikaat
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com
zcli certificate-le-wildcard delete *.example.domain.com
DELETE /certificates/letsencryptz-wildcard/<domain>
Kustutage Let's Encrypt metamärgiga sertifikaat domeeni järgi.
Vastuse näide:
{
"description" : "Delete Let's Encrypt wildcard certificate",
"message" : "Let's Encrypt wildcard Certificate example.domain.com has been deleted.",
"success" : "true"
}
Krüpteerime SSL-i metamärkideta sertifikaate
Let'sEncrypt ilma metamärgita sertifikaadid on sertifikaadid, mis kehtivad ainult metamärgita domeenide jaoks.
Looge uus Let'sEncrypt ilma metamärkideta sertifikaat
Looge uus sertifikaat ilma metamärkideta krüptimiseta
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"lefarm","domains":["test.zevenet.com"],"test":"true","wildcard":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le create -wildcard false
POST /certificates/letsencryptz
Looge uus Let's Encrypt metamärgisertifikaat.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| farmname | nöör | Farmi nimi, milles on konfigureeritud ajutine teenus "Let's Encryptz". | tõene, kui param vip ei saadeta. |
| vip | nöör | Süsteemi IP, kus on konfigureeritud ajutine talu "Let's Encryptz". | tõene, kui param talunime ei saadeta. |
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. | tõsi |
| metamärk | nöör | tõsi, on sertifikaat metamärkide domeenide jaoks. vale, on sertifikaat mitte metamärke sisaldavate domeenide jaoks. | tõsi |
| test | nöör | tõsi, sertifikaadi väljastab LetsEncrypt Staging Server. vale, sertifikaadi väljastab LetsEncrypt Server ja see kehtib tootmiskeskkonnas. | tõsi |
Vastuse näide:
{
"description" : "Create Let's Encrypt certificate",
"params" : {
"CN" : "test.zevenet.com",
"creation" : "May 31 11:05:30 2021 GMT",
"domains" : [
"test.zevenet.io"
],
"expiration" : "Aug 29 11:05:30 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "false"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| CN | nöör | Domeeni tavapärane nimi. |
| loomine | nöör | Loomise kuupäev. |
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. |
| aegumine | nöör | Aegumiskuupäev. |
| fail | nöör | See on sertifikaadi failinimi, unikaalne ID. |
| emitent | nöör | Sertifitseeritud asutus, kes allkirjastab sertifikaadi. |
| staatus | nöör | Sertifikaadi olek.kehtiv,sertifikaat kehtib.aegumas, sertifikaat hakkab aeguma.lõppenud, sertifikaat on aegunud.välja andmata, ootab tunnistuse väljastamist.tundmatu, sertifikaat ei kehti. |
| tüüp | nöör | LE sertifikaat. |
| metamärk | nöör | tõsi, on sertifikaat metamärkide domeenide jaoks. vale, on sertifikaat mitte metamärke sisaldavate domeenide jaoks. |
Määrake toiming metamärgita krüptimise sertifikaadis
Määrake toiming metamärgita krüptimiseta sertifikaadis
Päringu näide:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","vip":"192.168.101.44","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com/actions
zcli certificate-le renew example.domain.com ( not implemented )
POST /certificates/letsencryptz/<domain>/actions
Määrake toiming metamärgita krüptimise serdis, toimingute kohta vaadake parameetrite taotlemise tabelit.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Teostav toiming: võimalused on järgmised: uuendama, sertifikaati uuendatakse. | |
| farmname | nöör | Farmi nimi, mille jaoks on sertifikaadi uuendamiseks konfigureeritud ajutine teenus “Let’s Encryptz”. | tõene, kui param vip ei saadeta. |
| vip | nöör | Süsteemi IP, kus sertifikaadi uuendamiseks on seadistatud ajutine talu "Let's Encryptz". | tõene, kui param talunime ei saadeta. |
| jõu_uuendamine | nöör | tõsi, sunnib sertifikaati uuendama, isegi kui see ei ole aegunud, vale, sertifikaati uuendatakse, kui seda tuleb uuendada (kehtivusaeg on vähem kui 30 päeva). | |
| restart | nöör | tõsi, taaskäivitatakse kõik sertifikaati kasutavad farmid. vale, ei taaskäivitata ühtegi sertifikaati kasutavat talu. |
Vastuse näide:
{
"description" : "Let's Encrypt certificate actions",
"params" : {
"CN" : "test.zevenet.com",
"creation" : "May 31 11:35:08 2021 GMT",
"domains" : [
"test.zevenet.com"
],
"expiration" : "Aug 29 11:35:08 2021 GMT",
"file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
"issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
"status" : "valid",
"type" : "LE Certificate",
"wildcard" : "false"
},
"warning" : "The following farms were been restarted: testl7farm"
}
Vastuse parameetrid
Kui are-farmid taaskäivitati, siis hoiatus väli kirjeldab seda.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| parameetrid | Objekt [] | Sertifikaatide objektide loend. |
Sertifikaadi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| CN | nöör | Domeeni tavapärane nimi. |
| loomine | nöör | Loomise kuupäev. |
| Domeenid | String [] | Domeenide loend, mille jaoks sertifikaat kehtib. |
| aegumine | nöör | Aegumiskuupäev. |
| fail | nöör | See on sertifikaadi failinimi, unikaalne ID. |
| emitent | nöör | Sertifitseeritud asutus, kes allkirjastab sertifikaadi. |
| staatus | nöör | Sertifikaadi olek.kehtiv,sertifikaat kehtib.aegumas, sertifikaat hakkab aeguma.lõppenud, sertifikaat on aegunud.välja andmata, ootab tunnistuse väljastamist.tundmatu, sertifikaat ei kehti. |
| tüüp | nöör | LE sertifikaat. |
| metamärk | nöör | tõsi, on sertifikaat metamärkide domeenide jaoks. vale, on sertifikaat mitte metamärke sisaldavate domeenide jaoks. |
Kustutage metamärki kasutamata Krüptigem sertifikaat
Kustutage metamärki kasutamata Krüptigem sertifikaat
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com
zcli certificate-le delete example.domain.com
DELETE /certificates/letsencryptz/<domain>
Kustutage Let's Encrypt sertifikaat domeeni järgi.
Vastuse näide:
{
"description" : "Delete Let's Encrypt certificate",
"message" : "Let's Encrypt Certificate example.domain.com has been deleted.",
"success" : "true"
}
Põllumajandusettevõtted
Zevenet suudab hallata liiklust kolmel erineval viisil, iga teed haldab erinev moodul, kohaliku teenuse koormuse tasakaalustaja või LSLB moodul, globaalse teenuse koormuse tasakaalustaja või GSLB moodul ja Datalink teenuse koormuse tasakaalustaja või DSLB moodul.
Kõik moodulid töötavad farmiprofiili kontseptsiooniga, põllumajandusprofiil on grupp parameetreid, mis on valmis konkreetse toimingu tegemiseks võrguliiklusega, on oluline mõista, mida iga põllumajandusprofiil võimaldab Zevenet ADC parima tulemuse saamiseks.
- LSLB: see moodul töötab http ja l4xnat profiilifarmid. See toimib veebi tagasipööratud proksina või ruuterina
- GSLB: see moodul töötab gslb profiili talu. See toimib domeeninimede serverina
- DSLB: see moodul töötab andmelink profiili talu. See toimib lüüsi.
Loetlege põllumajandusettevõtete kokkuvõte
Loetlege koondfarmid
Päringu näide:
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
Loetlege süsteemi süsteemide kokkuvõte, mis on rühmitatud moodulite kaupa.
Vastuse näide:
{
"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"
}
]
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on nende talumajapidamiste arv.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| farmname | nöör | Talu kirjeldav nimi. Seda kasutatakse põllumajandusettevõtete ainulaadse identifikaatorina. |
| profiil | nöör | Profiili tüüp, profiili olemasolevad väärtused on järgmised: http, https or l4xnat LSLB mooduli jaoks gslb GLSB mooduli ja andmelink DSLB mooduli jaoks |
| teenus | String [] | See on talumajapidamises sisalduvate teenuste loetelu. See väli on saadaval tüübi kasvandustes http, httpsja gslb. |
Loetlege kõik talud
Loetlege kõik talud
Päringu näide:
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
Loetlege kõik olemasolevad talud
Vastuse näide:
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on põllumajandusettevõtete jätkamise objektide massiivi, millest igaüks sisaldab allpool toodud võtme atribuute.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| farmname | nöör | Talu kirjeldav nimi. Seda kasutatakse põllumajandusettevõtete ainulaadse identifikaatorina. |
| profiil | nöör | Profiili tüüp, profiili olemasolevad väärtused on järgmised: http, https or l4xnat LSLB mooduli jaoks gslb GLSB mooduli ja andmelink DSLB mooduli jaoks. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| vip | nöör | Virtuaalne IP, kus talu võtab liiklust vastu. |
| vport | nöör | Virtuaalne sadam, kus farm võtab liiklust, on pordi saadaolevad väärtused: pordi number profiilide [s], l4xnat ja gslb jaoks, pordide rühm, mis on eraldatud tähega „,” või pordivahemik, mis on eraldatud tähisega „:” l4xnati profiilide jaoks, l4xnat saab mõlemal eraldaja väärtusel (“,” ja “:”) kasutada samal väljal. |
Talu eemaldamine
Talu eemaldamine
Päringu näide:
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>
Kustuta põllumajandusettevõte oma ettevõtte nime identifikaatori kaudu.
Vastuse näide:
{
"description" : "Delete farm FarmHTTP",
"message" : "The Farm FarmHTTP has been deleted.",
"success" : "true"
}
Tehke tegevus talus
Tehke tegevus talus
Päringu näide:
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
Rakenda põllumajandusettevõttele toimingut, vaadake tegevuste tabeli Taotluse parameetrid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tegevus | nöör | Rakendatav tegevus, võimalused on järgmised: peatus, talu peatatakse, lõigatakse praegused ühendused ja ei aktsepteeri rohkem ühendusi; algus, alustatakse talu, juhitakse kuulajat ja tasakaalustatakse uusi ühendusi selle taustaprogrammide vahel; restart, talu peatatakse ja käivitatakse automaatselt. |
Vastuse näide:
{
"description" : "Set a new action in FarmHTTP",
"params" : [
{
"action" : "stop"
}
]
}
Vastuse parameetrid
Kui konfiguratsioonis puuduvad probleemid, tagastab ZAPI soovitud toimingu.
HTTP talud
HTTP-profiil on täiustatud kihi 7 koormuse tasakaalustamine (või rakenduse kohaletoimetamise kontroller), millel on proxy-spetsiifilised omadused. See profiil pakub mõningaid funktsioone, nagu HTTPSi koormuse tasakaalustamine koos SSL-i koormuse kiirendamisega. See profiil on piisav veebiteenustele (kaasa arvatud veebirakendusserverid) ja kõikidele rakenduste protokollidele, mis põhinevad HTTP- ja HTTPS-protokollidel, nagu WebDav, RDP HTTP-l, ICA-l HTTP-ga jne. Selle põllumajandusprofiili, virtuaalse IP-aadressi ja virtuaalse TCP konfigureerimiseks sadamasse.
Too talu nime järgi
Too talu nime järgi
Päringu näide:
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>
Näita kõiki antud talu konfiguratsioone.
Vastuse näide:
{
"description" : "List farm httpFarm",
"ipds" : {
"blacklists" : [
{
"name" : "outside",
"status" : "down"
}
],
"dos" : [],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
],
"waf" : [
{
"name" : "XSSi",
"status" : "down"
},
{
"name" : "SQLi",
"status" : "up"
}
]
},
"params" : {
"addheader" : [
{
"header" : "load-balancer: true",
"id" : 0
}
],
"addresponseheader" : [
{
"header" : "Session: true",
"id" : 0
}
],
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"errorWAF" : "The request was rejected by the server.",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"headremove" : [
{
"id" : 0,
"pattern" : "^client"
}
],
"httpverb" : "MSRPCext",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "false",
"removeresponseheader" : [
{
"id" : 0,
"pattern" : "Host"
}
],
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : "check_tcp",
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"redirect" : "http://192.168.101.254/index.html",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
{
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"priority" : null
}
],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"farmguardian" : null,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
]
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ipds | objekt | Selle talu IPDS-reeglite loetelu. |
| parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
| teenused | Objekt [] | Koostage kõik selles talus loodud teenused ja selle konfiguratsioon. |
IPDS-objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| mustad nimekirjad | Objekt [] | Põllumajandusettevõtte suhtes kohaldatakse musta nimekirja reegleid. |
| dos | Objekt [] | Põllumajandusettevõtte suhtes kohaldatavad DoS-reeglid. |
| rbl | Objekt [] | Põllumajandusettevõtte suhtes kohaldatakse RBL-eeskirju. |
| WAF | Objekt [] | See on ühe võtmega objekt, nimi. |
Must nimekiri, DoS ja RBL objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Reegli nimi. |
| staatus | nöör | Reegli olek. |
HTTP-põllumajandusettevõtete parameetrite objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| addheader | Objekt [] | See on objektide loend koos päistega, mida lisada kliendi päringule. |
| Adresponseheader (alates 4.0.1) | Objekt [] | See on objektide loend päistega, mida taustaprogrammi vastusele lisada. |
| certlist | Objekt [] | Ainult siis, kui kuulaja on HTTPS. Sertifikaatide loendit kasutas põllumajandusettevõte, kellel on PEM-vormingus, on lubatud lisada rohkem kui üks PEM-sertifikaat samale ettevõttele SNI-toe saamiseks. Siin võib kasutada kõiki sertifikaatide poe sertifikaate. |
| cipherc | nöör | Ainult https kuulaja. See on lubatud krüpteeringute loend, mida SSL-ühendus aktsepteerib ja mis on string, mis on samas formaadis kui OpenSSL-i šifreerides. Seda atribuuti kasutatakse ainult siis, kui salakirjad väljal on väärtus „tolliturvalisus“. |
| salakirjad | nöör | Ainult siis, kui kuulaja on HTTPS. Kasutatakse SSL-ühenduste poolt SSL-ühenduse tugevdamiseks aktsepteeritud krüptide loendi koostamiseks. Valikud on järgmised: kõik, kõik šifrid aktsepteeritakse; kõrge turvalisusaktsepteeritakse ainult kõrge turvalisusega šifreid; tollikindlust, laaditakse ainult šifrid cipherc valdkonnas aktsepteeritakse; või ssloffloadingSee annab krüpteerimistöö protsessile, see kood sõltub protsessorist. |
| contimeout | Number | Kui kaua talu ootab TCP ühendus backendiga sekundites. |
| disable_sslv2 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi 2i versiooniga SSL-turvaprotokolli kasutavad ühendused ei ole lubatud; või vale kui protokoll SSLv2 on lubatud. |
| disable_sslv3 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi 3i versiooniga SSL-turvaprotokolli kasutavad ühendused ei ole lubatud; või vale kui protokoll SSLv3 on lubatud. |
| disable_tlsv1 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1, ei ole lubatud; või vale kui protokoll TLSv1 on lubatud. |
| disable_tlsv1_1 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1.1, ei ole lubatud; või vale kui protokoll TLSv1.1 on lubatud. |
| disable_tlsv1_2 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1.2, ei ole lubatud; või vale kui protokoll TLSv1.2 on lubatud. |
| errorWAF | nöör | Isikupärastatud sõnum vastamiseks, kui WAF päringu tagasi lükkab (alates 4.0.2). |
| error414 | nöör | Isikupärastatud sõnum, mis vastab 414i HTTP-veakoodile. |
| error500 | nöör | Isikupärastatud sõnum, mis vastab 500i HTTP-veakoodile. |
| error501 | nöör | Isikupärastatud sõnum, mis vastab 501i HTTP-veakoodile. |
| error503 | nöör | Isikupärastatud sõnum, mis vastab 503i HTTP-veakoodile. |
| headremove | Objekt [] | See on regulaaravaldiste loend, mille abil kliendi soovidest päised eemaldada. Eemaldatud päised ei jõua taustaprogrammi. |
| httpverb | nöör | See väli näitab operatsioone, mis lubatakse HTTP-kliendi taotlustele. saadaolevad väärtused on: standardHTTP, aktsepteeritud HTTP päringud GET, POST, HEAD. expandHTTP, aktsepteeritud eelmised HTTP päringud pluss PUT, DELETE. võimalusedHTTP (alates 4.0.1), lisage verb OPTIONS eelmistele. standardWebDAV, aktsepteeritud eelmised HTTP päringud pluss LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV aktsepteeritud eelmised HTTP-päringud ja SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT või MSRPCext, aktsepteerisid eelmised HTTP päringud pluss RPC_IN_DATA, RPC_OUT_DATA. Pange tähele, et need väärtused on tõstutundlikud. |
| ignore_100_continue | nöör | Kui sellel väljal on väärtus tõsi the,en 100 jätkub HTTP päist ignoreeritakse; kui väärtus on vale, 100 jätkub päist töödeldakse. |
| kuulaja | nöör | Kuulaja määrab kindlaks, kuidas talu kliendi soovidega mängib. Valikud on järgmised: http turvatud protokolli või https turvatud protokolli jaoks. |
| logisid | nöör | Talu logib HTTP-ühenduste jälgi. Kui selle parameetri väärtus on tõsi, logid on lubatud; kui sellel on väärtus vale, logid on keelatud. |
| eemalda vastajaotsik (alates 4.0.1) | Objekt [] | See on regulaarväljendite loetelu päiste eemaldamiseks taustavastusest. Eemaldatud päised ei jõua kliendini. |
| reqtimeout | Number | Kui kaua talu ootab kliendi soov sekundites. |
| restimeout | Number | Kui kaua talu ootab vastupidi vastuseid sekundites. |
| ülestõusmisaeg | Number | Aeg langenud reaalsest serverist välja, pärast seda perioodi kontrollib koormuse tasakaalustaja, kas reaalne server on elus, sekundites. |
| ümberkirjutamine | Objekt [] | Kui see on lubatud, on talumaja kohustatud muutma asukoha ja sisu asukohta: päised vastustes virtuaalserveriga klientidele. Valikud on järgmised: lubatud, aktiveeritud blokeeritud, inaktiveeritud või lubatud taustad võrreldakse ainult taustaprogrammi. Alates 4.0.2 uued valikud saadaval: lubatud-tee ja enabled-backends-path. tee rakendub, kui direktiiv RewriteUrl muutis päringu URL-i. See lipp sunnib tühistama URL-i teisenduse, mille RewriteUrl tegi. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | Number | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
Certlisti objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| fail | nöör | Sertifikaadi nimi, sertifikaadipoe sertifikaadi viited. |
| id | Number | Sertifikaadi ID: loendis esimest järjekorda kasutatakse vaikimisi, kui virtuaalse hosti päis ei ühti sertifikaadi CN-väljaga. Kasutatakse SNI jaoks. |
HTTP objektide teenuste objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Teenuses määratletud taustaprogrammid. |
| cookiedomain | nöör | Prääniku sisestamine toimub siis, kui domeen sobib küpsise sisuga. Luba cookieinsert on vaja. |
| cookieinsert | nöör | See võimaldab küpsiste sisestamist taustaprogrammide kleepuvate seansside jaoks. Valikud on järgmised tõsi, otsib profiil antud küpsisest välja cookiename, kui seda pole, lisatakse see küpsis, vale, ei võeta midagi ette. |
| cookiename | nöör | Küpsise nime (seansi ID) kasutatakse kleepuva protsessi identifitseerimiseks taustaprogrammidena. Luba cookieinsert on vaja. |
| cookiepath | nöör | See haldab antud küpsise küpsise tee väärtust. Luba cookieinsert on vaja. |
| cookiettl | Number | See on küpsise maksimaalne eluaeg sekundites. Luba cookieinsert on vaja. |
| talupoeg | nöör | See on FarmGuardian nimi, mis kontrollib taustaprogrammi olekut. FarmGuardian töötab samal ajal, kui talu seisab. |
| httpsb | nöör | See parameeter näitab põllumajandusettevõttele, et taustaprogrammid on määratud kasutama HTTPS-i keelt ja seejärel krüpteeritakse andmed enne saatmist. tõsi, saadab profiil HTTPS-protokolli liikluse taustaprogrammidele, vale, saadab profiil HTTP protokolli liikluse taustaprogrammidele. |
| id | nöör | Teenuse nimi, seda ei saa pärast teenuse loomist muuta. |
| hüpata | nöör | See võimaldab kõige vähem vastamise tasakaalustamise meetodit. tõsi Sageli kontrollib profiil, millise taustaprogrammi reageerimine võtab vähem aega, et saata sellele ühendusele rohkemat ühendust vale profiil ei kontrolli, millisele taustaprogrammile reageerimiseks kulub vähem aega. |
| püsivus | nöör | See parameeter määrab kindlaks, kuidas HTTP-teenust kliendi seansi hallata. Valikud on järgmised: "" tühi string, midagi ei võeta, IP püsivus istung toimub kliendi IP baasil, BASIC püsivus istung toimub BASICi päiste baasil, URL püsivuse seanss toimub URI-s oleva välja alusel; PARM püsivusseanss tehakse URI lõpus oleva väärtuse baasil, COOKIE püsivuse seanss toimub küpsise nime alusel, see küpsis peab olema loodud taustaprogrammide poolt ja HEADER, toimub püsivuse seanss päise nime alusel. |
| suunata | nöör | See toimib nagu spetsiaalne taustaprogramm, kuna kliendi soovile vastatakse automaatselt uuele URL-ile. Kui ümbersuunamine on konfigureeritud, siis päringut ei edastata taustaprogrammile, siis suunatakse kliendile ümbersuunamine. |
| redirect_code | Number | Redigeerimise konfigureerimise korral tagastatakse HTTP-kood. Võimalikud väärtused on 301, 302, 307, |
| ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutseks hostiks ja suunamiseks, lisada, lisatakse päringu algne tee või URI vaikesuvandiga määratud hostile ja teele. Kui suunata väli ei ole konfigureeritud, on see väli tühi string. |
| seanss | nöör | See on saadaval, kui püsivus väli on URL, COOKIE või HEADER, parameetri väärtust otsib talu HTTP päises ja haldab kliendi seanssi. |
| sts_status | nöör | Strict Transport Security päise olek. Selle funktsiooni võimaldamiseks on vaja seada talu kuulaja HTTPS. Võimalikud väärtused on: tõsi võimaldada teenuses STS-direktiivi; või vale STS-direktiivi keelamine teenuses. |
| sts_timeout | Number | Aeg (sekundites), mida klient mäletab, et teenus on saadaval ainult HTTSiga. |
| ttl | Number | Ainult püsivusega. See väärtus näitab passiivse kliendi seansi maksimaalset eluaega (maksimaalne seansi vanus) sekundites. |
| urlp | nöör | Võimaldab määrata veebiteenuse seoses URL-iga, mida klient taotleb konkreetse URL-i mustri kaudu, mida süntaktiliselt kontrollitakse. PCRE regulaaravaldist toetatakse. |
| vhost | nöör | See määrab domeeninime poolt kindlaks määratud tingimuse sama virtuaalse IP ja pordi kaudu, mis on määratud HTTP-talu poolt. PCRE regulaaravaldist toetatakse. |
| kinnitatud ühendus (alates versioonist 4.0.2) | Number | Määrake, kas tahame kinnitada kõik ühendused, (vaikimisi: 0, pole kinnitatud). Kui Pinnedconnection on seatud väärtusele 1, edastab zproxy otse kõik andmed ilma sõelumise või redigeerimiseta. |
| marsruutimise poliitika (alates versioonist 4.0.2) | nöör | Määrake marsruutimispoliitika. Kõik algoritmid on kaalutud kõigi igas taustaprogrammis seatud kaaludega. Valikuid on neli: ROUND_ROBIN kasutage marsruutimise poliitikana ringtöö algoritmi (vaikimisi). LEAST_CONNECTIONS vali taustaprogramm, millel on kõige vähem loodud ühendusi, kasutades proportsionaalselt määratud kaalusid. REAKTSIOONIAEG valige madalaima reageerimisajaga taustaprogramm, kasutades proportsionaalselt määratud kaalusid. PENDING_CONNECTIONS vali taustaprogramm, millel on kõige vähem ootel olevaid ühendusi, kasutades proportsionaalselt määratud kaalusid. |
| rewriteurl (alates versioonist 4.0.2) | Objekt [] | See kontrollib mustrit, et saada URL-ist stringe ja need asendada. Lisada saab mitu RewriteUrl-i käsku. Kõik need rakendatakse järjestikku sissetulevale URL-ile, välja arvatud juhul, kui on määratud viimane lipp, mis lõpetab URL-i ümberkirjutamise etapi. |
HTTP-põllumajandusettevõtete taustaprogramm:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Backend-tunnus antud teenuse sees. |
| ip | nöör | Taustaprogrammi IP, kus tõeline teenus töötab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus töötab. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| timeout | Number | See on maksimaalne aeg, mis ootab taustaprogrammi vastust enne kui see pole saadaval. See aeg on sekundites. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus, suurema kaalu väärtusega taustaprogramm saab rohkem ühendusi. Vaikeväärtus null, selle taustaprogrammi jaoks pole kasutatud erikaalu. Võimalikud väärtused on pärit 1 et 9. |
| prioriteet (alates 4.0.1) | Number | (Ainult uue põlvkonna puhverserveri töötamise korral) See on praeguse tegeliku serveri prioriteetne väärtus, madalama prioriteediga taustaprogramm on valmis ühendusi vastu võtma varem kui teised kõrgema prioriteediga serverid. Vaikeväärtus null, prioriteetne väärtus 1 kasutatakse. Võimalikud väärtused on alates 1 et 9 |
| ühenduse_piir (alates 4.0.2) | Number | (Ainult uue põlvkonna puhverserveri töökorras) Maksimaalne loodud ühenduste arv taustaprogrammi kohta. Kui väärtus on 0, siis taustaprogrammis piirangut ei ole. Klient saab tõrketeate 503, kui saadaolevaid taustaprogramme pole. |
Loo uus talu
Loo uus talu
Päringu näide:
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
Looge uus HTTP-talu.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| farmname | nöör | Talu kirjeldav nimi. Seda kasutatakse unikaalse identifikaatorina. | tõsi |
| profiil | nöör | Loodud talu profiil. HTTP talude puhul on http. | tõsi |
| vip | nöör | Selle põllumajandusettevõtte IP, kus virtuaalne teenus käivitub. Näidatud IP peab olema konfigureeritud süsteemis ja UP | tõsi |
| vport | Number | Talu sadam, kus virtuaalne teenus kuulab. Sama virtuaalset pordi ja virtuaalset IP-d ei tohi kasutada teine farm. | tõsi |
| copy_from (alates 4.0.1) | nöör | See parameeter eeldab olemasoleva talu nime. Selle parameetri saatmise korral kopeeritakse farm selles täpsustatud talust. farmname, vip ja vport väärtused kirjutatakse üle. |
Vastuse näide:
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"interface" : "eth0.2",
"farmname" : "newHTTPfarm",
"profile" : "http",
"vip" : "192.168.100.23",
"vport" : 80
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda talu
Muuda talu
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP", "errorWAF":"Message error WAF",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -contimeout 22 -newfarmname FarmHTTP2 -vip 178.62.126.152 -vport 88 -ignore_100_continue true -restimeout 47 -resurrectime 12 -reqtimeout 32 -rewritelocation enabled -httpverb standardHTTP -errorcode414 'Message error 414' -logs true
PUT /farms/<farmname>
Muuda antud HTTP-talu globaalseid parameetreid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| contimeout | Number | Kui kaua talu ootab sekundi jooksul ühendust backendiga. |
| restimeout | Number | Kui kaua talu ootab vastupidi vastuseid sekundites. |
| ülestõusmisaeg | Number | See väärtus sekundites on ajavahemik, et saada välja musta nimekirja kantud taust ja kontrollida, kas see on elus. |
| reqtimeout | Number | Kui kaua talu ootab kliendi soov sekundites. |
| disable_sslv2 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi 2i versiooniga SSL-turvaprotokolli kasutavad ühendused ei ole lubatud; või vale kui protokoll SSLv2 on lubatud. |
| disable_sslv3 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi 3i versiooniga SSL-turvaprotokolli kasutavad ühendused ei ole lubatud; või vale kui protokoll SSLv3 on lubatud. |
| disable_tlsv1 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1, ei ole lubatud; või vale kui protokoll TLSv1 on lubatud. |
| disable_tlsv1_1 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1.1, ei ole lubatud; või vale kui protokoll TLSv1.1 on lubatud. |
| disable_tlsv1_2 | nöör | Ainult https kuulaja. Kui sellel väljal on väärtus tõsi ühendused, mis kasutavad TLS-i turvaprotokolli versiooni 1.2, ei ole lubatud; või vale kui |
| ümberkirjutamine | nöör | Kui see on lubatud, on talumaja kohustatud muutma asukoha ja sisu asukohta: päised vastustes virtuaalserveriga klientidele. Valikud on järgmised: lubatud aktiveeritud; blokeeritud inaktiveeritud; või lubatud taustad võrreldakse ainult taustaprogrammi. |
| httpverb | nöör | See väli näitab operatsioone, mis lubatakse HTTP-kliendi taotlustele. saadaolevad väärtused on: standardHTTP, aktsepteeritud HTTP päringud GET, POST, HEAD. expandHTTP, aktsepteeritud eelmised HTTP päringud pluss PUT, DELETE. võimalusedHTTP (alates 4.0.1), lisage verb OPTIONS eelmistele. standardWebDAV, aktsepteeritud eelmised HTTP päringud pluss LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV aktsepteeritud eelmised HTTP-päringud ja SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT või MSRPCext, aktsepteerisid eelmised HTTP päringud pluss RPC_IN_DATA, RPC_OUT_DATA. Pange tähele, et need väärtused on tõstutundlikud. |
| ignore_100_continue | nöör | Kui sellel väljal on väärtus tõsi the,en 100 jätkub HTTP päist ignoreeritakse; kui väärtus on vale, 100 jätkub päist töödeldakse. |
| errorWAF | nöör | Isikupärastatud sõnumi viga WAF (alates versioonist 4.0.2). |
| error414 | nöör | Isikupärastatud sõnumiviga 414. |
| error500 | nöör | Isikupärastatud sõnumiviga 500. |
| error501 | nöör | Isikupärastatud sõnumiviga 501. |
| error503 | nöör | Isikupärastatud sõnumiviga 503. |
| kuulaja | nöör | Kuulaja määrab kindlaks, kuidas talu kliendi soovidega mängib. Valikud on järgmised: http turvatud protokolli või https turvatud protokolli jaoks. |
| logisid | nöör | Talu logib HTTP-ühenduste jälgi. Kui selle parameetri väärtus on tõsi, logid on lubatud; kui sellel on väärtus vale, logid on keelatud. |
| salakirjad | nöör | Ainult https-väärtusega kuulaja. Kasutatakse SSL-ühenduste poolt aktsepteeritud šifrite loendi koostamiseks, et SSL-ühendust tugevdada. Valikud on järgmised: kõik, kõik šifrid aktsepteeritakse; kõrge turvalisusaktsepteeritakse ainult kõrge turvalisusega šifreid; tollikindlust, laaditakse ainult šifrid cipherc valdkonnas aktsepteeritakse; või ssloffloadingSee annab krüpteerimistöö protsessile, see kood sõltub protsessorist. |
| cipherc | nöör | Ainult https kuulaja. See on lubatud krüpteeringute loend, mida SSL-ühendus aktsepteerib ja mis on string, mis on samas formaadis kui OpenSSL-i šifreerides. Seda atribuuti kasutatakse ainult siis, kui salakirjad väljal on väärtus „tolliturvalisus“. |
| newfarmname | nöör | Uue talu nimi. Talu tuleb lõpetada. |
| vport | Number | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
| vip | nöör | Selle IP-aadress, kus virtuaalne teenus kuulab, peab see IP olema konfigureeritud ja üles ehitatud. |
| sertifitseeritud nimi | nöör | HTTPS-sertifikaat on konfigureeritud |
Vastuse näide:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
"ciphers" : "customsecurity",
"contimeout" : 22,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"errorWAF" : "Message error WAF",
"error414" : "Message error 414",
"error500" : "Message error 500",
"error501" : "Message error 501",
"error503" : "Message error 503",
"httpverb" : "standardHTTP",
"ignore_100_continue" : "true",
"listener" : "https",
"logs" : "true",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Lisage päringule kohandatud päis
Lisage päringule kohandatud päis
Päringu näide:
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
Põllumajandusettevõte lisab päise taustaprogrammi.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | See on string koos päisega, mis saadetakse taustaprogrammile. | tõsi |
Vastuse näide:
{
"description" : "Add addheader directive.",
"message" : "Added a new item to the addheader list",
"status" : "needed restart",
"success" : "true"
}
Muutke ja lisage taotluse reeglile kohandatud päis
Muutke ja lisage taotluse reeglile kohandatud päis
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/id
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"
PUT /farms/<farmname>/addheader/<id>
Põllumajandusettevõte lisab päise taustaprogrammi.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | See on string koos päisega, mis saadetakse taustaprogrammile. | tõsi |
Vastuse näide:
{
"description" : "Modify an addheader directive.",
"message" : "Modified an item from the addheader list",
"success" : "true"
}
Kustutage päringust kohandatud päis
Kustutage päringust kohandatud päis
Päringu näide:
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 on kustutatava lisandmehhanismi indeks.
Vastuse näide:
{
"description" : "Delete addheader directive.",
"message" : "The addheader 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Lisage päringust päringute eemaldamiseks reegel
Lisage päringust päringute eemaldamiseks reegel
Päringu näide:
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
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Add headremove directive.",
"message" : "Added a new item to the headremove list",
"status" : "needed restart",
"success" : "true"
}
Muutke taotluse reeglist päiste eemaldamist
Muutke taotluse reeglist päiste eemaldamist
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/id
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"
PUT /farms/<farmname>/headremove/<id>
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Modify an headremove directive.",
"message" : "Modified an item from the headremove list",
"success" : "true"
}
Kustutage päringust päiste eemaldamiseks reegel
Kustutage päringust päiste eemaldamiseks reegel
Päringu näide:
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 on kustutatava peatoe massiivi indeks.
Vastuse näide:
{
"description" : "Delete headremove directive.",
"message" : "The headremove 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Lisage vastusele kohandatud päis
Lisage vastusele kohandatud päis
Päringu näide:
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
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/addresponseheader
Talu lisab päise taustaprogrammi vastusele.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | See on string koos päisega, mis saadetakse taustaprogrammile. | tõsi |
Vastuse näide:
{
"description" : "Add a header to the backend repsonse.",
"message" : "Added a new header to the backend response",
"status" : "needed restart",
"success" : "true"
}
Muutke ja lisage vastusereeglile kohandatud päis
Muutke ja lisage vastusereeglile kohandatud päis
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/id
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/addresponseheader/<id>
Talu lisab päise taustaprogrammi vastusele.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | See on string koos päisega, mis saadetakse taustaprogrammile. | tõsi |
Vastuse näide:
{
"description" : "Modify an addresponseheader directive.",
"message" : "Modified an item from the addresponseheader list",
"success" : "true"
}
Kustutage vastusest kohandatud päis
Kustutage vastusest kohandatud päis
Päringu näide:
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
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/addresponseheader/<index>
indeks on kustutatava addresponseheader massiivi indeks.
Vastuse näide:
{
"description" : "Delete a header previously added to the backend response.",
"message" : "The header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Päise vastusest eemaldamise reegli lisamine
Päise vastusest eemaldamise reegli lisamine
Päringu näide:
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:"
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/removeresponseheader
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Remove a header from the backend response.",
"message" : "Added a patter to remove reponse headers",
"status" : "needed restart",
"success" : "true"
}
Muutke vastuse päiste eemaldamise reeglit
Muutke vastuse päiste eemaldamise reeglit
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/id
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/removeresponseheader/<id>
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Modify a remove response header directive.",
"message" : "Modified an item from the removeresponseheader list",
"success" : "true"
}
Kustutage päise vastusest eemaldamise reegel
Kustutage päise vastusest eemaldamise reegel
Päringu näide:
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
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/removeresponseheader/<index>
indeks on kustutatava rearealaatoririba indeks.
Vastuse näide:
{
"description" : "Delete a pattern to remove response headers.",
"message" : "The pattern 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Lisage nõudest päiste ümberkirjutamise reegel
Lisage nõudest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/replacerequestheader
Lisage päringu päiste ümberkirjutamiseks reeglid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"status" : "needed restart",
"success" : "true"
}
Päiste ümberkirjutamise muutmine taotluse reeglist
Päiste ümberkirjutamise muutmine taotluse reeglist
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/replacerequestheader/<id>
Lisage päringu päiste ümberkirjutamiseks reeglid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Kustutage nõudest päiste ümberkirjutamise reegel
Kustutage nõudest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/0
zcli farm-replace-request-header remove MyHttpFarm 0
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/replacerequestheader/<index>
indeks on kustutatava requestrequestheaderi massiivi indeks.
Vastuse näide:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Päiste ümberkirjutamise reeglist päringu teisaldamine
Päiste ümberkirjutamise reeglist päringu teisaldamine
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id/actions
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/replacerequestheader/<id>/actions
Teisaldage ReplaceRequest päis.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Uus reegli positsioon | tõsi |
Vastuse näide:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Lisage vastusest päiste ümberkirjutamise reegel
Lisage vastusest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/replaceresponseheader
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"status" : "needed restart",
"success" : "true"
}
Päiste ümberkirjutamise muutmine vastuse reeglist
Päiste ümberkirjutamise muutmine vastuse reeglist
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/replaceresponseheader/<id>
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Kustutage vastusest päiste ümberkirjutamise reegel
Kustutage vastusest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/0
zcli farm-replace-response-header remove MyHttpFarm 0
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/replaceresponseheader/<index>
indeks on kustutatava responseheaderi massiivi indeks.
Vastuse näide:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header 0 was deleted successfully",
"status" : "needed restart",
"success" : "true"
}
Päiste ümberkirjutamise reeglist päringu teisaldamine
Teisaldage vastusereeglist päiste ümberkirjutamine
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/replaceresponseheader/<id>/actions
Teisaldage ReplaceRequest päis.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Uus reegli positsioon | tõsi |
Vastuse näide:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Lisage sertifikaat
Lisage sertifikaat
Päringu näide:
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
Kaasa SNI-loendisse või certlist HTTPS-kuulajaga HTTP-talu massiiv. Kasutatud sertifikaat tuleb süsteemi juba üles laadida, vt Sertifikaadid> Loetlege kõik sertifikaadid saadaval olevate sertifikaatide loend.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| fail | nöör | sertifikaadi faili nimi, eelnevalt tuleb sertifikaat süsteemi üles laadida. | tõsi |
Vastuse näide:
{
"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"
}
Liigutage sertifikaat
Liigutage sertifikaat
Päringu näide:
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 parameeter on sertifikaadifaili nimi, mida liigutatakse.
See funktsioon võimaldab sertifikaate liigutada, et muuta nende kontrollimise järjekorda.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Täisarv | ZAPI-kõne töötlemise ajal on sertifikaadil põllumajandusettevõtte konfiguratsioonis positsioon | tõsi |
Vastuse näide:
{
"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."
}
Sertifikaadi kustutamine
Sertifikaadi kustutamine
Päringu näide:
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>
Kustutage valitud failinimega sertifikaat HTTPS-kuulajaga HTTP-talu certlistist. Sertifikaadi poest sertifikaati ei kustutata.
Vastuse näide:
{
"description" : "Delete farm certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true",
"status": "needed restart"
}
Lisage IPDS-reegel
Lisage IPDS-reegel
Päringu näide:
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>
Rakenda põllumajandusettevõttele must nimekiri, DoS, RBL või WAF reegel.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Unikaalse identifikaatorina kasutatav IPDS-reegli nimi. |
Vastuse näide:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm httpFarm.",
"success" : "true"
}
Teisalda IPDS-reegel
Teisalda IPDS-reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2
POST /farms/<farmname>/ipds/<waf|blacklists>/<name>/actions
IPDS-i teisaldamise reeglid on saadaval ainult WAF-i ja musta nimekirja reeglite jaoks. Seda tüüpi reeglite puhul on oluline järjekord, mida kontrollitakse.
. name URI parameeter on komplekti reeglite nimetus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Täisarv | See on positsioon, mis IPDS-reeglil on farmi konfiguratsioonis, kui ZAPI-kutset töödeldakse | tõsi |
Vastuse näide:
{
"message" : "The rule was moved properly to the position 2.",
"description" : "Move a rule in the set test_waf_ori"
}
Eemaldage IPDS-reegel
Eemaldage IPDS-reegel
Päringu näide:
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>
Eemaldage mustanimekiri, DoS, RBL või WAF reegel antud talust kasutades oma indikaatorit nimi.
Vastuse näide:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm httpFarm.",
"success" : "true"
}
HTTP - Teenused
HTTP-profiili talu teenused pakuvad sisu vahetamise meetodit, et pakkuda mitut eri omaduste, taustaprogrammide või isegi püsivusmeetoditega veebiteenuseid, kasutades mõningaid deterministlikke tingimusi, mida talu tuum kasutab iga kliendi päringu jaoks õige teenuse sobitamiseks. Seda teenuse määratlust kasutab põllumajandusettevõte, et määrata kindlaks taustaprogrammide serverid, mis võiksid kliendile vastuse anda.
Too teenus ID-ga
Too teenus ID-ga
Päringu näide:
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>
Näita kõiki antud teenuse konfiguratsioone.
Vastuse näide:
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null,
"priority" : null,
"connection_limit" : null
},
{
"alias" : "http-server",
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"priority" : null,
"connection_limit" : null
}
],
"cookiedomain" : "zevenet.cpm",
"cookieinsert" : "true",
"cookiename" : "peasocookie",
"cookiepath" : "/patfh",
"cookiettl" : 20,
"farmguardian" : "check_tcp-cut_conns",
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirect_code" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"sts_status" : "false",
"sts_timeout" : 0,
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN",
"replacerequestheader" : [],
"replaceresponseheader" : [],
"addrequestheader" : [],
"addresponseheader" : [],
"removerequestheader" : [],
"removeresponseheader" : [],
"rewriteurl" : [],
"sessions" : []
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
HTTP objektide teenuste objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Teenuses määratletud taustaprogrammid. |
| cookiedomain | nöör | Prääniku sisestamine toimub siis, kui domeen sobib küpsise sisuga. Luba cookieinsert on vaja. |
| cookieinsert | nöör | See võimaldab küpsiste sisestamist taustaprogrammide kleepuvate seansside jaoks. Valikud on järgmised tõsi, otsib profiil antud küpsisest välja cookiename, kui seda pole, lisatakse see küpsis, vale, ei võeta meetmeid. |
| cookiename | nöör | Küpsise nime (seansi ID) kasutatakse kleepuva protsessi identifitseerimiseks taustaprogrammidena. Luba cookieinsert on vaja. |
| cookiepath | nöör | See haldab antud küpsise küpsise tee väärtust. Luba cookieinsert on vaja. |
| cookiettl | Number | See on küpsise maksimaalne eluaeg sekundites. Luba cookieinsert on vaja. |
| talupoeg | nöör | See on FarmGuardian nimi, mis kontrollib taustaprogrammi olekut. FarmGuardian töötab samal ajal, kui talu seisab. |
| httpsb | nöör | See parameeter näitab talule, et taustaprogrammid on konfigureeritud HTTPSi kasutamiseks, siis krüpteeritakse andmed enne saatmist. tõsi, saadab profiil HTTPS-protokolli liikluse taustaprogrammidele, vale, saadab profiil HTTP protokolli liikluse taustaprogrammidele. |
| id | nöör | Teenuse nimi, seda ei saa pärast teenuse loomist muuta. |
| hüpata | nöör | See võimaldab kõige vähem vastamise tasakaalustamise meetodit. tõsi sageli kontrollib profiil, milline taustaprogramm võtab vähem aega, et sellele ühele rohkem ühendust saada, vale profiil ei kontrolli, millisele taustaprogrammile reageerimiseks kulub vähem aega. |
| püsivus | nöör | See parameeter määrab kindlaks, kuidas HTTP-teenust kliendi seansi hallata. Valikud on järgmised: "" tühi string, midagi ei võeta, IP püsivus istung toimub kliendi IP baasil, BASIC püsivus istung toimub BASICi päiste baasil, URL püsivuse seanss toimub URI-s oleva välja alusel; PARM püsivusseanss tehakse URI lõpus oleva väärtuse baasil, COOKIE püsivuse seanss toimub küpsise nime alusel, see küpsis peab olema loodud taustaprogrammide poolt ja HEADER, toimub püsivuse seanss päise nime alusel. |
| suunata | nöör | See toimib nagu spetsiaalne taustaprogramm, kuna kliendi soovile vastatakse automaatselt uuele URL-ile. Kui ümbersuunamine on konfigureeritud, siis päringut ei edastata taustaprogrammile, siis suunatakse kliendile ümbersuunamine. |
| redirect_code | Number | Redigeerimise konfigureerimise korral tagastatakse HTTP-kood. Võimalikud väärtused on 301, 302, 307. |
| ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutseks hostiks ja suunamiseks, lisada, lisatakse algne päringutee või URI teie vaikimisi suvandiga määratud masinale ja teele. Kui suunata väli ei ole konfigureeritud, on see väli tühi string. |
| seanss | nöör | See on saadaval, kui püsivus väli on URL, COOKIE või HEADER, parameetri väärtust otsib talu HTTP päises ja haldab kliendi seanssi. |
| sts_status | nöör | Strict Transport Security päise olek. Selle funktsiooni võimaldamiseks on vaja seada talu kuulaja HTTPS. Võimalikud väärtused on: tõsi võimaldada teenuses STS-direktiivi; või vale STS-direktiivi keelamine teenuses. |
| sts_timeout | Number | Aeg (sekundites), mida klient mäletab, et teenus on saadaval ainult HTTSiga. |
| ttl | Number | Ainult püsivusega. See väärtus näitab passiivse kliendi seansi maksimaalset eluaega (maksimaalne seansi vanus) sekundites. |
| urlp | nöör | Võimaldab määrata veebiteenuse seoses URL-iga, mida klient taotleb konkreetse URL-i mustri kaudu, mida süntaktiliselt kontrollitakse. PCRE regulaaravaldist toetatakse. |
| vhost | nöör | See määrab domeeninime poolt kindlaks määratud tingimuse sama virtuaalse IP ja pordi kaudu, mis on määratud HTTP-talu poolt. PCRE regulaaravaldist toetatakse. |
| kinnitatud ühendus (alates versioonist 4.0.2) | Number | Määrake, kas tahame kinnitada kõik ühendused, (vaikimisi: 0, pole kinnitatud). Kui Pinnedconnection on seatud väärtusele 1, edastab zproxy otse kõik andmed ilma sõelumise või redigeerimiseta. |
| marsruutimise poliitika (alates versioonist 4.0.2) | nöör | Määrake marsruutimispoliitika. Kõik algoritmid on kaalutud kõigi igas taustaprogrammis seatud kaaludega. Valikuid on neli: ROUND_ROBIN kasutage marsruutimise poliitikana ringtöö algoritmi (vaikimisit). LEAST_CONNECTIONS vali taustaprogramm, millel on kõige vähem loodud ühendusi, kasutades proportsionaalselt määratud kaalusid. REAKTSIOONIAEG valige madalaima reageerimisajaga taustaprogramm, kasutades proportsionaalselt määratud kaalusid. PENDING_CONNECTIONS vali taustaprogramm, millel on kõige vähem ootel olevaid ühendusi, kasutades proportsionaalselt määratud kaalusid. |
| asendamistaotluse päis (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv päise soovi korral asendamiseks. Kui päises kattub mitu regexit, rakendub ainult esimene. Asenda päise direktiiv teenustes on kuulaja ees prioriteet. |
| asendusresponseheader (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv vastuseks päise asendamiseks. Kui päises kattub mitu regexit, rakendub ainult esimene. Asenda päise direktiiv teenustes on kuulaja ees prioriteet. |
| aadressi päis (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv, et lisada määratletud päis klientidele edastatavale päringule. Päis lisatakse sõna-sõnalt. |
| Adresponseheader (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv, et lisada klientidele edastatavale vastusele määratletud päis. Päis lisatakse sõna-sõnalt. |
| Removerequestheader (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv, et eemaldada väljuvast päringust teatud päised, taustaprogrammi saadetud päist kliendile ei saadeta. |
| eemalda vastajaotsik (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv, et eemaldada väljuvast vastusest teatud päised, taustaprogrammi saadetud päist kliendile ei saadeta. |
| rewriteurl (alates versioonist 4.0.2) | Objekt [] | Reeglite massiiv Muudab vastustes päiseid Asukoht ja Sisu-asukoht, et näidata päringus saadetud virtuaalset hosti. |
| seansid (alates versioonist 4.0.2) | Objekt [] | Selle farmiteenuse jaoks loodud staatiliste ja dünaamiliste seansside loend. |
HTTP-põllumajandusettevõtete taustaprogramm:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Backend-tunnus antud teenuse sees. |
| ip | nöör | Taustaprogrammi IP, kus tõeline teenus töötab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus töötab. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| timeout | Number | See on maksimaalne aeg, mis ootab backend-vastust enne selle allalaadimist. See aeg on sekundites. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus, suurema kaalu väärtusega taustaprogramm saab rohkem ühendusi. Vaikeväärtus null, selle taustaprogrammi jaoks pole kasutatud erikaalu. Võimalikud väärtused on pärit 1 et 9. |
| prioriteet (alates 4.0.1) | Number | (Ainult uue põlvkonna puhverserveri töötamise korral) See on praeguse tegeliku serveri prioriteetne väärtus, madalama prioriteediga taustaprogramm on valmis ühendusi vastu võtma varem kui teised kõrgema prioriteediga serverid. Vaikeväärtus null, prioriteetne väärtus 1 kasutatakse. Võimalikud väärtused on alates 1 et 9. |
| ühenduse_piir (alates 4.0.2) | Number | (Ainult uue põlvkonna puhverserveri töökorras) Maksimaalne loodud ühenduste arv taustaprogrammi kohta. Kui väärtus on 0, siis taustaprogrammis piirangut ei ole. Klient saab tõrketeate 503, kui saadaolevaid taustaprogramme pole. |
asendada RequestHeader ja asendada ResponseHeader HTTP farmiteenuste objektid:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada. |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada. |
| asendama | nöör | Väärtus vastete asendamiseks. |
addRequestHeader ja addResponseHeader objekt HTTP farmiteenuste jaoks:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada. |
RemoveRequestHeader ja removeResponseHeader objekt HTTP farmiteenuste jaoks:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| muster | nöör | See on regexpiga string, mida kliendi päringutest otsida. Kui mõni päis mustris kattub, siis päis eemaldatakse. |
rewriteUrl objekt HTTP farmiteenuste jaoks:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| muster | nöör | See on string regexpiga, mida otsida URL-ist. Kui url kattub mustris, asendatakse sobitatud tekst. |
| asendama | nöör | See on string sobitatud teksti asendamiseks. |
| viimane | nöör | Õige või vale. Kui on seatud tõene, lõpetab see URL-i ümberkirjutamise etapi. |
HTTP farmiteenuste seansiobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'IP' istung peaks olema IPv4 või IPv6, nt 192.168.42.65; |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss ei ole staatiline. |
Looge uus teenus
Looge uus teenus
Päringu näide:
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
Looge teenus antud HTTP-profiili talus. Selle muudatuse rakendamiseks on talus vaja uuesti käivitada.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| id | nöör | Teenuse nimi, mida kasutatakse kordumatu identifikaatorina. Lubatud on ainult tähtnumbrilised väärtused. | tõsi |
Vastuse näide:
{
"description" : "New service newserv",
"params" : {
"id" : "newserv"
},
"status" : "needed restart"
}
Teenuse muutmine
Teenuse muutmine
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL", "redirect_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true","pinnedconnection":0,"routingpolicy":"ROUND_ROBIN"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -vhost www.mywebserver.com -urlp ^/myapp1$ -persistence URL -redirect_code 302 -redirect http://zenloadbalancer.com -ttl 125 -sessionid sid -sts_status true -sts_timeout 21600000 -pinnedconnection 0 -routingpolicy ROUND_ROBIN
PUT /farms/<farmname>/services/<id>
Muuda HTTP-profiili teenuse parameetreid. id on teenuse kordumatu tunnus, mida muudetakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| vhost | nöör | Määrab domeeninime poolt kindlaks määratud tingimuse sama virtuaalse IP ja pordi kaudu, mis on määratud HTTP-profiili talu poolt. PCRE regulaaravaldist toetatakse. |
| urlp | nöör | Võimaldab määrata veebiteenuse seoses URL-iga, mida klient taotleb konkreetse URL-i mustri kaudu, mida süntaktiliselt kontrollitakse. PCRE regulaaravaldist toetatakse. |
| suunata | nöör | See toimib spetsiaalse taustaprogrammina, kliendi soovile vastatakse automaatselt uuele URL-ile. |
| redirect_code | Number | Redigeerimise konfigureerimise korral tagastatakse HTTP-kood. Võimalikud väärtused on 301, 302, 307, |
| ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutseks hostiks ja suunamiseks, lisada, lisatakse päringu algne tee või URI teie poolt määratud hostile ja teele suunata valdkonnas. See käitumine kehtib ainult siis, kui suunata ei ole tühi väärtus. |
| cookieinsert | nöör | See võimaldab küpsiste sisestamist taustaprogrammide kleepuvate seansside jaoks. Valikud on järgmised tõsi, otsib profiil antud küpsisest välja cookiename, kui seda pole, lisatakse see küpsis, vale, sisestamise küpsis on keelatud. |
| cookiename | nöör | Küpsise nime (seansi ID) kasutatakse kleepuva protsessi identifitseerimiseks taustaprogrammidena. Luba cookieinsert on vaja. |
| cookiedomain | nöör | Prääniku sisestamine toimub siis, kui domeen sobib küpsise sisuga. Luba cookieinsert on vaja. |
| cookiepath | nöör | See haldab antud küpsise küpsise tee väärtust, kui kliendi päringu või taustaprogrammi vastuses olev URI ei ühti küpsise teega, siis küpsise sisestamise püsivuse meetodit ei rakendata. Luba cookieinsert on vaja. |
| cookiettl | Number | See on küpsise maksimaalne eluaeg sekundites. Luba cookieinsert on vaja. |
| püsivus | nöör | See parameeter määrab kindlaks, kuidas HTTP-teenust kliendi seansi hallata. Valikud on järgmised: "" tühi string, midagi ei võeta, IP püsivus istung toimub kliendi IP baasil, BASIC püsivus istung toimub BASICi päiste baasil, URL püsivuse seanss toimub URI-s oleva välja alusel; PARM püsivusseanss toimub väärtuse alusel, mis on eraldatud tähega „;” URI lõpus, COOKIE püsivuse seanss toimub küpsise nime alusel, see küpsis peab olema loodud taustaprogrammide poolt ja HEADER, toimub püsivuse seanss päise nime alusel. |
| ttl | Number | Ainult püsivusega. Inaktiivse kliendi seansi maksimaalne eluaeg (maksimaalne seansi vanus) sekundites. |
| seanss | nöör | See on saadaval, kui püsivus väli on URL, COOKIE or HEADER, otsitakse parameetri väärtust HTTP-päises olev profiil ja see haldab kliendi seanssi. |
| sts_status | nöör | Strict Transport Security päise olek. Selle funktsiooni võimaldamiseks on vaja seada talu kuulaja HTTPS. Võimalikud väärtused on: tõsi võimaldada teenuses STS-direktiivi; või vale STS-direktiivi keelamine teenuses. |
| sts_timeout | Number | Aeg (sekundites), mida klient mäletab, et teenus on saadaval ainult HTTSiga. |
| hüpata | nöör | See võimaldab kõige vähem vastamise tasakaalustamise meetodit. tõsisageli kontrollib profiil, milline taustaprogramm võtab vähem aega, et sellele ühele rohkem ühendust saada, vale, profiil ei kontrolli, millisele taustaprogrammile reageerimiseks kulub vähem aega. |
| httpsb | nöör | See näitab talule, et taustserverid on seatud HTTPS-i kasutamiseks, seejärel krüpteeritakse andmed enne saatmist. tõsi, saadab profiil HTTPS-protokolli liikluse taustaprogrammidele, vale, saadab profiil HTTP protokolli liikluse taustaprogrammidele. |
| kinnitatud ühendus (alates versioonist 4.0.2) | Number | Määrake, kas tahame kinnitada kõik ühendused, (vaikimisi: 0, pole kinnitatud). Kui Pinnedconnection on seatud väärtusele 1, edastab zproxy otse kõik andmed ilma sõelumise või redigeerimiseta. |
| marsruutimise poliitika (alates versioonist 4.0.2) | nöör | Määrake marsruutimispoliitika. Kõik algoritmid on kaalutud kõigi igas taustaprogrammis seatud kaaludega. Valikuid on neli: ROUND_ROBIN kasutage marsruutimise poliitikana ringtöö algoritmi (vaikimisi). LEAST_CONNECTIONS vali taustaprogramm, millel on kõige vähem loodud ühendusi, kasutades proportsionaalselt määratud kaalusid. REAKTSIOONIAEG valige madalaima reageerimisajaga taustaprogramm, kasutades proportsionaalselt määratud kaalusid. PENDING_CONNECTIONS vali taustaprogramm, millel on kõige vähem ootel olevaid ühendusi, kasutades proportsionaalselt määratud kaalusid. |
| asukoha ümberkirjutamine (alates versioonist 4.0.2) | nöör | Kui see on lubatud, on talumaja kohustatud muutma asukoha ja sisu asukohta: päised vastustes virtuaalserveriga klientidele. Valikud on järgmised: lubatud, aktiveeritud blokeeritud, inaktiveeritud või lubatud taustad võrreldakse ainult taustaaadressi. Muud saadaolevad valikud: lubatud-tee ja enabled-backends-path. tee rakendub, kui direktiiv RewriteUrl muutis päringu URL-i. See lipp sunnib tühistama URL-i teisenduse, mille RewriteUrl tegi. |
Vastuse näide:
{
"description" : "Modify service newsrv in farm newHTTPfarm",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"params" : {
"backends" : [],
"cookiedomain" : "",
"cookieinsert" : "false",
"cookiename" : "",
"cookiepath" : "",
"cookiettl" : 0,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirect_code" : 302,
"redirecttype" : "default",
"sessionid" : "sid",
"sts_status" : "true",
"sts_timeout" : 21600000,
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetritega uuendatud JSON ja staatus põllu praeguse olekuga. Kui talu muudatuste rakendamiseks on vaja uuesti käivitada, on väärtus järgmine vaja uuesti taaskäivitada.
Lisa FarmGuardian
Lisa FarmGuardian
Päringu näide:
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
Rakenda teenusele FarmGuardian.
URI parameeter on teenuse kordumatu tunnus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | FarmGuardian kordumatu tunnus. FarmGuardians luuakse ja muudetakse seirealas. |
Vastuse näide:
{
"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"
}
Eemaldage FarmGuardian
Eemaldage FarmGuardian
Päringu näide:
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>
Eemaldage FarmGuardian talu teenusest.
Vastuse näide:
{
"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"
}
Teisalda teenused
Teisalda teenused
Päringu näide:
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
See tegevus liigutab antud teenust Teenuse loendis üles või alla, see valik on kasulik, kui on vaja muuta prioriteedijärjekorda, märkida, et teenuseid hinnatakse samas järjekorras, nagu on näidatud. see toiming taaskäivitab talu automaatselt.
id on teenuse kordumatu tunnus, mida muudetakse.
Päringu parameetrid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Asukoht, kus teenus on. Esimesel positsioonil on indeks 0. | tõsi |
Vastuse näide:
{
"description" : "Move service",
"message" : "service1 was moved successful.",
"params" : {
"position" : 0
}
}
Teenuse kustutamine
Teenuse kustutamine
Päringu näide:
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>
HTTP-profiili teatud teenuse kustutamine. id on teenuse kordumatu tunnus, mis kustutatakse.
Vastuse näide:
{
"description" : "Delete service service1 in farm FarmHTTP",
"message" : "The service service1 in farm FarmHTTP has been deleted.",
"success" : "true",
"status": "needed restart"
}
Lisage nõudest päiste ümberkirjutamise reegel
Lisage nõudest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/service/<servicename>/replacerequestheader
Lisage päringu päiste ümberkirjutamiseks reeglid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header"
}
Päiste ümberkirjutamise muutmine taotluse reeglist
Päiste ümberkirjutamise muutmine taotluse reeglist
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>
Muutke päringu päiste ümberkirjutamise reeglit.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Modify replaceHeader directive.",
"message" : "Modified an item from the ReplaceHeader list",
"success" : "true"
}
Päiste ümberkirjutamise muutmine taotluse reeglist
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>
Muutke päringu päiste ümberkirjutamise reeglit.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Modify replaceHeader directive.",
"message" : "Modified an item from the ReplaceHeader list",
"success" : "true"
}
Kustutage nõudest päiste ümberkirjutamise reegel
Kustutage nõudest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/Index
zcli farm-service-replacerequestheader remove MyHttpFarm MyService Index
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/service/<servicename>/replacerequestheader/<index>
indeks on kustutatava requestrequestheaderi massiivi indeks.
Vastuse näide:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"success" : "true"
}
Lisage vastusest päiste ümberkirjutamise reegel
Lisage vastusest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/service/<servicename>/replaceresponseheader
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Add a Replace Header.",
"message" : "Added a new replace header",
"success" : "true"
}
Päiste ümberkirjutamise reeglist päringu teisaldamine
Päiste ümberkirjutamise reeglist päringu teisaldamine
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/services/<service>/replacerequestheader/<id>/actions
Teisaldage ReplaceRequest päis.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Uus reegli positsioon | tõsi |
Vastuse näide:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Päiste ümberkirjutamise muutmine vastuse reeglist
Päiste ümberkirjutamise muutmine vastuse reeglist
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/service/<servicename>/replaceresponseheader/<id>
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
| vastama | nöör | Regex väärtus, mis vastab sellele, mida tahame asendada | tõsi |
| asendama | nöör | Väärtus vastete asendamiseks | tõsi |
Vastuse näide:
{
"description" : "Modify a replaceHeader directive.",
"message" : "Modified an item from the replaceHeader list",
"success" : "true"
}
Kustutage vastusest päiste ümberkirjutamise reegel
Kustutage vastusest päiste ümberkirjutamise reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/Index
zcli farm-service-replaceresponseheader remove MyHttpFarm MyService Index
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/service/<servicename>/replaceresponseheader/<index>
indeks on kustutatava responseheaderi massiivi indeks.
Vastuse näide:
{
"description" : "Delete a replace header directive.",
"message" : "The replace header <index> was deleted successfully"
}
Teisaldage vastusereeglist päiste ümberkirjutamine
Teisaldage vastusereeglist päiste ümberkirjutamine
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/services/<service>/replaceresponseheader/<id>/actions
Teisaldage ReplaceRequest päis.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Uus reegli positsioon | tõsi |
Vastuse näide:
{
"description" : "Move a replace header directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Lisage päringule päise lisamiseks reegel
Taotlusele päise lisamiseks lisage reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader
farm-service-addrequestheader add farm1 -header "header: value"
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/addrequestheader
Lisage päringu päiste ümberkirjutamiseks reeglid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
Vastuse näide:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Muutke päringureeglile päise lisamist
Muutke päringureeglile päise lisamist
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/id
farm-service-addrequestheader add farm1 -header "header: value"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/addrequestheader/<id>
Lisage päringu päiste ümberkirjutamiseks reeglid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
Vastuse näide:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Taotlusele päise lisamiseks kustutage reegel
Taotlusele päise lisamiseks kustutage reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/Index
zcli farm-service-addrequestheader remove MyHttpFarm MyService Index
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/addrequestheader/<index>
indeks on kustutatava requestrequestheaderi massiivi indeks.
Vastuse näide:
{
"message": "The add request header <index> has been deleted successfully"
}
Lisage vastusele päise lisamiseks reegel
Lisage vastusele päise lisamiseks reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader
zcli farm-service-addresponseheader add farm1 -header "header: value"
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/addresponseheader
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
Vastuse näide:
{
"description" : "Add a AddHeader.",
"message" : "Added a new add request header",
"success" : "true"
}
Muutke vastusereeglile päise lisamist
Muutke vastusereeglile päise lisamist
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/id
zcli farm-service-addresponseheader add farm1 -header "header: value"
See kõne on saadaval versioonist 4.0.2
PUT /farms/<farmname>/addresponseheader/<id>
Lisage vastuse päiste ümberkirjutamiseks reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| päise kaudu | nöör | Regex koos päise nimega, mis tuleb ümber kirjutada | tõsi |
Vastuse näide:
{
"description" : "Modify an addheader directive.",
"message" : "Modified an item from the addheader list",
"success" : "true"
}
Vastusele päise lisamiseks kustutage reegel
Vastusele päise lisamiseks kustutage reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/Index
zcli farm-service-addresponseheader remove MyHttpFarm MyService Index
See kõne on saadaval versioonist 4.0.2
DELETE /farms/<farmname>/addrequestheader/<index>
indeks on kustutatava responseheaderi massiivi indeks.
Vastuse näide:
{
"message": "The add response header 0 has been deleted successfully"
}
Lisage päringust päringute eemaldamiseks reegel
Lisage päringust päringute eemaldamiseks reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""
POST /farms/<farmname>/service/<servicename>/removerequestheader
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"message": "Added a new remove request header"
}
Muutke reeglit, et eemaldada taotlusest päised
Muutke reeglit, et eemaldada taotlusest päised
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/id
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""
PUT /farms/<farmname>/service/<servicename>/removerequestheader/<id>
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Modify RemoveResponseHeader directive.",
"message" : "Modify an item from the removeresponseheader list",
"success" : "true"
}
Kustutage päringust päiste eemaldamiseks reegel
Kustutage päringust päiste eemaldamiseks reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/removerequestheader/<index>
indeks on kustutatava removerequestheaderi massiivi indeks.
Vastuse näide:
{
"message": "The remove request header <index> has been deleted successfully"
}
Lisage vastusest päiste eemaldamiseks reegel
Lisage vastusest päiste eemaldamiseks reegel
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""
POST /farms/<farmname>/service/<servicename>/removeresponseheader
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"message": "Added a new remove response header"
}
Muutke vastusereeglist päiste eemaldamine
Muutke vastusereeglist päiste eemaldamine
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/id
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""
PUT /farms/<farmname>/service/<servicename>/removeresponseheader/<id>
Eemaldage teatavad päised sissetulevatest päringutest. Kõik sobiva määratud päise esinemised eemaldatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string, millel on kliendi nõudmistes otsitav regexp. Kui mõni päis sobib mustriga, eemaldatakse päis | tõsi |
Vastuse näide:
{
"description" : "Modify RemoveResponseHeader directive.",
"message" : "Modify an item from the removeresponseheader list",
"success" : "true"
}
Kustutage vastusest päiste eemaldamise reegel
Kustutage vastusest päiste eemaldamise reegel
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/removeresponseheader/<index>
indeks on kustutatava rearealaatoririba indeks.
Vastuse näide:
{
"message": "The remove request header <index> has been deleted successfully"
}
Lisage kontrollidele reegel ja kirjutage URL-ist mustrid ümber
Lisage kontrollidele reegel ja kirjutage URL-ist mustrid ümber
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"
POST /farms/<farmname>/service/<servicename>/rewriteurl
Versioonist 4.0.2. See kontrollib mustrit, et saada URL-ist stringe ja need asendada.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string regexpiga, mida otsida URL-ist. Kui url kattub mustris, asendatakse sobitatud tekst | tõsi |
| asendama | nöör | See on string sobitatud teksti asendamiseks | tõsi |
| viimane | nöör | Õige või vale. Kui on seatud tõene, lõpetab see URL-i ümberkirjutamise etapi | tõsi |
Vastuse näide:
{
"message": "Added a new rewriteurl"
}
Kontrollide reegli muutmine ja URL-i mustrite ümberkirjutamine
Kontrollide reegli muutmine ja URL-i mustrite ümberkirjutamine
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"
PUT /farms/<farmname>/service/<servicename>/rewriteurl/<id>
Versioonist 4.0.2. See kontrollib mustrit, et saada URL-ist stringe ja need asendada.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| muster | nöör | See on string regexpiga, mida otsida URL-ist. Kui url kattub mustris, asendatakse sobitatud tekst | tõsi |
| asendama | nöör | See on string sobitatud teksti asendamiseks | tõsi |
| viimane | nöör | Õige või vale. Kui on seatud tõene, lõpetab see URL-i ümberkirjutamise etapi | tõsi |
Vastuse näide:
{
"description" : "Modify a RewriteUrl.",
"message" : "Modify a new rewrite url",
"success" : "true"
}
Kustutage reegel URL-i mustrite kontrollimiseks ja ümberkirjutamiseks
Kustutage reegel URL-i mustrite kontrollimiseks ja ümberkirjutamiseks
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/Index
zcli arm-service-rewriteurl remove MyHttpFarm Service Index
DELETE /farms/<farmname>/service/<service0>/rewriteurl/<index>
Versioonist 4.0.2. indeks on kustutatava rewriteurl massiivi indeks.
Vastuse näide:
{
"message": "The rewriteurl <index> has been deleted successfully"
}
Teisaldage kontroll ja kirjutage mustrid ümber URL-i reeglist
Teisaldage kontroll ja kirjutage mustrid ümber URL-i reeglist
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`
See kõne on saadaval versioonist 4.0.2
POST /farms/<farmname>/services/<service>/rewriteurl/<id>/actions
Teisaldage ReplaceRequest päis.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| positsioon | Number | Uus reegli positsioon | tõsi |
Vastuse näide:
{
"description" : "Move a rewriteurl directive",
"message" : "Header was moved successfully.",
"params" : {
"position" : "1"
}
}
Loendage seansid
Loendage seansid
Päringu näide:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session list farm1 service0
GET /farms/<farmname>/services/<servicename>/sessions
Versioonist 4.0.2. Hankige farm:service seansside loend. Kinnistu on saadaval ainult uue põlvkonna puhverserveri jaoks zproksü.
Vastuse näide:
{
"description" : "Get farm sessions",
"params": [
{
"id": "0",
"session": "10.0.0.2",
"ttl": null,
"type": "static"
},
{
"id": "0",
"session": "10.0.0.2",
"ttl": "58m28s148ms",
"type": "dynamic"
},
{
"id": "0",
"session": "10.0.0.2",
"ttl": "59m56s496ms",
"type": "dynamic"
}
]
}
Vastusparameetrid
See päring tagastab seanssiobjektide loendi, iga seansiobjekt sisaldab järgmisi võtmeid:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'IP' istung peaks olema IPv4 või IPv6, nt 192.168.42.65; |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss ei ole staatiline. |
Lisage seanss
Lisage seanss
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session add farm1 service0 -backend 0 -session 10.0.0.2
POST /farms/<farmname>/services/<servicename>/sessions
Versioonist 4.0.2. See loob seansi taustaprogrammiga staatilise seansi. Sisendühendus, mis sobib istung edastatakse alati sellele taustaprogrammi. Kinnistu on saadaval ainult uue põlvkonna puhverserveri jaoks zproksü.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'IP', istung peaks olema IPv4 või IPv6, nt 192.168.42.65; |
Vastuse näide:
{
"description" : "Adding a static session to the farm1",
"message" : "Added a session for the farm 'farm1'",
"params" : {
"id" : "0",
"session" : "10.0.0.1",
"ttl" : null,
"type" : "static"
}
}
Vastusparameetrid
See taotlus tagastab sessiooniobjekti, mis sisaldab järgmisi võtmeid:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'IP" istung peaks olema IPv4 või IPv6, nt 192.168.42.65. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss on staatilist tüüpi. |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
Seansi eemaldamine
Seansi eemaldamine
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions/10.0.0.1
zcli farm-service-session remove farm1 service0 10.0.0.1
DELETE /farms/<farmname>/services/<servicename>/sessions/<session>
See kustutab staatilise seansi.
Vastuse näide:
{
"description" : "Delete a 'static' session",
"message" : "The session '10.0.0.1' was deleted properly from the farm 'farm1'.",
"success" : "true"
}
HTTP - Teenused - taustaprogrammid
Loetlege taustaprogrammid
Loetlege taustaprogrammid
Päringu näide:
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
Hankige teenuse taustaprogrammide loend. id on teenuse kordumatu tunnus.
Vastuse näide:
{
"description" : "List service backends",
"params" : [
{
"alias" : null,
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1,
"priority" : null,
"connection_limit" : null
},
{
"alias" : null,
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2,
"priority" : null,
"connection_limit": null
}
]
}
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | teenuse taustaprogrammi unikaalne identifikaator. See identifikaator genereeritakse süsteemi poolt. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. |
| timeout | Number | Teatud päringule vastamiseks on sekundi jooksul tagaplaani aeg. |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Võimalikud väärtused on pärit 1 et 9. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| prioriteet (alates 4.0.1) | Number | (Ainult uue põlvkonna puhverserveri töötamise korral) See on praeguse pärisserveri prioriteetne väärtus. Madalama prioriteediga taustaprogramm on valmis ühendusi vastu võtma varem kui teised kõrgema prioriteediga. Vaikeväärtus null, prioriteetne väärtus 1 kasutatakse. Võimalikud väärtused on alates 1 et 9 |
| ühenduse_piir (alates 4.0.2) | Number | (Ainult uue põlvkonna puhverserveri töökorras) Maksimaalne loodud ühenduste arv taustaprogrammi kohta. Kui väärtus on 0, siis taustaprogrammis piirangut ei ole. Klient saab tõrketeate 503, kui saadaolevaid taustaprogramme pole. |
Loo uus taust
Loo uus taust
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2 -connection_limit 10
POST /farms/<farmname>/services/<id>/backends
Uue taustaprogrammi loomine antud HTTP-profiilis. id on teenuse kordumatu tunnus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. | tõsi |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. | tõsi |
| timeout | Number | Teatud päringule vastamiseks on see backend timeout. | |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Võimalikud väärtused on pärit 1 et 9. | |
| prioriteet (alates 4.0.1) | Number | (Ainult uue põlvkonna puhverserveri töötamise korral) See on praeguse pärisserveri prioriteetne väärtus. Madalama prioriteediga taustaprogramm on valmis ühendusi vastu võtma varem kui teised kõrgema prioriteediga. Vaikeväärtus null, prioriteetne väärtus 1 kasutatakse. Võimalikud väärtused on alates 1 et 9 | |
| ühenduse_piir (alates 4.0.2) | Number | (Ainult uue põlvkonna puhverserveri töökorras) Maksimaalne loodud ühenduste arv taustaprogrammi kohta. Kui väärtus on 0, siis taustaprogrammis piirangut ei ole. Klient saab tõrketeate 503, kui saadaolevaid taustaprogramme pole. |
Vastuse näide:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 0,
"ip" : "192.168.102.244",
"port" : 80,
"timeout" : 2,
"weight" : 2,
"priority" : 1,
"connection_limit" : 10
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetritega uuendatud JSON ja staatus põllu praeguse olekuga. Kui talu muudatuste rakendamiseks on vaja uuesti käivitada, on väärtus järgmine vaja uuesti taaskäivitada.Kui seal on
Muuda taustaprogrammi
Muuda taustaprogrammi
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.0.10","port":88,"timeout":12,"weight":1,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1 -connection_limit 10
PUT /farms/<farmname>/services/<id>/backends/<id>
Muuda taustaprogrammi HTTP teenuse parameetreid.
esimene id on järgmine teenuse unikaalne identifikaator id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. |
| timeout | Number | Teatud päringule vastamiseks on sekundi jooksul tagaplaani aeg. |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Võimalikud väärtused on pärit 1 et 9. |
| prioriteet (alates 4.0.1) | Number | (Ainult uue põlvkonna puhverserveri töötamise korral) See on praeguse pärisserveri prioriteetne väärtus. Madalama prioriteediga taustaprogramm on valmis ühendusi vastu võtma varem kui teised kõrgema prioriteediga. Vaikeväärtus null, prioriteetne väärtus 1 kasutatakse. Võimalikud väärtused on alates 1 et 9 |
| ühenduse_piir (alates 4.0.2) | Number | (Ainult uue põlvkonna puhverserveri töökorras) Maksimaalne loodud ühenduste arv taustaprogrammi kohta. Kui väärtus on 0, siis taustaprogrammis piirangut ei ole. Klient saab tõrketeate 503, kui saadaolevaid taustaprogramme pole. |
Vastuse näide:
{
"description" : "Modify service backend",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.0.10",
"port" : 88,
"timeout" : 12,
"weight" : 1,
"priority" : 4,
"connection_limit" : 10
},
"status" : "needed restart",
"warning" : "Backends with high priority value (4) will not be used."
}
Vastusparameetrid
Vastuseks on nõutud parameetritega uuendatud JSON ja staatus põllu praeguse olekuga. Kui talu muudatuste rakendamiseks on vaja uuesti käivitada, on väärtus järgmine vaja uuesti taaskäivitada. Kui prioriteedi parameetrit värskendatakse vastuolulise väärtusega, siis hoiatus väli kirjeldab seda.
Hoolduse tagapõhi
Hoolduse tagapõhi
Päringu näide:
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
Määrake antud toiming HTTP-talu taustaprogrammis, olemasolevaid toiminguid kirjeldatakse allpool.
esimene id on järgmine teenuse unikaalne identifikaator id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Määrake soovitud toiming. Toimingud on järgmised: up taustaprogramm on klienditaotluste vastuvõtmiseks valmis, hooldus taustaprogramm ei ole klienditaotluste vastuvõtmiseks valmis, see toiming on kasulik, et peatada taustaprogrammi server ilma klientidele. | |
| režiimis | nöör | Valige hooldusrežiim. Saadaval olevad valikud on järgmised: äravool, taustaprogramm ei aktsepteeri uusi ühendusi, kuid jätkab praeguste ühenduste haldamist; või lõigatud, suletakse praegused ühendused. | Kui seda välja ei ole määratud, on vaikerežiim äravool. |
Vastuse näide:
{
"description" : "Set service backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
Kustuta taustaprogramm
Kustuta taustaprogramm
Päringu näide:
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>
Kustutage antud taustaprogramm HTTP-teenusest.
esimene id on järgmine teenuse unikaalne identifikaator id on taustaprogrammi unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
L4xNAT Talud
L4xNATi profiili talu võimaldab luua koormuse tasakaalustamise talusid, mis töötavad OSI mudeli kihis 4, millel on väga suur jõudlus ja palju rohkem samaaegseid ühendusi kui koormuse tasakaalustussüdamikud kihis 7 nagu HTTP taluprofiilid. See kiht 4 jõudluse parandamine on vastuolus täiustatud sisu käitlemisega, mida kiht 7 profiilid suudavad hallata.
Lisaks võiksid L4xNAT-farmid siduda terve rea porde, mitte ainult ühte virtuaalset porti, nagu seda kasutatakse teise 7. kihi profiiliga. Selleks, et saaksite L4xNAT-i farmides valida virtuaalse pordi vahemiku või konkreetse virtuaalse pordi, on kohustuslik valida protokolli tüüp. Teisel juhul kuulab talu kõiki sadamaid virtuaalsest IP-st (tähistatud tähega *). Kui TCP- või UDP-protokoll on valitud, saab määrata pordi, mitu pordi ',' vahel asuvat pordi vahemikku ':' või kõik pordid, millel on '*'. Kehtiv on ka nende kõigi kombinatsioon.
Too talu nime järgi
Too talu nime järgi
Päringu näide:
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>
Näita kõiki antud talu konfiguratsioone.
Vastus BODY:
{
"backends" : [
{
"alias" : null,
"max_conns" : 0,
"id" : 0,
"ip" : "192.168.55.40",
"port" : "88",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"alias" : "server-1",
"id" : 1,
"max_conns" : 500,
"ip" : "192.168.55.41",
"port" : "88",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"ipds" : {
"blacklists" : [
{
"status" : "down",
"name" : "blacklist"
}
],
"dos" : [
{
"name" : "newlimitconns",
"status" : "down"
}
],
"rbl" : [
{
"name" : "protection_ssh",
"status" : "up"
}
]
},
"params" : {
"algorithm" : "weight",
"farmguardian" : "check_tcp-cut_conns",
"listener" : "l4xnat",
"logs" : "false",
"nattype" : "nat",
"persistence" : "ip",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88",
"sessions": []
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ipds | objekt | Selle talu IPDS-reeglite loetelu. |
| parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
| taustaprogrammid | Objekt [] | Kõik tõelised serverid, mis on loodud selles talus ja selle konfiguratsioonis. |
IPDS-objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| mustad nimekirjad | Objekt [] | Põllumajandusettevõtte suhtes kohaldatakse musta nimekirja reegleid. |
| dos | Objekt [] | Põllumajandusettevõtte suhtes kohaldatavad DoS-reeglid. |
| rbl | Objekt [] | Põllumajandusettevõtte suhtes kohaldatakse RBL-eeskirju. |
Must nimekiri, DoS ja RBL objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Reegli nimi. |
| staatus | nöör | Reegli olek. |
L4xNAT talude parameetrite objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| algoritm | nöör | Koormuse tasakaalustamise ajakava, mida kasutatakse liikluse toetamiseks taustaprogrammide vahel. Valikud on järgmised: kõige vähem edastab alati ühendust kõige vähem ühendusserveriga; kaal ühendus lineaarne saatmine sõltuvalt taustaprotsendist; roundrobin teeb järjestikuse valiku taustaprogrammi vahel, iga taustaprogramm saab sama arvu taotlusi; hash_srcip tasakaalustab paketid, mis vastavad samale allikale IP sama taustaga; hash_srcip_srcport tasakaalustab paketid, mis vastavad samale IP ja portile sama taustaga; sümbol tasakaalu paketid, mis vastavad samale IP ja pordi ja sihtkoha IP ja pordile, nii et see võib ühendada mõlemal viisil (sissetuleva ja väljamineva) ajal. |
| kuulaja | nöör | Kuulaja määratleb, kuidas talu klientide päringutega mängima hakkab. teabeväljal, seda ei saa muuta. |
| logisid | nöör | Farm logib transpordikihi pakettandmeid, see ei ole rakenduste kihi teave. Kui selle parameetri väärtus on tõsi, logid on lubatud; kui sellel on väärtus vale, logid on keelatud. |
| nattype | nöör | Kuidas koormuse tasakaalustaja kiht 4 südamik töötab. Valikud on järgmised: nat nimetatakse ka sNAT-režiimi, reageerib taustaprogramm koormuse tasakaalustajale, et saata vastus kliendile; dnat taustaprogramm reageerib otse kliendile, koormuse tasakaalustaja peab olema konfigureeritud lüüsi taustaprogrammis; Sisse DSR (Direct Server Return) režiim, millega klient ühendub VIP-ga, siis muudab koormuse tasakaalustaja oma MAC-aadressi backend-MAC-aadressi jaoks (server peab olema samas linkmeedias nagu koormuse tasakaalustaja); Staatiline DNAT. Sisse stateless_dnat koormuse tasakaalustaja lülitab sihtkoha aadressi backend-aadressile ja edastab selle backendile nagu DNAT, kuid see ei halda mingit sideteavet. |
| püsivus | nöör | See parameeter edastab sissetuleva taotluse samale taustale valitud püsivusrežiimis. Valikud on järgmised: "" tühi väärtus keelab püsivuse, iga sissetulev pakett on tasakaalustatud taustaprogrammide vahel; ip or srcipAllikas IP määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt ainult allika IP-aadressist; port, Allikasport, määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt ainult lähtepordist. srcmac, Allikas MAC, Selle suvandi korral määrab talu iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt paketi lingi kihtide MAC-aadressist; srcip_srcportAllikas IP ja lähteport määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt nii allika IP kui ka lähtepordist; srcip_dstportAllikas IP ja sihtkoha port määravad iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt nii IP-allikast kui ka sihtkoha sadamast. |
| protokoll | nöör | Protokoll tasakaalustatakse kihis 4. Valikud on järgmised: kõik profiil laadib tasakaalu mis tahes L4i protokolli; tcp koormuse tasakaalustaja tasakaalustab ainult TCP L4i protokolli, ka TCP jaoks, on võimalik määrata üks kord järgmistest protokollidest, et analüüsida selle päiseid ja kasutada seda õigesti jaotamiseks: ftp, IRC, pptpvõi mõistlik; Udp ainult koormuse tasakaalustaja tasakaalustab UDP L4i protokolli, ka UDP jaoks, on võimalik määrata üks kord järgmistest protokollidest, et analüüsida selle päiseid ja kasutada seda õigesti jaotamiseks: lonks, tftp, Amanda, netbios-nsvõi SNMP; sctp, ainult koormuse tasakaalustaja tasakaalustab SCTP L4 protokolli. Kui h323 on valitud, talu kuulab TCP ja UDP taotleb ja analüüsib selle päiseid, et tasakaalustada taustaprogramme. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| ttl | Number | See välja väärtus näitab sekundite arvu, kui püsivus kliendi allika ja taustaprogrammi vahel on määratud. Püsivus peab olema konfigureeritud. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. Unikaalse pordi saab määrata, vahemiku porti saab määrata eraldajaga : ja mitu porti saab määrata eraldajaga ,. |
| talupoeg | nöör | See on FarmGuardian nimi, mis kontrollib taustaprogrammi olekut. FarmGuardian töötab samal ajal, kui talu seisab. |
| seansid (alates versioonist 4.0.2) | Objekt [] | Selle farmi jaoks loodud staatiliste ja dünaamiliste seansside loend. |
L4xNATi talude taustaprogramm:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | ID, et identifitseerida backendit talumajapidamiste taustal. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. Tühi väärtus aktsepteeritakse ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| prioriteet | Number | See on praeguse reaalserveri prioriteediväärtus. Madalama prioriteediga taustprogramm on ühenduste vastuvõtmiseks valmis varem kui teised, millel on kõrgem prioriteet. Vaikeväärtus null, prioriteediväärtus 1 kasutatakse. Võimalikud väärtused on pärit 1 et 9. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. Võimalikud väärtused on pärit 1 et 9. |
| max_conns | Number | See on maksimaalne ühenduste arv, mida taustaprogramm saab samaaegselt. Kui see on määratud a-ga 0 väärtus, mida taustaprogramm ei ole piiranud. |
L4xNAT farmide seansiobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| klient | Number | See on kliendi identifikaator. |
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'mac', istung peaks olema MAC, nt 02: 8e: 69: 38: 12: 8e; kui püsivus on 'ip' või 'srcip', istung peaks olema IPv4 või IPv6, nt 192.168.42.65; kui püsivus on 'sadam', istung peaks olema kehtiv port, nt 5445; kui püsivus on 'srcip_srcport' või 'srcip_dstport'; istung peaks olema string IP-ga ja alamjoonega ühendatud pordiga "", nt 122.36.54.280. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss on staatilist tüüpi. |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
Loo uus talu
Loo uus talu
Päringu näide:
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
Looge uus L4xNAT talu.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| farmname | nöör | Põllumajandusettevõtte nimi, kordumatu tunnus. | tõsi |
| profiil | nöör | Loodud talu profiil. L4xNATi jaoks on talud l4xnat, teatesõnum, seda väärtust ei saa muuta | tõsi |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. | tõsi |
| vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. L4xNATi talumajapidamised võimaldavad eraldada mitmepordist , või vahemikuport eraldatud :. | tõsi |
| copy_from (alates 4.0.1) | nöör | See parameeter eeldab olemasoleva talu nime. Selle parameetri saatmise korral kopeeritakse farm selles täpsustatud talust. farmname, vip ja vport väärtused kirjutatakse üle. |
Vastuse näide:
{
"description" : "Creating farm 'newl4farm'",
"params" : {
"farmname" : "newl4farm",
"interface" : "eth0",
"profile" : "l4xnat",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda talu
Muuda talu
Päringu näide:
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>
Muuda L4xNAT talu konfiguratsiooni.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| newfarmname | nöör | Uue talu nimi. Talu tuleb lõpetada. |
| logisid | nöör | Farm logib transpordikihi pakettandmeid, see ei ole rakenduste kihi teave. Kui selle parameetri väärtus on tõsi, logid on lubatud; kui sellel on väärtus vale, logid on keelatud. |
| ttl | Number | See välja väärtus näitab sekundite arvu, millal kliendi allika ja taustaprogrammi vahel on püsivus. Püsivus peab olema konfigureeritud. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. Unikaalse pordi saab määrata, vahemiku porti saab määrata eraldajaga : ja mitu porti saab määrata eraldajaga ,. |
| püsivus | nöör | See parameeter edastab sissetuleva taotluse samale taustale valitud püsivusrežiimis. Valikud on järgmised: "" tühi väärtus keelab püsivuse, iga sissetulev pakett on tasakaalustatud taustaprogrammide vahel; ip or srcipAllikas IP määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt ainult allika IP-aadressist; port, Allikasport, määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt ainult lähtepordist. srcmac, Allikas MAC, Selle suvandi korral määrab talu iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt paketi lingi kihtide MAC-aadressist; srcip_srcportAllikas IP ja lähteport määrab iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt nii allika IP kui ka lähtepordist; srcip_dstportAllikas IP ja sihtkoha port määravad iga sissetuleva ühenduse jaoks sama taustaprogrammi sõltuvalt nii IP-allikast kui ka sihtkoha sadamast. |
| nattype | nöör | Kuidas koormuse tasakaalustaja kiht 4 südamik töötab. Valikud on järgmised: nat nimetatakse ka sNAT-režiimi, reageerib taustaprogramm koormuse tasakaalustajale, et saata vastus kliendile; dnat taustaprogramm reageerib otse kliendile, koormuse tasakaalustaja peab olema konfigureeritud lüüsi taustaprogrammis; Sisse DSR (Direct Server Return) režiim, millega klient ühendub VIP-ga, siis muudab koormuse tasakaalustaja oma MAC-aadressi backend-MAC-aadressi jaoks (server peab olema samas linkmeedias nagu koormuse tasakaalustaja); Staatiline DNAT. Sisse stateless_dnat koormuse tasakaalustaja lülitab sihtkoha aadressi backend-aadressile ja edastab selle backendile nagu DNAT, kuid see ei halda mingit sideteavet. |
| algoritm | nöör | Koormuse tasakaalustamise ajakava, mida kasutatakse liikluse toetamiseks taustaprogrammide vahel. Valikud on järgmised: kõige vähem edastab alati ühendust kõige vähem ühendusserveriga; kaal ühendus lineaarne saatmine sõltuvalt taustaprotsendist; roundrobin teeb järjestikuse valiku taustaprogrammi vahel, iga taustaprogramm saab sama arvu taotlusi; hash_srcip tasakaalustab paketid, mis vastavad samale allikale IP sama taustaga; hash_srcip_srcport tasakaalustab paketid, mis vastavad samale IP ja portile sama taustaga; sümbol tasakaalu paketid, mis vastavad samale IP ja pordi ja sihtkoha IP ja pordile, nii et see võib ühendada mõlemal viisil (sissetuleva ja väljamineva) ajal. |
| protokoll | nöör | Protokoll tasakaalustatakse kihis 4. Valikud on järgmised: kõik profiil laadib tasakaalu mis tahes L4i protokolli; tcp koormuse tasakaalustaja tasakaalustab ainult TCP L4i protokolli, ka TCP jaoks, on võimalik määrata üks kord järgmistest protokollidest, et analüüsida selle päiseid ja kasutada seda õigesti jaotamiseks: ftp, IRC, pptpvõi mõistlik; Udp ainult koormuse tasakaalustaja tasakaalustab UDP L4i protokolli, ka UDP jaoks, on võimalik määrata üks kord järgmistest protokollidest, et analüüsida selle päiseid ja kasutada seda õigesti jaotamiseks: lonks, tftp, Amanda, netbios-nsvõi SNMP; sctp, ainult koormuse tasakaalustaja tasakaalustab SCTP L4 protokolli. Kui h323 on valitud, talu kuulab TCP ja UDP taotleb ja analüüsib selle päiseid, et tasakaalustada taustaprogramme. |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Lisa FarmGuardian
Lisa FarmGuardian
Päringu näide:
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
Rakendage talu FarmGuardian.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | FarmGuardian kordumatu tunnus. FarmGuardians luuakse ja muudetakse seirealas. |
Vastuse näide:
{
"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"
}
Eemaldage FarmGuardian
Eemaldage FarmGuardian
Päringu näide:
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>
Eemaldage FarmGuardian talust.
Vastuse näide:
{
"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"
}
lisama POST /farms/<farmname>/sessions
lisama DELETE /farms/<farmname>/sessions/<session>
Loendage seansid
Loendage seansid
Päringu näide:
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
Hankige farmis istungjärkude loetelu.
Vastuse näide:
{
"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"
}
]
}
Vastusparameetrid
See taotlus tagastab sessiooniobjektide loendi, iga seansiobjekt sisaldab järgmisi võtmeid:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| klient | Number | See on kliendi identifikaator. |
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'mac', istung peaks olema MAC, nt 02: 8e: 69: 38: 12: 8e; kui püsivus on 'ip' või 'srcip', istung peaks olema IPv4 või IPv6, nt 192.168.42.65; kui püsivus on 'sadam', istung peaks olema kehtiv port, nt 5445; kui püsivus on 'srcip_srcport' või 'srcip_dstport'; istung peaks olema string IP-ga ja alamjoonega ühendatud pordiga "", nt 122.36.54.280. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss on staatilist tüüpi. |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
Lisage seanss
Lisage seanss
Päringu näide:
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
See loob taustaprogrammiga staatilise seansi. Sisendühendus, mis sobib istung edastatakse alati sellesse taustaprogrammi.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'mac', istung peaks olema MAC, nt 02: 8e: 69: 38: 12: 8e; kui püsivus on 'ip' või 'srcip', istung peaks olema IPv4 või IPv6, nt 192.168.42.65; kui püsivus on 'sadam', istung peaks olema kehtiv port, nt 5445; kui püsivus on 'srcip_srcport' või 'srcip_dstport'; istung peaks olema string IP-ga ja alamjoonega ühendatud pordiga "", nt 122.36.54.280. |
Vastuse näide:
{
"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"
}
}
Vastusparameetrid
See taotlus tagastab sessiooniobjekti, mis sisaldab järgmisi võtmeid:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| klient | Number | See on kliendi identifikaator. |
| id | Number | Taustprogrammi ID, mis ühenduse võtab vastu. |
| istung | nöör | See on seansi identifikaator või ühendus, selle väärtus sõltub püsivus talu parameeter. Kui püsivus on 'mac', istung peaks olema MAC, nt 02: 8e: 69: 38: 12: 8e; kui püsivus on 'ip' või 'srcip', istung peaks olema IPv4 või IPv6, nt 192.168.42.65; kui püsivus on 'sadam', istung peaks olema kehtiv port, nt 5445; kui püsivus on 'srcip_srcport' või 'srcip_dstport'; istung peaks olema string IP-ga ja alamjoonega ühendatud pordiga "", nt 122.36.54.280. |
| ttl | nöör | See on string, mille seansi aeg lõpeb. ttl väärtus saab olema tühjaks kui seanss on staatilist tüüpi. |
| tüüp | nöör | Seansse on kahte tüüpi: dünaamiline on ühendus, mis koormab tasakaalustaja tihvtid taustprogrammiga, kasutades talu koormuse tasakaalustamise algoritmi; staatiline on ühendus, mille koormuse tasakaalustaja administraator seob taustaprogrammiga. Staatilisi seansse ei suunata teisele taustaprogrammile, kui selle varundamine pole juurdepääsetav. |
Seansi eemaldamine
Seansi eemaldamine
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56
DELETE /farms/<farmname>/sessions/<session>
See kustutab staatilise seansi.
Vastuse näide:
{
"description" : "Delete a 'static' session",
"message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
"success" : "true"
}
Lisage IPDS-reegel
Lisage IPDS-reegel
Päringu näide:
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>
Rakenda kasvandustele mustade nimekirjade, DoS või RBL reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Unikaalse identifikaatorina kasutatav IPDS-reegli nimi. |
Vastuse näide:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm l4Farm.",
"success" : "true"
}
Eemaldage IPDS-reegel
Eemaldage IPDS-reegel
Päringu näide:
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>
Eemaldage IPDS-mooduli must nimekiri, DoS-i või RBL-reegel antud indikaatorist selle indikaatori abil nimi.
Vastuse näide:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm l4Farm.",
"success" : "true"
}
L4xNAT - taustaprogrammid
Loetlege taustaprogrammid
Loetlege taustaprogrammid
Päringu näide:
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
Hankige teenuse taustaprogrammide loend.
Vastuse näide:
{
"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
},
]
}
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | ID, et identifitseerida backendit talumajapidamiste taustal. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. Tühi väärtus aktsepteeritakse ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| max_conns | Number | See on taustaprogrammi samaaegsete ühenduste maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. |
| prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige olulisema prioriteediga, kus 1 on kõige tähtsam ja 9 on kõige vähem prioriteetne. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. Võimalikud väärtused on pärit 1 et 9. |
Loo uus taust
Loo uus taust
Päringu näide:
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
Looge antud L4xNATi talus uus taust.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. | tõsi |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. Tühi väärtus aktsepteeritakse ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). | |
| max_conns | Number | See on taustaprogrammi samaaegsete ühenduste maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. | |
| prioriteet | Number | See on praeguse reaalserveri prioriteediväärtus. Madalama prioriteediga taustprogramm on ühenduste vastuvõtmiseks valmis varem kui teised, millel on kõrgem prioriteet. Vaikeväärtus null, prioriteediväärtus 1 kasutatakse. Võimalikud väärtused on pärit 1 et 9. | |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. Võimalikud väärtused on pärit 1 et 9. |
Vastuse näide:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"port" : 8080,
"max_conns" : 400,
"priority" : null,
"weight" : null
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda taustaprogrammi
Muuda taustaprogrammi
Päringu näide:
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>
Muuda L4xNAT talu taustaprogrammi parameetreid. id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. Tühi väärtus aktsepteeritakse ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
| max_conns | Number | See on taustaprogrammi samaaegsete ühenduste maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. |
| prioriteet | Number | See on praeguse reaalserveri prioriteediväärtus. Madalama prioriteediga taustprogramm on ühenduste vastuvõtmiseks valmis varem kui teised, millel on kõrgem prioriteet. Vaikeväärtus null, prioriteediväärtus 1 kasutatakse. Võimalikud väärtused on pärit 1 et 9. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. Võimalikud väärtused on pärit 1 et 9. |
Vastuse näide:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"port" : 8080,
"max_conns" : 220,
"priority" : 4,
"weight" : 7
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Hoolduse tagapõhi
Hoolduse tagapõhi
Päringu näide:
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
Määrake antud toiming L4xNAT talu taustaprogrammis. id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tegevus | nöör | Määrake soovitud toiming. Toimingud on järgmised: up taustaprogramm on klienditaotluste vastuvõtmiseks valmis, hooldus taustaprogramm ei ole klienditaotluste vastuvõtmiseks valmis, see toiming on kasulik, et peatada taustaprogrammi server ilma klientidele. |
| režiimis | nöör | Valige hooldusrežiim. Saadaval olevad valikud on järgmised: äravool, taustaprogramm ei aktsepteeri uusi ühendusi, kuid jätkab praeguste ühenduste haldamist; või lõigatud, suletakse praegused ühendused. |
Vastuse näide:
{
"description" : "Set backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta taustaprogramm
Kustuta taustaprogramm
Päringu näide:
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>
L4xNATi talu jaoks antud taustaprogrammi kustutamine.
id on taustaprogrammi unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
GSLB talud
Global Service Load Balancing, mida tavaliselt nimetatakse GSLB-ks, võimaldab luua DNS-teenuse hierarhilisel arhitektuuril põhineva koormuse tasakaalustamisteenuse. Selline talu annab autoriteetse DNS-i, millel on koormuse tasakaalustamise algoritmid ja teenuse oleku tuvastamine DNS-i rakenduste kihil.
Too talu nime järgi
Too talu nime järgi
Päringu näide:
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>
Näita kõiki antud talu konfiguratsioone.
Vastuse näide:
{
"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"
}
]
}
]
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ipds | objekt | Selle talu IPDS-reeglite loetelu. |
| parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
| teenused | Objekt [] | Koostage kõik selles talus loodud teenused ja selle konfiguratsioon. |
| tsoonid | Objekt [] | Koostage kõik selles talus loodud tsoonid ja selle konfiguratsioon. |
IPDS-objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| mustad nimekirjad | Objekt [] | Talumajapidamises rakendati musti loendeid. |
| dos | Objekt [] | Põllumajandusettevõtte suhtes kohaldatavad DoS-reeglid. |
| rbl | Objekt [] | Põllumajandusettevõtte suhtes kohaldatakse RBL-eeskirju. |
Must nimekiri, DoS ja RBL objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Reegli nimi. |
| staatus | nöör | Reegli olek. |
GSLB põllumajandusettevõtete parameeterobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | Number | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on ülespoole ja kõik taustaprogrammid on kättesaamatud; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
GSLB põllumajandusettevõtete teenindusobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Teenuses määratletud taustaprogrammid. |
| talupoeg | nöör | See on FarmGuardian nimi, mis kontrollib taustaprogrammi olekut. FarmGuardian töötab samal ajal, kui talu seisab. GSLB põllumajandusettevõtete jaoks ei ole talupoegade logisid saadaval |
| id | nöör | Teenuse nimi, mida kasutatakse kordumatu identifikaatorina. |
| algoritm | nöör | Teenuses kasutatav koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: roundrobin, mis tasakaalustab ühendused kõigi ülesvõtete vahel või prio mis saadab kõik ühendused esimese kättesaadava taustaprogrammiga. |
| deftcpport | Number | TCP-pordi vaikekontroll. See on tervisekontrolli TCP-port, mida teenus kontrollib, et kindlaks teha, kas taustaprogramm on elus. Tühi väärtus on keelatud. |
GSLB põllumajandusettevõtete taustaprogramm:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Teenuse taustaprogrammi unikaalne identifikaator. See identifikaator genereeritakse süsteemi poolt. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
Tsooni objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Tsooni nime kasutatakse kordumatu määratlejana. |
| defnamesv | nöör | See on sissepääsupunkti juurenimi server, mis on saadaval asutuse alguspunkti (SOA) DNS-kirje kujul. |
| ressursid | Objekt [] | Vahendid määratletud piirkonnas. |
Allika objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Tsooni ressursi unikaalne identifikaator. |
| rname | nöör | Ressursinimi on hüüdnimi, mida DNS-teenus tõlkib tegelike nõutavate andmete jaoks rdata. |
| ttl | Number | Praeguse kirje väärtus, mis on vajalik ajale Live (vabatahtlik), mis on vajalik selleks, et määrata, kui kaua praegune nimi salvestatakse. |
| tüüp | nöör | DNS-i kirje tüüp. Valikud on järgmised: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Lisateabe saamiseks vaadake GSLB - tsoonid - ressursid sektsiooni. |
| rdata | nöör | See on rekorditüübi jaoks vajalikud tegelikud andmed, sisendväärtus sõltub ressursi nime liigist, rname ja ressursitüüp, tüüp. |
Loo uus talu
Loo uus talu
Päringu näide:
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
Looge uus GSLB talu.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| farmname | nöör | Põllumajandusettevõtte nimi on põllumajandusettevõtete kordumatu tunnus. | tõsi |
| profiil | nöör | Loodud talu profiil. GSLB põllumajandusettevõtete puhul on gslb. | tõsi |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. | tõsi |
| vport | Number | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. | tõsi |
| copy_from (alates 4.0.1) | nöör | See parameeter eeldab olemasoleva talu nime. Selle parameetri saatmise korral kopeeritakse farm selles täpsustatud talust. farmname, vip ja vport väärtused kirjutatakse üle. |
Vastuse näide:
{
"description" : "Creating farm 'gslbfarm'",
"params" : {
"farmname" : "gslbfarm",
"interface" : "eth0",
"profile" : "gslb",
"vip" : "192.168.100.241",
"vport" : 53
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda talu
Muuda talu
Päringu näide:
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>
Muuda GSLB talu konfiguratsiooni.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| newfarmname | nöör | Uue talu nimi. Selle muudatuse tegemiseks tuleb talu peatada. |
| vport | Number | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
Vastuse näide:
{
"description" : "Modify farm gslbnewname",
"params" : {
"newfarmname" : "gslbnewname",
"vip" : "192.168.100.155",
"vport" : 60
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Lisage IPDS-reegel
Lisage IPDS-reegel
Päringu näide:
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>
Rakenda põllumajandusettevõttele must nimekiri, DoS või RBL reegel.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Unikaalse identifikaatorina kasutatav IPDS-reegli nimi. |
Vastuse näide:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
"success" : "true"
}
Eemaldage IPDS-reegel
Eemaldage IPDS-reegel
Päringu näide:
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>
Eemaldage mustal nimekirjal, DoS-il või RBL-reeglil antud põllumajandusettevõttest oma identifikaatori abil nimi.
Vastuse näide:
{
"description" : "Delete a rule form a farm",
"message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
"success" : "true"
}
GSLB - Teenused
GSLB teenus esindab rea reaalseid servereid ja nendega seotud algoritmi. Uue teenuse loomiseks peate määrama kehtiva identifitseerimisnime ja soovitud algoritmi.
Olemasolevad teenused on järgmised:
Round Robin: võrdne jagamine. Võrdne liiklus kõigi aktiivsete reaalsete serveritega. Iga sissetuleva ühenduse jaoks määrab tasakaalustaja järgmise vooru reaalse serveri päringu edastamiseks.
Prioriteet: ühendused on alati kõige olulisema prioriteediga. Tasakaalusta kõik ühendused sama kõrgeima prioriteediga serveriga. Kui see server on välja lülitatud, lülituvad ühendused järgmisele kõrgeimale serverile. Selle algoritmiga saate luua aktiivse passiivse klastri teenuse mitme reaalse serveriga.
Teenused objektiks GSLB taludele
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Teenuses määratletud taustaprogrammid. |
| talupoeg | nöör | See on FarmGuardian nimi, mis kontrollib taustaprogrammi olekut. FarmGuardian töötab samal ajal, kui talu seisab. |
| id | nöör | Teenuse nimi, mida kasutatakse kordumatu identifikaatorina. |
| algoritm | nöör | Teenuses kasutatav koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: roundrobin, mis tasakaalustab ühendused kõigi ülesvõtete vahel või prio mis saadab kõik ühendused esimese kättesaadava taustaprogrammiga. |
| deftcpport | nöör | TCP-pordi vaikekontroll. See on tervisekontrolli TCP-port, mida teenus kontrollib, et kindlaks teha, kas taustaprogramm on elus. Tühi väärtus on keelatud. |
Looge uus teenus
Looge uus teenus
Päringu näide:
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
Looge teenus antud GSLB talus. Selle muudatuse rakendamiseks tuleb talu uuesti alustada.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| id | nöör | Teenuse nimi, mida kasutatakse kordumatu identifikaatorina. | tõsi |
| algoritm | nöör | Teenuses kasutatav koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: roundrobin, mis tasakaalustab ühendused ja kõik tagaplaanid, või prio mis saadab kõik ühendused esimese kättesaadava taustaprogrammiga. | tõsi |
Vastuse näide:
{
"description" : "New service service1",
"params" : {
"algorithm" : "roundrobin",
"id" : "service1"
},
"status" : "needed restart"
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Teenuse muutmine
Teenuse muutmine
Päringu näide:
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>
Muuda GSLB teenuse parameetreid. id on teenuse kordumatu tunnus, mida muudetakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| deftcpport | Number | See on tervisekontrolli TCP-port, mida teenus kontrollib, et kindlaks teha, kas taustaprogramm on elus. |
Vastuse näide:
{
"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"
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Lisa FarmGuardian
Lisa FarmGuardian
Päringu näide:
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
Rakenda teenusele FarmGuardian.
URI parameeter on teenuse kordumatu tunnus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | FarmGuardian kordumatu tunnus. FarmGuardians luuakse ja muudetakse seirealas. FarmGuardian logid ei ole gslb talude jaoks saadaval. |
Vastuse näide:
{
"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"
}
Eemaldage FarmGuardian
Eemaldage FarmGuardian
Päringu näide:
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>
Eemaldage FarmGuardian GSLB-teenusest.
Vastuse näide:
{
"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"
}
Teenuse kustutamine
Teenuse kustutamine
Päringu näide:
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>
Kustutage GSLB talu antud teenus. id on teenuse kordumatu tunnus, mis kustutatakse.
Vastuse näide:
{
"description" : "Delete service service1 in farm gslbfarm",
"message" : "The service service1 in farm gslbfarm has been deleted.",
"success" : "true",
"status": "needed restart"
}
GSLB - Teenused - taustaprogrammid
See jaotis haldab teenusega seotud reaalset teenuse nimekirja.
Loetlege taustaprogrammid
Loetlege taustaprogrammid
Päringu näide:
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
Hankige teenuse taustaprogrammide loend. id on teenuse kordumatu tunnus.
Vastuse näide:
{
"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"
}
]
}
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Teenuse taustaprogrammi unikaalne identifikaator. See identifikaator genereeritakse süsteemi poolt. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| port | Number | Taustaprogrammi sadam, kus tegelik teenus kuulab. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
Loo uus taust
Loo uus taust
Päringu näide:
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
Looge GSLB talus antud teenuses uus taustaprogramm. id on teenuse kordumatu tunnus, kuhu taustaprogramm lisatakse.
Prioriteetsetel teenustel on 2-i taustaprogrammid kui maksimum, aktiivne host ja passiivne peremees.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. | tõsi |
Vastuse näide:
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 4,
"ip" : "192.135.10.2"
},
"status" : "needed restart"
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muuda taustaprogrammi
Muuda taustaprogrammi
Päringu näide:
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>
Muuda GSLB teenuse taustaprogrammi parameetreid.
Märkus PUT see on esimene id on teenuse unikaalne identifikaator ja järgmine id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
Vastuse näide:
{
"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"
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta taustaprogramm
Kustuta taustaprogramm
Päringu näide:
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>
Kustutage antud taustaprogramm GSLB-teenuses.
Vastuse näide:
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
GSLB - tsoonid
GSLB tsooni sektsioon kirjeldab DNS-domeeninime, alamdomeene, varjunimesid jne, mis on vajalikud täieliku DNS-tsooni loomiseks koos täiendavate koormuse tasakaalustamise kirjetega, kasutades määratud teenuseid.
Loo tsoon
Loo tsoon
Päringu näide:
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
Looge DNS-tsoon.
Päringu parameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| id | Number | Unikaalse indikaatorina kasutati tsooni nime. | tõsi |
Vastuse näide:
{
"description" : "New zone global.com",
"params" : {
"id" : "global.com"
}
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Tsooni muutmine
Tsooni muutmine
Päringu näide:
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>
Muuda tsooni parameetreid. id on tsooni kordumatu tunnus, mida muudetakse.
Päringu parameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| defnamesv | nöör | See on sissepääsupunkti juurenimi server, mis on saadaval asutuse alguspunkti (SOA) DNS-kirje kujul. |
Vastuse näide:
{
"description" : "Modify zone global.com in farm gslbfarm",
"params" : {
"defnamesv" : "ns3"
}
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Tsooni kustutamine
Tsooni kustutamine
Päringu näide:
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>
Kustutage GSLB talu teatud tsoon.
Vastuse näide:
{
"description" : "Delete zone dom.com in farm gslbfarm.",
"message" : "The zone dom.com in farm gslbfarm has been deleted.",
"success" : "true"
}
GSLB - tsoonid - ressursid
DNS-teenusena määratletud ressursid lahendavad taotlused. Võimalikud DNS-i ressursid Zevenet'i koormuse saldodes on:
- NS. Name Server tüüpi kirje, mis delegeerib DNS-tsooni antud autoriteetsete nimeserverite kasutamiseks.
- A. Aadressi tüübi kirje, mis tagastab hostile IPv4i aadressi.
- CNAME. Kanooniline nimetüübi kirje, see esindab antud nime varjunime.
- DYNA. Dünaamilise aadressi tüübi kirje, ta tagastab dünaamilise aadressi, mis on määratud GSLB teenusega, mis on juba loodud talumaja konfiguratsioonis vastavalt sellisele teenusele valitud algoritmile.
- AAAA. Aadressi tüübi kirje, mis tagastab hostile IPv6i aadressi.
- MX. E-posti vahetuse tüübi kirje kaardistab domeeninime selle domeeni sõnumiedastusagentide loendisse.
- SRV. Teenusepakkuja tüübi kirje, üldistatud teenuse asukoha kirje, mida kasutatakse uuemate protokollide asemel protokolli-spetsiifiliste kirjete, nagu MX, loomiseks.
- TXT. Tekstitüübi kirje, mida kasutatakse tekstipõhise teabe salvestamiseks, mida saab vajadusel haarata. Kõige sagedamini näeme TXT-kirjeid, mida kasutatakse SPF-andmete hoidmiseks ja domeeni omandiõiguse kontrollimiseks.
- PTR. Pointeri kirje, kanoonilise nime osuti. Erinevalt CNAME-st peatub DNS-i töötlemine ja lihtsalt nimi tagastatakse. Kõige tavalisem kasutamine on tagurpidi DNS-i otsingute rakendamiseks.
- NAPTR. Nimetamise asutuse pointer, võimaldab regulaarselt väljendada domeeninimede ümberkirjutamist, mida saab seejärel kasutada URI-dena, täiendavateks domeeninimedeks otsingutele jne.
Loetlege ressursid
Loetlege ressursid
Päringu näide:
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
Hankige tsoonis ressursside nimekiri. id on tsooni kordumatu tunnus.
Vastuse näide:
{
"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"
}
]
}
Vastusparameetrid
See kõne tagastab ressursiobjektide massiivi parameetritega.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Tsooni ressursi unikaalne identifikaator. |
| rname | nöör | Ressursinimi on hüüdnimi, mida DNS-teenus tõlkib tegelike nõutavate andmete jaoks rdata. |
| ttl | Number | Praeguse kirje väärtus, mis on vajalik ajale Live (vabatahtlik), mis on vajalik selleks, et määrata, kui kaua praegune nimi salvestatakse. |
| tüüp | nöör | DNS-i kirje tüüp. Valikud on järgmised: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Lisateabe saamiseks vaadake GSLB - tsoonid - ressursid sektsiooni. |
| rdata | nöör | See on rekorditüübi jaoks vajalikud tegelikud andmed, sisendväärtus sõltub ressursi nime liigist, rname ja ressursitüüp, tüüp. |
Loo uus ressurss
Loo uus ressurss
Päringu näide:
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
Looge GSLB talu kindlas tsoonis uus ressurss. id on tsooni kordumatu tunnus, mida muudetakse, kui ressurss lisatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| rname | nöör | Ressursinimi on hüüdnimi, mida DNS-teenus tõlkib tegelike nõutavate andmete jaoks rdata. | tõsi |
| ttl | Number | Aeg elada praeguse kirje väärtus. See on ruuteri maksimaalne arv, mille saab päring surra. Kasulik on see, et paketti ei sisestata võrgusilmus. | |
| tüüp | nöör | DNS-i kirje tüüp. Valikud on järgmised: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Lisateabe saamiseks vaadake GSLB - tsoonid - ressursid sektsiooni. | tõsi |
| rdata | nöör | See on rekorditüübi jaoks vajalikud tegelikud andmed, sisendväärtus sõltub ressursi nime liigist, rname ja ressursitüüp, tüüp. Kui DYNA on valitud tüüp siis peab rdata väärtus olema üks konfigureeritud teenused selles tsoonis. | tõsi |
Vastuse näide:
{
"description" : "New zone resource",
"message" : "Resource added",
"params" : {
"rdata" : "192.168.0.9",
"rname" : "resource2",
"ttl" : 10,
"type" : "A",
"zone" : "global.com"
}
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muutke ressurssi
Muutke ressurssi
Päringu näide:
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>
Muuda resouce parameetreid GSLB talu tsoonis.
esimene id on järgmise tsooni kordumatu tunnus id on ressursi kordumatu tunnus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| rname | nöör | Ressursinimi on hüüdnimi, mida DNS-teenus tõlkib tegelike nõutavate andmete jaoks rdata. |
| ttl | Number | Praeguse kirje väärtus, mis on vajalik ajale Live (vabatahtlik), mis on vajalik selleks, et määrata, kui kaua praegune nimi salvestatakse. |
| tüüp | nöör | DNS-i kirje tüüp. Valikud on järgmised: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). Lisateabe saamiseks vaadake GSLB - tsoonid - ressursid sektsiooni. |
| rdata | nöör | See on rekorditüübi jaoks vajalikud tegelikud andmed, sisendväärtus sõltub ressursi nime liigist, rname ja ressursitüüp, tüüp. Kui tüüp on koormatud väärtusega DYNA SIIS rdata tuleb laadida saadaval teenus nimi |
Vastuse näide:
{
"description" : "Modify zone resource",
"message" : "Resource modified",
"params" : {
"rdata" : "192.168.200.30",
"rname" : "resource2",
"ttl" : null,
"type" : "A"
},
"success" : "true"
}
Vastuse parameetrid
Vastuseks on kõik taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Kustutage ressurss
Kustutage ressurss
Päringu näide:
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>
Kustutage antud resouce GSLB talu tsoonis
Pange tähele, et DELETE URI üle esimese id on tsooni unikaalne identifikaator ja järgmine id on ressursi kordumatu tunnus.
Vastuse näide:
{
"description" : "Delete zone resource",
"message" : "Resource removed",
"success" : "true"
}
Datalink Farms
Datalinki talu profiil ehk DSLB (Datalink Service Load Balancing) võimaldab luua marsruudipõhise farmi, kus taustaprogrammid on üleslingi marsruuterid või lüüsid. Selline taluprofiil on valmis jagama mitut üleslingi WAN-ruuteri juurdepääsu, kasutades koormuse tasakaalustajat üleslingi kanali multipleksorina (1 sisend ja mitu ruuteri liini väljundit). Seetõttu saab datalinki farme kasutada kõrgete saadaolevate sidelinkidena ja lisaks kasutada ribalaiuse suurenemisena, ühendades ruuterite taustaprogrammide linkide ribalaiuse hulga.
Too talu nime järgi
Too talu nime järgi
Päringu näide:
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>
Kuva kõik talu konfiguratsioonid.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ipds | objekt | Selle talu IPDS-reeglite loetelu. |
| parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
| taustaprogrammid | Objekt [] | Selles talus loodud reaalsed serverid ja selle konfiguratsioon. |
IPDS-objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| mustad nimekirjad | String [] | Talumajapidamises rakendati musti loendeid. |
Parameetrite objekt datalinkide taludele:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal, jagab tasakaalustaja kõigi olemasolevate taustaprogrammide vahel, mis annavad suurema kaaluga atribuudiga või prio, mis saadab kõik ühendused taustaprogrammiga väikese väärtusega prioriteet. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on ülespoole ja kõik taustaprogrammid on kättesaamatud; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
Datalinkide talumajapidamiste taustaprogramm:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Talumajapidamise ainulaadne identifikaator. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
| prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Seda kasutatakse siis, kui algoritm on konfigureeritud prioriteedina ja madalam prioriteet eelistatakse |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on seadistatud kaaluks. |
Loo uus talu
Loo uus talu
Päringu näide:
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
Looge uus datalinkimaja.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| farmname | nöör | Põllumajandusettevõtte nimi, kordumatu tunnus. | tõsi |
| profiil | nöör | Loodud talu profiil. Datalink-tüüpi talu loomiseks on võti andmelink | tõsi |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. | tõsi |
| copy_from (alates 4.0.1) | nöör | See parameeter eeldab olemasoleva talu nime. Selle parameetri saatmise korral kopeeritakse farm selles täpsustatud talust. farmname ja vip väärtused kirjutatakse üle. |
Vastuse näide:
{
"description" : "Creating farm 'dlink'",
"params" : {
"farmname" : "dlink",
"interface" : "eth0",
"profile" : "datalink",
"vip" : "192.168.100.241"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda talu
Muuda talu
Päringu näide:
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>
Muuda datalinkide ettevõtte konfiguratsiooni.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| newfarmname | nöör | Uus talu nimi. Selle välja muutmiseks tuleb talu peatada. |
| algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal, jagab tasakaalustaja kõigi olemasolevate taustaprogrammide vahel, mis annavad suurema kaaluga atribuudiga või prio, mis saadab kõik ühendused taustaprogrammiga väikese väärtusega prioriteet. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
Vastuse näide:
{
"description" : "Modify farm dlink",
"params" : {
"algorithm" : "weight",
"vip" : "192.168.100.199",
"newfarmname" : "dlink2"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Lisage IPDS-reegel
Lisage IPDS-reegel
Päringu näide:
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>
Rakenda põllumajandusettevõttele musta nimekirja reegel. Datalinki profiil aktsepteerib ainult musta nimekirja reegleid.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Unikaalse identifikaatorina kasutatav IPDS-reegli nimi. |
Vastuse näide:
{
"description" : "Apply a rule to a farm",
"message" : "Blacklist rule china was applied successful to the farm dlink2.",
"success" : "true"
}
Eemaldage IPDS-reegel
Eemaldage IPDS-reegel
Päringu näide:
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>
Eemaldage IPDS-mooduli musta nimekirja reegel antud talust kasutades selle indikaatorit nimi.
Vastuse näide:
{
"description" : "Delete a rule from a farm",
"message" : "Blacklist rule china was removed successful from the farm dlink2.",
"success" : "true"
}
Datalink - taustaprogrammid
Datalinkide talumajapidamised on teenuse marsruutimise kaudu väravad. Teenus mitmekordistub nende väravate vahel ja mõned neist ei ole kättesaadavad, teenus kasutab teist (d).
Loetlege taustaprogrammid
Loetlege taustaprogrammid
Päringu näide:
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
Hankige teenuse taustaprogrammide loend.
Vastuse näide:
[
{
"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
}
]
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | See on nick, mis aitab taustaprogrammi kindlaks teha. Teise nimega |
| id | Number | Põllumajandusettevõtte taustaprogrammi unikaalne identifikaator. See identifikaator genereeritakse süsteemi poolt. |
| liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| prioriteet | Number | See on praeguse taustaprogrammi prioriteetne väärtus. Seda kasutatakse siis, kui algoritm on konfigureeritud prioriteedina ja madalam prioriteet eelistatakse. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on seadistatud kaaluks. |
Loo uus taust
Loo uus taust
Päringu näide:
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
Looge antud taustaprogrammile uus taustaprogramm.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. | tõsi |
| liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. | tõsi |
| prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Seda kasutatakse siis, kui algoritm on konfigureeritud prioriteedina ja madalam prioriteet eelistatakse. Vaikeväärtus on 1. | |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on seadistatud kaaluks. Vaikeväärtus on 1. |
Vastuse näide:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muuda taustaprogrammi
Muuda taustaprogrammi
Päringu näide:
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>
Muuda taustaprogrammi parameetreid datalinki talu teenuses. id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
| liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
| prioriteet | Number | Teatud päringule vastamine on taustaprogrammi prioriteet. |
| kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. |
Vastuse näide:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"interface" : "eth0",
"ip" : "192.168.102.50",
"priority" : 1,
"weight" : 1
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta taustaprogramm
Kustuta taustaprogramm
Päringu näide:
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>
Kustutage datalink-talust antud taustaprogramm. id on taustaprogrammi unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
võrk
Zevenet võib töötada erinevat tüüpi võrguliideste abil.
Selles jaotises saate NIC-, VLAN-, virtuaal- ja sidumisliideseid loetleda, luua, konfigureerida, kustutada ja määrata.
Nic: või võrguliidese kaart, see on arvuti riistvara komponent. Ülejäänud liidesed põhinevad NIC-idel.
vlan: või virtuaalne LAN-kaart on mingi võrguliides, mis pakub võrgusegmentimisteenuseid. Nic liidese kaudu saab luua rohkem kui ühe VLANi.
bonding: Ka teisi müüjaid nimetatakse pagasirajaliideteks, seda tüüpi nööri saab luua rohkem kui ühe nic liidesega. Zevenet toetab 7i erinevat tüüpi liideseid.
virtuaalne: Seda tüüpi liidese saab luua mis tahes ülalkirjeldatud liidese üle ja nad kasutavad oma vanemliidese marsruutimislaudu, nii et see peab olema konfigureeritud samas võrgusegmendis kui tema vanem. Seda tüüpi liidest tuleks kasutada põllumajandusettevõtete jaoks.
Loetlege kõik liidesed
Loetlege kõik liidesed
Päringu näide:
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
Hankige süsteemi liidesed nende konfiguratsiooniga.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on liidese objektirühm.
Liidese objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. IP peab paiknema samas võrgusegmendis, mis on tema liideses virtuaalses liideses. |
| has_vlan | nöör | tõsi, see liides on VLAN-liidese vanem; või vale, sellel liidesel pole ühtegi VLAN-liidest. See väli on ainult NIC-liideste jaoks. |
| võrgumask | nöör | Liidese võrgumask. Seda väärtust ei saanud virtuaalsetes liideses muuta, see on päritud vanemliideselt. |
| värav | nöör | Liidese värav. Seda väärtust ei saanud virtuaalsetes liideses muuta, see on päritud vanemliideselt. |
| mac | nöör | Liidese MAC. See väärtus pärineb esimesest NIC-orjast sidumisliidestes. Virtuaalsetes ja VLAN-i liidestes pärineb see vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, ei saa liides pakette vastu võtta. |
| tüüp | nöör | Erinevad liidesed on järgmised: Nic, vlan, virtuaalne or võlakiri. |
| is_slave | nöör | Saadaval ainult NIC-liideses, tõsi, liides on osa sidumisliidest, vale liides ei ole sidumisliidese osa. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Too vaikimisi lüüs
Too vaikimisi lüüs
Päringu näide:
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>
Vaikevärav on sõlmpunkt, mis saadab kogu sihtliikluse, mis ei ole koormuse tasakaalustaja mis tahes liideselt kohapeal kättesaadav.
Hankige vaikelüüsi liidese parameetrid.
Süsteem on seadistanud kaks lüüsi, üks kord IPv4i ja teise IPv6i marsruutimiseks. URI ootab IP-versiooni ipv4 or ipv6.
Vastuse näide:
{
"description" : "Default gateway",
"params" : {
"address" : "192.168.100.5",
"interface" : "eth0"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| aadress | nöör | See on lüüsi IP. |
| liides | nöör | Lüüsi liidese nimi. |
Muuda vaikelüüsi
Muuda vaikelüüsi
Päringu näide:
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>
Muuda lüüsi liidese konfiguratsiooni.
URI ootab aadressiväljal kasutatavat IP-versiooni. Võimalikud väärtused on ipv4 ja ipv6.
Vastuse näide:
{
"description" : "Modify default gateway",
"message" : "The default gateway has been changed successfully",
"success" : "true"
}
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| aadress | nöör | See on lüüsi IP. |
| liides | nöör | Lüüsi liidese nimi. |
Kustuta lüüsi konfiguratsioon
DELETE /interfaces/gateway/<ip_version>
Kustuta vaikelüüsi konfiguratsiooni konfiguratsioon.
URI eeldab, et vaikimisi lüüsi üks IP-versioon kustutatakse. Võimalikud väärtused on ipv4 ja ipv6.
Hoiatus: kui lüüsi ei ole, ei ole Zevenet välisvõrgu segmendist kättesaadav.
Kustuta lüüsi konfiguratsioon
Päringu näide:
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
Vastussõnum
Kui lüüs on sama võrgusegmendist välja lülitatud, ilmub see teade, vastasel juhul kaob ühendus.
Vastuse näide:
{
"description" : "Remove default gateway",
"message" : "The default gateway has been deleted successfully",
"params" : {
"address" : null,
"interface" : null
}
}
Võrk - NIC liidesed
NIC-liidesed on teie Zevenet-i koormuse tasakaalustajaga ühendatud füüsilised liidesed.
Süsteem tuvastab uued liidesed automaatselt pärast nende ühendamist.
Kasutades NIC-liideseid vanematena, saab luua muud tüüpi liideseid, millel on erinevad omadused. Saadaolevad liidesed on VLAN, virtuaalne ja bonding.
NIC-liideste loend
GET /interfaces/nic
Hankige kõik NIC-liideste parameetrid.
NIC-liideste loend
Päringu näide:
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
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on rida NIC-liidese objekte.
NIC-i liidese objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. |
| has_vlan | nöör | tõsi, see liides on VLAN-liidese vanem; või vale, sellel liidesel pole ühtegi VLAN-liidest. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse pakettide saatmiseks teisele võrgusegmendile. |
| mac | nöör | Linkkihi unikaalne identifikaator. See on muutmatu. |
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, ei saa liides pakette vastu võtta. |
| is_slave | nöör | tõsi liides on osa sidumisliidest, \ t vale liides ei ole sidumisliidese osa. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
NIC-liidese hankimine
NIC-liidese hankimine
Päringu näide:
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>
Hangi kõik NIC-liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse pakettide saatmiseks teisele võrgusegmendile. |
| mac | nöör | Linkkihi unikaalne identifikaator. See on muutmatu. |
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, ei saa liides pakette vastu võtta. |
| tüüp | nöör | Erinevat tüüpi liidesed on: Nic, vlan, virtuaalne or võlakiri. Igaüks neist on määratletud nende alammenüüs. |
| is_slave | nöör | tõsi liides on osa sidumisliidest, \ t vale liides ei ole sidumisliidese osa. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Muuda NIC-liidest
Muuda NIC-liidest
Päringu näide:
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>
Muutke NIC-liidese parameetreid. nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| sundida | nöör | Kui farm kasutab liidest, ei saa seda liidest muuta. Siis, kui see parameeter saadetakse koos väärtusega tõsi, liides on sunnitud võtma uue konfiguratsiooni ja kõik talud kasutavad liidest taaskäivitatakse. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Vastuse näide:
{
"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"
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta NIC-konfiguratsioon
Kustuta NIC-konfiguratsioon
Päringu näide:
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>
Kustutage NIC-liidese konfiguratsioon. Pärast seda toimingut on liides kasutu ja uuesti konfigureerimiseks valmis. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete nic interface",
"message" : "The configuration for the network interface eth3 has been deleted.",
"success" : "true"
}
Määra NIC-liidese toiming
Määra NIC-liidese toiming
Päringu näide:
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
Rakenda NIC-liidesele toiming. See kõne võimaldab võrguliidese lubamist või keelamist.
nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Liidesele rakendatav tegevus. Olemasolevad väärtused on järgmised: uplubage liides ja valmistage see ette kasutamiseks; alla, keelake liides, et pakette mitte vastu võtta või mitte. | tõsi |
Vastuse näide:
{
"description" : "Action on nic interface",
"params" : {
"action" : "up"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Võrgu - VLAN liidesed
VLAN-i liides võimaldab NIC-i või sidumisliidese töötada teises võrgus, nii et võrgu konfiguratsioon (IP, väravja võrgumask) peab olema erinevas võrgusegmendis. VLAN-i liides pärsib MAC-aadressi oma vanemliideselt.
VLAN-i liideste väli nimi ilmub punktiga ".", mida kasutatakse VLAN-liidese identifikaatorite loomiseks.
Nimeta VLAN-i liidesed
Nimeta VLAN-i liidesed
Päringu näide:
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
Hankige kõik VLAN-i liideste parameetrid.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on VLAN-i liidese objekti massiiv.
VLAN-i parameetrid on järgmised:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. See võib olla erinev ema-liidese IP-st. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| mac | nöör | Liidese MAC. See väärtus pärineb vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanema liidese nime, punktmärgi „.” Abil. ja number VLAN-võrguliidese või VLAN-märgendi jaoks. |
| vanem | nöör | Selle loomiseks kasutatakse seda liidest. |
| staatus | nöör | Väärtused võivad olla up liides võib vastu võtta pakette, alla liides ei saa pakette vastu võtta. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
VLAN-i liidese hankimine
VLAN-i liidese hankimine
Päringu näide:
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>
Hankige kõik VLAN-i liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| mac | nöör | Liidese MAC. See väärtus pärineb vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanema liidese nime, punktmärgi „.” Abil. ja number VLAN-võrguliidese jaoks. |
| staatus | nöör | Väärtused võivad olla up liides võib vastu võtta pakette, alla liides ei saa pakette vastu võtta. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Looge VLAN-liides
Loo VLAN-i liides
Päringu näide:
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
Looge VLAN-i liides NIC-i või sidumisliidese kaudu. Uus VLAN-i liides jagab MAC-i, kuigi järgmised võrguparameetrid peavad olema erinevad: ipja järgmised muudatused võivad muutuda: värav, võrgumask.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Liidese IP. See peab erinema põhiliidese IP-st. | tõsi |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. | tõsi |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. | tõsi |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanema liidese nime, punktmärgi „.” Abil. ja number VLAN-võrguliidese jaoks. | tõsi |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. | |
| mac | nöör | Kirjutab liidese MAC-i uuesti. |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Muuda VLAN-i liidest
Muuda VLAN-i liidest
Päringu näide:
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>
Muuda VLAN-i liidese parameetreid. nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Liidese IP. See võib olla erinev ema-liidese IP-st. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
| mac | nöör | Kirjutab liidese MAC-i uuesti. |
| sundida | nöör | Kui farm kasutab liidest, ei saa seda liidest muuta. Siis, kui see parameeter saadetakse koos väärtusega tõsi, liides on sunnitud võtma uue konfiguratsiooni ja kõik talud kasutavad liidest taaskäivitatakse. |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta VLAN-i liides
Kustuta VLAN-i liides
Päringu näide:
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>
VLAN-liidese kustutamine. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete VLAN interface",
"message" : "The VLAN interface eth0.1 has been deleted.",
"success" : "true"
}
Seadke VLAN-i liidese tegevus
Seadke VLAN-i liidese tegevus
Päringu näide:
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
Rakenda VLAN-liidesele toiming. See kõne võimaldab võrguliidese lubamist või keelamist.
nimi on unikaalne nimi.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Liidesele rakendatav tegevus. Olemasolevad väärtused on järgmised: uplubage liides ja valmistage see ette kasutamiseks; alla, keelake liides, et pakette mitte vastu võtta või mitte. | tõsi |
Vastuse näide:
{
"description" : "Action on vlan interface",
"params" : {
"action" : "down"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Võrk - virtuaalsed liidesed
Võrgu liidesed võimaldavad kasutajatel seada samas võrgusegmendis teise võrguliidese kui nende vanemad, nii et virtuaalsed liidesed pärivad võrgukonfiguratsiooni alati oma vanemalt. Erinev parameeter on ip. Virtuaalset liidest saab luua NIC, side või VLAN abil. Uue virtuaalse liidese loomine ilmub kooloniga „:” tähistatud väljale, mida kasutatakse virtuaalse liidese identiteedi loomiseks.
Nimekiri virtuaalsed liidesed
Nimekiri virtuaalsed liidesed
Päringu näide:
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
Hankige kõik virtuaalsete liideste parameetrid.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis, mida vanemliides. |
| võrgumask | nöör | Määrake võrgu segment, kus liides töötab. See pärineb vanemliideselt. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. See pärineb vanemliideselt. |
| mac | nöör | Liidese MAC. See pärineb vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on vanemliidese abil vormindatud kett, koolon märk „:” ja virtuaalse võrguliidese nimi on lubatud tähtnumbriliste tähtedega. |
| vanem | nöör | Selle loomiseks kasutatakse seda liidest. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, ei saa liides pakette vastu võtta. |
Too virtuaalne liides
Too virtuaalne liides
Päringu näide:
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>
Hangi kõik virtuaalse liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis, mida vanemliides. |
| võrgumask | nöör | Määrake võrgu segment, kus liides töötab. See pärineb vanemliideselt. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. See pärineb vanemliideselt. |
| mac | nöör | Liidese MAC. See pärineb vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanemliidese, koolonimärgi „:” ja virtuaalse võrguliidese tähtnumbrilise stringi abil. |
| vanem | nöör | Selle loomiseks kasutatakse seda liidest. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, ei saa liides pakette vastu võtta. |
Loo virtuaalne liides
Loo virtuaalne liides
Päringu näide:
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
Loo virtuaalne liides.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis, mida vanemliides. | tõsi |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanemliidese, koolonimärgi „:” ja virtuaalse võrguliidese tähtnumbrilise stringi abil. | tõsi |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on liidese konfiguratsiooniga JSON. Lisateabe saamiseks vaadake vastuse näidet.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis, mida vanemliides. |
| võrgumask | nöör | Määrake võrgu segment, kus liides töötab. See pärineb vanemliideselt. |
| värav | nöör | IP, mida kasutatakse pakettide saatmiseks teisele võrgusegmendile. See pärineb vanemliideselt. |
| mac | nöör | Liidese MAC. See pärineb vanemliideselt. |
| nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mis on vormindatud vanemliidese, koolonimärgi „:” ja virtuaalse võrguliidese tähtnumbrilise stringi abil. |
Virtuaalse liidese muutmine
Virtuaalse liidese muutmine
Päringu näide:
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>
Muutke virtuaalse liidese parameetreid. nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | nõutav |
|---|---|---|---|
| ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis, mida vanemliides. | tõsi |
| sundida | nöör | Kui farm kasutab liidest, ei saa seda liidest muuta. Siis, kui see parameeter saadetakse koos väärtusega tõsi, liides on sunnitud võtma uue konfiguratsiooni ja kõik talud kasutavad liidest taaskäivitatakse. |
Vastuse näide:
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10",
"force" : "true"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta virtuaalne liides
Kustuta virtuaalne liides
Päringu näide:
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>
Virtuaalsete liideste kustutamine. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete virtual interface",
"message" : "The virtual interface eth0:virtiface has been deleted.",
"success" : "true"
}
Seadista virtuaalse liidese tegevus
Seadista virtuaalse liidese tegevus
Päringu näide:
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
Rakendage toimingut virtuaalsele liidesele. See kõne võimaldab võrguliidese lubamist või keelamist.
nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Liidesele rakendatav tegevus. Olemasolevad väärtused on järgmised: uplubage liides ja valmistage see ette kasutamiseks; alla, keelake liides, et pakette mitte vastu võtta või mitte. | tõsi |
Vastuse näide:
{
"description" : "Action on virtual interface",
"params" : {
"action" : "down"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Võrk - sidumisliidesed
Linuxi sidumisliides või ka teiste müüjate poolt pakutud Trunk pakub meetodit mitme võrguliidese koondamiseks üheks loogiliseks liideseks. Ühendatud liideste käitumine sõltub režiimist, Zevenet Load Balancer toetab järgmisi meetodeid:
Ümarahela poliitika: Edastage pakette järjestikuses järjekorras esimesest olemasolevast orjast viimase kaudu. See režiim tagab koormuse tasakaalustamise ja tõrketaluvuse.
Aktiivne varukoopia: Ainult üks sideme ori on aktiivne. Erinev ori muutub aktiivseks, kui ja ainult siis, kui aktiivne ori ei toimi. Lingi MAC-aadress on väliselt nähtav ainult ühel pordil (võrgukaart), et vältida lüliti segadust. See režiim tagab tõrketaluvuse. Esmane valik mõjutab selle käitumist.
XORi poliitika: Edastamine lähteallika MAC-aadressi XOR'd alusel sihtkoha MAC-aadressiga. See valib sama sihtkoha iga MAC-aadressi jaoks. See režiim tagab koormuse tasakaalustamise ja tõrketaluvuse.
Ringhäälingupoliitika: Edastab kõike kõigil ori liidestel. See režiim tagab tõrketaluvuse.
IEEE 802.3ad LACP: Loob koondamisgrupid, millel on ühesugused kiiruse ja dupleksseaded. Kasutab kõiki aktiivseid agregatoreid vastavalt 802.3adi spetsifikatsioonile.
Eeltingimused:
Võrgu liidese tugi baasi draiverites iga ori kiiruse ja dupleksi saamiseks.
Lüliti, mis toetab IEEE 802.3adi dünaamilise lingi koondamist. Enamik lülititest vajab 802.3adi režiimi lubamiseks teatud tüüpi konfiguratsiooni.
Adaptive edastuskoormuse tasakaalustamine: Kanaliühendus, mis ei vaja spetsiaalset lülititugi. Väljuv liiklus jaotatakse vastavalt igale orjale jooksva koormuse (kiiruse suhtes arvutatud) järgi. Sissetulev liiklus saabub praegusele orjale. Kui vastuvõtev slave ei õnnestu, võtab teine slave ebaõnnestunud vastuvõtva orja MAC-aadressi üle.
Eeltingimus:
Alustage juhi tugi iga orja kiiruse saamiseks.
Kohanduv koormuse tasakaalustamine: Sisaldab adaptiivset ülekandekoormuse tasakaalustamist ja IPV4i liikluse koormuse tasakaalustamist ning ei vaja spetsiaalset lülititugi. Vastuvõtu koormuse tasakaalustamine saavutatakse ARP läbirääkimistega. Sidumisseadme juht takistab kohaliku süsteemi poolt saadetud väljapääsu ARP-vastuseid ja kirjutab allika riistvara aadressi ühe liiteseadme unikaalse riistvara aadressi nii, et erinevad eakaaslased kasutavad serverile erinevaid riistvara aadresse.
Loend Sidumisliidesed
Loend Sidumisliidesed
Päringu näide:
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
Konfigureerige süsteemi kõik liideseid.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on sidumisliidese objekti massiiv.
Sidumisparameetrid on:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| mac | nöör | Linkkihi unikaalne identifikaator. See on mac esimese NIC liidese orja. |
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, liides ei saa pakette vastu võtta. |
| orjad | Objekt [] | Sidumisliidese NIC liidese liikmed. |
| režiimis | nöör | See on liimimisliidese töörežiim. Valikud on järgmised: tasakaal-rr, Ümmargune poliitika; aktiivne varukoopiaAktiivne varukoopia; tasakaalu - võiXOR poliitika; ülekanne, Ringhäälingupoliitika; 802.3ad, IEEE 802.3ad LACP; tasakaal-tlbAdaptive saatekoormuse tasakaalustamine; tasakaal-alb, Kohanduv koormuse tasakaalustamine. Need väärtused on määratletud punktis Võrk - sidumisliidesed. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Orjade objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Nimi on NIC orja liidese unikaalne identifikaator. |
Laadi sidumisliides
Laadi sidumisliides
Päringu näide:
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>
Hangi kõik liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on sidumisliidese objekt.
Sidumisparameetrid on:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| mac | nöör | Linkkihi unikaalne identifikaator. See on mac esimese NIC liidese orja. |
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, liides ei saa pakette vastu võtta. |
| orjad | Objekt [] | Sidumisliidese NIC liidese liikmed. |
| režiimis | nöör | See on liimimisliidese töörežiim. Valikud on järgmised: tasakaal-rr, Ümmargune poliitika; aktiivne varukoopiaAktiivne varukoopia; tasakaalu - võiXOR poliitika; ülekanne, Ringhäälingupoliitika; 802.3ad, IEEE 802.3ad LACP; tasakaal-tlbAdaptive saatekoormuse tasakaalustamine; tasakaal-alb, Kohanduv koormuse tasakaalustamine. Need väärtused on määratletud punktis Võrk> Liimimisliidesed. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
Ori objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Nimi on NIC orja liidese unikaalne identifikaator. |
Loo sidumisliides
Loo sidumisliides
Päringu näide:
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
Looge NIC-liideste ühendamiseks liidese liides.
Sidumise MAC-aadress võetakse selle esimesest NIC-liidesest. Liimimisrežiimi ei saa pärast liidese liidese loomist muuta, kuid liideseid võib liidese liideses vajadusel lisada või kustutada. NIC-liides lukustatakse, kui see on liidese liidese osa.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. | tõsi |
| orjad | String [] | Kõik NIC-liidesed, mis loovad sideme. Nõutav on NIC-parameeter nimi. | tõsi |
| režiimis | nöör | See on liimimisliidese töörežiim. Valikud on järgmised: tasakaal-rr, Ümmargune poliitika; aktiivne varukoopiaAktiivne varukoopia; tasakaalu - võiXOR poliitika; ülekanne, Ringhäälingupoliitika; 802.3ad, IEEE 802.3ad LACP; tasakaal-tlbAdaptive saatekoormuse tasakaalustamine; tasakaal-alb, Kohanduv koormuse tasakaalustamine. Need väärtused on määratletud punktis Võrk> Liimimisliidesed. | tõsi |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on konfigureeritud parameetrid.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| mac | nöör | Linkkihi unikaalne identifikaator. See on mac esimese NIC liidese orja. |
| nimi | nöör | Liidese nimi. Seda kasutatakse liidese unikaalse identifikaatorina. |
| staatus | nöör | Väärtused võivad olla up, liides võib vastu võtta pakette; alla, liides ei saa pakette vastu võtta. |
| orjad | Objekt [] | NIC liidesed, mis loovad liidese liidese. |
| režiimis | nöör | See on liimimisliidese töörežiim. Valikud on järgmised: tasakaal-rr, Ümmargune poliitika; aktiivne varukoopiaAktiivne varukoopia; tasakaalu - võiXOR poliitika; ülekanne, Ringhäälingupoliitika; 802.3ad, IEEE 802.3ad LACP; tasakaal-tlbAdaptive saatekoormuse tasakaalustamine; tasakaal-alb, Kohanduv koormuse tasakaalustamine. Need väärtused on määratletud punktis Võrk> Liimimisliidesed. |
Ori objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Nimi on NIC orja liidese unikaalne identifikaator. |
Muuda sidumisliidest
Muuda sidumisliidest
Päringu näide:
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>
Muuda sidumisliidese parameetreid. nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ip | nöör | Liidese IP. |
| võrgumask | nöör | Määrake võrgusegment, kus liides töötab. |
| värav | nöör | IP, mida kasutatakse erinevate võrgusegmendi pakettide saatmiseks. |
| sundida | nöör | Kui farm kasutab liidest, ei saa seda liidest muuta. Siis, kui see parameeter saadetakse koos väärtusega tõsi, liides on sunnitud võtma uue konfiguratsiooni ja kõik talud kasutavad liidest taaskäivitatakse. |
| dhcp | nöör | Võimaldab DHCP-teenusel saada liidese võrgu konfiguratsiooni DHCP-serverist. See parameeter aktsepteerib: tõsiteenuse lubamiseks blokeeritakse liidese konfiguratsioon, kui DHCP-teenus on lubatud; vale teenuse peatamiseks kaotab liides kogu võrgu konfiguratsiooni. |
| mac | nöör | Kirjutab liidese MAC-i uuesti. |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta sidumiskonfiguratsioon
Kustuta sidumiskonfiguratsioon
Päringu näide:
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>
Kustutage liidese liidese konfiguratsioon. Konfiguratsiooniparameetrid on järgmised: värav, ip ja võrgumask.
nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete bonding network configuration",
"message" : "The configuration for the bonding interface bondiface has been deleted.",
"success" : "true"
}
Määra sidumisliidese toiming
Määra sidumisliidese toiming
Päringu näide:
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
Rakendage liimimisliidesele toiming. See kõne võimaldab sidumisliidese kustutamist ja selle lubamist või keelamist.
Vajalik on sidumisliidese kustutamine hävitama toiming, kui soovite lahti ühendada kasutatud NIC-liidesed. Seejärel taastab liimimisdraiver MAC-aadressid, mis liikmeliidestel olid enne nende ühendamisliidesesse lisamist.
nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | Liidesele rakendatav tegevus. Olemasolevad väärtused on järgmised: up lubage liides ja valmistage see ette kasutamiseks alla keelake liides, et pakette ei saada või mitte, hävitama kustutada liimimine ja taastada NIC-i orjade liidesed. | tõsi |
Vastuse näide:
{
"description" : "Action on bond interface",
"params" : {
"action" : "up"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Lisa liimimisliides
Lisa liimimisliides
Päringu näide:
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
Lisage olemasoleva sidumisliidese jaoks ori NIC-liides.
nimi on liidese unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | NIC-liidesed nimi liidese liidese lisamiseks. | tõsi |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on uuendatud konfiguratsiooniga väärtustega JSON. Lisateabe saamiseks vaadake vastuse näidet.
Eemaldage liimimisliides
Eemaldage liimimisliides
Päringu näide:
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>
Kustutage liidesega NIC slave liides. Sidumisliidese peab olema peaaegu üks NIC-i alliliides.
Esiteks nimi on DELETE kõne on sidumisnime unikaalne identifikaator nimi aasta DELETE kõne on liidese nime unikaalne identifikaator.
Vastuse näide:
{
"description" : "Remove bonding slave interface",
"message" : "The bonding slave interface eth2 has been removed.",
"success" : "true"
}
Võrk - ujuvad liidesed
Selline liides kasutab määratletud virtuaalset liidest ja varjab a Nic, bonding or VLAN liides lapsega virtuaalne liides. Seda liidest kasutatakse l4xnati profiilides olekus, kus klaster on konfigureeritud.
Nimekirja ujuvad liidesed
Nimekirja ujuvad liidesed
Päringu näide:
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
Näita kõiki olemasolevaid või konfigureeritud liideseid, kus ujuv IP on loodud.
Vastuse näide:
{
"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
}
]
}
Vastuse parameetrid
Vastus on JSON-objekt, millel on ujuva liidese objekti massiiv:
Ujuv objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| floating_alias | nöör | See on virtuaalse liidese alias. |
| floating_ip | nöör | Ujuv IP kasutati liides. floating_ip peab eksisteerima virtuaalse liidese lapsena liides. |
| liides | nöör | Liidesega varjatud liides. |
| interface_virtual | nöör | Liidese varjamiseks kasutatava ujuva IP virtuaalse liidese nimi. |
Laadi ujuv liides
Laadi ujuv liides
Päringu näide:
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>
Näitab, kas liidesel on konfigureeritud ujuv IP. Kui see on konfigureeritud, näidatakse seda siin.
nimi on liidese unikaalne identifikaator, mis võib olla tüüpi nic, side või VLAN.
Vastuse näide:
{
"description" : "Show floating interface",
"params" : {
"alias" : null,
"floating_alias" : null,
"floating_ip" : "192.168.100.41",
"interface" : "eth0",
"interface_virtual" : "eth0:virtiface"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| alias | nöör | Liidese kindlakstegemisel on nick. Teise nimega |
| floating_alias | nöör | See on virtuaalse liidese alias. |
| floating_ip | nöör | Ujuv IP kasutati liides. floating_ip peab eksisteerima virtuaalse liidese lapsena liides. |
| liides | nöör | Liidesega varjatud liides. |
| interface_virtual | nöör | Liidese varjamiseks kasutatava ujuva IP virtuaalse liidese nimi. |
Muuda ujuvat liidest
Muuda ujuvat liidest
Päringu näide:
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>
Seadistage ujuv IP NIC-, sidumis- või VLAN-liidese jaoks.
nimi on liidese unikaalne identifikaator, mis võib olla tüüpi nic, side või VLAN.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| floating_ip | nöör | Ujuv IP kasutati liides. floating_ip peab eksisteerima virtuaalse liidese lapsena liides. | tõsi |
Vastuse näide:
{
"description" : "Modify floating interface",
"message" : "Floating interface modification done",
"success" : "true"
}
Kustuta ujuv konfiguratsioon
Kustuta ujuv konfiguratsioon
Päringu näide:
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>
Eemaldage liideses ujuv IP-konfiguratsioon.
nimi on liidese unikaalne identifikaator, mis võib olla tüüpi nic, side või VLAN.
Vastuse näide:
{
"description" : "Remove floating interface",
"message" : "The floating interface has been removed.",
"success" : "true"
}
Võrk - varjunimed
Kiiresti tuvastamiseks asetage liidesele või taustaprogrammile varjunimi.
Olemas on kaks tüüpi varjunimesid, liidese alias saab rakendada igat tüüpi liideses: NIC, sidumine, VLAN või virtuaalne. See on lihtne viis liidese nime sidumiseks sõbraliku nimega.
Teist tüüpi alias on taustaprogrammide jaoks. See seostab taustaprogrammi IP aliasega.
Varjunimed on ainult visuaalsed andmed, see ei asenda taustaprogrammi IP ega liidese nime ZAPI taotluses.
Nimeta varjunimed
Nimeta varjunimed
Päringu näide:
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>
Loetlege liideste või taustaprogrammide süsteemi varjunimed.
Vastuse näide:
{
"description" : "List the aliases",
"params" : [
{
"id" : "192.168.11.13",
"alias" : "http-backend"
},
{
"id" : "127.0.0.1",
"alias" : "localhost"
}
]
}
Vastuse parameetrid
ZAPI tagastab räsi, kus võti on taustaprogramm IP või liidese nimi ja väärtus on selle varjunimi.
Looge alias
Looge alias
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"eth0","alias":"management"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces
zcli network-alias-interface set eth0 -alias management
POST /aliases/<backends|interfaces>
Taustaprogramm või liideste tüüpi objekt, mis saab varjunime.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| alias | nöör | See on elemendi nick id saadetakse URI-sse. | tõsi |
| id | nöör | See on taustaprogrammi IP või liidese nimi. | tõsi |
Vastuse näide:
{
"description" : "Set an alias",
"message" : "Alias for eth0 has been updated successfully",
"success" : "true"
}
Vastuse parameetrid
ZAPI tagastab edukuse teate, kui protsess oli õige.
Muutke varjunime
Muutke varjunime
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"gateway"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zcli network-alias-interface set eth0 -alias gateway
PUT /aliases/<backends|interfaces>/<id>
Kui objektil on varjunimi, siis see asendatakse, muidu luuakse objektile alias.
. id URI parameeter on taustaprogramm IP või liidese nimi.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| alias | nöör | See on elemendi nick id saadetakse URI-sse. | tõsi |
Vastuse näide:
{
"description" : "Set an alias",
"message" : "Alias for eth0 has been updated successfully",
"success" : "true"
}
Vastuse parameetrid
ZAPI tagastab edukuse teate, kui protsess oli õige.
Kustuta alias
Kustuta alias
Päringu näide:
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>
See kustutab liidese või taustaprogrammi alias.
. id URI parameeter on taustaprogramm IP või liidese nimi.
Vastuse näide:
{
"description" : "Delete an alias",
"message" : "The alias has been deleted.",
"success" : "true"
}
Vastuse parameetrid
ZAPI tagastab edukuse teate, kui protsess oli õige.
Võrk - marsruutimine
See moodul on saadaval zapi versioonist 4.0.1.
See moodul haldab liikluse marsruute, mis läbivad koorma tasakaalustaja või sealt edasi. Selle protsessi käigus arvutatakse väljundliides paketi allikast ja paketi sihtkohast. Selle ülesande täitmiseks kasutab koormuse tasakaalustaja kahte tüüpi objekte eeskirjade ja tabelid.
Esimene samm on: välistada kus paketi allikas sobib, kui reegel on leitud, otsib pakettide väljuv liides kaustas tabel et välistada määratletud. Liides on marsruudi märk, mis sobib paketi sihtkohaga.
Loendis marsruutimisreeglid
Loendis marsruutimisreeglid
Päringu näide:
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
Loetlege koorma tasakaalustaja marsruudireeglid. Liideste tabeli saamiseks kasutatakse marsruutimisreegleid sõltuvalt lähtepaketi IP-st
Vastuse näide:
{
"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
}
]
}
Vastuse parameetrid
Vastus on JSON-nimekiri koos kõigi marsruutimisreeglitega süsteemis. Iga reegel on järgmiste parameetritega objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | See on kordumatu identifikaator, mida kasutatakse marsruutimisreeglite jaoks. |
| mitte | nöör | Seda välja kasutatakse koos parameetriga Alates matši tulemust eitama. See parameeter on väärtusega loogiline string tõsi selle lubamiseks või väärtusega vale kui matši tulemust ei saa tühistada. |
| Alates | nöör | See on lähte-IP või võrgusegment, mida kasutatakse paketi lähteteksti IP-ga sobitamiseks. |
| prioriteet | Number | See on reegliküsimus, esmatähtis on prioriteedi väike väärtus. |
| tabel | nöör | See on liideste tabel, mida kasutatakse marsruutimiseks, kui paketiallika IP vastab parameetrile Alates. |
| tüüp | nöör | See on selline reegel, sellel väljal võivad olla järgmised väärtused: talu on marsruut, mida kasutatakse l4xnat talu liikluse suunamiseks, kasutaja on reegel, mille lõi koormuse tasakaalustaja administraator või süsteem on süsteemile automaatselt genereeritud reegel. |
Loo marsruutimisreegel
Loo marsruutimisreegel
Päringu näide:
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
Looge marsruutimisreegel.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| mitte | nöör | Seda välja kasutatakse koos parameetriga Alates matši tulemust eitama. See parameeter on väärtusega loogiline string tõsi selle lubamiseks või väärtusega vale kui matši tulemust ei saa tühistada. | |
| Alates | nöör | See on lähte-IP või võrgusegment, mida kasutatakse paketi lähteteksti IP-ga sobitamiseks. | tõsi |
| prioriteet | Number | See on reegliküsimus, esmatähtis on prioriteedi väike väärtus. Loodud reeglitel peab olema väärtus vahemikus 29000 ja 30999 | |
| tabel | nöör | See on liideste tabel, mida kasutatakse marsruutimiseks, kui paketiallika IP vastab parameetrile Alates. | tõsi |
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastus on JSON-objekt koos kõigi süsteemi marsruudireeglitega. Iga marsruut on objekt parameetritega:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | See on kordumatu identifikaator, mida kasutatakse marsruutimisreeglite jaoks. |
| mitte | nöör | Seda välja kasutatakse koos parameetriga Alates matši tulemust eitama. See parameeter on väärtusega loogiline string tõsi selle lubamiseks või väärtusega vale kui matši tulemust ei saa tühistada. |
| Alates | nöör | See on lähte-IP või võrgusegment, mida kasutatakse paketi lähteteksti IP-ga sobitamiseks. |
| prioriteet | Number | See on reegliküsimus, esmatähtis on prioriteedi väike väärtus. |
| tabel | nöör | See on liideste tabel, mida kasutatakse marsruutimiseks, kui paketiallika IP vastab parameetrile Alates. |
| tüüp | nöör | See on selline reegel, sellel väljal võivad olla järgmised väärtused: talu on marsruut, mida kasutatakse l4xnat talu liikluse suunamiseks, kasutaja on reegel, mille lõi koormuse tasakaalustaja administraator või süsteem on süsteemile automaatselt genereeritud reegel. |
Muutke marsruutimisreeglit
Muutke marsruutimisreeglit
Päringu näide:
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>
Marsruutimisreegli parameetrite muutmine.
. id URI parameeter on reegli kordumatu identifikaator.
Reeglid tüüp kasutaja on ainulaadsed, mida saab muuta
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| mitte | nöör | Seda välja kasutatakse koos parameetriga Alates matši tulemust eitama. | |
| Alates | nöör | See on lähte-IP või võrgusegment, mida kasutatakse paketi lähteteksti IP-ga sobitamiseks. See parameeter on väärtusega loogiline string tõsi selle lubamiseks või väärtusega vale kui matši tulemust ei saa tühistada. | tõsi |
| prioriteet | Number | See on reegliküsimus, esmatähtis on prioriteedi väike väärtus. Loodud reeglitel peab olema väärtus vahemikus 29000 ja 30999 | |
| tabel | nöör | See on liideste tabel, mida kasutatakse marsruutimiseks, kui paketiallika IP vastab parameetrile Alates. | tõsi |
Vastuse näide:
{
"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
},
]
}
Vastuse parameetrid
Vastus on JSON-objekt koos kõigi süsteemi marsruudireeglitega. Iga marsruut on objekt parameetritega:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | See on kordumatu identifikaator, mida kasutatakse marsruutimisreeglite jaoks. |
| mitte | nöör | Seda välja kasutatakse koos parameetriga Alates matši tulemust eitama. See parameeter on väärtusega loogiline string tõsi selle lubamiseks või väärtusega vale kui matši tulemust ei saa tühistada. |
| Alates | nöör | See on lähte-IP või võrgusegment, mida kasutatakse paketi lähteteksti IP-ga sobitamiseks. |
| prioriteet | Number | See on reegliküsimus, esmatähtis on prioriteedi väike väärtus. |
| tabel | nöör | See on liideste tabel, mida kasutatakse marsruutimiseks, kui paketiallika IP vastab parameetrile Alates. |
| tüüp | nöör | See on selline reegel, sellel väljal võivad olla järgmised väärtused: talu on marsruut, mida kasutatakse l4xnat talu liikluse suunamiseks, kasutaja on reegel, mille lõi koormuse tasakaalustaja administraator või süsteem on süsteemile automaatselt genereeritud reegel. |
Kustuta marsruutimisreegel
Kustuta marsruutimisreegel
Päringu näide:
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>
Marsruudi reegli kustutamine.
. id URI parameeter on reegli kordumatu identifikaator.
Vastuse näide:
{
"message" : "The routing rule '1024' has been deleted successfully.",
"description" : "Delete the routing rule '1024'"
}
Loendis marsruutimistabelid
Loendis marsruutimistabelid
Päringu näide:
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
Loetlege marsruutimistabelid, mida koormuse tasakaalustaja haldab.
Põhitabel on kõigi liideste jaoks globaalne. See sisaldab kõigi liideste vaikemarsruute, mida kasutatakse juhul, kui ükski reegel ei vasta paketiga. Iga liideste tabel haldab selle liidese väljuva liikluse marsruute.
Vastuse näide:
{
"description" : "List routing tables",
"params" : [
"main",
"table_eth0",
"table_eth1",
"table_eth2",
"table_eth3"
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt koos parameetrid võti, mis sisaldab loendit süsteemis olevate tabelitega.
Tabeli marsruutide loetelu
Loendis marsruutimisreeglid
Päringu näide:
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>
Loetlege liideste tabeli hallatavad marsruudikirjed. Neid kirjeid kasutatakse paketi sihtkoha IP-le vastamiseks. Paketi väljuv liides on esimene liides, mis sobib tabeli kirjega.
Vastuse näide:
{
"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
}
]
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja tabelit sisaldav marsruutide loend.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| toores | nöör | See on marsruudi sisestus koos IP-marsruut formaadis. |
| prioriteet | Number | See on prioriteet, milles marsruuti uuritakse. Madalam väärtus on prioriteetsem. Selle välja väärtus peab olema vahemikus 1 ja 10. |
| liides | nöör | Kui marsruut sobib, kasutatakse väljuvat liidest. |
| allikas | nöör | See on IP, mida kasutatakse paketi maskeerimiseks. See allikas peab olema koormuse tasakaalustajas virtuaalse liidesena olemas. |
| tüüp | nöör | See on marsruudi tüüp. Marsruudid võivad olla teatud tüüpi süsteem mida süsteem loob ja haldab automaatselt, või kasutaja kui marsruudi koostas laadimiste tasakaalustaja kasutaja. Kontrollimine haldamatu funktsioon a eemaldamiseks süsteem liinil. |
| et | nöör | See on sobimatus tingimus. Kui paketi sihtkoha IP sobib sellega, on marsruut edukas. |
| kaudu | nöör | See on paketi järgmine hüpe. Seda kasutatakse lüüsina. Selle IP-ni tuleb jõuda liidese võrgusegmendist. |
| id | Number | See on marsruudi kordumatu identifikaator. Seda parameetrit kasutatakse marsruudi muutmiseks või kustutamiseks ja see on saadaval ainult tüüpi marsruutidel kasutaja. |
Loo marsruudikanne
Loo marsruudikanne
Päringu näide:
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
Looge liidese jaoks marsruut.
. tabel URI parameeter on liideste tabel, kuhu marsruut lisatakse.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| toores | nöör | See on marsruudi sisestus koos IP-marsruut vormingus. Selle parameetri kasutamisel välditakse teisi. | |
| et | nöör | See on sobimatus tingimus. Kui paketi sihtkoha IP sobib sellega, on marsruut edukas. | See on vajalik siis, kui toores ei saadeta |
| prioriteet | Number | See on prioriteet, milles marsruuti uuritakse. Madalam väärtus on prioriteetsem. Selle välja väärtus peab olema vahemikus 1 ja 10. | |
| liides | nöör | Kui marsruut sobib, kasutatakse väljuvat liidest. | |
| allikas | nöör | See on IP, mida kasutatakse paketi maskeerimiseks. See allikas peab olema koormuse tasakaalustajas virtuaalse liidesena olemas. | |
| kaudu | nöör | See on paketi järgmine hüpe. Seda kasutatakse lüüsina. Selle IP-ni tuleb jõuda liidese võrgusegmendist. |
Vastuse näide:
{
"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" : ""
},
]
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja tabelit sisaldav marsruutide loend.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| prioriteet | Number | See on prioriteet, milles marsruuti uuritakse. Madalam väärtus on prioriteetsem. Selle välja väärtus peab olema vahemikus 1 ja 10. |
| toores | nöör | See on marsruudi sisestus koos IP-marsruut formaadis. |
| liides | nöör | Kui marsruut sobib, kasutatakse väljuvat liidest. |
| allikas | nöör | See on IP, mida kasutatakse paketi maskeerimiseks. See allikas peab olema koormuse tasakaalustajas virtuaalse liidesena olemas. |
| tüüp | nöör | See on marsruudi tüüp. Marsruudid võivad olla teatud tüüpi süsteem mida süsteem loob ja haldab automaatselt, või kasutaja kui marsruudi koostas laadimiste tasakaalustaja kasutaja. Kontrollimine haldamatu funktsioon a eemaldamiseks süsteem liinil. |
| et | nöör | See on sobimatus tingimus. Kui paketi sihtkoha IP sobib sellega, on marsruut edukas. |
| kaudu | nöör | See on paketi järgmine hüpe. Seda kasutatakse lüüsina. Selle IP-ni tuleb jõuda liidese võrgusegmendist. |
| id | Number | See on marsruudi kordumatu identifikaator. Seda parameetrit kasutatakse marsruudi muutmiseks või kustutamiseks ja see on saadaval ainult tüüpi marsruutidel kasutaja. |
Marsruudi kirje muutmine
Marsruudi kirje muutmine
Päringu näide:
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>
Marsruudi kirje parameetrite muutmine.
. tabel URI parameeter on muudetava marsruudi liideste tabel. id URI parameeter on muudetava marsruudi kordumatu tunnus.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| toores | nöör | See on marsruudi sisestus koos IP-marsruut vormingus. Selle parameetri kasutamisel välditakse teisi. |
| prioriteet | Number | See on prioriteet, milles marsruuti uuritakse. Madalam väärtus on prioriteetsem. Selle välja väärtus peab olema vahemikus 1 ja 10. |
| liides | nöör | Kui marsruut sobib, kasutatakse väljuvat liidest. |
| allikas | nöör | See on IP, mida kasutatakse paketi maskeerimiseks. See allikas peab olema koormuse tasakaalustajas virtuaalse liidesena olemas. |
| et | nöör | See on sobimatus tingimus. Kui paketi sihtkoha IP sobib sellega, on marsruut edukas. |
| kaudu | nöör | See on paketi järgmine hüpe. Seda kasutatakse lüüsina. Selle IP-ni tuleb jõuda liidese võrgusegmendist. |
Vastuse näide:
{
"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"
},
]
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja tabelit sisaldav marsruutide loend.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| prioriteet | Number | See on prioriteet, milles marsruuti uuritakse. Madalam väärtus on prioriteetsem. Selle välja väärtus peab olema vahemikus 1 ja 10. |
| toores | nöör | See on marsruudi sisestus koos IP-marsruut formaadis. |
| liides | nöör | Kui marsruut sobib, kasutatakse väljuvat liidest. |
| allikas | nöör | See on IP, mida kasutatakse paketi maskeerimiseks. See allikas peab olema koormuse tasakaalustajas virtuaalse liidesena olemas. |
| tüüp | nöör | See on marsruudi tüüp. Marsruudid võivad olla teatud tüüpi süsteem mida süsteem loob ja haldab automaatselt, või kasutaja kui marsruudi koostas laadimiste tasakaalustaja kasutaja. Kontrollimine haldamatu funktsioon a eemaldamiseks süsteem liinil. |
| et | nöör | See on sobimatus tingimus. Kui paketi sihtkoha IP sobib sellega, on marsruut edukas. |
| kaudu | nöör | See on paketi järgmine hüpe. Seda kasutatakse lüüsina. Selle IP-ni tuleb jõuda liidese võrgusegmendist. |
| id | Number | See on marsruudi kordumatu identifikaator. Seda parameetrit kasutatakse marsruudi muutmiseks või kustutamiseks ja see on saadaval ainult tüüpi marsruutidel kasutaja. |
Marsruudi kirje kustutamine
Marsruudi kirje kustutamine
Päringu näide:
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>
Liidetabeli marsruudi kustutamine.
. tabel URI parameeter on liideste tabel, kust marsruut kustutatakse. id URI parameeter on kustutatava marsruudi unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete the routing entry '1024' from the table 'table_eth2'",
"message" : "The routing rule '1024' has been deleted successfully."
}
Tabelis haldamata liideste loetelu
Tabelis manustamata liideste loetelu
Päringu näide:
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
Seda funktsiooni kasutatakse liikluse vältimiseks liideselt, mis võib väljuda teisele.
tabel on sissetuleva liidese marsruutitabel.
Loetlege liidesed ja kas neid saab kasutada liikluse väljumiseks.
Vastuse näide:
{
"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'"
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid mis sisaldab järgmiste parameetritega objektide loendit.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| liides | nöör | See on väljundliidese nimi. |
| juhtimata | nöör | See on liidese marsruutimisolek. Kui sellel on väärtus vale, sellele liidesele pääseb tabelist; kui sellel on väärtus tõsi, ei välju see tabelist liiklust. |
Lisage liides haldamata loendisse
Liidese juhtimata jätmine
Päringu näide:
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
Keela väljuva liikluse liides.
. tabel URI parameeter on marsruutimistabeli nimi, millelt marsruut pole juurdepääsetav. Kui tabel on väärtusega*”(Tärn), liides ei pääse ühestki tabelist.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| liides | nöör | See on liides, mida ei saa teekonna kaudu marsruutida tabel. | tõsi |
Vastuse näide:
{
"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'"
}
Eemaldage liides haldamata loendist
Hallake marsruutimistabelit
Päringu näide:
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>
Luba liides on nähtav teisest liideste tabelist
. tabel URI parameeter on liideste tabel, mida muudetakse. Kui tabel on väärtusega*”(Tärn), liides hallatakse kõigist tabelitest. liides URI parameeter on liides, mis on lubatud tabel tabelis.
Vastuse näide:
{
"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'"
}
Seire - FarmGuardian
FarmGuardianit kasutatakse taustaprogrammide täiustatud jälgimise olekuks. Kui FarmGuardian tuvastab probleemi, lülitab see reaalse serveri automaatselt välja ja see märgistatakse musta nimekirja.
Nimekiri FarmGuardians
Nimekiri FarmGuardians
Päringu näide:
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
Loetlege FarmGuardians. See nimekiri kuvatakse mallide ja kohandatud FarmGuardians.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| käsk | nöör | Käsk, et kontrollida teenuse olekut taustaprogrammis. Need võimalikud käsud on libexeci teekonnal. |
| cut_conns | nöör | Võimalikud väärtused on: tõsiFarmGuardian lõikab praegused ühendused, kui taustaprogramm pole saadaval; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| kirjeldus | nöör | Kontrolli lühikirjeldus. |
| talud | Keelpill [] | Põllumajandusettevõtted, kus rakendatakse FarmGuardianit. |
| intervall | Number | Kontrollide vaheline aeg. |
| logi | nöör | Võimalikud väärtused on: tõsi, FarmGuardian logib iga kontrolli; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| nimi | nöör | Unikaalne identifikaator. |
| šabloon | nöör | Kui FarmGuardian on mall, ei rakendata seda ühegi talu jaoks. Mallid on kasulikud uue FarmGuardiani loomiseks. |
| backend_alias (alates 4.0.1) | nöör | Kui selle parameetri väärtus on vale, on taustaprogrammi hostiks taustaprogrammi IP. Taustprogrammi pseudonüümi kasutatakse hostina, kui sellel parameetril on väärtus tõsi, tuleb varjunimi määratleda ja koormuse tasakaalustaja peaks suutma selle lahendada. |
Too FarmGuardian
Too FarmGuardian
Päringu näide:
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>
Näita FarmGuardiani konfiguratsiooni.
URI parameeter nimi on FarmGuardian kordumatu tunnus.
Vastuse näide:
{
"description" : "Retrive the farm guardian check_tcp",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 10,
"log" : "false",
"name" : "check_tcp",
"template" : "true",
"backend_alias" : "false",
"timeout" : 5
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| käsk | nöör | Käsk, et kontrollida teenuse olekut taustaprogrammis. Need võimalikud käsud on libexeci teekonnal. |
| cut_conns | nöör | Võimalikud väärtused on: tõsiFarmGuardian lõikab praegused ühendused, kui taustaprogramm pole saadaval; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| kirjeldus | nöör | Kontrolli lühikirjeldus. |
| talud | Keelpill [] | Põllumajandusettevõtted, kus rakendatakse FarmGuardianit. |
| intervall | Number | Kontrollide vaheline aeg. See on aeg loendi viimase taustaprogrammi testimisest kuni esimese taustaprogrammi uuesti testimiseni. |
| logi | nöör | Võimalikud väärtused on: tõsi, FarmGuardian logib iga kontrolli; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| nimi | nöör | Unikaalne identifikaator. |
| šabloon | nöör | Kui FarmGuardian on mall, siis seda ei muudeta. Mallid on kasulikud uue FarmGuardiani loomiseks või rakendamiseks otse farmides. |
| backend_alias (alates 4.0.1) | nöör | Kui selle parameetri väärtus on vale, on taustaprogrammi hostiks taustaprogrammi IP. Taustprogrammi pseudonüümi kasutatakse hostina, kui sellel parameetril on väärtus tõsi, tuleb varjunimi määratleda ja koormuse tasakaalustaja peaks suutma selle lahendada. |
| aeg maha (alates 4.0.2) | Number | Iga taustaprogrammi ajalõpp. Pärast selle aja möödumist taustaprogrammi testis loetakse see aeglaseks. Vaikimisi võrdub ajalõpp intervalliga. |
Loo FarmGuardian
Loo FarmGuardian
Päringu näide:
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
Looge uus FarmGuardian.
Taotlege parameetreid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | Unikaalne identifikaator. | tõsi |
| copy_from | nöör | FarmGuardianit kasutatakse uue FarmGuardia loomiseks mallina. Kui seda välja ei saadeta, luuakse uus FarmGuardian ilma konfiguratsioonita. |
Vastuse näide:
{
"description" : "Create a farm guardian check_tcp-cut_conns",
"message" : "The farm guardian check_tcp-cut_conns has been created successfully",
"params" : {
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp-cut_conns",
"template" : "true",
"backend_alias" : "false",
"timeout" : 5
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| käsk | nöör | Käsk, et kontrollida teenuse olekut taustaprogrammis. Need võimalikud käsud on libexeci teekonnal. |
| cut_conns | nöör | Võimalikud väärtused on: tõsiFarmGuardian lõikab praegused ühendused, kui taustaprogramm pole saadaval; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| kirjeldus | nöör | Kontrolli lühikirjeldus. |
| talud | Keelpill [] | Põllumajandusettevõtted, kus rakendatakse FarmGuardianit. |
| intervall | Number | Kontrollide vaheline aeg. See on aeg loendi viimase taustaprogrammi testimisest kuni esimese taustaprogrammi uuesti testimiseni. |
| logi | nöör | Võimalikud väärtused on: tõsi, FarmGuardian logib iga kontrolli; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| nimi | nöör | Unikaalne identifikaator. |
| šabloon | nöör | Kui FarmGuardian on mall, siis seda ei muudeta. Mallid on kasulikud uue FarmGuardiani loomiseks või rakendamiseks otse farmides. |
| backend_alias (alates 4.0.1) | nöör | Kui selle parameetri väärtus on vale, on taustaprogrammi hostiks taustaprogrammi IP. Taustprogrammi pseudonüümi kasutatakse hostina, kui sellel parameetril on väärtus tõsi, tuleb varjunimi määratleda ja koormuse tasakaalustaja peaks suutma selle lahendada. |
| aeg maha (alates 4.0.2) | Number | Iga taustaprogrammi ajalõpp. Pärast selle aja möödumist taustaprogrammi testis loetakse see aeglaseks. Vaikimisi võrdub ajalõpp intervalliga. |
Muuda FarmGuardianit
Muuda FarmGuardianit
Päringu näide:
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>
Muuda FarmGuardianit.
URI parameeter nimi on FarmGuardian kordumatu tunnus.
Taotlege parameetreid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| käsk | nöör | Käsk, et kontrollida teenuse olekut taustaprogrammis. Need võimalikud käsud on libexeci teekonnal. | |
| cut_conns | nöör | Võimalikud väärtused on: tõsiFarmGuardian lõikab praegused ühendused, kui taustaprogramm pole saadaval; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. | |
| kirjeldus | nöör | Kontrolli lühikirjeldus. | |
| intervall | Number | Kontrollide vaheline aeg. See on aeg loendi viimase taustaprogrammi testimisest kuni esimese taustaprogrammi uuesti testimiseni. | |
| logi | nöör | Võimalikud väärtused on: tõsi, FarmGuardian logib iga kontrolli; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. | |
| sundida | nöör | Kui jooksev talu kasutab FarmGuardiani, ei saa FarmGuardianit muuta. Siis, kui see parameeter saadetakse koos väärtusega tõsi, FarmGuardian on sunnitud võtma uue konfiguratsiooni. | |
| backend_alias (alates 4.0.1) | nöör | Kui selle parameetri väärtus on vale, on taustaprogrammi hostiks taustaprogrammi IP. Taustprogrammi pseudonüümi kasutatakse hostina, kui sellel parameetril on väärtus tõsi, tuleb varjunimi määratleda ja koormuse tasakaalustaja peaks suutma selle lahendada. | |
| aeg maha (alates 4.0.2) | Number | Iga taustaprogrammi ajalõpp. Pärast selle aja möödumist taustaprogrammi testis loetakse see aeglaseks. Vaikimisi võrdub ajalõpp intervalliga. |
Vastuse näide:
{
"description" : "Modify farm guardian custom-tcp",
"message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
"params" : {
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false",
"backend_alias" : "false",
"timeout" : 7
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON-objekt parameetrid ja alltoodud vorming:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| käsk | nöör | Käsk, et kontrollida teenuse olekut taustaprogrammis. Need võimalikud käsud on libexeci teekonnal. |
| cut_conns | nöör | Võimalikud väärtused on: tõsiFarmGuardian lõikab praegused ühendused, kui taustaprogramm pole saadaval; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| kirjeldus | nöör | Kontrolli lühikirjeldus. |
| talud | Keelpill [] | Põllumajandusettevõtted, kus rakendatakse FarmGuardianit. |
| intervall | Number | Kontrollide vaheline aeg. See on aeg loendi viimase taustaprogrammi testimisest kuni esimese taustaprogrammi uuesti testimiseni. |
| logi | nöör | Võimalikud väärtused on: tõsi, FarmGuardian logib iga kontrolli; või valeKui taustaprogramm pole saadaval, siis see blokeeritakse, kuid elus istungid jätkuvad. |
| nimi | nöör | Unikaalne identifikaator. |
| šabloon | nöör | Kui FarmGuardian on mall, ei rakendata seda ühegi talu jaoks. Mallid on kasulikud uue FarmGuardiani loomiseks. |
| backend_alias (alates 4.0.1) | nöör | Kui selle parameetri väärtus on vale, on taustaprogrammi hostiks taustaprogrammi IP. Taustprogrammi pseudonüümi kasutatakse hostina, kui sellel parameetril on väärtus tõsi, tuleb varjunimi määratleda ja koormuse tasakaalustaja peaks suutma selle lahendada. |
| aeg maha (alates 4.0.2) | Number | Iga taustaprogrammi ajalõpp. Pärast selle aja möödumist taustaprogrammi testis loetakse see aeglaseks. Vaikimisi võrdub ajalõpp intervalliga. |
Kustuta FarmGuardian
Kustuta FarmGuardian
Päringu näide:
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 FarmGuardian.
URI parameeter nimi on FarmGuardian kordumatu tunnus.
Vastuse näide:
{
"description" : "Delete the farm guardian custom-tcp",
"message" : "custom-tcp has been deleted successful.",
"success" : "true"
}
Järelevalve - statistika
Näita teavet süsteemi ja talude kohta. See teave on kasulik Zeveneti koormuse tasakaalustaja oleku jälgimiseks.
Näita süsteemi statistikat
Näita süsteemi statistikat
Päringu näide:
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
Hankige globaalse süsteemi statistika.
Vastuse näide:
{
"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
}
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| cpu | objekt | CPU statistika. |
| andmed | nöör | Süsteemi kuupäev. |
| hostname | nöör | Saatejuhi nimi. |
| koormus | objekt | Põhikoormuse statistika. |
| mälu | objekt | Kasutatud mälu statistika. |
| võrk | objekt | Võrgu liikluse statistika. |
CPU objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| südamikud | Number | Protsessori südamike arv. |
| tühikäigul | Number | CPU ei kasuta ühtegi programmi. |
| iowait | Number | Sisend- või väljundprotsessis kasutatav protsessor. |
| irq | Number | Riistvarakatkestuste poolt kasutatav protsessor. |
| kena | Number | CPU sõiduplaani prioriteet. |
| softirq | Number | Tarkvarakatkestuste poolt kasutatav protsessor. |
| sys | Number | Süsteemi kasutatav protsessor. |
| kasutus | Number | Kasutatav CPU. |
| kasutaja | Number | Kasutaja poolt kasutatav protsessor. |
Laadige objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| Last_1 | Number | Laadige süsteemi protsent viimasele minutile. |
| Last_5 | Number | Laadige süsteemi protsent viis minutit tagasi. |
| Last_15 | Number | Laadige süsteemi protsent viisteist minutit tagasi. |
Mäluobjekt.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| Puhvrid | Number | See on puhvrite poolt kasutatav mälu. See summa on märgitud Mb. |
| Vahemällu salvestatud | Number | See on süsteemi mällu salvestatud kogu mälu. See summa on märgitud Mb. |
| MemFree | Number | See on kogu vaba mälu, mida süsteem pole vahemällu salvestanud. See summa on märgitud Mb. |
| MemTotal | Number | See on süsteemi kogu RAM. See summa on märgitud Mb. |
| MemUsed | Number | See on süsteemi poolt kasutatav mälu. See summa on märgitud Mb. |
| Vaheta vahetatud | Number | See on kogu vahemälu reserveeritud. |
| SwapFree | Number | See on kogu vaba mälu, mida süsteem pole vahemällu salvestanud. See summa on märgitud Mb. |
| Vaheta kokku | Number | See on kogu vahetusmälu reserveeritud. |
| SwapUsed | Number | See on süsteemi poolt kasutatav mälu, optimaalsetel süsteemidel peaks olema 0. |
Võrguobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| aastal sisse | Number | Sisestage liiklus selleks liides. |
| välja | Number | Selle jaoks väljastage liiklust liides. |
Kuva võrgu statistika
Kuva võrgu statistika
Päringu näide:
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
Hankige kokkuvõte sisend- ja väljundliiklusest võrguliidese kaudu.
Vastuse näide:
{
"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"
}
]
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON parameetrid mille väärtus on objekt, millel on järgmised võtmed:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| andmed | nöör | Süsteemi kuupäev. |
| hostname | nöör | Saatejuhi nimi. |
| liidesed | Objekt [] | Võrgu liikluse statistika. |
Liidese objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| in | nöör | Kogu sisendliiklus MB-s. |
| liides | nöör | Liidese nimi. |
| välja | nöör | Kogu väljundliiklus MB-s. |
Näita liideste statistikat
Näita liideste statistikat
Päringu näide:
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
Hankige iga võrguliidese kokkuvõte.
Vastuse näide:
{
"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"
]
}
]
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON parameetrid mille väärtus on võtmetega objekt võlakiri ja Nic.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| võlakiri | Objekt [] | Võlakirjaliidese statistika. |
| Nic | Objekt [] | NIC-liidese statistika. |
Võlakiri:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| in | nöör | Kogu sisendliiklus MB-s. |
| liides | nöör | Unikaalse identifikaatorina kasutatav liidese nimi. |
| ip | nöör | Liidese IP. |
| mac | nöör | Liidese MAC. |
| välja | nöör | Kogu väljundliiklus MB-s. |
| orjad | String [] | Nimekiri orjadest, mis ehitavad sideme liidese. |
| staatus | nöör | Liidese olek. Väärtus võib olla alla, liides on keelatud; up, liides on lubatud. |
| virtuaalne | String [] | Virtuaalsed liidesed, mis pärivad selle liidese kaudu. |
| vlan | String [] | Sellest liidesest pärinevad VLAN-liidesed. |
Nic objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| in | nöör | Kogu sisendliiklus MB-s. |
| liides | nöör | Unikaalse identifikaatorina kasutatav liidese nimi. |
| ip | nöör | Liidese IP. |
| mac | nöör | Liidese MAC. |
| välja | nöör | Kogu väljundliiklus MB-s. |
| staatus | nöör | Liidese olek. Väärtus võib olla alla, liides on keelatud; up, liides on lubatud. |
| virtuaalne | String [] | Virtuaalsed liidesed, mis pärivad selle liidese kaudu. |
| vlan | String [] | Sellest liidesest pärinevad VLAN-liidesed. |
Näita mälu statistikat
Näita mälu statistikat
Päringu näide:
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
Hankige süsteemi mälu kokkuvõte.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON parameetrid mille väärtus on mäluobjekt.
Mälu objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| Puhvrid | Number | See on puhvrite poolt kasutatav mälu. See summa on märgitud Mb. |
| Vahemällu salvestatud | Number | See on süsteemi mällu salvestatud kogu mälu. See summa on märgitud Mb. |
| MemFree | Number | See on kogu vaba mälu, mida süsteem pole vahemällu salvestanud. See summa on märgitud Mb. |
| MemTotal | Number | See on süsteemi kogu RAM. See summa on märgitud Mb. |
| MemUsed | Number | See on süsteemi poolt kasutatav mälu. See summa on märgitud Mb. |
| Vaheta vahetatud | Number | See on kogu vahemälu reserveeritud. |
| SwapFree | Number | See on kogu vaba mälu, mida süsteem pole vahemällu salvestanud. See summa on märgitud Mb. |
| Vaheta kokku | Number | See on kogu vahetusmälu reserveeritud. |
| SwapUsed | Number | See on süsteemi poolt kasutatav mälu, optimaalsetel süsteemidel peaks olema 0. |
| andmed | nöör | Süsteemi kuupäev. |
| hostname | nöör | Saatejuhi nimi. |
Näita koormuse statistikat
Näita koormuse statistikat
Päringu näide:
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
Hankige CPU süsteemi koormuse kokkuvõte.
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| Last_1 | Number | Koormussüsteemi kasutamine viimane. |
| Last_5 | Number | Laadimissüsteemi kasutamine viimase viie minuti jooksul. |
| Last_15 | Number | Koormussüsteemi kasutamine viimase viieteistkümne minuti jooksul. |
| andmed | nöör | Süsteemi kuupäev. |
| hostname | nöör | Saatejuhi nimi. |
Näita CPU statistikat
Näita CPU statistikat
Päringu näide:
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
Vastuse näide:
{
"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
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| südamikud | Number | Protsessori südamike arv. |
| tühikäigul | Number | CPU ei kasuta ühtegi programmi. |
| iowait | Number | Sisend- või väljundprotsessis kasutatav protsessor. |
| irq | Number | Riistvarakatkestuste poolt kasutatav protsessor. |
| kena | Number | CPU sõiduplaani prioriteet. |
| softirq | Number | Tarkvarakatkestuste poolt kasutatav protsessor. |
| sys | Number | Süsteemi kasutatav protsessor. |
| kasutus | Number | Kasutatav CPU. |
| kasutaja | Number | Kasutaja poolt kasutatav protsessor. |
| andmed | nöör | Süsteemi kuupäev. |
| hostname | nöör | Saatejuhi nimi. |
Kuva ühenduste statistika
Kuva ühenduste statistika
Päringu näide:
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
Hankige süsteemis praeguste ühenduste koguarv. Loendur võtab kokku mis tahes tüüpi jälgitavad ühendused: TAGATUD, ESTABLISED, SYN_SENT, TIME_WAIT, LISTEN…
Vastuse näide:
{
"description" : "System connections",
"params" : {
"connections" : 324
}
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ühendused | Number | Jälgitud ühendused kokku. |
Kuva põllumajandusettevõtete arv
Kuva põllumajandusettevõtete arv
Päringu näide:
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
Näita süsteemis loodud talude koguarvu.
Vastuse näide:
{
"description" : "Number of farms.",
"number" : 8
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| number | Number | See on süsteemis olemasolevate põllumajandusettevõtete arv. |
Näita talude statistikat
Näita talude statistikat
Päringu näide:
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
Hankige kõikide süsteemide ühenduste ja konfiguratsiooni kokkuvõte.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| asutatud | Number | praegu loodud ühenduste koguarv. |
| farmname | nöör | Põllumajandusettevõtte nimi, kordumatu tunnus. |
| kuni | Number | Ootel olevate ühenduste arv. |
| profiil | nöör | Põllumajandusettevõtte tüüp. Võimalikud väärtused on: andmelink, l4xnat, http, https or gslb. Iga profiil on määratletud selle jaotises. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
Kuva põllumajandusstatistika
Kuva põllumajandusstatistika
Päringu näide:
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>
Näitab praegust talu staatust, nende taustaprogrammi olekut ja ühendusi. Iga põllumajandusettevõte reageerib sõltuvalt profiilist erineva objektiga.
HTTP põllumajandusettevõtte vastuse näide:
{
"backends" : [
{
"established" : 0,
"id" : 0,
"ip" : "192.168.0.168",
"pending" : 0,
"port" : 80,
"service" : "srv1",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"client" : "0",
"id" : "0"
"backend_ip" : "192.168.0.168"
"backend_port" : 80
"service" : "srv1",
"session" : "192.168.0.186",
"ttl" : "1m28s0ms"
}
],
"total_sessions" : 1
}
Reageerimisparameetrid HTTP taludes
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Kuva taustaprogrammide teave. |
| istungid | Objekt [] | Näita teavet seansside kohta. |
| kokku_seansse | Number | Alates versioonist 4.0.2. Kuvab registreeritud seansside koguarvu. |
Backend-objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| asutatud | Number | Kindlaksmääratud ühenduste koguarv. |
| id | Number | Taustaprogrammi unikaalne identifikaator. |
| ip | nöör | IP, kus tegelik teenus kuulab. |
| kuni | Number | Ootel olevate ühenduste arv. |
| port | Number | Sadam, kus tegelik teenus kuulab. |
| teenus | nöör | Unikaalse identifikaatorina kasutatav teenuse nimi. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
Seansi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| klient | nöör | Kliendi kordumatu tunnus. |
| id | nöör | Kliendile määratud unikaalne tunnus. |
| teenus | nöör | Kliendile määratud teenuse kordumatu tunnus. |
| istung | nöör | Seansi kordumatu tunnus. See väärtus sõltub püsivuse tüübist. |
| ttl | nöör | Alates versioonist 4.0.2. Seansi lõpuni jäänud aeg |
| backend_ip | nöör | Alates versioonist 4.0.2. Kliendile määratud taustaprogrammi IP. |
| backend_port | nöör | Alates versioonist 4.0.2. Kliendile määratud taustaport. |
GSLB talu vastuse näide:
{
"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
}
}
Vastusparameetrid GSLB taludes
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| taustaprogrammid | Objekt [] | Näita taustaprogrammide kohta teavet. |
| klient | objekt | Kliendiga seotud statistika. |
| pikendatud | objekt | Laiendatud teave teenuse kohta. |
| server | objekt | Serveriga seotud statistika. |
Backend-objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Taustaprogrammi unikaalne identifikaator. |
| ip | nöör | IP, kus tegelik teenus kuulab. |
| port | Number | Sadam, kus tegelik teenus kuulab. |
| teenus | nöör | Unikaalse identifikaatorina kasutatav teenuse nimi. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
Kliendi objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| edns_big | Number | Vastused, mis olid suuremad kui 512 baiti. |
| edns_tc | Number | Kliendi määratud laiendatud DNS-puhvri suurus oli taotletud andmete jaoks liiga väike. |
| recvfail | Number | UDP-vigade arv, kus operatsioonisüsteem näitas, et vastuvõtmisel juhtus midagi halba. |
| reqs | Number | Serveriga töödeldud UDP-taotluste koguarv. |
| sendfail | Number | UDP-vigade arv, kus operatsioonisüsteem osutas, et saatmisel oli midagi halba. |
| tc | Number | Vastused, mis olid kärbitud TC bitikomplektiga. |
Laiendatud objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| badversid | Number | Taotlus, millel oli EDNS OPT-RR ja versioon, mida ei toetatud. |
| langes | Number | Vigastatud vormingu taotluste tühistamine. |
| edns | Number | Taotlus sisaldas EDNS OPT-RR. |
| edns_clientsub | Number | Edns_client_subnet valikule määratud edns-päringute alamhulk. |
| agr | Number | Taotlus oli halvasti vormindatud, kuid oli piisavalt mõistlik, et me saatisime vastuse rcode FORMERR'iga. |
| hirmus | Number | Edukad taotlused. |
| notimp | Number | Taotletud teenus, mida see deemon ei rakendanud, näiteks tsooni ülekande taotlused. |
| nxdomain | Number | Taotlus mitteoleva domeeninime saamiseks. |
| keeldus | Number | Server jättis taotluse tagasi, sest server ei ole küsitava nime jaoks autoriteetne. |
| v6 | Number | IPv6i kliendi taotlus. |
Serveri objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| recvfail | Number | TCP-vigade arv, kus operatsioonisüsteem näitas, et vastuvõtmisel juhtus midagi halba. |
| reqs | Number | Serveriga töödeldud TCP-päringute koguarv. |
| sendfail | Number | TCP-vigade arv, kus operatsioonisüsteem osutas, et saatmisel on midagi halba. |
L4xNAT talu vastuse näide:
{
"backends" : [
{
"established" : 5,
"id" : 1,
"ip" : "192.168.5.40",
"pending" : 0,
"port" : "8080",
"status" : "maintenance"
},
{
"established" : null,
"id" : 3,
"ip" : "192.5.1.1",
"pending" : 0,
"port" : "787",
"status" : "down"
},
{
"established" : 1,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"client": 0,
"id" : 5,
"backend_ip" : "192.168.5.100",
"backend_port" : "8080",
"session" : "192.168.5.100",
"ttl" : "1m51s564ms",
"type" : "dynamic"
}
],
"total_sessions" : 1
}
Vastusparameetrid L4xNAT taludes
Vastus on objektiga JSON taustaprogrammid ja istungid:
Backend-objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| asutatud | Number | Praegu loodud ühenduste koguarv. |
| id | Number | Taustaprogrammi unikaalne identifikaator. |
| ip | nöör | IP, kus tegelik teenus kuulab. |
| kuni | Number | Ootel olevate ühenduste arv. |
| port | Number | Sadam, kus tegelik teenus kuulab. |
| staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
Seansi objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| klient | Number | Seansi turvaidentifikaator. |
| id | Number | Taustaprogrammi unikaalne identifikaator, kuhu klient on määratud. |
| istung | nöör | Seansi kordumatu tunnus. See on kliendi IP. |
| tüüp | nöör | Väärtused on: staatilised või dünaamilised. Staatiline, kui seanss tehti käsitsi, ja dünaamiline, kui seanss tehti automaatselt. |
| ttl | nöör | Alates versioonist 4.0.2. Seansi lõpuni jäänud aeg |
| backend_ip | nöör | Alates versioonist 4.0.2. Kliendile määratud taustaprogrammi IP. |
| backend_port | Number | Alates versioonist 4.0.2. Kliendile määratud taustaport. |
Vastusparameetrid datalinkide taludes
Datalinki talude statistika ei ole tegelikult kättesaadav.
Näita mooduli olekut
Näita mooduli olekut
Päringu näide:
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
Saada statistiliste moodulite kokkuvõte. See kõne näitab iga mooduli olekut, konfigureeritud arvu, alam- ja ülespoole paigutatud talude arvu.
Moodulite määratlus on sisse lülitatud Põllumajandusettevõtted sektsiooni.
Vastuse näide:
{
"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
}
}
}
Vastuse parameetrid
Vastuseks on JSON, millel on kolm võtit: dslb, gslb ja lllb.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| kriitiline | Number | Kriitilises seisundis olevate põllumajandusettevõtete arv. Talu on kriitiline, kui see on üles ehitatud ja kõik taustaprogrammid on kättesaamatud (alla või hooldus). |
| alla | Number | Peatatud põllumajandusettevõtete arv. Talumajapidamised peatavad süsteemi administraator. |
| probleem | Number | Probleemse seisundiga põllumajandusettevõtete arv. Talu on probleem, kui see on üles ehitatud ja peaaegu tagaplaan on alles. |
| summaarne | Number | Kokku põllumajandusettevõtete arv. |
| up | Number | Käimasolevate põllumajandusettevõtete arv. Siin kuvatakse hooldus ja vajadus talu staatuse taaskäivitamiseks. |
Näita mooduli statistikat
Näita mooduli statistikat
Päringu näide:
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>
Kuva konkreetse mooduli põllumajandusstatistika.
. \ T moodul parameeter on: lllb, gslb or dslb.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mis sisaldab teavet moodulite talude kohta.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| asutatud | Number | Praegu loodud ühenduste koguarv. |
| farmname | nöör | Põllumajandusettevõtte nimi, unikaalne identifikaator taludele. |
| kuni | Number | Ootel olevate ühenduste arv. |
| profiil | nöör | Põllumajandusettevõtte tüüp. Võimalikud väärtused on: andmelink, l4xnat, http, https or gslb. Iga profiil on määratletud ise. |
| staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
| vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
| vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. |
Järelevalve - graafikud
See osa on kasulik sisemise koormuse tasakaalustussüsteemi jälgimiseks, et tuvastada probleeme CPU kasutamise, vahetusmälu, RAM, kõigi konfigureeritud võrguliideste, koormuse ja kõvaketta salvestamise parameetrite kaudu.
Samuti saate juurdepääsu nädalale, kuule ja aastale.
Informatsiooniga graafikud vastatakse base64-vormingus.
Saada kättesaadavad graafikud
Saada kättesaadavad graafikud
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs
GET /graphs
Näita objekti kõigi olemasolevate graafikutega süsteemis. See näitab võimalikku taotlust, mida saab teha.
Vastuse näide:
{
"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"
]
}
]
}
Vastuse parameetrid
Vastuseks on JSONi kolme tüüpi graafikud, talud, liidesed ja süsteem.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Loend põllumajandusettevõtete graafikutest. |
| liidesed | String [] | Võimalike liidese graafikute loend. |
| süsteem | Objekt [] | Süsteemide graafikute nimekiri. Massiivil on objekt, millel on massiiv, mis näitab ketta kinnituspunkte. |
Süsteemi objekt:
Süsteemiobjekt sisaldab süsteemi ja järgmise objektiga ketasobjektide massiivide nimekirja.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| ketas | String [] | Selle massiivi väärtused on kõik olemas kinnituspunktid süsteemis, igaühel neist on olemas graafikud. |
Näita graafikuid
Näita graafikuid
Taotluse näide talu kohta:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb
Liidese päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3
Ketta näitamise näide:
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>
Olemasolevad väärtused graafik See on:
| Väärtus | Kirjeldus |
|---|---|
farms/<farmname> |
farmname, talu unikaalne identifikaator. |
interfaces/<interface> |
liides, liidese unikaalne identifikaator. |
system/<system> |
süsteemvõimalikud süsteemi graafikud on: cpu, koormus, RAM or vahetama. |
system/disk/<mount point> |
kinnituspunkt, on väärtuseks ketas objekt, mille tagastab kõne 'GET / graphs'. |
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| sagedus | nöör | Diagrammi genereerimiseks kasutatud periood. Võimalikud väärtused on: iga päev, iga nädal, igakuine or aastas. |
| graafikud | nöör | Graafik base64 formaadis. |
Näita sagedusgraafikut
Näita sagedusgraafikut
Taotluse näide talu kohta:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb/daily
Liidese päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3/monthly
Ketta näitamise näide:
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>
Olemasolevad väärtused graafik See on:
| Väärtus | Kirjeldus |
|---|---|
farms/<farmname> |
farmname, talu unikaalne identifikaator. |
interfaces/<interface> |
liides, liidese unikaalne identifikaator. |
system/<system> |
süsteemvõimalikud süsteemi graafikud on: cpu, koormus, RAM or vahetama. |
system/disk/<mount point> |
kinnituspunkt, on väärtuseks ketas objekt, mille tagastab kõne 'GET / graphs'. |
Olemasolevad väärtused sagedus See on:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| sagedus | nöör | Diagrammi genereerimiseks kasutatud periood. Võimalikud väärtused on: iga päev, iga nädal, igakuine or aastas. |
Vastuse näide:
{
"description" : "Get farm graphs",
"graph" : "PNG IN BASE 64"
}
Vastuse parameetrid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| graafikud | nöör | Graafik base64 formaadis. |
IPDS
See moodul on programmi rakendamine IPS (Sissetungi vältimise süsteem) ja IDS (Sissetungide avastamise süsteemi) süsteem, mis pakub kasutajale turvakihti. IPDS-moodul kontrollib liiklust vahetult enne, et jõuda koormuse tasakaalustamise mooduliteni LSLB or GSLB, kui liiklus avastatakse pahatahtlikuna, lükatakse see tagasi.
Ta rakendab turvaeeskirju süsteemile, mis määratletakse erineva iseloomuga objektina. Igaüks pakub lahendust välisele pahatahtlikule või kahtlasele tegevusele. See tööriist aitab süsteemiadministraatoritel kontrollida ohtusid ja rünnakuid.
Zevenetile kohaldatavad reeglid võivad olla mustad nimekirjad, DoS, RBL or WAF.
IPDS-paketi allalaadimine
IPDS-paketi allalaadimine
Päringu näide:
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
Hankige zevenet-ipds paketi teave. See pakett sisaldab iga IPDS mooduli värskendatud reegleid.
Vastuse näide:
{
"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
}
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetridon selle väärtus IPDS-paketi teave.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| staatus | nöör | Näitab IPDS-paketi värskenduse olekuteavet. Kui pakett on installitud, kui see on värskendatud ja on ootel värskendusi. |
| ruleet_date | nöör | See on paketi ehitamise kuupäev. See ei ole installitud kuupäev. |
| plaanitud | nöör | Kirjeldav sõnum selgitab ajakava konfiguratsiooni. |
| režiimis | nöör | See näitab, kui tihti värskendus toimub või ajakava keelata. Olemasolevad väärtused on: Iga päev Planeerige iga päev tehtav värskendus, see võimaldab sagedusväljal näidata, mitu tundi uuendatakse korraga; Iganädalane, Ajastage värskendus, mis tuleb teha kord nädalas, see võimaldab sagedus nädala päevaks, et näidata, millisel nädalapäeval värskendus planeeritakse (esmaspäevast pühapäevani); igakuine, ajastage värskendus üks kord kuus. |
| sagedus | Number | If režiimis on iga päev, sagedus on tundide arv paketi värskenduse vahel alates aeg; Kui režiimis on nädalane, eeldatav väärtus on number nädalapäev (alates esmaspäevast, 1, pühapäevani 7); Kui režiimis on igakuine, eeldatav väärtus on arv kuus 1 et 31). |
| aeg | objekt | Võimaldab määrata, millisel ajal värskendus ilmneb või millal pakett värskendatakse, kui režiim on seatud päevale ja sagedus on suurem kui 0. |
Ajaobjekt:
See objekt, tund: minut, on tund, mil pakett uuendatakse.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tund | Number | Kas tund on vormingus 0 et 23. |
| minut | Number | on vormingus minutid 0 et 59. |
Rakenda IPDS-paketti
Rakenda IPDS-paketti
IPDS-reeglite värskendamise soovide näide:
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
Vastuse näide:
{
"desc" : "Execute an action over the zevenet-ipds package",
"params" : {
"ruleset_date" : "07-06-2019",
"status" : "Installed and updated"
}
}
Taotluse näidis ajastamise värskenduste jaoks:
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
Vastuse näide:
{
"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
Rakenda zevenet-ipds paketi toiming.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| tegevus | nöör | IPDS-eeskirjade paketi suhtes kohaldatakse tegevust. Valikud on järgmised: upgrade sundida paketi uuendamist. ajakava süsteemi konfigureerimiseks uuendatakse paketti perioodiliselt. | |
| režiimis | nöör | See näitab, kui tihti värskendus toimub või ajakava keelata. Olemasolevad väärtused on: Iga päev Planeerige iga päev tehtav värskendus, see võimaldab sagedusväljal näidata, mitu tundi uuendatakse korraga; Iganädalane, Ajastage värskendus, mis tuleb teha kord nädalas, see võimaldab sagedus nädala päevaks, et näidata, millisel nädalapäeval värskendus planeeritakse (esmaspäevast pühapäevani); igakuine, ajastage värskendus üks kord kuus. | |
| sagedus | Number | If režiimis on iga päev, sagedus on tundide arv paketi värskenduse vormi vahel aeg; Kui režiimis on nädalane, eeldatav väärtus on number nädalapäev (alates esmaspäevast, 1, pühapäevani 7); Kui režiimis on igakuine, eeldatav väärtus on arv kuus 1 et 31). | |
| aeg | objekt | Võimaldab määrata, millisel ajal värskendus ilmneb või millal pakett värskendatakse, kui režiim on seatud päevale ja sagedus on suurem kui 0. |
Ajaobjekt:
See objekt, tund: minut, on tund, mil pakett uuendatakse.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tund | Number | Kas tund on vormingus 0 et 23. |
| minut | Number | on vormingus minutid 0 et 59. |
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on info IPDS-paketi kohta.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| staatus | nöör | Näitab IPDS-paketi värskenduse olekuteavet. Kui pakett on installitud, kui see on värskendatud ja on ootel värskendusi. |
| ruleet_date | nöör | See on paketi ehitamise kuupäev. See ei ole installitud kuupäev. |
| plaanitud | nöör | Kirjeldav sõnum selgitab ajakava konfiguratsiooni. |
| režiimis | nöör | See näitab, kui tihti värskendus toimub või ajakava keelata. Olemasolevad väärtused on: Iga päev Planeerige iga päev tehtav värskendus, see võimaldab sagedusväljal näidata, mitu tundi uuendatakse korraga; Iganädalane, Ajastage värskendus, mis tuleb teha kord nädalas, see võimaldab sagedus nädala päevaks, et näidata, millisel nädalapäeval värskendus planeeritakse (esmaspäevast pühapäevani); igakuine, ajastage värskendus üks kord kuus. |
| sagedus | Number | If režiimis on iga päev, sagedus on tundide arv paketi värskenduse vahel alates aeg; Kui režiimis on nädalane, eeldatav väärtus on number nädalapäev (alates esmaspäevast, 1, pühapäevani 7); Kui režiimis on igakuine, eeldatav väärtus on arv kuus 1 et 31). |
| aeg | objekt | Võimaldab määrata, millisel ajal värskendus ilmneb või millal pakett värskendatakse, kui režiim on seatud päevale ja sagedus on suurem kui 0. |
Ajaobjekt:
See objekt, tund: minut, on tund, mil pakett uuendatakse.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tund | Number | Kas tund on vormingus 0 et 23. |
| minut | Number | on vormingus minutid 0 et 59. |
Loetle kõik IPDS-reeglid
Nimekiri ipds reeglid
Päringu näide:
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
Loetlege kõik süsteemi IPDS-reeglid.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on mustade nimekirjade objektide massiiv, millest igaüks sisaldab allpool toodud võtmes atribuute.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | IPDS reegli nimi. Seda kasutatakse unikaalse identifikaatorina. |
| välistada | nöör | See on IPDS-i reegli olemus. See võib olla Musta Nimekirja, dos or rbl. |
| tüüp | nöör | See väli kuvatakse dos reeglites ja see määrab, kas reegel on süsteem, see kehtib tasakaalustaja kohta; või talu, kehtivad eeskirjad talu kohta. |
IPDS - mustad nimekirjad
Mustlased võimaldab kasutajatel kasutada nimekirju, et filtreerida või lubada liiklust vastavalt IP allikatele (sissetulev liiklus).
On kahte tüüpi nimekirju:
- Kaugjuhtimispuldid: loendid saadakse URL-ilt, need nimekirjad ei ole muudetavad ja neid saab alla laadida.
- Kohalik: kasutajad saavad oma poliitika luua kindla poliitikaga, eitama kui sissetulevad IP-vasted siis lükatakse liiklus tagasi või võimaldama kui sissetulevad IP-vasted siis liiklus on lubatud.
See moodul sisaldab eelsalvestatud Zevenet'i meeskonna poolt esitatud nimekirjad, on nimekiri valmis põllumajandusettevõtetele. Lisaks saavad kasutajad luua oma isikupärastatud loendeid.
Samasse talusse saab rakendada mitmeid nimekirju, kui lähteteksti IP vastab mõnedele nimekirjadele, kui liiklus on lubatud või keelatud sõltuvalt musta nimekirja poliitikast. Hetkel on IP-vasted siis enam lähte-IP-le tehtud mustade nimekirjade kontroll.
Kui allika IP on kahes erinevas nimekirjas, üks tüüp eitama ja teist tüüpi võimaldama, siis alati hinnatakse kõigepealt lubamispoliitikat.
Loetle kõik mustade nimekirjade reeglid
Loetle kõik mustad nimekirjad
Päringu näide:
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
Loetle kõik kasutaja poolt loodud või süsteemile eelnevalt laaditud mustad nimekirjad, mida saab põllumajandusettevõtetele rakendada.
Vastuse näide:
{
"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"
},
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on mustade nimekirjade objektide massiiv, millest igaüks sisaldab allpool toodud võtmes atribuute.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Põllumajandusettevõtete nimekiri, kus kasutatakse musta nimekirja. |
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| eelkoormus | nöör | Võimalikud väärtused on: tõsi, must nimekiri on süsteemis eelsalvestatud; või vale, must nimekiri on loodud süsteemi administraatori poolt. |
| staatus | nöör | Võimalikud väärtused on: up, aktiveeritakse must nimekiri ja blokeeritakse (või lubatakse) loendi moodustavate allikate liiklust; või alla, tegelikult reegel ei tööta ja see ei ole liikluse filtreerimine. |
| tüüp | nöör | Kui nimekiri on salvestatud ja kes seda säilitab. Väärtused on järgmised: kohalik, salvestatakse nimekiri kohalikus süsteemis ja seda saab muuta kohapeal või kauge, allalaaditakse loend kaugallikast a URL, Seda ei saa lokaalselt muuta, nii et muudatused tuleb teha kaugallikas. |
Too mustade nimekirjade reegel
Too must nimekiri
Päringu näide:
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>
Näita musta nimekirja konfiguratsiooni ja kirjelduse parameetreid. nimi on mustade nimekirjade unikaalne identifikaator.
Vastuse parameetrid
Vastuse kohaliku loendi näide:
{
"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"
}
}
Kohalik musta nimekirja objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Põllumajandusettevõtete nimekiri, kus kasutatakse musta nimekirja. |
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| eelkoormus | nöör | Võimalikud väärtused on: tõsi, must nimekiri on süsteemis eelsalvestatud; või vale, must nimekiri on loodud süsteemi administraatori poolt. |
| staatus | nöör | Võimalikud väärtused on: up, aktiveeritakse must nimekiri ja blokeeritakse (või lubatakse) loendi moodustavate allikate liiklust; või alla, tegelikult reegel ei tööta ja see ei ole liikluse filtreerimine. |
| tüüp | nöör | Kui nimekiri on salvestatud ja kes seda säilitab. Väärtused on järgmised: kohalik, salvestab nimekirja süsteem ja haldab süsteemihaldur; või kauge, loend on alla laaditud kaugelt URL-ilt. |
| allikad | Objekt [] | Loetelu IP-dest, mida loend kontrollib. Vastuvõetud allikavõrgu formaat: Võrgu aadress / mask natuke või IP |
Vastuse kaugloendi näide:
{
"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"
}
}
Musta musta nimekirja objekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Põllumajandusettevõtete nimekiri, kus kasutatakse musta nimekirja. |
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| eelkoormus | nöör | Võimalikud väärtused on: tõsi, must nimekiri on süsteemis eelsalvestatud; või vale, must nimekiri on loodud süsteemi administraatori poolt. |
| tüüp | nöör | Kui nimekiri on salvestatud ja kes seda säilitab. Väärtused on järgmised: kohalik, salvestab nimekirja süsteem ja haldab süsteemihaldur; või kauge, laaditakse loend kaugjuhtimispuldilt alla URL. |
| allikad | Objekt [] | Allikate IP-d, mis kontrollivad kontrollimisi. Kui nimekiri on tüüpiline kauge seejärel ei kuvata loendi sisu enne esimest allalaadimist. |
| uuenda staatust | nöör | Kohaliku süsteemi viimase eduka värskenduse loendi ja kuupäeva viimane allalaadimine. |
| URL | nöör | Kui kaugloend on alla laaditud. Kaugformaadiks peab olema ühe loend allikas võrk / bitmask või IP rea kohta. |
| sagedus | nöör | Kaugloendi uuendamise sagedus. Valikud on järgmised: iga päev, värskendage kõiki päevi üks kord või perioodiliselt frequency_type väli; iga nädal, uuendage kord nädalas; või igakuine, värskendage kord kuus. |
| frequency_type | nöör | See parameeter lõpetab sagedus iga päev, kui selle väärtus on iga päev. Võimalikud väärtused on: täpne. defineerige tund päevas; või periood, määrake päeva jooksul värskendamise aeg. |
| päev | String või number | See parameeter täiendab parameetrit sagedus millal sagedus väärtus ei iga nädal or igakuine. Kui sagedus is iga nädal see parameeter peab olema nädala päev (hommikul, teisipäev, kolmapäev, neljapäeval, reede, laupäev or pühapäev) kui sagedus väärtus ei igakuine siis peab see parameeter olema kuu päev (arv vahel 1 ja 31). |
| aeg | objekt | See on struktuur, mis sõltub väljadest sagedus. |
| staatus | nöör | Võimalikud väärtused on: up, aktiveeritakse must nimekiri ja blokeeritakse (või lubatakse) loendi moodustavate allikate liiklust; või alla, tegelikult reegel ei tööta ja see ei ole liikluse filtreerimine. |
Ajaobjekt päevase sageduse ja ajavahemiku sageduse jaoks
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| periood | Number | Kui tihti nimekirja uuendatakse. |
| üksused | nöör | Perioodi üksus. Valikud on järgmised: protokoll, näidake, et loendit uuendatakse iga konfigureeritud minuti jooksul; või tundi, uuendatakse loendit iga konfigureeritud tunni kohta. |
Teiste sageduste ajaobjekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tund | Number | Tundi loendi uuendamiseks. Väärtus peab olema number 0 ja 23. |
| protokoll | Number | Nimekirja uuendamiseks minutid. Väärtus peab olema number 0 ja 59. |
Allikate objekt
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Allika unikaalne identifikaator loendis. |
| allikas | nöör | IP-aadressid või võrgusegmendid, mida loend kontrollib. |
Looge musta nimekirja reegel
Loo uus must nimekiri
Kohaliku loendi näide:
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
Kaugloendi päringu näide:
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
Looge kasvandustes kasutatav must nimekiri. Mustad nimekirjad võivad olla kahte tüüpi:
- Kohalik: allikad lisatakse kasutajale. Nimekiri salvestatakse kohapeal.
- Kaugjuhtimine: allikad saadakse kaugelt. Seda asukohta näitab URL. Toetatud kaugloendi formaat on üks Võrgu aadress / mask or IP rida rea kohta.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. | tõsi |
| tüüp | nöör | Kui nimekiri on salvestatud ja kes seda hooldab. Väärtused on järgmised: kohalik, see salvestatakse haldussüsteemi süsteemi ja hooldusse; või kauge, loend on välja võetud teenusest a URL ja administraatori teenus hooldab loendit. | tõsi |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. Vaikeväärtus on keelatud. | |
| URL | nöör | Kui kaugloend on alla laaditud. Kaugformaadiks peab olema ühe loend allikas vormingus rea kohta Võrgu aadress / mask or IP. | kehtib ka kaugloendi puhul |
{
"description" : "Post list list1",
"params" : {
"farms" : [],
"name" : "newListLoc",
"policy" : "deny",
"preload" : "false",
"type" : "local"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on mustade nimekirjade objektide massiiv, millest igaüks sisaldab järgmisi võtme atribuute.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Põllumajandusettevõtete nimekiri, kus kasutatakse musta nimekirja. |
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| eelkoormus | nöör | Võimalikud väärtused on: tõsi, must nimekiri on süsteemis eelsalvestatud; või vale, must nimekiri on loodud süsteemiadministraatorile. |
| tüüp | nöör | Kui nimekiri on salvestatud ja kes seda hooldab. Väärtused on järgmised: kohalik, see salvestatakse haldussüsteemi süsteemi ja hooldusse; või kauge, loend on välja võetud teenusest a URL ja administraatori teenus hooldab loendit. |
Muuda musta nimekirja reeglit
Muuda musta nimekirja
Kohaliku loendi näide:
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>
Muuda musta nimekirja reegli konfiguratsiooni. nimi on mustade nimekirjade unikaalne identifikaator.
Kohaliku nimekirja parameetrite taotlemine:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. Ainult seda saab muuta nr eelkoormus nimekirju. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| allikas | String [] | See on nimekiri IP-aadressidest või võrgusegmentidest, mida loend kontrollib. Ainult allika muutmiseks vaadake dokumentatsiooni jaotist IPDS> mustad nimekirjad> musta nimekirja allika muutmine. Ainult allikaid saab muuta nr eelkoormus nimekirju. |
Vastuse näide:
{
"description" : "Modify list whiteList.",
"params" : {
"name" : "whiteList",
"policy" : "allow",
"preload" : "false",
"type" : "local"
}
}
Vastuse parameetrid
Vastus on JSON koos kõigi nõutud väärtustega. Lisateabe saamiseks vaadake vastuse näidet.
Kaugloendi päringu näide:
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
Taotluse näidis nimekirja uuendamiseks iga 2 tundi:
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
Soovi näide nimekirja uuendamiseks kõikidel päevadel 2is: 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
Taotluse näide kõigi esmaspäevade uuendamiseks aadressil 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
Taotlusnäide kuu 1i värskendamiseks 12is: 00 PM:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"frequency":"monthly","day":"1","time":{"hour":12,"minutes":0}}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/newListRem
Küsi kaugloendi parameetreid
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| talud | String [] | Põllumajandusettevõtete nimekiri, kus kasutatakse musta nimekirja. |
| nimi | nöör | Mustade nimekirjade nimi. Seda kasutatakse unikaalse identifikaatorina. |
| poliitika | nöör | Allikale rakendatav tegevus. Valikud on järgmised: eitamablokeerige sisendliiklus nimekirja allikatest; või võimaldama aktsepteerima liikluse nimekirja allikatest. |
| URL | nöör | Kui kaugloend on alla laaditud. |
| sagedus | nöör | Kaugloendi uuendamise sagedus. Valikud on järgmised: iga päev, värskendage kõiki päevi, üks kord või periood, see on näidatud frequency_type väli; iga nädal, uuendage kord nädalas; või igakuine, värskendage kord kuus. |
| frequency_type | nöör | See parameeter lõpetab sagedus iga päev, kui selle väärtus on iga päev. Võimalikud väärtused on: täpne. defineerige tund päevas; või periood, määrake päeva jooksul värskendamise aeg. |
| päev | String või number | See parameeter lõpetab sagedus kui selle väärtus on kord nädalas või kuus. Kui see on iganädalane, peab see parameeter olema nädalapäev (hommikul, teisipäev, kolmapäev, neljapäeval, reede, laupäev or pühapäev) muul juhul kui sagedus on igakuine, siis peab see parameeter olema kuupäev (number vahel 1 ja 31). |
| aeg | objekt | See on struktuur, mis sõltub väljadest sagedus. |
Ajaperioodi objekt
Need on väljad, mille jooksul seadistatakse periood.
See on vajalik konfigureerimisel sagedus väärtusega iga päevja frequency_type väärtusega periood.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| periood | Number | Kui tihti nimekirja uuendatakse. |
| üksus | nöör | Perioodi üksus. Valikud on järgmised: protokoll or tundi, märkige loenduuenduste mõõtühik. |
Täpne tundide objekt
Need on väljad, kus konfigureeritakse täpne tunniaeg.
Seda objekti kasutatakse koos järgmise konfiguratsiooniga:
sagedus väljal on väärtus iga päev ja frequency_type is täpne.
sagedus väljal on väärtus iga nädal ja päev on loendi uuendamise nädalapäev.
sagedus väljal on väärtus igakuine ja päev on päevade arv, mil loend värskendatakse.
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| tund | Number | Tundi loendi uuendamiseks. Väärtus peab olema number 0 ja 23. |
| protokoll | Number | Nimekirja uuendamiseks minutid. Väärtus peab olema number 0 ja 59. |
Vastuse näide:
{
"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"
}
}
Vastuse parameetrid
Vastuseks on JSON koos kõigi loendikonfiguratsioonidega. Lisateabe saamiseks vaadake vastuse näidet.
Kustuta mustade nimekirjade reegel
Kustuta mustade nimekirjade loend
Päringu näide:
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>
Kustutage antud must nimekiri. nimi on mustade nimekirjade unikaalne identifikaator.
Vastuse näide:
{
"description" : "Delete list 'remoteList'",
"message" : "The list remoteList has been deleted successful.",
"success" : "true"
}
Mustade nimekirjade allikate loetelu
Nimekirja allikas loetletakse allikas
Päringu näide:
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
Loetle musta nimekirja allikad. nimi on mustade nimekirjade unikaalne identifikaator.
Vastuse näide:
{
"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"
}
]
}
Vastuse parameetrid
Vastuseks on võtmega JSON parameetrid ja lähtefunktsiooni massiivi väärtuseks.
Allikasobjekt:
| Väli | KASUTUSALA | Kirjeldus |
|---|---|---|
| id | Number | Allika unikaalne identifikaator loendis. |
| allikas | String [] | IP-aadressid või võrgusegmendid, mida loend kontrollib. |
Lisage allikad musta nimekirja
Lisage mustale nimekirja allikas
Päringu näide:
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
Taotlege partii näidet:
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
Lükake must allikas uus allikas. Saadaval ainult kohalike nimekirjade ja eelsalvestamata nimekirjade puhul. nimi on mustade nimekirjade unikaalne identifikaator.
Taotlege parameetreid
| Väli | KASUTUSALA | Kirjeldus | Nõutud |
|---|---|---|---|
| allikas | String või string [] | IP-aadress või võrgusegment, mida loend kontrollib. | tõsi |
Vastuse näide:
{
"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"