Zevenet Community Edition API v3.1
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 / v3.1 / 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 nõutavat parameetrit.
Sertifikaadid
Zevenet toetab PEM-vormingus cetificates, et neid HTTPS-kuulajaga HTTP-taludes kasutada. 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/v3.1/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/v3.1/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/v3.1/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/v3.1/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 | Teie serveri täielikult kvalifitseeritud domeeninimi. | tõsi |
jaotus | nöör | Sertifikaadiga tegelev organisatsiooni jaotus. | tõsi |
organisatsioon | nöör | Teie organisatsiooni juriidiline nimi. | tõsi |
asukoht | nöör | Linn, kus asub teie organisatsioon. | tõsi |
riik | nöör | Riik / piirkond, kus teie organisatsioon asub. | tõsi |
riik | nöör | Selle riigi kahekohaline ISO kood, kus teie organisatsioon asub. | tõsi |
post | nöör | E-posti aadress, mida kasutatakse teie organisatsiooni poole pöördumiseks. | tõsi |
Vastuse näide:
{
"description" : "Create CSR",
"message" : "Certificate NewCSR created",
"success" : "true"
}
Laadige sertifikaat üles
Laadige sertifikaat üles
Päringu näide:
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v3.1/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/v3.1/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. |
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/v3.1/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/v3.1/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/v3.1/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 kihi 7 koormuse tasakaalustamine (või rakenduse kohaletoimetamise kontroller), millel on proxy-spetsiifilised omadused. See profiil pakub mõningaid funktsioone, nagu HTTPSi kihi 7 koormuse tasakaalustamine. See profiil on mõeldud veebiteenustele (kaasa arvatud veebirakendusserverid) ja kõikidele rakenduste protokollidele, mis põhinevad HTTP ja HTTPS protokollidel, nagu WebDav, RDP üle HTTP, ICA HTTP kaudu jne. Selleks, et konfigureerida seda põllumajandusprofiili, virtuaalne IP-aadress ja virtuaalne TCP-port on vajalik.
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/v3.1/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
}
],
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"httpverb" : "MSRPCext",
"listener" : "https",
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "tcp_check",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
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: standardHTTP, vastuvõetamatud 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. |
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. |
fgenabled | nöör | Luba talupidaja kasutamine. tõsi talu eestkostja on lubatud ja kontrollib taustaprogrammi staatust, vale talu eestkostja on keelatud ja ei kontrolli taustaprogrammi staatust. HTTP-profiilides teostatakse check_tcp vaikimisi, isegi kui talude eestkostja on keelatud. |
liiv | nöör | Luba logide kasutamine talude eestkostjana. tõsi lubatud, vale, keelatud. fgenabled on nõutud. |
fgscript | nöör | Juht, mida talu eestkostja kasutab tagaplaanide tervise kontrollimiseks. tõsi lubatud, vale, keelatud. fgenabled on nõutud. |
fgtimecheck | Number | talu eestkostja kontrollib iga sekundit, kui sekundiline on taustaprogrammi tervislik seisund. fgenabled on nõutud. |
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. |
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/v3.1/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,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP
PUT /farms/<farmname>
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: standardHTTP, vastuvõetamatud 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/v3.1/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"
}
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.
Teeninduseobjekti sees on kahte liiki väärtusi: teenindusega seotud ja talupoegadega seotud väärtused.
Farmguardianit kasutatakse tagaplaanide täiustatud jälgimise oleku jaoks ja täielikult isikupärastatud praeguse teenuse jaoks mõeldud skriptide jaoks. Kui farmguardian tuvastab probleemi, lülitab ta reaalse serveri automaatselt välja ja märgistatakse musta nimekirja.
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/v3.1/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
},
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "check_tcp -H HOST -p PORT",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : ""
}
}
Vastuse parameetrid
Vastus on JSON-objekt, mille formaat on allpool.
HTTP objektide teenuste objekt:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
taustaprogrammid | Objekt [] | Teenuses määratletud taustaprogrammid. |
fgenabled | nöör | Luba talupidaja kasutamine. tõsi talu eestkostja on lubatud ja kontrollib taustaprogrammi staatust, vale talu eestkostja on keelatud ja ei kontrolli taustaprogrammi staatust. HTTP-profiilides teostatakse check_tcp vaikimisi, isegi kui talude eestkostja on keelatud. |
liiv | nöör | Luba logide kasutamine talude eestkostjana. tõsi lubatud, vale, keelatud. fgenabled on nõutud. |
fgscript | nöör | Juht, mida talu eestkostja kasutab tagaplaanide tervise kontrollimiseks. tõsi lubatud, vale, keelatud. fgenabled on nõutud. |
fgtimecheck | Number | talu eestkostja kontrollib iga sekundit, kui sekundiline on taustaprogrammi tervislik seisund. fgenabled on nõutud. |
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. |
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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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. |
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" : [],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirecttype" : "default",
"sessionid" : "sid",
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com"
},
"status" : "needed restart"
}
Vastusparameetrid
Vastuseks on nõutud parameetrite värskendaja ja staatus valdkonnas vaja uuesti taaskäivitada väärtus. Muutuste rakendamiseks tuleb võtta uuesti toiming.
Muuda talu eestkostjat
Muuda talu eestkostjat
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"check_tcp","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/fg
Farmguardianit kasutatakse tagaplaanide täiustatud jälgimise oleku jaoks ja täielikult isikupärastatud praeguse teenuse jaoks mõeldud skriptide jaoks. Kui farmguardian tuvastab probleemi, lülitab ta reaalse serveri automaatselt välja ja märgistatakse musta nimekirja.
PUT /farms/<farmname>/fg
Muuda põllumajandusettevõtte eestkostja parameetreid antud HTTP-profiilis.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus | Nõutud |
---|---|---|---|
fgtimecheck | Number | Farmi hooldaja kontrollib taustaprogrammi terviseseisundit iga „timetocheck” sekundi järel. | |
fgscript | nöör | Juht, mida talu eestkostja täidab tervisliku seisundi kontrollimiseks | |
fgenabled | nöör | See võimaldab näidatud teenuses talupidajat. tõsi talupoegade eestkostjat kasutatakse tagaplaanide staatuse kontrollimiseks, vale talu eestkostja keelatakse | |
liiv | nöör | Luba logide kasutamine talude eestkostjana. tõsi talu eestkostja logib kõik toimingud, vale talu eestkostja ei kavatse ühtegi tegevust sisse logida, on soovitatav lubada liiv ainult tõrkeotsinguks. | |
teenus | nöör | Unikaalse identifikaatorina kasutatav teenuse nimi. | tõsi |
Vastuse näide:
{
"description" : "Modify farm FarmHTTP",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "checktcp",
"fgtimecheck" : 5,
"service" : "service1"
}
}
Teenuse kustutamine
Teenuse kustutamine
Päringu näide:
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/service1
DELETE /farms/<farmname>/services/<id>
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://<zenlb_server>:444/zapi/v3.1/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
},
{
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2
}
]
}
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. |
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. |
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://<zenlb_server>:444/zapi/v3.1/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. |
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
},
"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://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/service/<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. |
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
},
"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://<zenlb_server>:444/zapi/v3.1/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. | tõsi |
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://<zenlb_server>:444/zapi/v3.1/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 L4 talu ja palju rohkem samaaegseid ühendusi kui koormuse tasakaalustussüdamikud kihis 7, nagu HTTP talu profiilid. See kiht 4 jõudluse parandamine on vastuolus täiustatud sisuhaldusega, mida kiht 7 profiilid suudavad hallata.
Lisaks võisid L4xNATi talud siduda mitmete portidega, mitte ainult ühe virtuaalse pordiga, mida kasutatakse koos teiste 7i kihtide profiilidega. Selleks, et L4xNATi taludes saaks valida virtuaalsete pordide või konkreetse virtuaalse pordi, on kohustuslik valida protokolli tüüp. Muul juhul kuulab põllumajandusettevõte virtuaalsest IP-st (tähistatud tähemärgiga) kõigis sadamates.'). Kui TCP või UDP protokoll on valitud, on võimalik määrata port, mitu pordi ',', 'sadamate vahel': 'või kõigi portide vahel'". Kõigi nende kombinatsioon kehtib ka.
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/v3.1/zapi.cgi/farms/l4farm
GET /farms/<farmname>
Näita kõiki antud talu konfiguratsioone.
Vastus BODY:
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.55.40",
"max_conns" : 0,
"port" : "88",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.55.41",
"max_conns" : 0,
"port" : "88",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"params" : {
"algorithm" : "weight",
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"listener" : "l4xnat",
"nattype" : "nat",
"persistence" : "",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88"
}
}
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: kõige vähem ühendust alati kõige vähem ühendusserveriga, kaal ühendus lineaarselt, massi järgi, prio ühendused alati kõige kättesaadavamale tasemele. |
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. |
püsivus | nöör | Sama IP-aadress ühendatakse sama serveriga. Valikud on järgmised: "" tühi väärtus, püsivus on keelatud, ip püsivus on sisse lülitatud, kasutatakse päritolu IP-d nagu unikaalset ID-d istungil. |
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 ainult koormuse tasakaalustaja tasakaalustab 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. |
staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on üles ja kõik taustaprogrammid on kättesaamatud või hooldus; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; hooldus, talu on üles ja seal on tagapõhi, kuid peaaegu tagaplaan on hooldusrežiimis; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
ttl | Number | See välja väärtus näitab sekundite arvu, millal kliendi allika ja taustaprogrammi vahel on püsivus. Püsivus peab olema konfigureeritud. |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. Unikaalset porti saab täpsustada, vahemiku porti saab määrata eraldajaga : ja mitu porti saab määrata eraldajaga ,. |
fgenabled | nöör | Võimaldab kasutada talude eestkostjat. tõsi talu eestkostja on lubatud, vale talu eestkostja on keelatud. |
liiv | nöör | Võimaldab logide kasutamist talude eestkostjana. fgenabled peab olema lubatud. |
fgscript | nöör | Käsk, mida talu eestkostja kontrollib. Need võimalikud käsud on libexeci teekonnal. fgenabled peab olema lubatud. |
fgtimecheck | Number | Talu hooldaja kontrollib iga sekundit. fgenabled peab olema lubatud. |
L4xNATi talude taustaprogramm:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
id | Number | ID, et identifitseerida talu taustaprogramm. |
ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
max_conns | Number | See on taustaprogrammi samaaegse ühenduse maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. |
port | Number | Backendi sadam, kus tegelik teenus kuulab. Tühi väärtus on aktsepteeritud ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 1 on kõige tähtsam. |
kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. |
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/v3.1/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","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarml4
PUT /farms/<farmname>
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: kõige vähem ühendust alati kõige vähem ühendusserveriga, kaal ühendus lineaarselt, massi järgi, prio ühendused alati kõige kättesaadavamale tasemele. |
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. |
püsivus | nöör | Sama IP-aadress ühendatakse sama serveriga. Valikud on järgmised: "" tühi väärtus, püsivus on keelatud, ip püsivus on sisse lülitatud, kasutatakse päritolu IP-d nagu unikaalset ID-d istungil. |
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 ainult koormuse tasakaalustaja tasakaalustab 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. |
ttl | Number | See välja väärtus näitab sekundite arvu, millal kliendi allika ja taustaprogrammi vahel on püsivus. Püsivus peab olema konfigureeritud. |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
vport | nöör | Põllumajandusettevõtte sadam, kus virtuaalne teenus kuulab. 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",
"persistence" : "",
"protocol" : "tcp",
"ttl" : 125,
"vip" : "178.62.126.152",
"vport" : "81"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muuda talu eestkostjat
Muuda talu eestkostjat
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"Command of Farm Guardian","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/fg
Farmguardianit kasutatakse tagaplaanide täiustatud jälgimise oleku jaoks ja täielikult isikupärastatud praeguse teenuse jaoks mõeldud skriptide jaoks. Kui farmguardian tuvastab probleemi, lülitab ta reaalse serveri automaatselt välja ja märgistatakse musta nimekirja.
PUT /farms/<farmname>/fg
Muutke talu eestkostja parameetreid teenuses L4xNAT.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
fgenabled | nöör | Võimaldab kasutada talude eestkostjat. tõsi talu eestkostja on lubatud, vale talu eestkostja on keelatud. |
liiv | nöör | Võimaldab logide kasutamist talude eestkostjana. fgenabled peab olema lubatud. |
fgscript | nöör | Käsk, mida talu eestkostja kontrollib. Need võimalikud käsud on libexeci teekonnal. fgenabled peab olema lubatud. |
fgtimecheck | Number | Talu hooldaja kontrollib iga sekundit. fgenabled peab olema lubatud. |
Vastuse näide:
{
"description" : "Modify farm guardian",
"message" : "Success, some parameters have been changed in farm guardian in farm l4farm.",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "check_tcp",
"fgtimecheck" : 5
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
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://<zenlb_server>:444/zapi/v3.1/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",
"max_conns" : 400,
"port" : 787,
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.5.1.3",
"max_conns" : 200,
"port" : 787,
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
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. |
port | Number | Backendi sadam, kus tegelik teenus kuulab. Tühi väärtus on aktsepteeritud ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; hooldus, taustaprogramm on märgitud kui administraator pole ühenduste vastuvõtmiseks valmis, see valik on kasulik taustaprogrammi hooldustoimingute jaoks; defineerimata, pole taustaprogrammi olekut kontrollitud. |
max_conns | Number | See on taustaprogrammi samaaegse ühenduse maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 1 on kõige tähtsam. |
kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. |
Loo uus taust
Loo uus taust
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}'
https://<zenlb_server>:444/zapi/v3.1/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 |
port | Number | Backendi sadam, kus tegelik teenus kuulab. Tühi väärtus on aktsepteeritud ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). | |
max_conns | Number | See on taustaprogrammi samaaegse ühenduse maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. | |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 1 on kõige tähtsam. Vaikeväärtus on 1. | |
kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. Vaikeväärtus on 1. |
Vastuse näide:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"port" : 8080,
"max_conns" : 400,
"priority" : null,
"weight" : null
}
}
Vastuse parameetrid
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","port":8080,"max_conns":220,"priority":4,"weight":7}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/2
PUT /farms/<farmname>/backends/<id>
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. |
port | Number | Backendi sadam, kus tegelik teenus kuulab. Tühi väärtus on aktsepteeritud ja see kasutab sama konfiguratsiooni kui virtuaalne port (id). |
max_conns | Number | See on taustaprogrammi samaaegse ühenduse maksimaalne arv. Kui selle välja väärtus on 0, pole taustaprogramm seadistanud ühtegi ühenduse piirangut. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Ühendused on alati kõige enam kättesaadavad, kui 1 on kõige tähtsam. |
kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Suurema kaaluga taustaprogrammid saavad rohkem ühendusi. |
Vastuse näide:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"port" : 8080,
"max_conns" : 220,
"priority" : 4,
"weight" : 7
}
}
Vastuse parameetrid
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://<zenlb_server>:444/zapi/v3.1/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 | 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. | tõsi |
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 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://<zenlb_server>:444/zapi/v3.1/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"
}
Datalink Farms
Datalinki põllumajandusprofiil võimaldab luua marsruutidel põhineva põllumajandusettevõtte, kus taustaprogrammid on üleslingi marsruuterid või väravad. Selline põllumajandusprofiil on valmis jagama mitu üleslingi WAN-ruuteri ligipääsu, kasutades koormuse tasakaalustajat üleslingi kanali multipleksorina (1-i sisend ja mitu ruuteri-väljundit). Seetõttu võiksid datalinkide talumajapidamisi kasutada kõrgete kättesaadavate sideühendustena ja lisaks võiks neid kasutada ribalaiuse suurendamiseks, mis ühendab marsruuterite vahelise ribalaiuse.
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/v3.1/zapi.cgi/farms/dlink
GET /farms/<farmname>
Kuva kõik talu konfiguratsioonid.
Vastuse näide:
{
"backends" : [
{
"id" : 0,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"id" : 1,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
],
"description" : "List farm dlink",
"params" : {
"algorithm" : "weight",
"status" : "down",
"vip" : "192.168.100.199"
}
}
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 [] | Selles talus loodud reaalsed serverid ja selle konfiguratsioon. |
Parameetrite objekt datalinkide taludele:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal, jagab tasakaalustaja kõigi olemasolevate taustaprogrammide vahel, mis annavad rohkem tasu tagaplaanile suurema kaaluga prio, mis saadab kõik ühendused taustaprogrammiga väikese väärtusega prioriteet. |
staatus | nöör | Talu staatus. Olemasolevad oleku väärtused on järgmised: alla, talu ei tööta; vaja uuesti taaskäivitada, talu on üles, kuid see ootab taaskäivitamist; kriitiline, talu on ülespoole ja kõik taustaprogrammid on kättesaamatud; probleem, talu on ülespoole ja seal on mõni tagaplaanil kättesaamatu, kuid peaaegu tagaplaanil on staatus; up, talu on üles kasvanud ja kõik tagapõhjad on edukad. |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
Datalinkide talumajapidamiste taustaprogramm:
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
id | Number | Põllumajandusettevõtte taustaprogrammi unikaalne identifikaator. |
ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon, kuna eel- ja madalama prioriteediga eelistatakse |
staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
kaal | Number | See on praeguse reaalse serveri kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon kui kaal. |
Loo uus talu
Loo uus talu
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms
POST /farms
Looge uus datalinkimaja.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus | Nõutud |
---|---|---|---|
farmname | nöör | Põllumajandusettevõtte nimi, kordumatu tunnus. | tõsi |
profiil | nöör | Loodud talu profiil. Datalinkide puhul on andmelink | tõsi |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. | tõsi |
Vastuse näide:
{
"description" : "Creating farm 'dlink'",
"params" : {
"farmname" : "dlink",
"interface" : "eth0",
"profile" : "datalink",
"vip" : "192.168.100.241"
}
}
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 '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink
PUT /farms/<farmname>
Muuda datalinkide ettevõtte konfiguratsiooni.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
newfarmname | nöör | Uus talu nimi. Talu tuleb peatada. |
algoritm | nöör | Talus kasutatud koormuse tasakaalustamise algoritmi tüüp. Valikud on järgmised: kaal, jagab tasakaalustaja kõigi olemasolevate taustaprogrammide vahel, mis annavad rohkem tasu tagaplaanile suurema kaaluga prio, mis saadab kõik ühendused taustaprogrammiga väikese väärtusega prioriteet. |
vip | nöör | Fondi IP, kus virtuaalne teenus kuulab. |
Vastuse näide:
{
"description" : "Modify farm dlink",
"params" : {
"algorithm" : "weight",
"vip" : "192.168.100.199",
"newfarmname" : "dlink2"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Datalink - taustaprogrammid
Datalinkide talumajapidamised on teenuse marsruutimise kaudu väravad. Teenus mitmekordistub nende väravate vahel ja mõned neist ei ole kättesaadavad, teenus kasutab teist.
Loetlege taustaprogrammid
Loetlege taustaprogrammid
Päringu näide:
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends
GET /farms/<farmname>/backends
Hankige teenuse taustaprogrammide loend.
Vastuse näide:
[
{
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"id" : 7,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
]
Vastusparameetrid
See kõne tagastab backend-objekti massiivi parameetrite abil.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
id | Number | Põllumajandusettevõtte taustaprogrammi unikaalne identifikaator. See identifikaator genereeritakse süsteemi poolt. |
liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. |
prioriteet | Number | See on praeguse taustaprogrammi prioriteetne väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon, kuna eel- ja madalama prioriteediga eelistatakse. |
staatus | nöör | Taustase staatus. Võimalikud väärtused on: up, talu töötab ja taustaprogramm on valmis ühenduste vastuvõtmiseks; alla, talu töötab ja teenus on avastanud, et taustaprogramm ei tööta; defineerimata, pole taustaprogrammi olekut kontrollitud. |
kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon kui kaal. |
Loo uus taust
Loo uus taust
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends
POST /farms/<farmname>/backends
Looge antud taustaprogrammile uus taustaprogramm.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus | Nõutud |
---|---|---|---|
ip | nöör | Taustaprogrammi IP, kus tegelik teenus kuulab. | tõsi |
liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. | tõsi |
prioriteet | Number | See on praeguse reaalse serveri prioriteetne väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon, kuna eel- ja madalama prioriteediga eelistatakse. Vaikeväärtus on 1. | |
kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. Seda kasutatakse siis, kui algoritm väli on konfiguratsioon kui kaal. Vaikeväärtus on 1. |
Vastuse näide:
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muuda taustaprogrammi
Muuda taustaprogrammi
Päringu näide:
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"timeout":1}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/datalink/backends/2
PUT /farms/<farmname>/backends/<id>
Muuda taustaprogrammi parameetreid datalinki talu teenuses. id on taustaprogrammi unikaalne identifikaator.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
nöör | ip | Taustaprogrammi IP, kus tegelik teenus kuulab. |
liides | nöör | See on kohalik võrguliides, kus taustaprogramm on ühendatud. |
timeout | Number | Teatud päringu vastuvõtmiseks on taustaprogrammi aeg. |
kaal | Number | See on praeguse taustaprogrammi kaalu väärtus. |
Vastuse näide:
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"interface" : "eth0",
"ip" : "192.168.102.50",
"timeout" : 1,
"weight" : 1
}
}
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://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends/4
DELETE /farms/<farmname>/backends/<id>
Kustutage antud taustaprogramm datalinki talu teenuses. 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://<zenlb_server>:444/zapi/v3.1/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 | See väli näitab, kas see liides on VLAN-liidese vanem. 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/v3.1/zapi.cgi/interfaces/gateway
GET /interfaces/gateway
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.
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://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces
PUT /interfaces/gateway
Muuda lüüsi liidese konfiguratsiooni.
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
Kustuta vaikelüüsi konfiguratsiooni konfiguratsioon.
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://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/gateway
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://<zenlb_server>:444/zapi/v3.1/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 | See väli näitab, kas see liides on VLAN-liidese vanem. See väli on ainult NIC-liideste jaoks. |
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://<zenlb_server>:444/zapi/v3.1/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. |
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://<zenlb_server>:444/zapi/v3.1/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. |
Vastuse näide:
{
"description" : "Configure nic interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"netmask" : "255.255.255.0"
}
}
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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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. |
Vastuse näide:
{
"description" : "Modify VLAN interface",
"params" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"netmask" : "255.255.255.0"
}
}
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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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. |
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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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 |
---|---|---|
ip | nöör | Liidese IP. IP peab olema samas võrgusegmendis kui vanemliides. |
Vastuse näide:
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10"
}
}
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://<zenlb_server>:444/zapi/v3.1/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://<zenlb_server>:444/zapi/v3.1/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.
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/v3.1/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.1 in in" : 0,
"eth0.1 out out" : 0,
"eth1 in in" : 234.72,
"eth1 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/v3.1/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" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
},
{
"in" : "815.69",
"interface" : "eth0.1",
"out" : "4300.38"
}
]
}
}
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 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/v3.1/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/v3.1/zapi.cgi/stats/farms/httpFarm
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" : null,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats"
}
Vastusparameetrid L4xNAT taludes
Vastuseks on võtmega JSON taustaprogrammid ja väärtustada objekti massiivi allpool toodud parameetritega.
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. |
Vastusparameetrid datalinkide taludes
Datalinki talude statistika ei ole tegelikult kättesaadav.
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/v3.1/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",
"eth1",
"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/v3.1/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/v3.1/zapi.cgi/graphs/interfaces/eth0
Ketta näitamise näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot
GET /graphs/<graph>
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/v3.1/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/v3.1/zapi.cgi/graphs/interfaces/eth0/monthly
Ketta näitamise näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot/yearly
GET /graphs/<graph>/<frequency>
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/v3.1/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 Community Editioni versioon. |
Kuva DNS
Kuva DNS
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/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/v3.1/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/v3.1/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/v3.1/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/v3.1/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/v3.1/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/v3.1/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.
Loetle kõik kasutajad
Loetle kõik kasutajad
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users
GET /system/users
Loetlege süsteemi kasutajad.
Vastuse näide:
{
"description" : "Get users",
"params" : [
{
"status" : "true",
"user" : "root"
},
{
"status" : "true",
"user" : "zapi"
}
]
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on järgmised parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
staatus | nöör | Kasutaja olek. Võimalikud väärtused on: tõsi, kasutaja on aktiveeritud; või mitte vale, kasutaja on desaktiveeritud. |
kasutaja | nöör | Kasutajanimi. |
Zapi kasutaja allalaadimine
Zapi kasutaja allalaadimine
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi
GET /system/users/zapi
Näita zapi kasutaja konfiguratsiooni. Need parameetrid on vajalikud Zevenet'i teenuste kasutamiseks zapi kaudu.
Vastuse näide:
{
"description" : "Zapi user configuration.",
"params" : {
"key" : "root",
"status" : "true"
}
}
Vastuse parameetrid
Vastuseks on JSON-objekt, millel on järgmised parameetrid.
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
võti | nöör | Zapi autentimise võti. See on parameeter ZAPI_KEY kasutatakse zapi kõnede puhul. |
staatus | nöör | Zapi kasutaja staatus. Kui selle väärtus on tõsi, on võimalik kasutada zapi; või mitte vale, zapi on desaktiveeritud ja seda ei ole võimalik saata. |
Muuda zapi kasutaja konfiguratsiooni
Muuda zapi kasutaja konfiguratsiooni
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"key":"newzapikey","status":"enable","newpassword":"password1234"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi
POST /system/users/zapi
Muuda zapi kasutaja konfiguratsiooni. Need parameetrid on vajalikud Zevenet'i teenuste kasutamiseks zapi kaudu.
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus |
---|---|---|
võti | nöör | Zapi autentimise võti. See on parameeter ZAPI_KEY kasutatakse zapi kõnede puhul. |
uus salasõna | nöör | Zapi kasutaja uus parool. |
staatus | nöör | Zapi kasutaja staatus. Võimalikud väärtused on: võimaldama zapi kasutaja või keelata zapi kasutaja keelamiseks. Kui zapi kasutaja on keelatud, ei saa te taotlusi saata. |
Vastuse näide:
{
"description" : "Zapi user settings.",
"message" : "Settings was changed successful.",
"params" : {
"key" : "newzapikey",
"newpassword" : "password1234",
"status" : "enable"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Muuda root parooli
Muuda root parooli
Päringu näide:
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"password":"admin","newpassword":"alwaysisbetterastrongpass"}
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/root
POST /system/users/root
Muuda root parooli. Seda kasutajat kasutatakse juurdepääsuks zevenet-teenustele GUI kaudu
Taotlege parameetreid
Väli | KASUTUSALA | Kirjeldus | Nõutud |
---|---|---|---|
parool | nöör | Praegune juurkasutaja parool. | tõsi |
uus salasõna | nöör | Juurkasutaja uus parool. | tõsi |
Vastuse näide:
{
"description" : "User settings.",
"message" : "Settings was changed succesful.",
"params" : {
"newpassword" : "alwaysisbetterastrongpass",
"password" : "admin"
}
}
Vastuse parameetrid
Vastuseks on kõigi taotletud väärtuste värskendaja. Lisateabe saamiseks vaadake vastuse näidet.
Loendige logifailid
Loendige logifailid
Päringu näide:
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/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/v3.1/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/v3.1/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
Laadige alla logifail, mis sisaldab GET-i taotluse ajal loetletud logifaile.
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/v3.1/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/v3.1/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/v3.1/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/v3.1/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/v3.1/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/v3.1/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"
}
}
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/v3.1/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.