Zevenet Community Edition API v3.1

ZAPI (Zevenet Application Programming Interface) er værktøjet til systemadministrator til at kontrollere Zevenet load balancer adfærd.

Det er nødvendigt at aktivere zapi-brugeren fra web-grænsefladen, før den bruges, System / Brugere.

Når zapi-brugeren er oprettet, er det muligt at sende anmodning til URL'en, https: // (zevenet_server): 444 / zapi / v3.1 / zapi.cgi / (URI_path), hvor zevenet_server er den IP, hvor HTTP-tjenesten lytter.

URI_path definerer objektet eller handlingen. Hans opførsel og hans parametre vil blive defineret inden for hver enkelt dokumentsektion.

De verb som bruges i denne API vil være GET, POST, PUT or SLET. En PUT- eller POST-anmodning har altid brug for næsten en parameter, selvom dette ikke behøver nogen krævet parameter.

Certifikater

Zevenet understøtter cetificates i PEM format til at bruge dem med dine HTTP gårde med HTTPS lytter. Hvis du vil lære mere om, hvordan du opretter pem-certifikater, kan du besøge følgende artikel: GENERERENDE CERTIFIKATER I PEM FORMAT

Angiv alle certifikater

Angiv alle certifikater

Forespørgselseksempel:

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

GET /certificates

Angiv alle CSR- og PEM-certifikater i certifikatbutikken. Disse certifikater kan bruges sammen med HTTPS-bedrifter.

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af dette vil være en række certifikatobjekter, der hver indeholder nøgleattributterne nedenfor.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
params	Objekt []	Liste over certifikatobjekter.

Certifikatobjekt

Field	Type	Beskrivelse
CN	String	Domæne fælles navn.
skabelse	String	Oprettelsesdato.
udløb	String	Udløbsdato.
fil	String	Certifikatets filnavn, unikt id.
udsteder	String	Certified Authority, der underskriver certifikatet.
typen	String	CSR eller certifikat.

Download certifikat

Download certifikat

Forespørgselseksempel:

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>

Download et certifikat, der er installeret i certifikatbutikken, brug filnavnet i anmodningen til at identificere det.

Svaret vil indeholde overskrifterne angivet nedenfor med oplysninger om filen. Svarets krop er indholdet af filen.

Svar overskrifter:

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

Slet et certifikat

Slet et certifikat

Forespørgselseksempel:

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>

Slet et certifikat efter filnavn i certifikatbutikken.

Svar eksempel:

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

Opret et CSR-certifikat

Opret et CSR-certifikat

Forespørgselseksempel:

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

Opret en certifikatsigneringsforespørgsel (CSR-fil).

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
navn	String	Certifikat ID navn.	sand
FQDN	String	Det fuldt kvalificerede domænenavn på din server.	sand
division	String	Opdelingen af din organisation, der håndterer certifikatet.	sand
organisation	String	Det juridiske navn på din organisation.	sand
lokalitet	String	Byen, hvor din organisation er placeret.	sand
tilstand	String	Den stat / region, hvor din organisation er placeret.	sand
land	String	ISO-koden med to bogstaver for det land, hvor din organisation er placeret.	sand
post	String	En e-mail-adresse bruges til at kontakte din organisation.	sand

Svar eksempel:

{
   "description" : "Create CSR",
   "message" : "Certificate NewCSR created",
   "success" : "true"
}

Upload et certifikat

Upload et certifikat

Forespørgselseksempel:

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>

Upload et PEM-certifikat til HTTP-bedrifter med HTTPS-lytteren.

Kræver parameteren --tcp-nodelayog --data-binary at uploade filen i binær tilstand.

Anmod URI-parametre

Field	Type	Beskrivelse	påkrævet
fil	String	Certifikatfilnavn for at uploade og gemme i certifikatbutikken.	sand

Svar eksempel:

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

Liste Cipherer

Liste Cipherer

Forespørgselseksempel:

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

GET /ciphers

Angiv de tilgængelige cifre, som en HTTPS-gård kan bruge.

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af dette vil være en række certifikatobjekter, der hver indeholder nøgleattributterne nedenfor.

Svar eksempel:

{
   "description" : "Get the ciphers available",
   "params" : [
      {
         "ciphers" : "all",
         "description" : "All"
      },
      {
         "ciphers" : "highsecurity",
         "description" : "High security"
      },
      {
         "ciphers" : "customsecurity",
         "description" : "Custom security"
      }
   ]
}

Response parametre

Field	Type	Beskrivelse
params	Objekt []	Liste over certifikatobjekter.

Certifikatobjekt

Field	Type	Beskrivelse
ciphers	String	Den bruges som unik identifikator.
beskrivelse	String	Venligt navn.

Gårde

Zevenet er i stand til at styre trafikken på tre forskellige måder, hver vej styres af et andet modul, Local Service load balancer eller LSLB modul og Datalink Service Load Balancer eller DSLB modul.

Alle moduler arbejder med Farm Profile-konceptet, en Farm Profile er en gruppe af parametre klar til at gøre en særlig handling med netværkstrafik. Det er vigtigt at forstå, hvad der kan gøre hver gårdsprofil for at opnå de bedste resultater fra Zevenet ADC.

LSLB: Dette modul er i stand til at arbejde med http og l4xnat profil gårde. Det fungerer som en web-omvendt proxy eller router
DSLB: Dette modul er i stand til at arbejde med data link profil gård. Det fungerer som en gateway.

Liste over alle gårde

Liste over alle gårde

Forespørgselseksempel:

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

GET /farms

Liste over alle tilgængelige gårde

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af dette vil være en række af genbrugsgenstande, der hver især indeholder nøgleattributterne nedenfor.

Farm Object

Field	Type	Beskrivelse
farmname	String	Farm beskrivende navn. Den bruges som unik identifikator.
profil	String	Profiltype, de tilgængelige profiler er: http, https or l4xnat for LSLB modul og data link til DSLB modul
status	String	Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip	String	Virtual IP hvor gården modtager trafik
VPort	String	Virtuel port, hvor gården modtager trafik, de tilgængelige portværdier er: et portnummer for http [s] og l4xnat, en gruppe af porte adskilt af “,” eller et portområde adskilt af “:” for l4xnat-profiler, i l4xnat begge separator værdier (“,” og “:”) kan bruges i det samme felt.

Svar eksempel:

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

Slet en gård

Slet en gård

Forespørgselseksempel:

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>

Slet en gård gennem sin bedrifts navn identifikator.

Svar eksempel:

{
  "description" : "Delete farm FarmHTTP",
  "message" : "The Farm FarmHTTP has been deleted.",
  "success" : "true"
}

Indstil en handling i en gård

Indstil en handling i en gård

Forespørgselseksempel:

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

Anvend en handling på en gård, se tabellen Forespørgselsparametre for handlinger.

Anmod om parametre

Field	Type	Beskrivelse
Action	String	Indstil den ønskede handling. Handlingerne er: stoppe, bliver gården stoppet. starte, gården bliver startet og genstart, gården stoppes og startes automatisk.

Svar eksempel:

{
  "description" : "Set a new action in FarmHTTP",
  "params" : [
     {
        "action" : "stop"
     }
  ]
}

Response parametre

Hvis der ikke er nogen problemer i konfigurationen, returnerer zapi den ønskede handling.

HTTP Farms

HTTP-profil er et avanceret lag 7-belastningsbalancering (eller Application Delivery Controller) med proxy-specialegenskaber. Denne profil indeholder nogle funktioner som HTTPS layer 7 load balancing. Denne profil er adecuated for webtjenester (inkluderet webapplikationsservere) og alle applikationsprotokoller baseret på HTTP- og HTTPS-protokoller som WebDav, RDP over HTTP, ICA over HTTP osv. For at konfigurere denne gårdsprofil, en virtuel IP-adresse og en Virtual TCP-port vil blive påkrævet.

Hent gården ved navn

Hent gården ved navn

Forespørgselseksempel:

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

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Svar eksempel:

{
   "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" : ""
      },
   ]
}

Response parametre

Svaret vil være et JSON objekt med nedenstående format.

Farm Object:

Field	Type	Beskrivelse
params	Object	Parametre for gårdskonfiguration.
tjenester	Objekt[]	Array med alle tjenester skabt i denne gård og dens konfiguration.

Parametre objekt for HTTP gårde:

Field	Type	Beskrivelse
certlist	Objekt[]	Kun i https profil. Certifikat aktiveret i gården, i pem format, er det tilladt at tilføje kun ét pem certifikat til samme gård. lytter med https værdi er påkrævet. Enhver pem certifikat i certifikatbutikken kan bruges her.
cipherc	String	Kun i https-lytteren. Dette er den tilladte tilpassede liste over cifre, der accepteres af SSL-forbindelsen, hvilket er en streng i samme format som i OpenSSL-cifre. Denne attribut bruges kun når ciphers feltet har værdien sutomsikkerhed.
ciphers	String	Kun i lytter med https værdi. Bruges til at opbygge en liste over cifre accepteret af SSL-forbindelser for at hærde SSL-forbindelsen. Indstillingerne er: alle, alle cifre vil blive accepteret; highsecurity, kun cifre for høj sikkerhed vil blive accepteret; eller customsecurity, kun cifre indlæst i cipherc feltet accepteres.
contimeout	nummer	Hvor længe gården skal vente på en TCP-forbindelse til backend på sekunder.
disable_sslv2	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af SSL-sikkerhedsprotokol med version 2 er ikke tilladt eller falsk hvis protokollen SSLv2 er tilladt.
disable_sslv3	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af SSL-sikkerhedsprotokol med version 3 er ikke tilladt eller falsk hvis protokollen SSLv3 er tilladt.
disable_tlsv1	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1 er ikke tilladt eller falsk hvis protokollen TLSv1 er tilladt.
disable_tlsv1_1	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.1 er ikke tilladt eller falsk hvis protokollen TLSv1.1 er tilladt.
disable_tlsv1_2	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.2 er ikke tilladt eller falsk hvis protokollen TLSv1.2 er tilladt.
error414	String	Personlig besked til reaktion med 414 HTTP fejlkode.
error500	String	Personlig besked til reaktion med 500 HTTP fejlkode.
error501	String	Personlig besked til reaktion med 501 HTTP fejlkode.
error503	String	Personlig besked til reaktion med 503 HTTP fejlkode.
httpverb	String	Dette felt angiver de operationer, der vil blive tilladt for HTTP-klientanmodningerne. tilgængelige værdier er: standardHTTP, accepterede http-forespørgsler GET, POST, HEAD. extendedHTTP, accepteret tidligere http-anmodninger plus PUT, DELETE. standardWebDAV, accepteret tidligere http-anmodninger plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SØG, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV accepteret tidligere http-anmodninger plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, eller MSRPCext, accepteret tidligere http-anmodninger plus RPC_IN_DATA, RPC_OUT_DATA. Bemærk, at disse værdier er følsomme.
lytter	String	En lytter definerer, hvordan gården skal spille med forespørgsler fra klienterne. Indstillingerne er: http for ikke sikret protokol eller https for sikret protokol.
reqtimeout	nummer	Hvor lang tid går gården til at vente på en klientanmodning om få sekunder.
restimeout	nummer	Hvor lang tid går gården til at vente på et svar fra backends i sekunder.
resurrectime	nummer	Perioden for at komme ud af en faldet reel server, efter denne periode kontrollerer belastningsbalanceren, om den virkelige server lever, i sekunder.
rewritelocation	String	Hvis det er aktiveret, er bedriften tvunget til at ændre placeringen: og indholdssted: overskrifter i svar til klienter med den virtuelle vært. Indstillingerne er: aktiveret, aktiveret deaktiveret, inaktiveret eller aktiveret-backends kun backend-adressen er sammenlignet.
status	String	Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.
VPort	nummer	Havnen på gården, hvor den virtuelle tjeneste lytter.

Certlist objekt:

Field	Type	Beskrivelse
fil	String	Certifikatets navn, referencer til certifikatet i certifikatbutikken.
id	nummer	Certifikat-id.

Servicesobjekt for HTTP-bedrifter:

Field	Type	Beskrivelse
backends	Objekt[]	Backends defineret i tjenesten.
fgenabled	String	Aktivér brug af værge. sand Farm Guardian er aktiveret og kontrollerer backends status, falsk gårdsholderen er deaktiveret og kontrollerer ikke backends status. I HTTP-profiler udføres en check_tcp som standard, selvom værger er deaktiveret.
fglog	String	Aktiver brugen af logfiler i gården. sand aktiveret, falsk, handicappet. fgenabled er nødvendigt.
fgscript	String	Kommandoen, som gårdsholderen vil bruge til at kontrollere ryggenes sundhed. sand aktiveret, falsk, handicappet. fgenabled er nødvendigt.
fgtimecheck	nummer	gårdens værge kontrollerer hvert 'timetocheck' sekund af backendens sundhedsstatus. fgenabled er nødvendigt.
httpsb	String	Denne parameter angiver til gården, at backends-servere defineret i den aktuelle tjeneste bruger HTTPS-sproget, og derefter bliver dataene krypteret før, for at blive sendt. sand, sender profilen trafikken i HTTPS-protokollen til bagsiden, falsk, sender profilen trafikken i HTTP-protokollen til bagsiden.
id	String	Tjenestens navn, det kan ikke ændres, når tjenesten er oprettet.
leastresp	String	Det muliggør den mindst responderende balance metode. sand frecuently profilen kontrollerer hvilken backend tager mindre tid til at reagere for at sende flere forbindelser til denne, falsk profilen kontrollerer ikke, hvilken backend der tager kortere tid at svare.
udholdenhed	String	Denne parameter definerer, hvordan HTTP-tjenesten skal klare klientsessionen. Indstillingerne er: "" tom streng, ingen handling er taget, IP persistenssessionen udføres i bunden af klientens IP, GRUNDLÆGGENDE Persistenssessionen udføres i bunden af BASIC headers, URL persistenssessionen udføres i basis af et felt i URI'en, PARM persistenssessionen udføres i basis af en værdi i slutningen af URI'et, COOKIE Persistenssessionen udføres i bunden af et cookie navn, denne cookie skal oprettes af bagsiden og HEADER, er persistenssessionen udført i bunden af et overskriftsnavn.
omdirigere	String	Den opfører sig som en speciel backend, da klientens anmodning besvares ved omdirigering til en ny webadresse automatisk. Hvis omdirigering er konfigureret, vil anmodningen ikke blive videresendt til backend, en omdirigering vil blive besvaret til klienten i stedet.
redirecttype	String	Hvordan omdirigering vil blive gjort, to muligheder: standard, er url taget som en absolut vært og vej til omdirigering til, append, vil den oprindelige forespørgselssti eller URI blive tilføjet til værten og den sti, du har angivet med standardindstillingen. Hvis omdirigere feltet er ikke konfigureret, dette felt vil være en tom streng.
Sessions ID	String	Det er tilgængeligt, hvis udholdenhed feltet er URL, COOKIE eller HEADER, vil parameterværdien søges af gården i http-overskriften og administrere klientsessionen.
ttl	nummer	Kun med vedholdenhed. Denne værdi angiver den maksimale levetid for en inaktiv klientsession (maks. Sessionsalder) i sekunder.
urlp	String	Giver mulighed for at bestemme en webtjeneste vedrørende den webadresse, som klienten anmoder om gennem et bestemt webadressemønster, som vil blive kontrolleret syntaktisk. PCRE regulære udtryk understøttes.
vhost	String	Det specificerer betingelsen bestemt af domænenavnet via den samme virtuelle IP og port defineret af en HTTP-gård. PCRE regulære udtryk understøttes.

Backend-objekt til HTTP-bedrifter:

Field	Type	Beskrivelse
id	nummer	Backend-id i den givne tjeneste.
ip	String	Backend's IP, hvor den rigtige tjeneste kører.
port	nummer	Backends havn, hvor den rigtige service kører.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
timeout	nummer	Det er backend-timeouten at svare på en bestemt anmodning om sekunder. Hvis null system bruger global parameter Backends timeout.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server, backend med højere vægtværdi modtager flere forbindelser. Standardværdi null, ikke speciel vægt, der bruges til denne backend.

Opret en ny gård

Opret en ny gård

Forespørgselseksempel:

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

Opret en ny HTTP-bedrift.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
farmname	String	Farm beskrivende navn. Den bruges som unik identifikator.	sand
profil	String	Profilen til den oprettede Farm. For http gårde er http.	sand
vip	String	IP af gården, hvor den virtuelle service vil løbe. Den angivne IP skal konfigureres i systemet og UP	sand
VPort	nummer	Havnen på gården, hvor den virtuelle tjeneste skal lytte. Samme virtuelle port og virtuel IP må ikke bruges af en anden gård.	sand

Svar eksempel:

{
   "description" : "Creating farm 'newHTTPfarm'",
   "params" : {
      "farmname" : "newHTTPfarm",
      "profile" : "http",
      "vip" : "192.168.100.23",
      "vport" : 80
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Ændre en gård

Ændre en gård

Forespørgselseksempel:

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>

Rediger globale parametre for en given HTTP-bedrift.

Anmod om parametre

Field	Type	Beskrivelse
contimeout	nummer	Hvor længe går gården at vente på en forbindelse til backend på få sekunder.
restimeout	nummer	Hvor lang tid går gården til at vente på et svar fra backends i sekunder.
resurrectime	nummer	Denne værdi i sekunder er perioden for at komme ud af en sortlistet backend og kontrollere, om den er i live.
reqtimeout	nummer	Hvor lang tid går gården til at vente på en klientanmodning om få sekunder.
disable_sslv2	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af SSL-sikkerhedsprotokol med version 2 er ikke tilladt eller falsk hvis protokollen SSLv2 er tilladt.
disable_sslv3	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af SSL-sikkerhedsprotokol med version 3 er ikke tilladt eller falsk hvis protokollen SSLv3 er tilladt.
disable_tlsv1	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1 er ikke tilladt eller falsk hvis protokollen TLSv1 er tilladt.
disable_tlsv1_1	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.1 er ikke tilladt eller falsk hvis protokollen TLSv1.1 er tilladt.
disable_tlsv1_2	String	Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.2 er ikke tilladt eller falsk hvis
rewritelocation	String	Hvis det er aktiveret, er bedriften tvunget til at ændre placeringen: og indholdssted: overskrifter i svar til klienter med den virtuelle vært. Indstillingerne er: aktiveret, aktiveret deaktiveret, inaktiveret eller aktiveret-backends kun backend-adressen er sammenlignet.
httpverb	String	Dette felt angiver de operationer, der vil blive tilladt for HTTP-klientanmodningerne. tilgængelige værdier er: standardHTTP, accepterede http-forespørgsler GET, POST, HEAD. extendedHTTP, accepteret tidligere http-anmodninger plus PUT, DELETE. standardWebDAV, accepteret tidligere http-anmodninger plus LOCK, UNLOCK, PROPFIND, PROPPATCH, SØG, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV accepteret tidligere http-anmodninger plus SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT, eller MSRPCext, accepteret tidligere http-anmodninger plus RPC_IN_DATA, RPC_OUT_DATA. Bemærk, at disse værdier er følsomme.
error414	String	Personlig meddelelsesfejl 414.
error500	String	Personlig meddelelsesfejl 500.
error501	String	Personlig meddelelsesfejl 501.
error503	String	Personlig meddelelsesfejl 503.
lytter	String	En lytter definerer, hvordan gården skal spille med forespørgsler fra klienterne. Indstillingerne er: http for ikke sikret protokol eller https for sikret protokol.
ciphers	String	Kun i lytter med https værdi. Bruges til at opbygge en liste over cifre accepteret af SSL-forbindelser for at hærde SSL-forbindelsen. Indstillingerne er: alle, alle cifre vil blive accepteret; highsecurity, kun cifre for høj sikkerhed vil blive accepteret; eller customsecurity, kun cifre indlæst i cipherc feltet accepteres.
cipherc	String	Kun i https-lytteren. Dette er den tilladte tilpassede liste over cifre, der accepteres af SSL-forbindelsen, hvilket er en streng i samme format som i OpenSSL-cifre. Denne attribut bruges kun når ciphers feltet har værdien sutomsikkerhed.
newfarmname	String	Den nye gårds navn. Gården skal stoppes.
VPort	nummer	Havnen på gården, hvor den virtuelle tjeneste lytter.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter, skal denne IP konfigureres og op i systemet.

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Tilføj et certifikat

Tilføj et certifikat

Forespørgselseksempel:

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

Skift PEM-certifikatet for en HTTP-bedrift med en HTTPS-lytter. Det anvendte certifikat skal allerede uploades i systemet, se Certifikater> Liste over alle certifikater for listen over tilgængelige certifikater.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
fil	String	certifikatfilnavn, tidligere skal certifikatet uploades i systemet.	sand

Svar eksempel:

{
   "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 - Services

Tjenesterne inden for en HTTP-profilgård leverer en indholdskoblingsmetode til at levere flere webtjenester med forskellige egenskaber, backends eller endog persistensmetoder gennem nogle deterministiske betingelser, der anvendes af gårdkernen for at matche den korrekte service for hver klientanmodning. Denne service definition vil blive brugt af gården for at bestemme backends servere, der kunne levere svaret til klienten.

Inside serviceobjekt er der to slags værdier: service relateret og farmguardian relateret.

Farmguardian bruges til avanceret overvågningstilstand bagtil og er helt tilpasset til dine egne scripts til den aktuelle service. Når et problem opdages af farmguardian deaktiveres den reelle server automatisk og markeres som sortlistet.

Hent service med ID

Hent service med ID

Forespørgselseksempel:

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>

Vis alle konfigurationer om en given tjeneste.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med nedenstående format.

Servicesobjekt for HTTP-bedrifter:

Field	Type	Beskrivelse
backends	Objekt[]	Backends defineret i tjenesten.
fgenabled	String	Aktivér brug af værge. sand Farm Guardian er aktiveret og kontrollerer backends status, falsk gårdsholderen er deaktiveret og kontrollerer ikke backends status. I HTTP-profiler udføres en check_tcp som standard, selvom værger er deaktiveret.
fglog	String	Aktiver brugen af logfiler i gården. sand aktiveret, falsk, handicappet. fgenabled er nødvendigt.
fgscript	String	Kommandoen, som gårdsholderen vil bruge til at kontrollere ryggenes sundhed. sand aktiveret, falsk, handicappet. fgenabled er nødvendigt.
fgtimecheck	nummer	gårdens værge kontrollerer hvert 'timetocheck' sekund af backendens sundhedsstatus. fgenabled er nødvendigt.
httpsb	String	Denne parameter angiver til gården, at backends-servere defineret i den aktuelle tjeneste bruger HTTPS-sproget, og derefter bliver dataene krypteret før, for at blive sendt. sand, sender profilen trafikken i HTTPS-protokollen til bagsiden, falsk, sender profilen trafikken i HTTP-protokollen til bagsiden.
id	String	Tjenestens navn, det kan ikke ændres, når tjenesten er oprettet.
leastresp	String	Det muliggør den mindst responderende balance metode. sand frecuently profilen kontrollerer hvilken backend tager mindre tid til at reagere for at sende flere forbindelser til denne, falsk profilen kontrollerer ikke, hvilken backend der tager kortere tid at svare.
udholdenhed	String	Denne parameter definerer, hvordan HTTP-tjenesten skal klare klientsessionen. Indstillingerne er: "" tom streng, ingen handling er taget, IP persistenssessionen udføres i bunden af klientens IP, GRUNDLÆGGENDE Persistenssessionen udføres i bunden af BASIC headers, URL persistenssessionen udføres i basis af et felt i URI'en, PARM persistenssessionen udføres i basis af en værdi i slutningen af URI'et, COOKIE Persistenssessionen udføres i bunden af et cookie navn, denne cookie skal oprettes af bagsiden og HEADER, er persistenssessionen udført i bunden af et overskriftsnavn.
omdirigere	String	Den opfører sig som en speciel backend, da klientens anmodning besvares ved omdirigering til en ny webadresse automatisk. Hvis omdirigering er konfigureret, vil anmodningen ikke blive videresendt til backend, en omdirigering vil blive besvaret til klienten i stedet.
redirecttype	String	Hvordan omdirigering vil blive gjort, to muligheder: standard, er url taget som en absolut vært og vej til omdirigering til, append, vil den oprindelige forespørgselssti eller URI blive tilføjet til værten og den sti, du har angivet med standardindstillingen. Hvis omdirigere feltet er ikke konfigureret, dette felt vil være en tom streng.
Sessions ID	String	Det er tilgængeligt, hvis udholdenhed feltet er URL, COOKIE eller HEADER, vil parameterværdien søges af gården i http-overskriften og administrere klientsessionen.
ttl	nummer	Kun med vedholdenhed. Denne værdi angiver den maksimale levetid for en inaktiv klientsession (maks. Sessionsalder) i sekunder.
urlp	String	Giver mulighed for at bestemme en webtjeneste vedrørende den webadresse, som klienten anmoder om gennem et bestemt webadressemønster, som vil blive kontrolleret syntaktisk. PCRE regulære udtryk understøttes.
vhost	String	Det specificerer betingelsen bestemt af domænenavnet via den samme virtuelle IP og port defineret af en HTTP-gård. PCRE regulære udtryk understøttes.

Backend-objekt til HTTP-bedrifter:

Field	Type	Beskrivelse
id	nummer	Backend-id i den givne tjeneste.
ip	String	Backend's IP, hvor den rigtige tjeneste kører.
port	nummer	Backends havn, hvor den rigtige service kører.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
timeout	nummer	Det er backend-timeouten at svare på en bestemt anmodning om sekunder. Hvis null system bruger global parameter Backends timeout.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server, backend med højere vægtværdi modtager flere forbindelser. Standardværdi null, ikke speciel vægt, der bruges til denne backend.

Opret en ny tjeneste

Opret en ny tjeneste

Forespørgselseksempel:

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

Opret en tjeneste i en given HTTP-profil Farm. Gården har brug for en genstart for at anvende denne ændring.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
id	String	Servicenavn, der bruges som unik identifikator. Kun alfanumeriske værdier er tilladt.	sand

Svar eksempel:

{
   "description" : "New service newserv",
   "params" : {
      "id" : "newserv"
   },
   "status" : "needed restart"
}

Ændre en tjeneste

Ændre en tjeneste

Forespørgselseksempel:

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>

Ændre parametrene for en tjeneste i en HTTP-profil. id er tjenesten unikke identifikator, som vil blive ændret.

Anmod om parametre

Field	Type	Beskrivelse
vhost	String	Angiver tilstanden bestemt af domænenavnet via den samme virtuelle IP og port defineret af en HTTP-profil gård. PCRE regulære udtryk understøttes.
urlp	String	Giver mulighed for at bestemme en webtjeneste vedrørende den webadresse, som klienten anmoder om gennem et bestemt webadressemønster, som vil blive kontrolleret syntaktisk. PCRE regulære udtryk understøttes.
omdirigere	String	Det fungerer som en speciel backend, klientens anmodning besvares ved omdirigering til en ny webadresse automatisk.
redirecttype	String	Hvordan omdirigering vil ske, to muligheder: standard, er url taget som en absolut vært og vej til omdirigering til, append, vil den oprindelige forespørgselssti eller URI blive tilføjet til værten og stien, du har angivet i omdirigere Mark. Denne opførsel gælder kun hvis omdirigere er ikke en tom værdi.
udholdenhed	String	Denne parameter definerer, hvordan HTTP-tjenesten skal klare klientsessionen. Indstillingerne er: "" tom streng, ingen handling er taget, IP persistenssessionen udføres i bunden af klientens IP, GRUNDLÆGGENDE Persistenssessionen udføres i bunden af BASIC headers, URL persistenssessionen udføres i basis af et felt i URI'en, PARM vedholdenhedssessionen udføres i basis af en værdi adskilt af “;” i slutningen af URI, COOKIE Persistenssessionen udføres i bunden af et cookie navn, denne cookie skal oprettes af bagsiden og HEADER, er persistenssessionen udført i bunden af et overskriftsnavn.
ttl	nummer	Kun med vedholdenhed. Den maksimale levetid for en inaktiv klientsession (maks. Sessionsalder) i sekunder.
Sessions ID	String	Det er tilgængeligt, hvis udholdenhed feltet er URL, COOKIE or HEADER, vil parameterværdien blive søgt af profilen i http-headeren og vil klare klientsessionen.
leastresp	String	Det muliggør den mindst responderende balance metode. sand, selv om profilen kontrollerer hvilken backend der tager mindre tid til at reagere for at sende flere forbindelser til dette, falsk, profil kontrollerer ikke, hvilken backend der tager kortere tid at svare.
httpsb	String	Det angiver til gården, at backends-serverne defineret i den aktuelle tjeneste bruger HTTPS-sproget, og derefter bliver dataene krypteret før at blive sendt. sand, sender profilen trafikken i HTTPS-protokollen til bagsiden, falsk, sender profilen trafikken i HTTP-protokollen til bagsiden.

Svar eksempel:

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

Response Parametre

Svaret vil være en json med ønskede parametre opdateret og status felt med nødvendige genstart værdi. Genstart handling skal tages for at kunne anvende ændringerne.

Ændr bedriftsmægler

Ændr bedriftsmægler

Forespørgselseksempel:

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

PUT /farms/<farmname>/fg

Ændre parametrene for bedriftsmagten i den givne HTTP-profil.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
fgtimecheck	nummer	Gårdens værge vil kontrollere backends sundhedsstatus hvert 'timetocheck'-sekund.
fgscript	String	Kommandoen, som gårdhavevogter vil køre for at kontrollere backends sundhedstilstand
fgenabled	String	Det gør det muligt for værge i den angivne tjeneste. sand gårdsholder skal bruges til kontrol af backends status, falsk gårdsholder bliver deaktiveret
fglog	String	Aktiver brugen af logfiler i gården. sand gårdsholder skal logge enhver handling, falsk gårdsbeskytter ikke logge nogen handling, anbefales det at aktivere fglog kun til fejlfinding.
tjeneste	String	Servicenavn, der bruges som unik identifikator.	sand

Svar eksempel:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "fgenabled" : "true",
      "fglog" : "true",
      "fgscript" : "checktcp",
      "fgtimecheck" : 5,
      "service" : "service1"
   }
}

Slet en tjeneste

Slet en tjeneste

Forespørgselseksempel:

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>

Slet en given tjeneste for en http-profil. id er tjenesten unikke identifikator, som vil blive slettet.

Svar eksempel:

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

HTTP - Services - Backends

Angiv backends

Angiv backends

Forespørgselseksempel:

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

Få listen over backends i en tjeneste. id er tjenesten unikke identifikator.

Svar eksempel:

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

Response Parametre

Dette opkald returnerer et backend-objekt array med bellow parametrene.

Field	Type	Beskrivelse
id	nummer	Unik identifikator for backend i tjenesten. Denne identifikator genereres af systemet.
ip	String	Backends IP, hvor den rigtige tjeneste lytter.
port	nummer	Backends havn, hvor den rigtige tjeneste lytter.
timeout	nummer	Det er backend-timeouten at svare på en bestemt anmodning om sekunder.
vægt	nummer	Det er vægtværdien for den aktuelle backend.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.

Opret en ny backend

Opret en ny backend

Forespørgselseksempel:

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

Opret en ny backend i en given HTTP-profil. id er tjenesten unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
ip	String	Backends IP, hvor den rigtige tjeneste lytter.	sand
port	nummer	Backends havn, hvor den rigtige tjeneste lytter.	sand
timeout	nummer	Det er backend timeout at svare på en bestemt anmodning.
vægt	nummer	Det er vægtværdien for den aktuelle backend.

Svar eksempel:

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

Response Parametre

Svaret vil være en json med ønskede parametre opdateret og status felt med nødvendige genstart værdi, hvis bedriften skal genstartes. Genstart handling skal tages for at kunne anvende ændringerne.

Rediger en backend

Rediger en backend

Forespørgselseksempel:

 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>

Ændre parametrene for en backend i en tjeneste af en HTTP-profil.

Fornavn id er tjenesten unikke identifikator, næste id er backend unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
ip	String	Backends IP, hvor den rigtige tjeneste lytter.
port	nummer	Backends havn, hvor den rigtige tjeneste lytter.
timeout	nummer	Det er backend-timeouten at svare på en bestemt anmodning om sekunder.
vægt	nummer	Det er vægtværdien for den aktuelle backend.

Svar eksempel:

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

Response Parametre

Backend i vedligeholdelse

Backend i vedligeholdelse

Forespørgselseksempel:

 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

Indstil en given handling i en backend på en HTTP-gård, beskrives tilgængelige handlinger nedenfor.

Fornavn id er tjenesten unikke identifikator, næste id er backend unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
Action	String	Indstil den ønskede handling. Handlingerne er: up backend er klar til at modtage klientanmodninger, vedligeholdelse backend er ikke klar til at modtage klientanmodninger. Denne handling er nyttig til at stoppe backend-serveren uden at påvirke klienterne.	sand
tilstand	String	Vælg en vedligeholdelsestilstand. De tilgængelige muligheder er: dræne, backend accepterer ikke nye forbindelser, men den vil fortsat håndtere de nuværende forbindelser; eller skære, de aktuelle forbindelser vil blive lukket.	Hvis dette felt ikke er angivet, vil standardindstillingen være dræne.

Svar eksempel:

{
   "description" : "Set service backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

Slet en backend

Slet en backend

Forespørgselseksempel:

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>

Slet en given backend i en tjeneste af en HTTP-profil.

Fornavn id er tjenesten unikke identifikator, næste id er backend unikke identifikator.

Svar eksempel:

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

L4xNAT Farms

L4xNAT profil gården giver mulighed for at oprette en L4 gård med en meget høj ydeevne og langt mere samtidige forbindelser end load balancer kerner i lag 7 som HTTP gårdsprofiler. Det forbedrede lag 4-forbedring modvirker den avancerede indholdshåndtering, som lag 7-profiler kunne klare.

Derudover kunne L4xNAT gårde binde en række porte, ikke kun en virtuel port, som bruges sammen med andre lag 7 profiler. For at kunne vælge en række virtuelle porte eller en bestemt virtuel port i L4xNAT gårde, er det obligatorisk at vælge en protokol type. I andre tilfælde vil gården lytte på alle havne fra den virtuelle IP (angivet med et tegn ''). Når en TCP- eller UDP-protokol er valgt, vil den være tilgængelig for at angive en port, flere porte mellem ',' porte spænder mellem ':' eller alle porte med ''. En kombination af dem alle vil også være gyldig.

Hent gården ved navn

Hent gården ved navn

Forespørgselseksempel:

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

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

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

Response parametre

Svaret vil være et JSON objekt med nedenstående format.

Farm Object:

Field	Type	Beskrivelse
params	Object	Parametre for gårdskonfiguration.
backends	Objekt[]	Alle rigtige servere skabt i denne gård og dens konfiguration.

Parametre objekt for L4xNAT gårde:

Field	Type	Beskrivelse
algoritme	String	Type lastbalanceringsalgoritme anvendt i gården. Indstillingerne er: leastconn forbindelse altid til den mindst forbindelses server, vægt forbindelse lineær forsendelse efter vægt, Prio forbindelser altid til den mest tilgængelige prio.
lytter	String	En lytter definerer, hvordan gården skal lege med anmodningerne fra klienterne. informationsfelt, kan det ikke ændres.
nattype	String	Hvordan belastningsbalancelaget 4-kernen skal fungere. Indstillingerne er: NAT også kaldet sNAT-tilstand, svarer bagenden til belastningsbalanceren for at sende svaret til klienten, DNAT backend vil reagere direkte på klienten, load balancer skal konfigureres som gateway i backend serveren.
udholdenhed	String	Den samme ip-adresse vil blive forbundet til den samme server. Indstillingerne er: "" tom værdi, persistens er deaktiveret, ip Persistens er aktiveret gennem, oprindelse IP bruges som unik ID i session.
protokol	String	Protokol skal afbalanceres ved lag 4. Indstillingerne er: alle profilen vil indlæse balance enhver L4-protokol, tcp belastningsbalanceren vil kun afbalancere TCP L4-protokollen, uDP belastningsbalanceren vil kun balancere UDP L4-protokollen, tår belastningsbalanceren vil kun balancere SIP- eller VoIP L7-protokollen, ftp belastningsbalanceren vil kun balancere FTP L7-protokollen, tftp belastningsbalanceren vil kun balancere TFTP L7-protokollen.
status	String	Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
ttl	nummer	Denne feltværdi angiver det antal sekunder, som persistensen mellem klientkilden og bagenden tildeles, i sekunder. Persistens skal konfigureres.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.
VPort	String	Havnen på gården, hvor den virtuelle tjeneste lytter. En unik port kan specificeres, en rækkeport kan specificeres med separator : og flere porte kan specificeres med separator ,.
fgenabled	String	Gør det muligt at bruge husmor. sand farm guard er aktiveret, falsk gårdsbeskytter er deaktiveret.
fglog	String	Gør det muligt at anvende logfiler i gården. fgenabled skal være aktiveret.
fgscript	String	Kommandoen, som gårdsholderen vil kontrollere. De tilgængelige kommandoer findes i libexec-stien. fgenabled skal være aktiveret.
fgtimecheck	nummer	Gårdens værge kontrollerer hvert 'timetocheck'-sekund. fgenabled skal være aktiveret.

Backend objekt til L4xNAT gårde:

Field	Type	Beskrivelse
id	nummer	ID for at identificere backend i gården.
ip	String	Backends IP, hvor den rigtige tjeneste lytter.
max_conns	nummer	Det er det maksimale antal samtidige forbindelse til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
port	nummer	Backends havn, hvor den rigtige tjeneste lytter. Tom værdi accepteres, og den bruger den samme konfiguration end virtuel port (er).
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Forbindelser er altid til den mest tilgængelige prio, hvor 1 er mest prioriteret.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser.

Opret en ny gård

Opret en ny gård

Forespørgselseksempel:

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

Opret en ny L4xNAT gård.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
farmname	String	Landbrugsnavn, entydigt identifikator.	sand
profil	String	Profilen til den oprettede Farm. For L4xNAT gårde er l4xnat, informationsbesked, kan denne værdi ikke ændres	sand
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.	sand
VPort	String	Havnen på gården, hvor den virtuelle tjeneste lytter. L4xNAT gårde tillader multiport adskilt af , eller interval port adskilt af :.	sand

Svar eksempel:

{
   "description" : "Creating farm 'newl4farm'",
   "params" : {
      "farmname" : "newl4farm",
      "interface" : "eth0",
      "profile" : "l4xnat",
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Ændre en gård

Ændre en gård

Forespørgselseksempel:

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>

Rediger konfigurationen af en L4xNAT gård.

Anmod om parametre

Field	Type	Beskrivelse
newfarmname	String	Den nye gårds navn. Gården skal stoppes.
algoritme	String	Type lastbalanceringsalgoritme anvendt i gården. Indstillingerne er: leastconn forbindelse altid til den mindst forbindelses server, vægt forbindelse lineær forsendelse efter vægt, Prio forbindelser altid til den mest tilgængelige prio.
nattype	String	Hvordan belastningsbalancelaget 4-kernen skal fungere. Indstillingerne er: NAT også kaldet sNAT-tilstand, svarer bagenden til belastningsbalanceren for at sende svaret til klienten, DNAT backend vil reagere direkte på klienten, load balancer skal konfigureres som gateway i backend serveren.
udholdenhed	String	Den samme ip-adresse vil blive forbundet til den samme server. Indstillingerne er: "" tom værdi, persistens er deaktiveret, ip Persistens er aktiveret gennem, oprindelse IP bruges som unik ID i session.
protokol	String	Protokol skal afbalanceres ved lag 4. Indstillingerne er: alle profilen vil indlæse balance enhver L4-protokol, tcp belastningsbalanceren vil kun afbalancere TCP L4-protokollen, uDP belastningsbalanceren vil kun balancere UDP L4-protokollen, tår belastningsbalanceren vil kun balancere SIP- eller VoIP L7-protokollen, ftp belastningsbalanceren vil kun balancere FTP L7-protokollen, tftp belastningsbalanceren vil kun balancere TFTP L7-protokollen.
ttl	nummer	Denne feltværdi angiver det antal sekunder, som persistensen mellem klientkilden og bagenden tildeles, i sekunder. Persistens skal konfigureres.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.
VPort	String	Havnen på gården, hvor den virtuelle tjeneste lytter. En unik port kan specificeres, en rækkeport kan specificeres med separator : og flere porte kan specificeres med separator ,.

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Ændr bedriftsmægler

Ændr bedriftsmægler

Forespørgselseksempel:

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

PUT /farms/<farmname>/fg

Ændre parametrene for gårdens værge i en L4xNAT-tjeneste.

Anmod om parametre

Field	Type	Beskrivelse
fgenabled	String	Gør det muligt at bruge husmor. sand farm guard er aktiveret, falsk gårdsbeskytter er deaktiveret.
fglog	String	Gør det muligt at anvende logfiler i gården. fgenabled skal være aktiveret.
fgscript	String	Kommandoen, som gårdsholderen vil kontrollere. De tilgængelige kommandoer findes i libexec-stien. fgenabled skal være aktiveret.
fgtimecheck	nummer	Gårdens værge kontrollerer hvert 'timetocheck'-sekund. fgenabled skal være aktiveret.

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

L4xNAT - Backends

Angiv backends

Angiv backends

Forespørgselseksempel:

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

Få listen over backends i en tjeneste.

Svar eksempel:

{
   "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
      },
   ]
}

Response Parametre

Dette opkald returnerer et backend-objekt array med bellow parametrene.

Field	Type	Beskrivelse
id	nummer	ID for at identificere backend i gården.
ip	String	Backends IP, hvor den rigtige tjeneste lytter.
port	nummer	Backends havn, hvor den rigtige tjeneste lytter. Tom værdi accepteres, og den bruger den samme konfiguration end virtuel port (er).
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
max_conns	nummer	Det er det maksimale antal samtidige forbindelse til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Forbindelser er altid til den mest tilgængelige prio, hvor 1 er mest prioriteret.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser.

Opret en ny backend

Opret en ny backend

Forespørgselseksempel:

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

Opret en ny backend i en given L4xNAT Farm.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
ip	String	Backends IP, hvor den rigtige tjeneste lytter.	sand
port	nummer	Backends havn, hvor den rigtige tjeneste lytter. Tom værdi accepteres, og den bruger den samme konfiguration end virtuel port (er).
max_conns	nummer	Det er det maksimale antal samtidige forbindelse til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Forbindelser er altid til den mest tilgængelige prio, hvor 1 er mest prioriteret. Standardværdien er 1.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser. Standardværdien er 1.

Svar eksempel:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 5,
      "ip" : "192.168.5.100",
      "port" : 8080,
      "max_conns" : 400,
      "priority" : null,
      "weight" : null
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Rediger en backend

Rediger en backend

Forespørgselseksempel:

 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>

Ændre parametrene for en backend i en tjeneste af en L4xNAT Farm. id er backend unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
ip	String	Backends IP, hvor den rigtige tjeneste lytter.
port	nummer	Backends havn, hvor den rigtige tjeneste lytter. Tom værdi accepteres, og den bruger den samme konfiguration end virtuel port (er).
max_conns	nummer	Det er det maksimale antal samtidige forbindelse til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Forbindelser er altid til den mest tilgængelige prio, hvor 1 er mest prioriteret.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser.

Svar eksempel:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.5.40",
      "port" : 8080,
      "max_conns" : 220,
      "priority" : 4,
      "weight" : 7
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Backend i vedligeholdelse

Backend i vedligeholdelse

Forespørgselseksempel:

 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

Indstil en given handling i en backend på en L4xNAT gård. id er backend unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
Action	String	Indstil den ønskede handling. Handlingerne er: up backend er klar til at modtage klientanmodninger, vedligeholdelse backend er ikke klar til at modtage klientanmodninger. Denne handling er nyttig til at stoppe backend-serveren uden at påvirke klienterne.	sand
tilstand	String	Vælg en vedligeholdelsestilstand. De tilgængelige muligheder er: dræne, backend accepterer ikke nye forbindelser, men den vil fortsat håndtere de nuværende forbindelser; eller skære, de aktuelle forbindelser vil blive lukket.	Hvis dette felt ikke er angivet, vil standardindstillingen være dræne.

Svar eksempel:

{
   "description" : "Set backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Slet en backend

Slet en backend

Forespørgselseksempel:

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>

Slet en given backend i en tjeneste af en L4xNAT Farm.

id er backend unikke identifikator.

Svar eksempel:

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

Datalink Farms

Datalink gårdsprofilen gør det muligt at oprette en ruter baseret gård, hvor backends er uplink routere eller gateways. Denne slags gårdsprofil er klar til at dele flere uplink WAN router-adganger ved hjælp af belastningsbalanceren som en uplink-kanalmultiplexor (1-indgang og flere routerlinjeudgange). Datalink gårdene kunne derfor bruges som høje tilgængelige kommunikationsforbindelser og kunne desuden bruges som båndbreddeforøgelse, der forbinder mængden af båndbredde mellem routers backends links.

Hent gården ved navn

Hent gården ved navn

Forespørgselseksempel:

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

GET /farms/<farmname>

Vis alle konfigurationer om en gård.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med nedenstående format.

Farm Object:

Field	Type	Beskrivelse
params	Object	Parametre for gårdskonfiguration.
backends	Objekt[]	Reelle servere skabt i denne gård og dens konfiguration.

Parametre genstand for datalink gårde:

Field	Type	Beskrivelse
algoritme	String	Type lastbalanceringsalgoritme anvendt i gården. Indstillingerne er: vægt, balanceren fordeler blandt alle tilgængelige backends givet mere charge backends med højere vægt attribut eller Prio, som sender alle forbindelser til backend med den mindre værdi af prioritet.
status	String	Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; up, gården er op og alle backends arbejder succes.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.

Backend objekt for datalink gårde:

Field	Type	Beskrivelse
id	nummer	Unik identifikator til backend på gården.
ip	String	IP af backend, hvor den rigtige tjeneste lytter.
grænseflade	String	Det er den lokale netværksinterface, hvor backend er forbundet.
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Det vil blive brugt, når algoritme feltet er konfiguration som prio og lavere prioritet vil have præference
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.
vægt	nummer	Det er vægtværdien for den aktuelle virkelige server. Det vil blive brugt når algoritme feltet er konfigureret som vægt.

Opret en ny gård

Opret en ny gård

Forespørgselseksempel:

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

Opret en ny datalink gård.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
farmname	String	Landbrugsnavn, entydigt identifikator.	sand
profil	String	Profilen til den oprettede Farm. For datalink gårde er data link	sand
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.	sand

Svar eksempel:

{
   "description" : "Creating farm 'dlink'",
   "params" : {
      "farmname" : "dlink",
      "interface" : "eth0",
      "profile" : "datalink",
      "vip" : "192.168.100.241"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Ændre en gård

Ændre en gård

Forespørgselseksempel:

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>

Rediger konfigurationen af en datalink gård.

Anmod om parametre

Field	Type	Beskrivelse
newfarmname	String	Det nye landbrugsnavn. Gården skal stoppes.
algoritme	String	Type lastbalanceringsalgoritme anvendt i gården. Indstillingerne er: vægt, balanceren fordeler blandt alle tilgængelige backends givet mere charge backends med højere vægt attribut eller Prio, som sender alle forbindelser til backend med den mindre værdi af prioritet.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.

Svar eksempel:

{
   "description" : "Modify farm dlink",
   "params" : {
      "algorithm" : "weight",
      "vip" : "192.168.100.199",
      "newfarmname" : "dlink2"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Datalink - Backends

Backends i datalink gårde er gateways gennem routing tjenesten. Tjenesten vil multiplexere blandt disse gateways, og nogle af dem er ikke tilgængelige, tjenesten bruger de andre (e).

Angiv backends

Angiv backends

Forespørgselseksempel:

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

Få listen over backends i en tjeneste.

Svar eksempel:

[
   {
      "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
   }
]

Response Parametre

Dette opkald returnerer et backend-objekt array med bellow parametrene.

Field	Type	Beskrivelse
id	nummer	Unik identifikator til backend på gården. Denne identifikator genereres af systemet.
grænseflade	String	Det er den lokale netværksinterface, hvor backend er forbundet.
ip	String	IP af backend, hvor den rigtige tjeneste lytter.
prioritet	nummer	Det er den prioriterede værdi for den nuværende backend. Det vil blive brugt, når algoritme feltet er konfiguration som prio og lavere prioritet vil have præference.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.
vægt	nummer	Det er vægtværdien for den aktuelle backend. Det vil blive brugt når algoritme feltet er konfigureret som vægt.

Opret en ny backend

Opret en ny backend

Forespørgselseksempel:

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

Opret en ny backend i en given datalink Farm.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
ip	String	IP af backend, hvor den rigtige tjeneste lytter.	sand
grænseflade	String	Det er den lokale netværksinterface, hvor backend er forbundet.	sand
prioritet	nummer	Det er prioriteringsværdien for den aktuelle reelle server. Den bliver brugt når algoritme feltet er konfiguration som prio og lavere prioritet vil have præference. Standardværdien er 1.
vægt	nummer	Det er vægtværdien for den aktuelle backend. Det vil blive brugt når algoritme feltet er konfigureret som vægt. Standardværdien er 1.

Svar eksempel:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "weight" : 2
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Rediger en backend

Rediger en backend

Forespørgselseksempel:

 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>

Ændre parametrene for en backend i en service af en datalink Farm. id er backend unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
String	ip	IP af backend, hvor den rigtige tjeneste lytter.
grænseflade	String	Det er den lokale netværksinterface, hvor backend er forbundet.
timeout	nummer	Det er backend timeout at svare på en bestemt anmodning.
vægt	nummer	Det er vægtværdien for den aktuelle backend.

Svar eksempel:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "interface" : "eth0",
      "ip" : "192.168.102.50",
      "timeout" : 1,
      "weight" : 1
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Slet en backend

Slet en backend

Forespørgselseksempel:

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>

Slet en given backend i en service af en datalink Farm. id er backend unikke identifikator.

Svar eksempel:

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

Netværk

Zevenet kan arbejde med forskellige typer netværksinterfaces.

I dette afsnit kan du liste, oprette, konfigurere, slette og indstille en handling i NIC, VLAN og virtuelle grænseflader.

nic: eller netværkskort, er det en computerhardware komponent, og den slags grænseflade er grundlaget for følgende type grænseflader, som kan defineres og styres i Zevenet.

VLAN: eller virtuelt lan-kort er venlig eller netværksgrænseflade, der leverer netværkssegmenteringstjenester. Mere end en vlan kan oprettes via en nic-grænseflade.

virtuelt: Denne form for interface kan oprettes over enhver form for grænseflade, der beskrives ovenfor. Denne form for grænseflade bør bruges til Gårde og det kræves, at den virtuelle grænseflade er defineret i det samme undernet som forældren.

Liste over alle grænseflader

Liste over alle grænseflader

Forespørgselseksempel:

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

GET /interfaces

Få en liste over grænseflader i systemet med deres konfiguration.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med en grænseflade objekt array.

Interface objekt:

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. IP skal være i samme netværkssegment end overordnet grænseflade i virtuel grænseflade.
has_vlan	String	Dette felt viser, om denne grænseflade er forælder til en VLAN-grænseflade. Dette felt er kun til NIC-grænseflader.
netmaske	String	Netmaske af grænsefladen. Denne værdi kunne ikke ændres i virtuelle grænseflader, det er arvet fra moderinterface.
gateway	String	Gateway til grænsefladen. Denne værdi kunne ikke ændres i virtuelle grænseflader, det er arvet fra moderinterface.
mac	String	MAC af grænsefladen. Denne værdi er arvet fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator.
status	String	Værdierne kan være up, grænsefladen kan modtage pakker; ned, grænsefladen kan ikke modtage pakker.
typen	String	De forskellige former for grænseflader er: nic, VLAN or virtuelt.

Hent standard gateway

Hent standard gateway

Forespørgselseksempel:

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

GET /interfaces/gateway

Standard gatewayen er noden, som sender alle destinationstrafik, der ikke kan nås lokalt fra en hvilken som helst grænseflade i belastningsbalanceren.

Få parametrene for standard gateway interface.

Svar eksempel:

{
   "description" : "Default gateway",
   "params" : {
      "address" : "192.168.100.5",
      "interface" : "eth0"
   }
}

Response parametre

Field	Type	Beskrivelse
adresse	String	Det er gatewayens IP.
grænseflade	String	Interface navn for gatewayen.

Ændre standard gateway

Ændre standard gateway

Forespørgselseksempel:

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

Rediger konfigurationen af gateway-grænsefladen.

Svar eksempel:

{
   "description" : "Modify default gateway",
   "message" : "The default gateway has been changed successfully",
   "success" : "true"
}

Anmod om parametre

Field	Type	Beskrivelse
adresse	String	Det er gatewayens IP.
grænseflade	String	Interface navn for gatewayen.

Slet gateway-konfiguration

DELETE /interfaces/gateway

Slet konfigurationen af standard gateway-konfigurationen.

Advarsel: Hvis gatewayen er afbrudt, vil Zevenet ikke nås fra et eksternt netværkssegment.

Slet gateway-konfiguration

Forespørgselseksempel:

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

Svarmeddelelse

Hvis gatewayen ophæves fra samme netværkssegment, vises denne meddelelse, ellers vil forbindelsen tabe.

Svar eksempel:

{
   "description" : "Remove default gateway",
   "message" : "The default gateway has been deleted successfully",
   "params" : {
      "address" : null,
      "interface" : null
   }
}

Netværk - NIC-grænseflader

NIC-grænseflader er de fysiske grænseflader, der er forbundet med din Zevenet-belastningsbalancer.

Systemet genkender nye grænseflader automatisk, når de er tilsluttet.

Ved brug af NIC-grænseflader som forældre kan andre typer af grænseflader med forskellige egenskaber oprettes. Tilgængelige grænseflader er: VLAN og virtuelt.

Liste NIC-grænseflader

GET /interfaces/nic

Få alle parametrene i NIC-grænsefladerne.

Liste NIC-grænseflader

Forespørgselseksempel:

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

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med en række NIC interface objekter.

NIC-grænsefladeobjekt:

Field	Type	Beskrivelse
ip	String	IP af grænsefladen.
has_vlan	String	Dette felt viser, om denne grænseflade er forælder til en VLAN-grænseflade. Dette felt er kun til NIC-grænseflader.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker til et andet netværkssegment.
mac	String	Link lag unikt indentifier. Det er umuligt.
navn	String	Interface navn. Det bruges som unik interface-id.
status	String	Værdierne kan være up, grænsefladen kan modtage pakker; ned, grænsefladen kan ikke modtage pakker.

Hent NIC-grænseflade

Hent NIC-grænseflade

Forespørgselseksempel:

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>

Få alle parametrene i en NIC-grænseflade. navn er grænsefladen unikke identifikator.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker til et andet netværkssegment.
mac	String	Link lag unikt indentifier. Det er umuligt.
navn	String	Interface navn. Det bruges som unik interface-id.
status	String	Værdierne kan være up, grænsefladen kan modtage pakker; ned, grænsefladen kan ikke modtage pakker.

Rediger NIC interface

Rediger NIC interface

Forespørgselseksempel:

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>

Ændre parametrene for en NIC-grænseflade. navn er grænsefladen unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment.

Svar eksempel:

{
   "description" : "Configure nic interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "netmask" : "255.255.255.0"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Slet NIC-konfiguration

Slet NIC-konfiguration

Forespørgselseksempel:

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>

Slet konfigurationen for en NIC-grænseflade. Efter denne handling er grænsefladen ubrugelig og klar til at blive konfigureret igen. navn er grænsefladen unikke identifikator.

Svar eksempel:

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

Indstil NIC interface handling

Indstil NIC interface handling

Forespørgselseksempel:

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

Anvend en handling til en NIC-grænseflade. Dette opkald lader aktivere eller deaktivere en netværksgrænseflade.

navn er grænsefladen unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
Action	String	Handling til anvendelse på grænsefladen. De tilgængelige værdier er: up, aktiver grænsefladen og forberede den til at blive brugt ned, deaktiver grænsefladen for ikke at modtage eller ikke sende pakker.	sand

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Netværk - VLAN-interfaces

VLAN interface gør det muligt at bruge et NIC interface i et andet netværk, så IP, gateway og netmaske felter kan være forskellige fra forældreinterfacet. VLAN-grænsefladen arver MAC-adressen fra dens overordnede grænseflade.

VLAN-grænsefladen navn vises med et punkt "." tegn, der vil blive brugt til at etablere et identifikationsmærke til VLAN-grænsefladen.

Liste VLAN-grænseflader

Liste VLAN-grænseflader

Forespørgselseksempel:

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

GET /interfaces/vlan

Få alle parametre af VLAN-interfaces.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med en VLAN interface objekt array.

VLAN parametrene er:

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. Det kan være anderledes end den overordnede intuitive IP.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment.
mac	String	MAC af grænsefladen. Denne værdi er arvet fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af et overordnet interface-navn, et priktegn “.” og et nummer til vlan-netværksgrænsefladen eller vlan-taggen.
forælder	String	Det er grænsefladen, der bruges til at oprette denne.
status	String	Værdierne kan være up grænsefladen kan modtage pakker, ned grænsefladen kan ikke modtage pakker.

Hent VLAN-grænseflade

Hent VLAN-grænseflade

Forespørgselseksempel:

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>

Få alle parametre i VLAN-grænsefladen. navn er grænsefladen unikke identifikator.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment.
mac	String	MAC af grænsefladen. Denne værdi er arvet fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af et overordnet interface-navn, et priktegn “.” og et nummer til vlan-netværksgrænsefladen.
status	String	Værdierne kan være up grænsefladen kan modtage pakker, ned grænsefladen kan ikke modtage pakker.

Opret VLAN-grænseflade

Opret VLAN-grænseflade

Forespørgselseksempel:

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

Opret en VLAN-grænseflade fra en NIC-grænseflade. Den nye VLAN-grænseflade vil dele MAC, selvom følgende netværksparametre skal være forskellige: ip, og følgende kan ændres: gateway, netmaske.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
ip	String	IP af grænsefladen. Det skal være forskelligt fra den overordnede IP-IP.	sand
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.	sand
gateway	String	IP bruges til at sende pakker af et andet netværkssegment.	sand
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af et overordnet interface-navn, et priktegn “.” og et nummer til vlan-netværksgrænsefladen.	sand

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Ændr VLAN-grænseflade

Ændr VLAN-grænseflade

Forespørgselseksempel:

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>

Ændr parametrene for en VLAN-grænseflade. navn er grænsefladen unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. Det kan være anderledes end den overordnede intuitive IP.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment.

Svar eksempel:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Slet VLAN-grænseflade

Slet VLAN-grænseflade

Forespørgselseksempel:

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>

Slet en VLAN-grænseflade. navn er grænsefladen unikke identifikator.

Svar eksempel:

{
   "description" : "Delete VLAN interface",
   "message" : "The VLAN interface eth0.1 has been deleted.",
   "success" : "true"
}

Indstil VLAN interface handling

Indstil VLAN interface handling

Forespørgselseksempel:

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

Anvend en handling til en VLAN-grænseflade. Dette opkald lader aktivere eller deaktivere en netværksgrænseflade.

navn er navnet unikt identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
Action	String	Handling til anvendelse på grænsefladen. De tilgængelige værdier er: up, aktiver grænsefladen og forberede den til at blive brugt ned, deaktiver grænsefladen for ikke at modtage eller ikke sende pakker.	sand

Svar eksempel:

{
   "description" : "Action on vlan interface",
   "params" : {
      "action" : "down"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Netværk - Virtuelle grænseflader

Netværksgrænseflader giver brugerne mulighed for at have en anden netværksgrænseflade i samme netværkssegment end forælder, så virtuelle grænseflader arver altid netværkskonfigurationen fra dets forælder. Den forskellige parameter vil være ip. Virtual interface kan oprettes fra NIC eller VLAN. Oprettelse af en ny virtuel grænseflade vises et felt med et kolon ":" tegn, som vil blive brugt til at etablere en identifikation til den virtuelle grænseflade.

Liste Virtuelle grænseflader

Liste Virtuelle grænseflader

Forespørgselseksempel:

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

GET /interfaces/virtual

Få alle parametre af virtuelle grænseflader.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. IP'en skal være i samme netværkssegment end overordnet grænseflade.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker. Det arver fra overordnet grænseflade.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment. Det arver fra overordnet grænseflade.
mac	String	MAC af grænsefladen. Det arver fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af en overordnet grænseflade, et kolontegn “:” og navnet på den virtuelle netværksgrænseflade, alfanumeriske tegn er tilladt.
forælder	String	Det er grænsefladen, der bruges til at oprette denne.
status	String	Værdierne kan være up, grænsefladen kan modtage pakker; ned, grænsefladen kan ikke modtage pakker.

Hent virtuel grænseflade

Hent virtuel grænseflade

Forespørgselseksempel:

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>

Få alle parametre af en virtuel grænseflade. navn er grænsefladen unikke identifikator.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. IP'en skal være i samme netværkssegment end overordnet grænseflade.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker. Det arver fra overordnet grænseflade.
gateway	String	IP bruges til at sende pakker af et andet netværkssegment. Det arver fra overordnet grænseflade.
mac	String	MAC af grænsefladen. Det arver fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af en overordnet grænseflade, et kolontegn ":" og en alfanumerisk streng til den virtuelle netværksgrænseflade.
status	String	Værdierne kan være up, grænsefladen kan modtage pakker; ned, grænsefladen kan ikke modtage pakker.

Opret virtuel grænseflade

Opret virtuel grænseflade

Forespørgselseksempel:

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

Opret en virtuel grænseflade.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
ip	String	IP af grænsefladen. IP'en skal være i samme netværkssegment end overordnet grænseflade.	sand
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af en overordnet grænseflade, et kolontegn ":" og en alfanumerisk streng til den virtuelle netværksgrænseflade.	sand

Svar eksempel:

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

Response parametre

Svaret vil være en json med interface-konfigurationen. Se svareksempel for mere information.

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. IP'en skal være i samme netværkssegment end overordnet grænseflade.
netmaske	String	Definer netværkssegmentet, hvor grænsefladen virker. Det arver fra overordnet grænseflade.
gateway	String	IP bruges til at sende pakker til et andet netværkssegment. Det arver fra overordnet grænseflade.
mac	String	MAC af grænsefladen. Det arver fra overordnet grænseflade.
navn	String	Interface navn. Det bruges som unik identifikator. Dette navn er en kæde dannet af en overordnet grænseflade, et kolontegn “:” og en alpahnumerisk streng til den virtuelle netværksgrænseflade.

Modificer den virtuelle grænseflade

Modificer den virtuelle grænseflade

Forespørgselseksempel:

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>

Ændre parametrene for en virtuel grænseflade. navn er grænsefladen unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
ip	String	IP af grænsefladen. IP'en skal være i samme netværkssegment end overordnet grænseflade.

Svar eksempel:

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

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Slet den virtuelle grænseflade

Slet den virtuelle grænseflade

Forespørgselseksempel:

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>

Slet en virtuel grænseflade. navn er grænsefladen unikke identifikator.

Svar eksempel:

{
   "description" : "Delete virtual interface",
   "message" : "The virtual interface eth0:virtiface has been deleted.",
   "success" : "true"
}

Indstil Virtual Interface-handling

Indstil Virtual Interface-handling

Forespørgselseksempel:

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

Anvend en handling til en virtuel grænseflade. Dette opkald lader aktivere eller deaktivere en netværksgrænseflade.

navn er grænsefladen unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
Action	String	Handling til anvendelse på grænsefladen. De tilgængelige værdier er: up, aktiver grænsefladen og forberede den til at blive brugt ned, deaktiver grænsefladen for ikke at modtage eller ikke sende pakker.	sand

Svar eksempel:

{
   "description" : "Action on virtual interface",
   "params" : {
      "action" : "down"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Overvågning - Statistik

Vis oplysninger om system og gårde. Disse oplysninger vil være nyttige for at overvåge Zevenet load balancer status.

Vis systemstatistikker

Vis systemstatistikker

Forespørgselseksempel:

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

GET /stats

Få global systemstatistik.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
cpu	Object	CPU statistikker.
dato	String	System dato.
hostname	String	Værts navn.
belastning	Object	Kernelastestatistik.
hukommelse	Object	Brugt hukommelsesstatistik.
netværk	Object	Netværkstrafikstatistik.

CPU objekt:

Field	Type	Beskrivelse
kerner	nummer	Antal kerner i processoren.
tomgang	nummer	CPU bruger ikke noget program.
iowait	nummer	CPU bruges ved input eller output proces.
IRQ	nummer	CPU bruges af hardware interrrupcions.
rart	nummer	CPU planlægning prioritet.
softirq	nummer	CPU bruges af software interruptions.
sys	nummer	CPU bruges af systemet.
forbrug	nummer	Total CPU brugt.
bruger	nummer	CPU brugt af brugeren.

Indlæs objekt:

Field	Type	Beskrivelse
Last_1	nummer	Indlæs systemets andel i sidste øjeblik.
Last_5	nummer	Indlæs systemprocent for fem minutter siden.
Last_15	nummer	Indlæs systemprocent for femten minutter siden.

Hukommelsesobjekt.

Field	Type	Beskrivelse
Buffere	nummer	Det er den hukommelse, der bruges af bufferne. Dette beløb er angivet i Mb.
Cached	nummer	Det er den samlede hukommelse cached af systemet. Dette beløb er angivet i Mb.
MemFree	nummer	Det er den samlede ledige hukommelse, der ikke er cachelagret af systemet. Dette beløb er angivet i Mb.
MemTotal	nummer	Det er den samlede RAM-hukommelse på systemet. Dette beløb er angivet i Mb.
MemUsed	nummer	Det er den hukommelse der bruges af systemet. Dette beløb er angivet i Mb.
SwapCached	nummer	Det er den samlede cache hukommelse reserveret.
SwapFree	nummer	Det er den samlede ledige hukommelse, der ikke er cachelagret af systemet. Dette beløb er angivet i Mb.
SwapTotal	nummer	Det er den samlede swap-hukommelse reserveret.
SwapUsed	nummer	Det er den bytte, der bruges til hukommelsen af systemet, på optimale systemer skal 0 være.

Netværksobjekt:

Field	Type	Beskrivelse
ind i	nummer	Indtast trafik for dette grænseflade.
ude	nummer	Output trafik til dette grænseflade.

Vis netværksstatistik

Vis netværksstatistik

Forespørgselseksempel:

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

Få en oversigt over den samlede input- og outputtrafik via en netværksgrænseflade.

Svar eksempel:

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

Response parametre

Svaret vil være en JSON med en nøgle params hvis værdi er et objekt med følgende nøgler:

Field	Type	Beskrivelse
dato	String	System dato.
hostname	String	Værts navn.
grænseflader	Objekt[]	Netværkstrafikstatistik.

Interfaces objekt

Field	Type	Beskrivelse
in	String	Samlet inputtrafik i MB.
grænseflade	String	Interface navn.
ud	String	Total output trafik i MB.

Vis gårdsstatistik

Vis gårdsstatistik

Forespørgselseksempel:

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

GET /stats/farms

Få et resumé af forbindelser og konfiguration for alle gårde i systemet.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
etableret	nummer	Samlet antal nuværende etablerede forbindelser.
farmname	String	Landbrugsnavn, entydigt identifikator.
verserende	nummer	Antal ventende forbindelser.
profil	String	Type gård. De mulige værdier er: data link, l4xnat, http or https. Hver profil er defineret i sin sektion.
status	String	Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip	String	IP af gården, hvor den virtuelle tjeneste lytter.
VPort	String	Havnen på gården, hvor den virtuelle tjeneste lytter.

Vis en bedriftsstatistik

Vis en bedriftsstatistik

Forespørgselseksempel:

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>

Viser den aktuelle gårdsstatus, deres backend status og forbindelser. Hver gård vil reagere med forskellige objekter, afhængigt af profilen.

Svareksempel for HTTP gård:

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

Response parametre i HTTP gårde

Field	Type	Beskrivelse
backends	Objekt[]	Vis oplysninger om backends.
sessioner	Objekt[]	Vis oplysninger om sessioner.

Backend Object

Field	Type	Beskrivelse
etableret	nummer	Samlet antal etablerede forbindelser.
id	nummer	Backend unik identifikator.
ip	String	IP hvor den rigtige tjeneste lytter.
verserende	nummer	Antal ventende forbindelser.
port	nummer	Port, hvor den rigtige tjeneste lytter.
tjeneste	String	Servicenavn, der bruges som unik identifikator.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.

Session Object

Field	Type	Beskrivelse
kunde	String	Client unikke identifikator.
id	String	Backend unik identifikator tildelt til klienten.
tjeneste	String	Service unik identifikator tildelt til klienten.
Session	String	Session unik identifikator. Denne værdi afhænger af persistens typen.

Reaktionseksempel for L4xNAT gård:

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

Response parametre i L4xNAT gårde

Svaret bliver en JSON med nøgle backends og værdi et objekt array med nedenstående parametre.

Backend objekt:

Field	Type	Beskrivelse
etableret	nummer	Samlet antal nuværende etablerede forbindelser.
id	nummer	Backend unik identifikator.
ip	String	IP hvor den rigtige tjeneste lytter.
verserende	nummer	Antal ventende forbindelser.
port	nummer	Port, hvor den rigtige tjeneste lytter.
status	String	Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.

Response parametre i datalink gårde

Datalink gårdsstatistik er ikke tilgængelig faktisk.

Overvågning - Grafer

Dette afsnit er nyttigt at overvåge det interne belastningsbalancersystem til at registrere problemer via parametrene for CPU-brug, swap-hukommelse, RAM-hukommelse, alle konfigurerede nework-grænseflader, belastning og harddiskopbevaring.

Du vil også kunne få adgang til den ugentlige, mothly og årlige historie.

Grafer med oplysninger besvares i base64 format.

Liste ledige grafer

Liste ledige grafer

Forespørgselseksempel:

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

GET /graphs

Vis et objekt med alle tilgængelige grafer i systemet. Det viser den mulige anmodning, der kan foretages.

Svar eksempel:

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

Response parametre

Svaret vil være en JSON tre typer af grafer, gårde, grænseflader og systemet.

Field	Type	Beskrivelse
gårde	Snor[]	Liste over landbrugsgrafer tilgængelige.
grænseflader	Snor[]	Liste over grænseflader grafer tilgængelige.
systemet	Objekt[]	Liste over systemgrafer tilgængelige. Arrayet har et objekt med et array, som det angiver disk mount points.

System objekt:

Systemobjekt indeholder en matrixliste relateret til systemet og et diskobjekt med det næste format.

Field	Type	Beskrivelse
disk	Snor[]	Værdierne i dette array er alle eksisterende monteringspunkter I systemet har hver en tilgængelig graf.

Vis grafer

Vis grafer

Anmodning om eksempel på en gård:

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

Anmod om eksempel på en grænseflade:

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

Anmod om eksempel på en disk:

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>

De tilgængelige værdier for graf er:

Værdi	Beskrivelse
`farms/<farmname>`	farmname, farm unikke identifikator.
`interfaces/<interface>`	grænseflade, grænseflade unik identifikator.
`system/<system>`	systemet, mulige systemgrafer er: cpu, belastning, RAM or bytte.
`system/disk/<mount point>`	monteringspunkt, er en værdi af disk objekt, returneret af 'GET / grafer' opkald.

Svar eksempel:

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

Response parametre

Field	Type	Beskrivelse
frekvens	String	Tidsperiode brugt til at generere grafen. De mulige værdier er: dagligt, ugentlig, månedligt or årligt.
grafer	String	Graf i base 64 format.

Vis frekvensdiagram

Vis frekvensdiagram

Anmodning om eksempel på en gård:

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

Anmod om eksempel på en grænseflade:

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

Anmod om eksempel på en disk:

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>

De tilgængelige værdier for graf er:

Værdi	Beskrivelse
`farms/<farmname>`	farmname, farm unikke identifikator.
`interfaces/<interface>`	grænseflade, grænseflade unik identifikator.
`system/<system>`	systemet, mulige systemgrafer er: cpu, belastning, RAM or bytte.
`system/disk/<mount point>`	monteringspunkt, er en værdi af disk objekt, returneret af 'GET / grafer' opkald.

De tilgængelige værdier for frekvens er:

Field	Type	Beskrivelse
frekvens	String	Tidsperiode brugt til at generere grafen. De mulige værdier er: dagligt, ugentlig, månedligt or årligt.

Svar eksempel:

{
    "description" : "Get farm graphs",
    "graph" : "PNG IN BASE 64"
}

Response parametre

Field	Type	Beskrivelse
grafer	String	Graf i base 64 format.

System

System muligheder giver dig mulighed for at personalisere de tjenester, der kører i balanceren og de globale parametre.

Vis version

Vis version

Forespørgselseksempel:

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

GET /system/version

Vis informacion om produktversionen.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med nedenstående parametre.

Field	Type	Beskrivelse
appliance_version	String	Ansøgningsversion. Vis også hypervisor, hvis det er en virtuel maskine.
hostname	String	Værtsnavn.
kernel_version	String	Linux kernel version.
system_date	String	System dato.
zevenet_version	String	Zevenet Community Edition version.

Vis DNS

Vis DNS

Forespørgselseksempel:

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

GET /system/dns

Vis DNS-servicekonfigurationen.

Svar eksempel:

{
   "description" : "Get dns",
   "params" : {
      "primary" : "8.8.8.8",
      "secondary" : null
   }
}

Response parametre

Svaret vil være et JSON objekt med nedenstående parametre.

Field	Type	Beskrivelse
primære	String	Primær DNS konfigureret i systemet.
sekundær	String	Sekundær DNS konfigureret i systemet.

Ændre DNS

Ændre DNS

Forespørgselseksempel:

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

Rediger DNS-tjeneste konfiguration.

Anmod om parametre

Field	Type	Beskrivelse
primære	String	Primær DNS konfigureret i systemet.
sekundær	String	Sekundær DNS konfigureret i systemet.

Svar eksempel:

{
   "description" : "Post dns",
   "params" : {
      "primary" : "8.8.4.4",
      "secondary" : "8.8.8.8"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Vis SNMP

Vis SNMP

Forespørgselseksempel:

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

GET /system/snmp

Vis SNMP-servicekonfigurationen.

Svar eksempel:

{
   "description" : "Get snmp",
   "params" : {
      "community" : "public",
      "ip" : "*",
      "port" : "161",
      "scope" : "0.0.0.0/0",
      "status" : "false"
   }
}

Response parametre

Svaret vil være et JSON objekt med nedenstående parametre.

Field	Type	Beskrivelse
samfund	String	Gruppenavn. Læs kun Fællesskabet, der bruges.
ip	String	Interface IP, hvor SNMP-tjenesten kører. Det er sikkert at holde alle grænseflader aktiveret ved hjælp af Karakter *.
port	String	Port, hvor SNMP-tjenesten kører.
rækkevidde	String	IP eller subnet med adgang (IP / bit). Tilladte klient-IP'er til at tilgå SNMPD-tjeneste, hvis du kun vil tillade adgang til en IP, skal du bruge bit "/ 32".
status	String	Status for SNMP-tjeneste. De mulige værdier er: sandtjenesten kører; eller falsk, tjenesten stoppes.

Rediger SNMP

Rediger SNMP

Forespørgselseksempel:

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

Rediger SNMP-tjenestekonfigurationen.

Anmod om parametre

Field	Type	Beskrivelse
samfund	String	Gruppenavn. Læs kun Fællesskabet, der bruges.
ip	String	Interface IP, hvor SNMP-tjenesten kører. Det er sikkert at holde alle grænseflader aktiveret ved hjælp af Karakter *.
port	String	Port, hvor SNMP-tjenesten kører.
rækkevidde	String	IP eller subnet med adgang (IP / bit). Tilladte klient-IP'er til at tilgå SNMPD-tjeneste, hvis du kun vil tillade adgang til en IP, skal du bruge bit "/ 32".
status	String	Status for SNMP-tjeneste. De mulige værdier er: sandtjenesten kører; eller falsk, tjenesten stoppes.

Svar eksempel:

{
   "description" : "Post snmp",
   "params" : {
      "community" : "public",
      "ip" : "192.168.100.241",
      "port" : "170",
      "scope" : "0.0.0.0/0",
      "status" : "true"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Hent licens

Hent licens

Forespørgselseksempel:

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>

Vis Zevenet-licensen i et format. Den tilgængelige format værdier er html or txt.

Vis NTP

Vis NTP

Forespørgselseksempel:

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

GET /system/ntp

Vis konfigurationen af NTP-tjenesten.

Svar eksempel:

{
   "description" : "Get ntp",
   "params" : {
      "server" : "pool.ntp.org"
   }
}

Response parametre

Svaret vil være et JSON objekt med nedenstående parametre.

Field	Type	Beskrivelse
server	String	Server hvor NTP-klient gør anmodningerne.

Rediger NTP

Rediger NTP

Forespørgselseksempel:

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

Rediger konfigurationen af NTP-tjenesten.

Anmod om parametre

Field	Type	Beskrivelse
server	String	Server hvor NTP-klient gør anmodningerne.

Svar eksempel:

{
   "description" : "Post ntp",
   "params" : "pool.ntp.org"
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Liste over alle brugere

Liste over alle brugere

Forespørgselseksempel:

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

GET /system/users

Angiv de tilgængelige brugere i systemet.

Svar eksempel:

{
   "description" : "Get users",
   "params" : [
      {
         "status" : "true",
         "user" : "root"
      },
      {
         "status" : "true",
         "user" : "zapi"
      }
   ]
}

Response parametre

Svaret vil være et JSON objekt med en række af nedenstående parametre.

Field	Type	Beskrivelse
status	String	Brugerstatus. De mulige værdier er: sand, brugeren er aktiveret; eller ikke falsk, er brugeren desaktiveret.
bruger	String	Brugernavn.

Hent zapi-brugeren

Hent zapi-brugeren

Forespørgselseksempel:

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

Vis zapi-brugerkonfigurationen. Disse parametre er nødvendige for at få adgang til Zevenet-tjenester gennem zapi.

Svar eksempel:

{
   "description" : "Zapi user configuration.",
   "params" : {
      "key" : "root",
      "status" : "true"
   }
}

Response parametre

Svaret vil være et JSON objekt med en række af nedenstående parametre.

Field	Type	Beskrivelse
nøgle	String	Nøgle til at godkende i zapi. Dette er parameteren ZAPI_KEY bruges i opkald til zapi.
status	String	Zapi brugerstatus. Hvis dens værdi er sand, det er muligt at anvende zapi; eller ikke falsk, zapi er desaktiveret, og det er ikke muligt at sende den anmodning.

Rediger zapi brugerkonfiguration

Rediger zapi brugerkonfiguration

Forespørgselseksempel:

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

Rediger zapi-brugerkonfigurationen. Disse parametre er nødvendige for at få adgang til Zevenet-tjenester gennem zapi.

Anmod om parametre

Field	Type	Beskrivelse
nøgle	String	Nøgle til at godkende i zapi. Dette er parameteren ZAPI_KEY bruges i opkald til zapi.
nyt kodeord	String	Ny adgangskode til zapi-bruger.
status	String	Zapi brugerstatus. De mulige værdier er: muliggøre for at aktivere zapi-bruger eller deaktivere for at deaktivere zapi-brugeren. Hvis zapi-brugeren er deaktiveret, kan du ikke sende forespørgsler.

Svar eksempel:

{
   "description" : "Zapi user settings.",
   "message" : "Settings was changed successful.",
   "params" : {
      "key" : "newzapikey",
      "newpassword" : "password1234",
      "status" : "enable"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Rediger rodadgangskode

Rediger rodadgangskode

Forespørgselseksempel:

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

Rediger rodadgangskoden. Denne bruger bruges til at få adgang til syv tjenester via GUI

Anmod om parametre

Field	Type	Beskrivelse	påkrævet
adgangskode	String	Nuværende root brugeradgangskode.	sand
nyt kodeord	String	Nyt kodeord til root-bruger.	sand

Svar eksempel:

{
   "description" : "User settings.",
   "message" : "Settings was changed succesful.",
   "params" : {
      "newpassword" : "alwaysisbetterastrongpass",
      "password" : "admin"
   }
}

Response parametre

Svaret bliver en json med alle ønskede værdier opdateret. Se svareksempel for mere information.

Liste logfiler

Liste logfiler

Forespørgselseksempel:

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

GET /system/logs

Angiv de tilgængelige logfiler.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON med en række logfiler. Parametrene for hvert objekt er:

Field	Type	Beskrivelse
dato	String	Datoen for den sidste filændring.
fil	String	Filnavn på logfiler. Den bruges som log unik identifikator.

Vis linjer af en logfiler

Vis linjer af en logfiler

Forespørgselseksempel:

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>

Skriv en række linjer i en logfil. URI param fil er logfilen fra læsning. Lines er antallet af linjer at vise fra finalen.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON med en række logfiler. Nøglen er log og dens værdi er et array med antallet af ønskede linjer.

Download en logfil

Download en logfiler

Forespørgselseksempel:

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>

Download en logfil af de tilgængelige logfiler, der er angivet under GET-anmodningen.

fil er logfilens unikke identifikator.

System - Backups

Med Backup-indstillingen kan du gemme den nuværende systemkonfiguration og downloade den.

I dette afsnit vil du kunne oprette, gendanne, uploade og downloade backupfiler.

Liste backups

Liste backups

Forespørgselseksempel:

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

GET /system/backup

Svar eksempel:

{
   "description" : "Get backups",
   "params" : [
      {
         "date" : "Fri Feb  3 06:01:04 2017",
         "name" : "newbackup"
      },
      {
         "date" : "Fri Feb  3 05:50:48 2017",
         "name" : "firstConf"
      }
   ]
}

Response parametre

Svaret vil være en JSON med en række sikkerhedskopier. Parametrene for hvert arrayelement er:

Field	Type	Beskrivelse
dato	String	Datoen for den sidste ændring.
navn	String	Det er filnavnet, der bruges som en unik identifikator. Filforlængelsen er `.tar.gz`.

Opret en sikkerhedskopi

Opret en sikkerhedskopi

Forespørgselseksempel:

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

Opret en systemkonfigurationskopi af den nuværende konfiguration.

Anmod om parametre

Field	Type	Beskrivelse
navn	String	Det er filnavnet, der bruges som en unik identifikator. Filforlængelsen er `.tar.gz`.

Svar eksempel:

{
   "description" : "Create a backups",
   "message" : "Backup firstConf was created successful.",
   "params" : "firstConf"
}

Download en sikkerhedskopi

Download en sikkerhedskopi

Forespørgselseksempel:

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

Backupfilen er i TAR GZ-format.

GET /system/backup/<name>

Download en systemkonfigurationskopi. navn er den backup unikke identifikator.

Upload en sikkerhedskopi

Upload en sikkerhedskopi

Forespørgselseksempel:

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>

Upload en lokal gemt backup til Zevenet. navn er den backup unikke identifikator, som vil blive gemt i Zevenet.

Anmod om parametre

Det er nødvendigt at bruge –data-binær for at uploade en sikkerhedskopi.

Svar eksempel:

{
   "description" : "Upload a backup",
   "message" : "Backup newbackup was created successful.",
   "params" : "newbackup"
}

Slet en sikkerhedskopi

Slet en sikkerhedskopi

Forespørgselseksempel:

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>

Slet en sikkerhedskopieringsfil fra Zevenet-systemet. navn er den backup unikke identifikator.

Svar eksempel:

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

Anvend en sikkerhedskopi

Anvend en sikkerhedskopi

Forespørgselseksempel:

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

Gendan konfigurationen fra en backup-fil. navn er den backup unikke identifikator.

Anmod om parametre

Field	Type	Beskrivelse
Action	String	For at gendanne sikkerhedskonfigurationen skal værdien være ansøge.

Svar eksempel:

{
   "description" : "Apply a backup to the system",
   "params" : {
      "action" : "apply"
   }
}

Download en supportsave

Download en supportsave

Forespørgselseksempel:

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

Få systemstatusbillede med alle konfigurationer og processer, der kører i systemet. Denne understøttelse er nødvendigt for at finde problemer eller støttehjælp.