Zevenet API v4.0 viide
ZAPI (Zeveneti rakenduse programmeerimisliides) on süsteemi administraatori Zeveneti koormuse tasakaalustaja käitumise vahend.
Enne kasutamist tuleb zapi kasutaja veebi kasutajaliidese abil aktiveerida. Süsteem / kasutajad.
Kui zapi kasutaja on loodud, on võimalik saata päring URL-ile, https: // (zevenet_server): 444 / zapi / v4.0 / zapi.cgi / (URI_path), kus zevenet_server on IP, kus HTTP teenus kuulab.
URI_path
määratleb toimingu või toimingu. Tema käitumine ja tema parameetrid määratletakse iga dokumendi osas.
Selles API-s kasutatavad tegusõnad on GET, POST, PUT or Kustuta. PUT- või POST-päring vajab alati peaaegu parameetrit, kuigi see ei vaja ühtegi nõutavat parameetrit.
Sertifikaadid
Zevenet toetab PEM-vormingus cetificates'i, et kasutada neid HTTPS-kuulajaga HTTP-põllumajandusettevõtetes 444 / zapi / v4.0 / zapi.cgi. Kui soovite rohkem teada saada, kuidas pem-sertifikaate luua, 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
GET /certificates
Loetlege sertifikaatide poes kõik CSR- ja PEM-sertifikaadid, neid sertifikaate saab kasutada HTTPS-i põllumajandusettevõtetega.
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on sertifikaatobjektide massiiv, millest igaüks sisaldab allpool toodud võtme atribuute.
Vastuse näide:
{
"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 [] | Sertifikaadi 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 | 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
GET /certificates/<file>
Laadige sertifikaatide kauplusesse installitud sertifikaat alla, kasutage failinime selle identifitseerimiseks.
Vastus sisaldab allpool toodud päiseid koos teabega faili kohta. Vastuse sisu on faili sisu.
Vastuse päised:
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
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
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 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
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 | 444 / zapi / v4.0 / zapi.cgi serveri täielikult kvalifitseeritud domeeninimi. | tõsi |
jaotus | nöör | Sertifikaati käsitseva 444 / zapi / v4.0 / zapi.cgi organisatsiooni jagamine. | tõsi |
organisatsioon | nöör | 444 / zapi / v4.0 / zapi.cgi organisatsiooni juriidiline nimi. | tõsi |
asukoht | nöör | Linn, kus asub 444 / zapi / v4.0 / zapi.cgi organisatsioon. | tõsi |
riik | nöör | Olek / piirkond, kus asub 444 / zapi / v4.0 / zapi.cgi organisatsioon. | tõsi |
riik | nöör | 444 / zapi / v4.0 / zapi.cgi organisatsiooni asukohaks oleva riigi kahekohaline ISO-kood. | tõsi |
post | nöör | 444 / zapi / v4.0 / zapi.cgi organisatsiooniga kontakteerumiseks kasutatav e-posti aadress. | 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
POST /certificates/<file>
Laadige üles HTMPS-kuulajaga HTTP-põllumajandusettevõtete PEM-sertifikaat.
Nõuab parameetrit --tcp-nodelay
ja --data-binary
faili üleslaadimiseks binaarrežiimis.
URI parameetrite taotlemine
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.
Vastuseks on JSON-objekt, mille klahv on seatud parameetrid. Selle väärtus on sertifikaatobjektide massiiv, millest igaüks sisaldab allpool toodud võtme atribuute.
Vastuse näide:
{
"description" : "Get the ciphers available",
"params" : [
{
"ciphers" : "all",
"description" : "All"
},
{
"ciphers" : "highsecurity",
"description" : "High security"
},
{
"ciphers" : "customsecurity",
"description" : "Custom security"
}
]
}
Vastuse parameetrid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
parameetrid | Objekt [] | Sertifikaadi objektide loend. |
Sertifikaadi objekt
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
salakirjad | nöör | Seda kasutatakse unikaalse 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-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 ja Datalink Service Load Balancer või DSLB moodul.
Kõik moodulid töötavad farmiprofiili kontseptsiooniga, põllumajandusprofiil on grupp parameetreid, mis on valmis tegema konkreetse toimingu võrguliiklusega, on oluline mõista, mida on võimalik teha iga põllumajandusprofiili jaoks, et saada Zevenet'i parimaid tulemusi ADC.
- LSLB: see moodul on võimeline töötama http ja l4xnat profiilifarmid. See toimib veebi tagasipööratud proksina või ruuterina
- DSLB: see moodul on võimeline töötama andmelink profiili talu. See toimib lüüsi.
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
GET /farms
Loetlege kõik olemasolevad talud
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 unikaalse identifikaatorina. |
profiil | nöör | Profiili tüüp, profiili olemasolevad väärtused on järgmised: http, https or l4xnat LSLB 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 saab liiklust |
vport | nöör | Virtuaalne sadam, kus farm võtab liiklust vastu, on porti saadaolevad väärtused: pordi number http [s] ja l4xnat jaoks, pordirühm, mis on eraldatud tähega "," või pordivahemik, mis on eraldatud tähisega ":" l4xnati profiilide jaoks, l4xnatis mõlemad eraldajad väärtusi (“,” ja “:”) saab kasutada samal väljal. |
Vastuse näide:
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
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
DELETE /farms/<farmname>
Kustuta põllumajandusettevõte oma ettevõtte nime identfier abil.
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
PUT /farms/<farmname>/actions
Rakenda põllumajandusettevõttele toimingut, vaadake tegevuste tabeli Taotluse parameetrid.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
tegevus | nöör | Määrake soovitud toiming. Toimingud on järgmised: peatus, talu peatatakse. algus, alustatakse talu ja restart, talu peatatakse ja käivitatakse automaatselt. |
Vastuse näide:
{
"description" : "Set a new action in FarmHTTP",
"params" : [
{
"action" : "stop"
}
]
}
Vastuse parameetrid
Kui konfiguratsioonis ei ole probleeme, tagastab zapi soovitud toimingu.
HTTP talud
HTTP-profiil on täiustatud 7. kihi koormuse tasakaalustamine (või rakenduste edastamise kontroller), millel on puhverserveri eriomadused. See profiil pakub mõningaid funktsioone, nagu HTTPS-i kihi 7 koormuse tasakaalustamine. See profiil on kohandatud veebiteenuste (kaasa arvatud veebirakenduse serverid) ja kõigi HTTP- ja HTTPS-protokollidel põhinevate rakendusprotokollide jaoks, nagu WebDav, RDP üle HTTP, ICA üle HTTP jne. Selle farmi profiili konfigureerimiseks tuleb virtuaalne IP-aadress ja vaja on virtuaalset TCP-porti.
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
GET /farms/<farmname>
Näita kõiki antud talu konfiguratsioone.
Vastuse näide:
{
"description" : "List farm httpFarm",
"params" : {
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"addheader" : [
{
"header" : "load-balancer: true",
"id" : 0
}
],
"addresponseheader" : [
{
"header" : "Session: true",
"id" : 0
}
],
"headremove" : [
{
"id" : 0,
"pattern" : "^client"
}
],
"removeresponseheader" : [
{
"id" : 0,
"pattern" : "Host"
}
],
"ignore_100_continue" : "true",
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"httpverb" : "MSRPCext",
"listener" : "https",
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"farmguardian" : "check_tcp",
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"redirect" : "http://192.168.101.254/index.html",
"redirecttype" : "default",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN"
},
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"farmguardian" : null,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
teenused | Objekt [] | Koostage kõik selles talus loodud teenused ja selle konfiguratsioon. |
HTTP-põllumajandusettevõtete parameetrite objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
certlist | Objekt [] | Ainult https-profiilis. Põllumajandusettevõttes aktiveeritud sertifikaat, pem-vormingus, on lubatud lisada samasse talusse ainult üks pem-sertifikaat. nõutav https-väärtusega kuulaja. Siin võib kasutada sertifikaatide kaupluses olevat pem-sertifikaati. |
cipherc | nöör | Ainult https kuulaja. See on lubatud krüpteeringute loend, mida SSL-ühendus aktsepteerib, mis on string, mis on samas formaadis kui OpenSSL-i šifreerides. Seda atribuuti kasutatakse ainult siis, kui salakirjad väljal on väärtuse õmblusväärtus. |
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; või tollikindlust, laaditakse ainult šifrid cipherc valdkonnas. |
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 ühendused, mis kasutavad SSL-i turvaprotokolli versiooni 2, 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 ühendused, mis kasutavad SSL-i turvaprotokolli versiooni 3, 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. |
error414 | nöör | Isikupärastatud teade 414i HTTP-veakoodiga vastamiseks. |
error500 | nöör | Isikupärastatud teade 500i HTTP-veakoodiga vastamiseks. |
error501 | nöör | Isikupärastatud teade 501i HTTP-veakoodiga vastamiseks. |
error503 | nöör | Isikupärastatud teade 503i HTTP-veakoodiga vastamiseks. |
httpverb | nöör | See väli näitab operatsioone, mis lubatakse HTTP-kliendi taotlustele. saadaolevad väärtused on: standardHTTPaktsepteeritud http-taotlused GET, POST, HEAD. expandHTTP, aktsepteeritud eelmised http-taotlused pluss PUT, DELETE. standardWebDAV, aktsepteeritud eelmised http-taotlused pluss LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV aktsepteeritud eelmised http-taotlused 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 juhutundlikud. |
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. |
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 | 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. |
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. |
palgid | String | Farm Logib HTTP ühenduste jälje. Kui sellel parameetril on väärtus tõsi, logid on lubatud; kui sellel on väärtus vale, logid on keelatud. ignore_100_continue | String | Kui sellel väljal on väärtus true, siis 100 jätka HTTP päist ignoreeritakse; kui väärtus on väär, töödeldakse 100 jätkamise päist (alates versioonist 4.0.2). lisa päis | Objekt[] | See on objektide loend koos päistega, mida lisada kliendi päringule (alates versioonist 4.0.2). Adresponseheader | Objekt[] | See on objektide loend koos päistega, mida lisada taustaprogrammi vastusele (alates versioonist 4.0.2). pea eemaldamine | Objekt[] | See on regulaaravaldiste loend, mille abil eemaldada kliendi päringutest päised. Eemaldatud päised ei jõua taustaprogrammi (alates versioonist 4.0.2). eemalda vastuse päis | Objekt[] | See on regulaaravaldiste loend, mille abil saab taustaprogrammi vastusest päised eemaldada. Eemaldatud päised ei jõua kliendini (alates versioonist 4.0.2). kinnitatud ühendus (alates versioonist 4.0.2) | Arv | 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) | String | 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.
Certlisti objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
fail | nöör | Sertifikaadi nimi, sertifikaadipoe sertifikaadi viited. |
id | Number | Sertifikaadi ID. |
HTTP objektide teenuste objekt:
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. |
httpsb | nöör | See parameeter näitab põllumajandusettevõttele, et praeguses teenuses määratletud taustaprogrammid kasutavad HTTPSi 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 reageerivat tasakaalustamismeetodit. tõsi profiilis kontrollitakse, milline taustaprogramm võtab vähem aega, et saata sellele rohkem ü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 käitub spetsiaalse taustaprogrammina, kuna kliendi soovile vastatakse automaatselt uuele URL-ile. Kui ümbersuunamine on konfigureeritud, siis päringut ei edastata taustaprogrammile, siis suunatakse kliendile ümbersuunamine. |
ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutse peremehe ja tee 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 kättesaadav, kui püsivus väli on URL, COOKIE või HEADER, parameetri väärtus otsib talu http päises ja haldab kliendi seanssi. |
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, mis puudutab URL-i, 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. |
HTTP-põllumajandusettevõtete taustaprogramm:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
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 | Teatud päringule vastamiseks on sekundi jooksul tagaplaani aeg. Kui nullsüsteem kasutab globaalset parameetrit Backends timeout. |
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. |
ü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
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 jaoks 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 |
Vastuse näide:
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"farmname" : "newHTTPfarm",
"profile" : "http",
"vip" : "192.168.100.23",
"vport" : 80
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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,
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
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 taustaprogramm 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 ühendused, mis kasutavad SSL-i turvaprotokolli versiooni 2, 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 ühendused, mis kasutavad SSL-i turvaprotokolli versiooni 3, 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: standardHTTPaktsepteeritud http-taotlused GET, POST, HEAD. expandHTTP, aktsepteeritud eelmised http-taotlused pluss PUT, DELETE. standardWebDAV, aktsepteeritud eelmised http-taotlused pluss LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV aktsepteeritud eelmised http-taotlused 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 juhutundlikud. |
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. |
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; või tollikindlust, laaditakse ainult šifrid cipherc valdkonnas. |
cipherc | nöör | Ainult https kuulaja. See on lubatud krüpteeringute loend, mida SSL-ühendus aktsepteerib, mis on string, mis on samas formaadis kui OpenSSL-i šifreerides. Seda atribuuti kasutatakse ainult siis, kui salakirjad väljal on väärtuse õmblusväärtus. |
newfarmname | nöör | Uue talu nimi. Farm 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. |
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",
"error414" : "Message error 414",
"error500" : "Message error 500",
"error501" : "Message error 501",
"error503" : "Message error 503",
"httpverb" : "standardHTTP",
"listener" : "https",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
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
POST /farms/<farmname>/certificates
HTTPS-kuulajaga HTTP-talu PEM-sertifikaadi muutmine. 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 farm httpFarm, you need restart the farm to apply",
"success" : "true",
"status": "needed restart"
}
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"
See kõne on saadaval versioonist 4.0.2
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"
See kõne on saadaval versioonist 4.0.2
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
See kõne on saadaval versioonist 4.0.2
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:"
See kõne on saadaval versioonist 4.0.2
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:"
See kõne on saadaval versioonist 4.0.2
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
See kõne on saadaval versioonist 4.0.2
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"
}
}
HTTP - Teenused
HTTP-profiili talu teenused pakuvad sisu vahetamise meetodit erinevate veebiteenuste pakkumiseks, millel on erinevad omadused, taustaprogrammid või isegi püsivuse meetodid, kasutades mõningaid deterministlikke tingimusi, mida talumaja südamik kasutab, et sobitada iga kliendi sooviga õige teenusega. Seda teenuse määratlust kasutab põllumajandusettevõte, et määrata kindlaks taustaprogrammide serverid, mis võivad 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
GET /farms/<farmname>/services/<id>
Näita kõiki antud teenuse konfiguratsioone.
Vastuse näide:
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null,
"connection_limit" : null
},
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null,
"connection_limit" : null
}
],
"farmguardian" : "check_tcp-cut_conns",
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : "",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN",
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
HTTP objektide teenuste objekt:
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. |
httpsb | nöör | See parameeter näitab põllumajandusettevõttele, et praeguses teenuses määratletud taustaprogrammid kasutavad HTTPSi 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 reageerivat tasakaalustamismeetodit. tõsi profiilis kontrollitakse, milline taustaprogramm võtab vähem aega, et saata sellele rohkem ü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 käitub spetsiaalse taustaprogrammina, kuna kliendi soovile vastatakse automaatselt uuele URL-ile. Kui ümbersuunamine on konfigureeritud, siis päringut ei edastata taustaprogrammile, siis suunatakse kliendile ümbersuunamine. |
ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutse peremehe ja tee 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 kättesaadav, kui püsivus väli on URL, COOKIE või HEADER, parameetri väärtus otsib talu http päises ja haldab kliendi seanssi. |
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, mis puudutab URL-i, 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. |
HTTP-põllumajandusettevõtete taustaprogramm:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
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 | Teatud päringule vastamiseks on sekundi jooksul tagaplaani aeg. Kui nullsüsteem kasutab globaalset parameetrit Backends timeout. |
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. |
ü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. |
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
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":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid",
"leastresp":"true","httpsb":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
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, mis puudutab URL-i, 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. |
ümbersuunamisviis | nöör | Kuidas suunatakse ümber, kaks võimalust: vaikimisi, võetakse URL absoluutse peremehe ja tee 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. |
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 kättesaadav, kui püsivus väli on URL, COOKIE or HEADER, otsitakse parameetri väärtust http päises olevast profiilist ja see haldab kliendi seanssi. |
hüpata | nöör | See võimaldab kõige vähem reageerivat tasakaalustamismeetodit. tõsi, kontrollib profiil profiilis, milline taustaprogramm võtab vähem aega, et sellele rohkem ühendust saada, vale, profiil ei kontrolli, millisele taustaprogrammile reageerimiseks kulub vähem aega. |
httpsb | nöör | See näitab talule, et praeguses teenuses määratletud taustaprogrammid kasutavad 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. |
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. |
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" : [],
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirecttype" : "default",
"sessionid" : "sid",
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com",
"pinnedconnection" : 0,
"routingpolicy" : "ROUND_ROBIN",
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetrite värskendaja ja staatus valdkonnas vaja uuesti taaskäivitada väärtus. Muutuste rakendamiseks tuleb võtta uuesti toiming.
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
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
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"
}
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
DELETE /farms/<farmname>/services/<id>
Kustutage http-profiili teatud teenus. 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"
}
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
GET /farms/<farmname>/services/<id>/backends
Hankige teenuse taustaprogrammide loend. id on teenuse kordumatu tunnus.
Vastuse näide:
{
"description" : "List service backends",
"params" : [
{
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1,
"connection_limit" : null
},
{
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2,
"connection_limit" : null
}
]
}
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
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. |
ü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}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
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äringu vastuvõtmiseks on taustaprogrammi aeg. | |
kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Võimalikud väärtused on pärit 1 et 9. |
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,
"connection_limit" : null
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetrite värskendaja ja staatus valdkonnas vaja uuesti taaskäivitada väärtus, kui talu tuleb uuesti alustada. Muutuste rakendamiseks tuleb võtta uuesti toiming.
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,"service":"sev2", "weight":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/services/<id>/backends/<id>
Muuda HTTP-profiili teenuse taustaprogrammi 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. |
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,
"connection_limit" : null
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetrite värskendaja ja staatus valdkonnas vaja uuesti taaskäivitada väärtus, kui talu tuleb uuesti alustada. Muutuste rakendamiseks tuleb võtta uuesti toiming.
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
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 taustalerveri peatamiseks, ilma et see mõjutaks kliente. | |
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
DELETE /farms/<farmname>/services/<id>/backends/<id>
Kustutage antud taustaprogramm HTTP-profiili teenuses.
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 väga suure jõudlusega L4i talu ja palju rohkem samaaegseid ühendusi kui koormuse tasakaalustussüdamikud kihis 7 nagu HTTP taluprofiilid. See kiht 4 jõudluse parandamine on vastuolus täiustatud sisuhaldusega, mida kiht 7 profiilid suudavad hallata.
Lisaks võiksid L4xNAT-farmid siduda terve rea porde, mitte ainult ühte virtuaalset porti, nagu seda kasutatakse teiste 7. kihi profiilidega. Selleks, et saaksite L4xNAT-i farmides valida virtuaalse pordi vahemiku või konkreetse virtuaalse pordi, on kohustuslik valida protokolli tüüp. Muul juhul kuulab farm kõiki virtuaalse IP-i sadamaid (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
GET /farms/<farmname>
Näita kõiki antud talu konfiguratsioone.
Vastus BODY:
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.55.40",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.55.41",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"params" : {
"algorithm" : "weight",
"farmguardian" : "check_tcp",
"listener" : "l4xnat",
"nattype" : "nat",
"protocol" : "tcp",
"status" : "down",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
Farm Objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
parameetrid | objekt | Põllumajandusettevõtte konfiguratsiooni parameetrid. |
taustaprogrammid | Objekt [] | Kõik tõelised serverid, mis on loodud selles talus ja selle konfiguratsioonis. |
L4xNAT talude parameetrite objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal ühendus lineaarselt, massi järgi, Allikas Hash Hash ühe allika IP ja lähtepordi kohta, Lihtne allikas Hash Hash per Source IP ainult Sümmeetriline Hash Ümberlülitunud räsi IP ja sadama kohta. |
kuulaja | nöör | Kuulaja määratleb, kuidas talu klientide päringutega mängima hakkab. teabeväljal, seda ei saa muuta. |
nattype | nöör | Kuidas koormuse tasakaalustaja kiht 4 südamik töötab. Valikud on järgmised: nat nn sNAT-režiim, reageerib taustaprogramm koormuse tasakaalustajale, et saata vastus kliendile, dnat taustaprogramm reageerib otse kliendile, koormuse tasakaalustaja tuleb konfigureerida lüüsi taustaprogrammis, DSR Otsene serveri tagastamine, koormuse tasakaalustaja muudab sihtkoha mac ja vastus läheb otse kliendile. |
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, Udp koormuse tasakaalustaja tasakaalustab ainult UDP L4 protokolli, lonks koormuse tasakaalustaja tasakaalustab ainult SIP või VoIP L7 protokolli, ftp koormuse tasakaalustaja tasakaalustab ainult FTP L7 protokolli, tftp koormuse tasakaalustaja tasakaalustab ainult TFTP L7 protokolli, sctp koormuse tasakaalustaja tasakaalustab ainult SCTP L4 protokolli, Amanda koormuse tasakaalustaja tasakaalustab ainult AMANDA L7i protokolli, h323 koormuse tasakaalustaja tasakaalustab ainult H323 L7 protokolli, IRC koormuse tasakaalustaja tasakaalustab ainult IRC L7i protokolli, netbios-ns koormuse tasakaalustaja tasakaalustab ainult NETBIOS-NS protokolli. |
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. Unikaalset porti saab täpsustada, 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. |
L4xNATi talude taustaprogramm:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
id | Number | ID, et identifitseerida talu taustaprogramm. |
ip | nöör | Taustaprogrammi IP, 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. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 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 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
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 |
Vastuse näide:
{
"description" : "Creating farm 'newl4farm'",
"params" : {
"farmname" : "newl4farm",
"interface" : "eth0",
"profile" : "l4xnat",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","vip":"178.62.126.152","vport":"81"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
PUT /farms/<farmname>
Muuda L4xNAT talu konfiguratsiooni.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
newfarmname | nöör | Uue talu nimi. Talu tuleb see peatada. |
algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal ühendus lineaarselt, massi järgi, Allikas Hash Hash ühe allika IP ja lähtepordi kohta, Lihtne allikas Hash Hash per Source IP ainult Sümmeetriline Hash Ümberlülitunud räsi IP ja sadama kohta. |
nattype | nöör | Kuidas koormuse tasakaalustaja kiht 4 südamik töötab. Valikud on järgmised: nat nn sNAT-režiim, reageerib taustaprogramm koormuse tasakaalustajale, et saata vastus kliendile, dnat taustaprogramm reageerib otse kliendile, koormuse tasakaalustaja tuleb konfigureerida lüüsi taustaprogrammis, DSR Otsene serveri tagastamine, koormuse tasakaalustaja muudab sihtkoha mac ja vastus läheb otse kliendile. |
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, Udp koormuse tasakaalustaja tasakaalustab ainult UDP L4 protokolli, lonks koormuse tasakaalustaja tasakaalustab ainult SIP või VoIP L7 protokolli, ftp koormuse tasakaalustaja tasakaalustab ainult FTP L7 protokolli, tftp koormuse tasakaalustaja tasakaalustab ainult TFTP L7 protokolli, sctp koormuse tasakaalustaja tasakaalustab ainult SCTP L4 protokolli, Amanda koormuse tasakaalustaja tasakaalustab ainult AMANDA L7i protokolli, h323 koormuse tasakaalustaja tasakaalustab ainult H323 L7 protokolli, IRC koormuse tasakaalustaja tasakaalustab ainult IRC L7i protokolli, netbios-ns koormuse tasakaalustaja tasakaalustab ainult NETBIOS-NS protokolli, pptp koormuse tasakaalustaja tasakaalustab ainult H323 L7 protokolli. |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. Unikaalset porti saab täpsustada, vahemiku porti saab määrata eraldajaga : ja mitu porti saab määrata eraldajaga ,. |
Vastuse näide:
{
"description" : "Modify farm l4farm",
"params" : {
"algorithm" : "weight",
"nattype" : "nat",
"newfarmname" : "l4farm",
"protocol" : "tcp",
"vip" : "178.62.126.152",
"vport" : "81"
}
}
Vastuse parameetrid
Vastuseks on kõigi 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":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg
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
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"
}
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
GET /farms/<farmname>/backends
Hankige teenuse taustaprogrammide loend.
Vastuse näide:
{
"description" : "List backends",
"params" : [
{
"id" : 0,
"ip" : "192.5.1.1",
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.5.1.3",
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
id | Number | ID, et identifitseerida talu taustaprogramm. |
ip | nöör | Taustaprogrammi IP, 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. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 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"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
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 |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 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. |
Vastuse näide:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"priority" : null,
"weight" : null
}
}
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.5.40","priority":4,"weight":7}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
PUT /farms/<farmname>/backends/<id>
Muuda taustaprogrammi parameetreid L4xNATi talu teenuses. id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 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. |
Vastuse näide:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"priority" : 4,
"weight" : 7
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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
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 taustalerveri peatamiseks, ilma et see mõjutaks kliente. |
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
Vastuseks on kõigi 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/l4farm/backends/4
DELETE /farms/<farmname>/backends/<id>
L4xNATi talu teenuses kustutage 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- ja virtuaalsete liideste loendi koostada, luua, konfigureerida, kustutada ja seadistada.
Nic: või võrguliidese kaart, see on arvuti riistvarakomponent ja tis-tüüpi liides on aluseks Zevenetis defineeritavatele ja hallatavatele järgmistele liidestele.
vlan: või virtuaalne lan kaart on lahke või võrguliides, mis pakub võrgu segmenteerimisteenuseid. Nic liidese kaudu saab luua rohkem kui ühe vlaani.
virtuaalne: Seda tüüpi liidest saab luua mis tahes ülaltoodud liidese kaudu. Seda tüüpi liidest tuleks kasutada põllumajandusettevõtete jaoks ja virtuaalset liidest on vaja määratleda samas alamvõrgus kui vanem.
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
GET /interfaces
Hankige süsteemi liidesed nende konfiguratsiooniga.
Vastuse näide:
{
"description" : "List interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
},
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "down",
"type" : "vlan"
},
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "virtual"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on liidese objektirühm.
Liidese objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Liidese IP. IP peab virtuaalses liideses olema samas võrgusegmendis kui vanemliides. |
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 saa virtuaalsetes liideses muuta, see on päritud algsest liidesest. |
värav | nöör | Liidese värav. Seda väärtust ei saa virtuaalsetes liideses muuta, see on päritud algsest liidesest. |
mac | nöör | Liidese MAC. See väärtus pärineb 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, liides ei saa pakette vastu võtta. |
tüüp | nöör | Erinevad liidesed on järgmised: Nic, vlan or virtuaalne. |
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
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
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 konfigureeritud, 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
Vastussõnum
Kui lüüs on sama võrgusegmendist erinev, 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 eri liideseid. Olemasolevad liidesed on järgmised: VLAN ja virtuaalne.
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
Vastuse näide:
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"is_slave" : "false",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on rida NIC-liidese objekte.
NIC-i liidese objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
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 tunnus. See on muutmatu. |
nimi | nöör | Liidese nimi. Seda kasutatakse liidese kordumatu 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. |
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
GET /interfaces/nic/<name>
Hangi kõik NIC-liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Show NIC interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
Vastuse parameetrid
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 pakettide saatmiseks teisele võrgusegmendile. |
mac | nöör | Linkkihi unikaalne tunnus. See on muutmatu. |
nimi | nöör | Liidese nimi. Seda kasutatakse liidese kordumatu 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. |
tüüp | nöör | Erinevad liidesed on järgmised: Nic, vlan or virtuaalne. Igaüks neist on määratletud nende alammenüüs. |
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
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. |
Vastuse näide:
{
"description" : "Configure nic interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"netmask" : "255.255.255.0",
"force" : "true"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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
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
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
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Võrgu - VLAN liidesed
VLAN-i liides võimaldab NIC-liidesel töötada teises võrgus, nii et IP, värav ja võrgumask väljad võivad olla vanemliidesest erinevad. 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
GET /interfaces/vlan
Hankige kõik VLAN-i liideste parameetrid.
Vastuse näide:
{
"description" : "List VLAN interfaces",
"interfaces" : [
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on VLAN-i liidese objekti massiiv.
VLAN-i parameetrid on järgmised:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Liidese IP. See võib olla erinev algseadme 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, mille moodustab vanema liidese nimi, punktmärk “.” ja vlan-võrguliidese või vlan-märgendi number. |
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. |
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
GET /interfaces/vlan/<name>
Hankige kõik VLAN-i liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Show VLAN interface",
"interface" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
Vastuse parameetrid
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. |
mac | nöör | Liidese MAC. See väärtus pärineb vanemliideselt. |
nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on kett, mille moodustab vanema liidese nimi, punktmärk “.” ja vlan-võrguliidese number. |
staatus | nöör | Väärtused võivad olla up liides võib vastu võtta pakette, alla liides ei saa pakette vastu võtta. |
Loo VLAN-i 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"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
POST /interfaces/vlan
Looge VLAN-liides NIC-liidesest. 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 olema erinev algseadme 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, mille moodustab vanema liidese nimi, punktmärk “.” ja vlan-võrguliidese number. | tõsi |
Vastuse näide:
{
"description" : "Add a vlan interface",
"params" : {
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : null,
"name" : "eth0.1",
"netmask" : "255.255.255.0"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
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 algseadme 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. |
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",
"force" : "true",
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. 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
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
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
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Võrk - virtuaalsed liidesed
Võrgu liidesed võimaldavad kasutajatel olla samas võrgusegmendis teine võrguliides, kui vanem, nii et virtuaalsed liidesed pärivad võrgukonfiguratsiooni alati oma vanemalt. Erinev parameeter on ip. Virtuaalset liidest saab luua NIC või VLAN abil. Uue virtuaalse liidese loomine ilmub kooloniga „:” tähistatud väljale, mida kasutatakse virtuaalse liidese identifitseerimise 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
GET /interfaces/virtual
Hankige kõik virtuaalsete liideste parameetrid.
Vastuse näide:
{
"description" : "List virtual interfaces",
"interfaces" : [
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
Vastuse parameetrid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis kui vanemliides. |
võrgumask | nöör | Määrake võrgusegment, 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 poolt moodustatud kett, koolon märk „:” ja virtuaalse võrguliidese nimi, tähtnumbrilised tähemärgid on lubatud. |
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. |
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
GET /interfaces/virtual/<name>
Hangi kõik virtuaalse liidese parameetrid. nimi on liidese unikaalne identifikaator.
Vastuse näide:
{
"description" : "Show virtual interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"status" : "down"
}
}
Vastuse parameetrid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis kui vanemliides. |
võrgumask | nöör | Määrake võrgusegment, 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 ahel, mille moodustavad vanemliides, koolon märk „:” ja virtuaalse võrguliidese tähtnumbriline string. |
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. |
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
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 kui vanemliides. | tõsi |
nimi | nöör | Liidese nimi. Seda kasutatakse kordumatu identifikaatorina. See nimi on ahel, mille moodustavad vanemliides, koolon märk „:” ja virtuaalse võrguliidese tähtnumbriline string. | 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 liidesekonfiguratsioon. Lisateabe saamiseks vaadake vastuse näidet.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis kui vanemliides. |
võrgumask | nöör | Määrake võrgusegment, 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 moodustatud 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
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 kui 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
Vastuseks on kõigi taotletud väärtuste värskendaja. 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
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
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
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
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
GET /monitoring/fg
Loetlege FarmGuardians. Loetelus on mallid ja kättesaadavad 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"
},
{
"command" : "check_tcp -p 80 -H HOST",
"cut_conns" : "false",
"description" : "TCP check to the port 80",
"farms" : [
"web_service",
"my_welcome_web"
],
"interval" : 7,
"log" : "true",
"name" : "custom-tcp",
"template" : "false"
},
{
"command" : "check_tcp -p PORT -H HOST",
"cut_conns" : "false",
"description" : "It does a TCP connection to test if the backend is alive",
"farms" : [],
"interval" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
]
}
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 | Väike kirjeldus kontrolli kohta. |
talud | String [] | 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. |
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
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" : 5,
"log" : "false",
"name" : "check_tcp",
"template" : "true"
}
}
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 | Väike kirjeldus kontrolli kohta. |
talud | String [] | 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, siis seda ei muudeta. Mallid on kasulikud uue FarmGuardiani loomiseks või rakendamiseks otse farmides. |
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", "parent":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
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 |
vanem | nöör | Uue FarmGuardiani loomiseks kasutatakse malli "FarmGuardian". Kui seda välja ei saadeta, luuakse uus FarmGuardian tühjaks. |
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"
}
}
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 | Väike kirjeldus kontrolli kohta. |
talud | String [] | 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, siis seda ei muudeta. Mallid on kasulikud uue FarmGuardiani loomiseks või rakendamiseks otse farmides. |
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
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 | Väike kirjeldus kontrolli kohta. | |
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. | |
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. |
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"
}
}
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 | Väike kirjeldus kontrolli kohta. |
talud | String [] | 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. |
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
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
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" : {
"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 | CPU, mida kasutavad riistvaravälised häired. |
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üsteem viimase minuti jooksul. |
Last_5 | Number | Laadige süsteemi keskmiselt viis minutit tagasi. |
Last_15 | Number | Laadige süsteem viiekümne minuti tagant. |
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 mälu mälu. 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
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" : "77.42",
"interface" : "eth6",
"out" : "0.00"
},
{
"in" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
}
]
}
}
Vastuse parameetrid
Vastuseks on võtmega JSON parameetrid mille väärtus on järgmiste võtmetega objekt:
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 | Väljundite koguarv MB. |
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
GET /stats/system/network/interfaces
Hankige iga võrguliidese kokkuvõte.
Vastuse näide:
{
"description" : "Interfaces info",
"params" : {
"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õtmega objekt Nic.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
Nic | Objekt [] | NIC-liidese statistika. |
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
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 mälu mälu. 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
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 fiveteen minutiga. |
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
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 | CPU, mida kasutavad riistvaravälised häired. |
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
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
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"
}
]
}
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 or https. 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. |
Näita põllumajandusstatistikat
Näita põllumajandusstatistikat
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
GET /stats/farms/<farmname>
Näitab praegust talu staatust, nende taustaprogrammi 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",
"service" : "srv1",
"session" : "192.168.0.186"
}
]
}
Reageerimisparameetrid HTTP taludes
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
taustaprogrammid | Objekt [] | Kuva taustaprogrammide teave. |
istungid | Objekt [] | Näita teavet seansside kohta. |
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. |
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" : [
{
"id" : 5,
"session" : "192.168.5.100"
}
]
}
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 |
---|---|---|
id | Number | Taustaprogrammi unikaalne identifikaator, kuhu klient on määratud. |
istung | nöör | Seansi kordumatu tunnus. See on kliendi IP. |
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
Hankige moodulite statistika kokkuvõte. See kõne näitab iga mooduli olekut, konfigureeritud arvu, kasvanduste arvu ja üles.
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
},
"lslb" : {
"critical" : 0,
"down" : 2,
"problem" : 0,
"total" : 4,
"up" : 2
}
}
}
Vastuse parameetrid
Vastuseks on JSON, millel on kolm võtit: dslb 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 talude arv. Talumajapidamised peatavad süsteemiadministraator. |
probleem | Number | Probleemse seisundiga põllumajandusettevõtete arv. Talu on probleemiks, kui see on üles ehitatud ja peaaegu tagaplaan on allapoole. |
summaarne | Number | Kokku põllumajandusettevõtete arv. |
up | Number | Käimasolevate põllumajandusettevõtete arv. Siin kuvatakse hooldatud 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>
Näita konkreetse mooduli põllumajandusettevõtete statistikat.
. \ T moodul parameeter on: lllb 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, põllumajandusettevõtete kordumatu tunnus. |
kuni | Number | Ootel olevate ühenduste arv. |
profiil | nöör | Põllumajandusettevõtte tüüp. Võimalikud väärtused on: andmelink, l4xnat, http or https. Iga profiil on defineeritud 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 avastada probleeme CPU kasutuse parameetrite, vahetusmälu, mälu mälu, kõigi konfigureeritud neworki liideste, koormuse ja kõvaketta salvestamise kaudu.
Samuti saate juurdepääsu iganädalasele, koole ja aastale.
Informatsiooniga graafikud vastatakse base64 formaadis.
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",
"nwl4farm",
"httpweb"
],
"interfaces" : [
"eth0.1",
"eth2",
"eth1",
"eth3",
"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 [] | Põllumajandusettevõtete graafikute nimekiri. |
liidesed | String [] | Liideste loend, kus graafikud on saadaval. |
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üsteemiga seotud massiiviloendit ja järgmise formaadiga ketasobjekti.
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 | Graafiku genereerimiseks kasutatud ajavahemik. Võimalikud väärtused on: iga päev, iga nädal, igakuine or aastas. |
graafikud | nöör | Graafik 64-vormingus. |
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 | Graafiku genereerimiseks kasutatud ajavahemik. 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 64-vormingus. |
süsteem
Süsteemi valikud pakuvad sulle võimalust kohandada tasakaalustaja ja globaalsete parameetrite teenuseid.
Näita versiooni
Näita versiooni
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/version
GET /system/version
Näita teavet toote versiooni kohta.
Vastuse näide:
{
"description" : "Get version",
"params" : {
"appliance_version" : "ZVA 4100, hypervisor: xen",
"hostname" : "DEV5",
"kernel_version" : "3.16.7-ckt20",
"system_date" : "Thu Feb 2 10:34:27 2017",
"zevenet_version" : "5.0"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
device_version | nöör | Rakenduse versioon. Näita ka hüperviisi, kui see on virtuaalne masin. |
hostname | nöör | Hosti nimi. |
kernel_version | nöör | Linuxi tuuma versioon. |
system_date | nöör | Süsteemi kuupäev. |
zevenet_version | nöör | Zevenet versioon. |
Kuva DNS
Kuva DNS
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/dns
GET /system/dns
Näita DNS-teenuse konfiguratsiooni.
Vastuse näide:
{
"description" : "Get dns",
"params" : {
"primary" : "8.8.8.8",
"secondary" : null
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
esmane | nöör | Süsteemis konfigureeritud esmane DNS. |
kesk- | nöör | Süsteemis konfigureeritud sekundaarne DNS. |
Muuda DNS-i
Muuda DNS-i
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/dns
POST /system/dns
Muuda DNS-teenuse konfiguratsiooni.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
esmane | nöör | Süsteemis konfigureeritud esmane DNS. |
kesk- | nöör | Süsteemis konfigureeritud sekundaarne DNS. |
Vastuse näide:
{
"description" : "Post dns",
"params" : {
"primary" : "8.8.4.4",
"secondary" : "8.8.8.8"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Näita SNMP-d
Näita SNMP-d
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/snmp
GET /system/snmp
Näita SNMP teenuse konfiguratsiooni.
Vastuse näide:
{
"description" : "Get snmp",
"params" : {
"community" : "public",
"ip" : "*",
"port" : "161",
"scope" : "0.0.0.0/0",
"status" : "false"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
kogukond | nöör | Kogukonna nimi. Kasutatakse ainult lugemisega ühendust. |
ip | nöör | Liides IP, kus SNMP teenus töötab. Kõiki liideseid on võimalik turvaliselt kasutada märk *. |
port | nöör | Port, kus SNMP teenus töötab. |
ulatus | nöör | IP või alamvõrk, millel on juurdepääs (IP / bit). Lubatud kliendi IP-dele juurdepääs SNMPD-teenusele, kui soovite lubada juurdepääsu ainult ühele IP-le, kasutage bitti “/ 32”. |
staatus | nöör | SNMP teenuse olek. Võimalikud väärtused on: tõsi, teenus töötab; või vale, teenus peatatakse. |
Muuda SNMP-d
Muuda SNMP-d
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/snmp
POST /system/snmp
Muuda SNMP teenuse konfiguratsiooni.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
kogukond | nöör | Kogukonna nimi. Kasutatakse ainult lugemisega ühendust. |
ip | nöör | Liides IP, kus SNMP teenus töötab. Kõiki liideseid on võimalik turvaliselt kasutada märk *. |
port | nöör | Port, kus SNMP teenus töötab. |
ulatus | nöör | IP või alamvõrk, millel on juurdepääs (IP / bit). Lubatud kliendi IP-dele juurdepääs SNMPD-teenusele, kui soovite lubada juurdepääsu ainult ühele IP-le, kasutage bitti “/ 32”. |
staatus | nöör | SNMP teenuse olek. Võimalikud väärtused on: tõsi, teenus töötab; või vale, teenus peatatakse. |
Vastuse näide:
{
"description" : "Post snmp",
"params" : {
"community" : "public",
"ip" : "192.168.100.241",
"port" : "170",
"scope" : "0.0.0.0/0",
"status" : "true"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Loa litsents
Loa litsents
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/license/txt
GET /system/license/<format>
Näita Zevenet-litsentsi vormingus. Kättesaadav formaat väärtused html or txt.
Näita NTP-d
Näita NTP-d
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/ntp
GET /system/ntp
Näita NTP-teenuse konfiguratsiooni.
Vastuse näide:
{
"description" : "Get ntp",
"params" : {
"server" : "pool.ntp.org"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on allpool toodud parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
server | nöör | Server, kus NTP klient taotleb. |
Muuda NTP-d
Muuda NTP-d
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"server":"pool.ntp.org"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/ntp
POST /system/ntp
Muuda NTP-teenuse konfiguratsiooni.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
server | nöör | Server, kus NTP klient taotleb. |
Vastuse näide:
{
"description" : "Post ntp",
"params" : "pool.ntp.org"
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Laadige tugi alla
Laadige tugi alla
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/supportsave > supportsave.tar.gz
GET /system/supportsave
Hankige süsteemi oleku kujutis koos kogu süsteemi konfiguratsiooniga ja protsessiga. See toetab seda, et on vaja leida probleeme või toetada abi.
Too praegune kasutaja
Too praegune kasutaja
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/users
GET /system/users
Näita teavet praeguse kasutaja kohta. Praegune kasutaja on kasutajalt ZAPI_KEY või kasutaja, kes on veebi sisse loginud
Vastuse näide:
{
"description" : "Retrieve the user root",
"params" : {
"user" : "root",
"zapi_permissions" : "true"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on järgmised parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
kasutaja | nöör | See on kasutaja kasutaja ZAPI_KEY. See võib olla vaikimisi vaikekasutaja. |
zapi_permissions | nöör | Kui väärtus on tõsi, saab kasutaja Zevenet api-d kasutada kasutaja zapikey abil; või kui väärtus on vale, on kasutaja keelanud zapi kasutamise. |
Muuda praegust kasutajat
Muuda praegust kasutajat
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"password":"CDe0c3ck","newpassword":"v2mfcvv2","zapi_permissions":"false","zapikey":"vCeH60mQFf2MgH5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/users
POST /system/users
Muuda praeguse kasutaja konfiguratsiooni. Praegune kasutaja on kasutajalt ZAPI_KEY või kasutaja, kes on veebi sisse loginud.
Taotlege parameetreid:
Väli | KASUTUSALA | Kirjeldus | Nõutud |
---|---|---|---|
zapikey | nöör | Igal kasutajal võib olla zapikey. Selle zapikey abil saab kasutaja toimida zapikey kaudu, kasutades kasutaja rolli õigusi. | |
zapi_permissions | nöör | Võimalikud väärtused on: tõsi, et võimaldada juurdepääsu zapi kaudu koormuse tasakaalustajale; või vale, et lubada juurdepääsu zapi kaudu. | |
uus salasõna | nöör | Uus kasutaja parool, et pääseda veebi kaudu. | |
parool | nöör | Praegune kasutaja parool. | See on vajalik siis, kui uus salasõna on saadetud. |
Vastuse näide:
{
"description" : "Modify the user Shadi",
"message" : "Settings was changed successful."
}
Loendige logifailid
Loendige logifailid
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs
GET /system/logs
Loetlege olemasolevad logifailid.
Vastuse näide:
{
"description" : "Get logs",
"params" : [
{
"date" : "Mon Jan 30 06:25:02 2017",
"file" : "syslog.4.gz"
},
{
"date" : "Tue Jan 31 06:25:03 2017",
"file" : "syslog.3.gz"
},
{
"date" : "Wed Feb 1 06:25:04 2017",
"file" : "syslog.2.gz"
},
{
"date" : "Thu Feb 2 06:25:03 2017",
"file" : "syslog.1"
},
{
"date" : "Sun Jan 29 06:25:03 2017",
"file" : "syslog.5.gz"
},
{
"date" : "Fri Feb 3 04:28:56 2017",
"file" : "syslog"
}
]
}
Vastuse parameetrid
Vastuseks on JSON koos logifaili hulgaga. Iga objekti parameetrid on:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
andmed | nöör | Viimase faili muutmise kuupäev. |
fail | nöör | Logifailide nimi. Seda kasutatakse logi kordumatu identifikaatorina. |
Näita logifailide ridu
Näita logifailide ridu
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs/kern.log/lines/2
GET /system/logs/<file>/lines/<lines>
Loetlege mitu logifaili rida. URI param fail on logifail lugemisest. Liinid on finaali näitavate ridade arv.
Vastuse näide:
{
"description" : "Show a log file",
"log" : [
"Aug 28 09:44:00 maq2 kernel: [258451.740173] Netfilter messages via NETLINK v0.30.\n",
"Aug 28 09:44:00 maq2 kernel: [258451.775666] ctnetlink v0.93: registering with nfnetlink.\n"
]
}
Vastuse parameetrid
Vastuseks on JSON koos logifaili hulgaga. Võti on log ja selle väärtus on massiiv koos taotletud ridade arvuga.
Laadige alla logifail
Laadige alla logifailid
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
Laadige alla logifail saadavalolevate logifailide kohta, mis on loetletud GET-taotluse ajal.
fail on logifaili unikaalne identifikaator.
Süsteem - varukoopiad
Varundamise suvandi abil saate salvestada praeguse süsteemi konfiguratsiooni ja selle alla laadida.
Selles jaotises saate luua, taastada, üles laadida ja alla laadida varukoopiaid.
Loendage varukoopiad
Loendage varukoopiad
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup
GET /system/backup
Vastuse näide:
{
"description" : "Get backups",
"params" : [
{
"date" : "Fri Feb 3 06:01:04 2017",
"name" : "newbackup"
},
{
"date" : "Fri Feb 3 05:50:48 2017",
"name" : "firstConf"
}
]
}
Vastuse parameetrid
Vastuseks on JSON koos hulga varukoopiatega. Iga massiivi elemendi parameetrid on:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
andmed | nöör | Viimase muudatuse kuupäev. |
nimi | nöör | See on unikaalse identifikaatorina kasutatav failinimi. Faili laiend on .tar.gz . |
Loo varukoopia
Loo varukoopia
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"firstConf"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup
POST /system/backup
Looge praeguse konfiguratsiooni süsteemi konfiguratsiooni varukoopia.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
nimi | nöör | See on unikaalse identifikaatorina kasutatav failinimi. Faili laiend on .tar.gz . |
Vastuse näide:
{
"description" : "Create a backups",
"message" : "Backup firstConf was created successful.",
"params" : "firstConf"
}
Laadige alla varukoopia
Laadige alla varukoopia
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz
Varufail on TAR GZ formaadis.
GET /system/backup/<name>
Laadige alla süsteemi konfiguratsiooni varukoopia. nimi on varukoopia kordumatu tunnus.
Laadige varukoopia üles
Laadige varukoopia üles
Päringu näide:
curl -k -X PUT -H 'Content-Type: text/plain'
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/newbackup
PUT /system/backup/<name>
Laadige kohalikule salvestatud varukoopia Zevenetile. nimi on varukoopia kordumatu tunnus, mis salvestatakse Zevenetisse.
Taotlege parameetreid
Varukoopia üleslaadimiseks on vaja kasutada –data-binary.
Vastuse näide:
{
"description" : "Upload a backup",
"message" : "Backup newbackup was created successful.",
"params" : "newbackup"
}
Kustuta varukoopia
Kustuta varukoopia
Päringu näide:
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf
DELETE /system/backup/<name>
Kustutage varundifail Zevenetist. nimi on varukoopia kordumatu tunnus.
Vastuse näide:
{
"description" : "Delete backup firstConf'",
"message" : "The list firstConf has been deleted successful.",
"success" : "true"
}
Rakenda varukoopia
Rakenda varukoopia
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"apply"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/system/backup/firstConf/actions
POST /system/backup/<name>/actions
Taastage konfigureerimine varukoopiafailist. nimi on varukoopia kordumatu tunnus.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
tegevus | nöör | Varukonfiguratsiooni taastamiseks peab väärtus olema kohaldada. |
Vastuse näide:
{
"description" : "Apply a backup to the system",
"params" : {
"action" : "apply"
}
}