NAV Navbar
Logo
Shell

Zevenet API v3 Reference

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 / zapi.cgi /URI_path.

zevenet_server er den IP, hvor HTTP-tjenesten lytter.

URI_path definerer objektet eller handlingen. Dets opførsel og dens parametre vil blive defineret inden for hver enkelt dokumen- tationsafdeling.

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

Vis certifikatoplysninger

Vis certifikatoplysninger

Forespørgselseksempel:

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

GET /certificates/<file>/info

Vis alle de oplysninger, der er indeholdt i et givet certifikat i certifikatbutikken, herunder underskrifter, det er påkrævet, at filnavnet skal referere.

Svar eksempel:

Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number: 14346016480403539444 (0xc71749fb005a45f4)
    Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Validity
            Not Before: Jan 12 14:49:03 2011 GMT
            Not After : Jan  9 14:49:03 2021 GMT
        Subject: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (1024 bit)
                Modulus:
...

Vis aktiveringsattestoplysninger

Vis aktiveringsattestoplysninger

Forespørgselseksempel:

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

GET /certificates/activation

Vis alle de oplysninger, der er inkluderet i aktiveringsattesten, herunder underskrifter, dette certifikat er gemt i certifikatbutikken. Hvis aktiveringscertifikatet er slettet, deaktiveres produktet.

Slet et certifikat

Slet et certifikat

Forespørgselseksempel:

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

Slet aktiveringscertifikatet

Slet aktiveringscertifikatet

Forespørgselseksempel:

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

DELETE /certificates/activation

Slet aktiveringsattesten, der er installeret i certifikatbutikken. Hvis dette certifikat er slettet, er belastningsbalancen deaktiveret.

Svar eksempel:

{
   "description" : "Delete activation certificate",
   "message" : "The activation certificate 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/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/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"
}

Upload et aktiveringscertifikat

Upload et aktiveringscertifikat

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/path/to/example.pem
https://<zevenet_server>:444/zapi/v3/zapi.cgi/certificates/activation

POST /certificates/activation

Upload et aktiveringscertifikat med PEM-format, dette certifikat er nødvendigt for at aktivere alle funktionaliteter. Dette certifikat er gemt i certifikatbutikken, hvis aktiveringscertifikatet findes i certifikatbutikken, overskrives det forrige certifikat.

Svar eksempel:

{
   "description" : "Upload activation certificate",
   "message" : "Activation certificate uploaded",
   "success" : "true"
}

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, Global Service Load Balancer eller GSLB 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.

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/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 til LSLB modul, GSLB for GLSB modul og data link til DSLB modul
status String Farm status, status tilgængelige værdier er: up, gården løber eller ned, gården er stoppet
vip String Virtual IP hvor gården modtager trafik
VPort String Virtuel port, hvor gården modtager trafik, port tilgængelige værdier er: et portnummer for http [s], l4xnat og gslb profiler, en gruppe af porte adskilt af “,” eller et portområde adskilt af “:” for l4xnat profiler, i l4xnat kan begge separatorværdier (“,” og “:”) bruges i 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/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/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-lag 7 belastningsbalancering kombineret med SSL offload acceleration. 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/zapi.cgi/farms/httpFarm

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Svar eksempel:

{
   "description" : "List farm httpFarm",
   "ipds" : {
      "blacklists" : [
         "rem"
      ],
      "dos" : []
   },
   "params" : {
      "certlist" : [
         {
            "file" : "zencert.pem",
            "id" : 1
         }
      ],
      "cipherc" : "ALL",
      "ciphers" : "all",
      "contimeout" : 20,
      "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" : "down",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "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
            }
         ],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "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
IPDS Object Liste over IPDS regler anvendt på denne gård.
params Object Parametre for gårdskonfiguration.
tjenester Objekt[] Array med alle tjenester skabt i denne gård og dens konfiguration.

IPDS-objekt:

Field Type Beskrivelse
sortlister Snor[] Blacklist regler anvendes på gården.
dos Snor[] DoS regler gælder for gården.

Parametre objekt for HTTP gårde:

Field Type Beskrivelse
certlist Objekt[] Kun i https profil. Certifikatliste aktiveret på gården, i pem-format, er det tilladt at tilføje mere end ét pem certifikat til samme gård til SNI support. lytter med https værdi er påkrævet. Ethvert 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, vil alle cifre 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.
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 mulige værdier er: upgården går; ned, gården er stoppet eller nødvendige genstart, gården skal genstartes for at de seneste ændringer kan træde i kraft.
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, rækkefølgen på listen, den første, bruges som standard, hvis den virtuelle værtsoverskrift ikke stemmer overens med CN-feltet i certifikatet. Bruges til SNI.

Servicesobjekt for HTTP-bedrifter:

Field Type Beskrivelse
backends Objekt[] Backends defineret i tjenesten.
cookiedomain String Cookie insertion vil blive udført, hvis domæne matcher i cookie indholdet. Aktiver cookieinsert Felt er påkrævet.
cookieinsert String Det gør det muligt at indsætte cookie til backends klæbrig sessioner. Indstillingerne er sand, vil profilen søge efter den givne cookie i feltet cookiename, hvis den ikke findes, tilføjes denne cookie, falsk, er der ikke taget skridt.
cookiename String Cookie-navnet (session-id) vil blive brugt til at identificere den klæbende proces til bagsiden. Aktiver cookieinsert Felt er påkrævet.
cookiepath String Det styrer cookie path værdien for den givne cookie. Aktiver cookieinsert Felt er påkrævet.
cookiettl nummer Det er den maksimale levetid for en cookie i sekunder. Aktiver cookieinsert Felt er påkrævet.
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. Værdien kan være: up backend er klar til at modtage forbindelser, vedligeholdelse backend er markeret som ikke klar til modtagelse af forbindelser, denne mulighed er nyttig til backend's vedligeholdelsesopgaver.
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/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" : {
      "interface" : "eth0.2",
      "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, 
"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",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3/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.
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 https-lytteren. Dette felt bruges til at opbygge en liste over cifre accepteret af SSL-forbindelser for at hærde SSL-forbindelsen. Indstillingerne er: alle, vil alle cifre 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,
      "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/zapi.cgi/farms/httpFarm/certificates

POST /farms/<farmname>/certificates

Inkluder et tilgængeligt PEM-certifikat på SNI-listen eller certlist array af en HTTP gård 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 SNI list of farm httpFarm, you need restart the farm to apply",
   "success" : "true",
   "status": "needed restart"
}

Slet et certifikat

Slet et certifikat

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/MyHttpFarm/certificates/example.pem

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

Slet certifikatet med det valgte filnavn fra certlisten i HTTP-gården med HTTPS-lytteren. Certifikatet slettes ikke i certifikatbutikken.

Svar eksempel:

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

Tilføj en IPDS-regel

Tilføj en IPDS-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm/ipds/blacklists

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

Anvend en sortliste eller DoS-regel til gården.

Anmod om parametre

Field Type Beskrivelse
navn String IPDS-reglenavn, der bruges som unik identifikator.

Svar eksempel:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm httpFarm.",
   "success" : "true"
}

Fjern en IPDS-regel

Fjern en IPDS-regel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/httpFarm/ipds/blacklists/china

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

Fjern en sortliste eller DoS-regel fra en given gård ved hjælp af dens idenficator navn.

Svar eksempel:

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

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.

For en komplet beskrivelse af Serviceobjekt i en HTTP-gård henvises til HTTP Farms> Hent gård ved navn> Table Services-objekt til HTTP-gårde

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/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/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.
cookieinsert String Det gør det muligt at indsætte cookie til backends klæbrig sessioner. Indstillingerne er sand, vil profilen søge efter den givne cookie i feltet cookiename, hvis den ikke findes, tilføjes denne cookie, falsk, indsætnings cookie er deaktiveret.
cookiename String Cookie-navnet (session-id) vil blive brugt til at identificere den klæbende proces til bagsiden. Aktiver cookieinsert Felt er påkrævet.
cookiedomain String Cookie insertion vil blive udført, hvis domæne matcher i cookie indholdet. Aktiver cookieinsert Felt er påkrævet.
cookiepath String Den administrerer cookiesti-værdien for den givne cookie, hvis URI i klientanmodningen eller backend-svaret ikke stemmer overens med cookiepath, anvendes ikke persistensmetoden til cookieindsættelse. Aktiver cookieinsert Felt er påkrævet.
cookiettl nummer Det er den maksimale levetid for en cookie i sekunder. Aktiver cookieinsert Felt er påkrævet.
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" : [],
      "cookiedomain" : "",
      "cookieinsert" : "false",
      "cookiename" : "",
      "cookiepath" : "",
      "cookiettl" : 0,
      "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/zapi.cgi/farms/FarmHTTP/fg

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.

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

Flyt tjenester

Flyt tjenester

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/FarmHTTP/services/service1/actions

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

Disse handlinger flytter den givne tjeneste op eller ned i servicelisten. Denne mulighed er nyttig, hvis det er nødvendigt at ændre prioriteringsordren, bemærk at tjenester evalueres i samme rækkefølge, som vises. Denne handling genstarter gården automatisk.

id er tjenesten unikke identifikator, som vil blive ændret.

Forespørgselsparametre

Field Type Beskrivelse påkrævet
position nummer Placering hvor vil være tjenesten. Første position har indekset 0. sand

Svar eksempel:

{
   "description" : "Move service",
   "message" : "service1 was moved successful.",
   "params" : {
      "position" : 0
   }
}

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/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/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 unikke 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. Værdien kan være: up backend er klar til at modtage forbindelser, vedligeholdelse backend er markeret som ikke klar til modtagelse af forbindelser, denne mulighed er nyttig til backend's vedligeholdelsesopgaver.

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

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.

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"}'
 https://<zenlb_server>:444/zapi/v3/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
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.

Svar eksempel:

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

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/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/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",
         "port" : "88",
         "priority" : 2,
         "status" : "up",
         "weight" : 1
      },
      {
         "id" : 1,
         "ip" : "192.168.55.41",
         "port" : "88",
         "priority" : 3,
         "status" : "up",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "ipds" : {
      "blacklists" : [],
      "dos" : []
   },
   "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
IPDS Object Liste over IPDS regler anvendt på denne gård.
params Object Parametre for gårdskonfiguration.
backends Objekt[] Alle rigtige servere skabt i denne gård og dens konfiguration.

IPDS-objekt:

Field Type Beskrivelse
sortlister Snor[] Sorte listeregler anvendes på gården.
dos Snor[] DoS regler gælder for gården.

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 mulige værdier er: up gården løber og fanger trafik, ned gården er nede og ikke fanger nogen trafik.
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.
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. Værdien kan være: up backend er klar til at modtage forbindelser, vedligeholdelse backend er ikke klar til at modtage forbindelser.
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/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/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.
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.
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/zapi.cgi/farms/l4farm/fg

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.

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.

Tilføj en IPDS-regel

Tilføj en IPDS-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4Farm/ipds/blacklists

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

Anvend en sortliste eller DoS-regel til en gård.

Anmod om parametre

Field Type Beskrivelse
navn String IPDS-reglenavn, der bruges som unik identifikator.

Svar eksempel:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm l4Farm.",
   "success" : "true"
}

Fjern en IPDS-regel

Fjern en IPDS-regel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/l4Farm/ipds/blacklists/china

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

Fjern en sortliste eller DoS-regel af IPDS-modul fra en given gård ved hjælp af dens idenficator navn.

Svar eksempel:

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

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/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. Værdien kan være: up backend er klar til at modtage forbindelser, vedligeholdelse backend er ikke klar til at modtage forbindelser.
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/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/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"}'
 https://<zenlb_server>:444/zapi/v3/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
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.

Svar eksempel:

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

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

GSLB Farms

Den globale servicebelastningsbalancering, der almindeligvis hedder GSLB, gør det muligt at oprette en belastningsbalanceringstjeneste baseret på DNS-servicehierarkisk arkitektur. Denne slags gård giver en autoritativ eneste DNS med belastningsbalanceringsalgoritmer og servicetilstandsdetektering ved DNS-applikationslag.

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/zapi.cgi/farms/gslbfarm

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Svar eksempel:

{
   "description" : "List farm gslbfarm",
   "ipds" : {
      "blacklists" : [],
      "dos" : []
   },
   "params" : {
      "status" : "needed restart",
      "vip" : "192.168.100.155",
      "vport" : 60
   },
   "services" : [
      {
         "algorithm" : "roundrobin",
         "backends" : [
            {
               "id" : 1,
               "ip" : "127.0.0.1"
            },
            {
               "id" : 2,
               "ip" : "192.168.55.40"
            },
            {
               "id" : 4,
               "ip" : "192.135.10.2"
            }
         ],
         "deftcpport" : 53,
         "fgenabled" : "true",
         "fgscript" : "check_tcp",
         "fgtimecheck" : 5,
         "id" : "service1"
      },
      {
         "algorithm" : "prio",
         "backends" : [
            {
               "id" : 1,
               "ip" : "127.0.0.1"
            },
            {
               "id" : 2,
               "ip" : "127.0.0.1"
            }
         ],
         "deftcpport" : 80,
         "fgenabled" : "false",
         "fgscript" : "",
         "fgtimecheck" : 5,
         "id" : "prioServ"
      }
   ],
   "zones" : [
      {
         "defnamesv" : "ns3",
         "id" : "global.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns3",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns3",
               "ttl" : null,
               "type" : "A"
            },
            {
               "id" : 3,
               "rdata" : "resource2",
               "rname" : "ns2",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 4,
               "rdata" : "192.168.200.30",
               "rname" : "resource2",
               "ttl" : null,
               "type" : "A"
            }
         ]
      },
      {
         "defnamesv" : "ns1",
         "id" : "DOM.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns1",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns1",
               "ttl" : null,
               "type" : "A"
            }
         ]
      }
   ]
}

Response parametre

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

Farm Object:

Field Type Beskrivelse
IPDS Object Liste over IPDS regler anvendt på denne gård.
params Object Parametre for gårdskonfiguration.
tjenester Objekt[] Array med alle tjenester skabt i denne gård og dens konfiguration.
zoner Objekt[] Array med alle zoner oprettet i denne gård og dens konfiguration.

IPDS-objekt:

Field Type Beskrivelse
sortlister Snor[] Sorte lister anvendes til gården.
dos Snor[] DoS regler gælder for gården.

Parameter objekt for GSLB gårde:

Field Type Beskrivelse
vip String IP af gården, hvor den virtuelle tjeneste lytter.
VPort nummer Havnen på gården, hvor den virtuelle tjeneste lytter.
status String Farm status. De mulige værdier er: upgården går; ned, gården er stoppet eller nødvendige genstart, gården skal genstartes for at de seneste ændringer kan træde i kraft.

Serviceobjekt for GSLB gårde:

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 GSLB-profiler udføres en tcp-check som standard, selvom værger er deaktiveret.
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 vil kontrollere hvert 'timetocheck' sekund af backendens sundhedsstatus. fgenabled er nødvendigt.
id String Servicenavn, der bruges som unik identifikator.
algoritme String Type belastningsbalanceringsalgoritme anvendt i tjenesten. Indstillingerne er: runde Robin, som vil afbalancere forbindelser mellem alle backends, eller Prio som sender alle forbindelser til den første tilgængelige backend.
deftcpport nummer Standard TCP port sundhedskontrol. Dette er den sundhedskontrol TCP-port, som tjenesten skal kontrollere for at bestemme, at backend-tjenesten lever. En tom værdi er deaktiveret.

Backend objekt til GSLB gårde:

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.

Zone objekt:

Field Type Beskrivelse
id nummer Zones navn bruges som en unik detektor.
defnamesv String Dette vil være startpunktets rodnavneserver, der vil være tilgængelig som DNS-posten Start of Authority (SOA).
ressourcer Objekt[] Ressourcer defineret i zonen.

Ressource objekt:

Field Type Beskrivelse
id nummer Unik identifikator for ressourcen i zonen.
rname String Resource-navnet er det nick, som DNS-tjenesten oversætter til de rigtige data i feltet rdata.
ttl nummer Den tid til live (valgfri) værdi for den aktuelle post, som det er nødvendigt for at bestemme hvor lang tid det aktuelle navn vil blive cachelagret.
typen String DNS-posttype. Indstillingerne er: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). For mere information, se på GSLB - Zones - Ressourcer sektion.
rdata String Det er de rigtige data, der kræves af posttypen, inputværdien afhænger af typen af ​​ressourcenavn, rname og ressourcetypen, typen.

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":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}' 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms

POST /farms

Opret en ny GSLB gård.

Anmod om parametre

Field Type Beskrivelse påkrævet
farmname String Farmens navn, unikke identifikator for gården. sand
profil String Profilen til den oprettede Farm. For GSLB gårde er GSLB. sand
vip String IP af gården, hvor den virtuelle tjeneste lytter. sand
VPort nummer Havnen på gården, hvor den virtuelle tjeneste lytter. sand

Svar eksempel:

{
   "description" : "Creating farm 'gslbfarm'",
   "params" : {
      "farmname" : "gslbfarm",
      "interface" : "eth0",
      "profile" : "gslb",
      "vip" : "192.168.100.241",
      "vport" : 53
   }
}

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":"gslbnewname","vip":"192.168.100.155","vport":60}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm

PUT /farms/<farmname>

Rediger konfigurationen af ​​en GSLB farm.

Anmod om parametre

Field Type Beskrivelse
newfarmname String Den nye gårds navn. Gården skal stoppes for at udføre denne ændring.
VPort nummer Havnen på gården, hvor den virtuelle tjeneste lytter.
vip String IP af gården, hvor den virtuelle tjeneste lytter.

Svar eksempel:

{
   "description" : "Modify farm gslbnewname",
   "params" : {
      "newfarmname" : "gslbnewname",
      "vip" : "192.168.100.155",
      "vport" : 60
   }
}

Response parametre

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

Tilføj en IPDS-regel

Tilføj en IPDS-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbFarm/ipds/blacklists

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

Anvend en sortliste eller DoS-regel til gården.

Anmod om parametre

Field Type Beskrivelse
navn String IPDS-reglenavn, der bruges som unik identifikator.

Svar eksempel:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
   "success" : "true"
}

Fjern en IPDS-regel

Fjern en IPDS-regel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbFarm/ipds/blacklists/china

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

Fjern en sortliste eller DoS-regel fra en given gård ved hjælp af dens idenficator navn.

Svar eksempel:

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

GSLB - Services

En GSLB-tjeneste repræsenterer en gruppe af ægte servere og en tilknyttet algoritme, der skal bruges til dem. For at oprette en ny tjeneste skal du angive et gyldigt identifikationsnavn og den ønskede algoritme, der skal bruges.

De tilgængelige tjenester er:

Round Robin: lige deling. En lige ligevægt i trafikken til alle aktive reelle servere. For hver indkommende forbindelse tildeler balanceren den næste runde robins ægte server for at levere anmodningen.

Prioritet: Tilslutninger altid til den mest tilgængelige prio. Afbalancere alle forbindelser til samme højeste prioritetsserver. Hvis denne server er nede, skifter forbindelserne til næste højeste server. Med denne algoritme kan du opbygge en Active-Pasive Cluster-tjeneste med flere rigtige servere.

Services genstand for GSLB gårde

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 GSLB-profiler udføres en tcp-check som standard, selvom værger er deaktiveret.
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 vil kontrollere hver 'timetocheck' sekunder af backendens sundhedsstatus. fgenabled er nødvendigt.
id String Servicenavn, der bruges som unik identifikator.
algoritme String Type belastningsbalanceringsalgoritme anvendt i tjenesten. Indstillingerne er: runde Robin, som vil afbalancere forbindelser mellem alle backends, eller Prio som sender alle forbindelser til den første tilgængelige backend.
deftcpport String Standard TCP port sundhedskontrol. Dette er den sundhedskontrol TCP-port, som tjenesten skal kontrollere for at bestemme, at backend-tjenesten lever. En tom værdi er deaktiveret.

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":"service1","algorithm":"roundrobin"}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services

POST /farms/<farmname>/services

Opret en tjeneste i en given GSLB Farm. Gården skal genstartes for at anvende denne ændring.

Anmod om parametre

Field Type Beskrivelse påkrævet
id String Servicenavn, der bruges som unik identifikator. sand
algoritme String Type belastningsbalanceringsalgoritme anvendt i tjenesten. Indstillingerne er: runde Robin, som vil afbalancere forbindelser mellem alle backends, eller Prio som sender alle forbindelser til den første tilgængelige backend. sand

Svar eksempel:

{
   "description" : "New service service1",
   "params" : {
      "algorithm" : "roundrobin",
      "id" : "service1"
   },
   "status" : "needed restart"
}

Response parametre

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

Ændre en tjeneste

Ændre en tjeneste

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"deftcpport":53}' https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1

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

Ændre parametrene for en tjeneste i en GSLB Farm. id er tjenesten unikke identifikator, som vil blive ændret.

Anmod om parametre

Field Type Beskrivelse
deftcpport nummer Dette er den sundhedskontrol TCP-port, som tjenesten skal kontrollere for at bestemme, at backend-tjenesten lever.

Svar eksempel:

{
   "description" : "Modify service service1 in farm gslbfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "deftcpport" : 53
   },
   "status" : "needed restart"
}

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":"check_tcp","fgenabled":"true",
"service":"service1"}' https://<zevenet_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/fg

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.

PUT /farms/<farmname>/fg

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

Anmod om parametre

Field Type Beskrivelse påkrævet
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 GSLB-profiler udføres en tcp-check som standard, selvom fgenabled er deaktiveret.
fgscript String Kommandoen, som gårdsholderen vil bruge til at kontrollere ryggenes sundhed. sand aktiveret, falsk, handicappet. sandt hvis fgenabled er aktiveret.
fgtimecheck nummer Gårdens værge vil kontrollere hver 'timetocheck' sekunder af backendens sundhedsstatus. fgenabled er nødvendigt.
tjeneste String Tjenesteidentifikatoren, id, hvilken farm vogter vil ændre. sand

Svar eksempel:

{
   "description" : "Modify farm guardian",
   "message" : "Success, some parameters have been changed in farm guardian in farm gslbfarm.",
   "params" : {
      "fgenabled" : "true",
      "fgscript" : "check_tcp",
      "fgtimecheck" : 5
   },
   "status" : "needed restart"   
}

Response parametre

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

Slet en tjeneste

Slet en tjeneste

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1

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

Slet en given tjeneste hos en GSLB Farm. id er tjenesten unikke identifikator, som vil blive slettet.

Svar eksempel:

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

GSLB - Services - Backends

Dette afsnit styrer den reelle service liste, der er knyttet til en tjeneste.

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/zapi.cgi/farms/gslbfarm/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" : 1,
         "ip" : "127.0.0.1"
      },
      {
         "id" : 2,
         "ip" : "192.168.55.40"
      }
   ]
}

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 IP af backend, hvor den rigtige tjeneste lytter.

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.135.10.2"}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends

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

Opret en ny backend i en given tjeneste i en GSLB Farm. id er tjenesten unikke identifikator, hvor backend vil blive tilføjet.

De prioriterede tjenester har 2 backends som maximun, den aktive vært og den passive vært.

Anmod om parametre

Field Type Beskrivelse påkrævet
ip String IP af backend, hvor den rigtige tjeneste lytter. sand

Svar eksempel:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 4,
      "ip" : "192.135.10.2"
   },
   "status" : "needed restart"
}

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.2.30"}' 
  https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/services/service1/backends/1

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

Ændre parametrene for en backend i en tjeneste af en GSLB Farm.

Bemærk i PUT over det første id er tjenesten unikke identifikator og næste id er backend unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
ip String IP af backend, hvor den rigtige tjeneste lytter.

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.2.30"
   },
   "status" : "needed restart"
}

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/zapi.cgi/farms/gslbfarm/services/service1/backends/3

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

Slet en given backend i en tjeneste af en GSLB Farm

Svar eksempel:

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

GSLB - Zones

GSLB-sektionsafsnittet beskriver DNS-domænenavnet, underdomænerne, aliaserne osv., Som skal bruges til at generere en komplet DNS-zone med yderligere belastningsbalanceringsoptegnelser ved hjælp af de definerede tjenester.

Opret zone

Opret zone

Forespørgselseksempel:

curl  -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"id":"global.conf"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones

POST /farms/<farmname>/zones

Opret en DNS-zone.

Forespørgselsparametre

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

Field Type Beskrivelse påkrævet
id nummer Zones navn bruges som en unik detektor. sand

Svar eksempel:

{
   "description" : "New zone global.com",
   "params" : {
      "id" : "global.com"
   }
}

Response parametre

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

Ændre en zone

Ændre en zone

Forespørgselseksempel:

curl  -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"defnamesv":"ns3"}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com

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

Ændre parametrene i en zone. id er zonen unikke identifikator, som vil blive ændret.

Forespørgselsparametre

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

Field Type Beskrivelse
defnamesv String Dette vil være startpunktets rodnavneserver, der vil være tilgængelig som DNS-posten Start of Authority (SOA).

Svar eksempel:

{
   "description" : "Modify zone global.com in farm gslbfarm",
   "params" : {
      "defnamesv" : "ns3"
   }
}

Response parametre

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

Slet en zone

Slet en zone

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/dom.com

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

Slet en given zone i en GSLB Farm.

Svar eksempel:

{
   "description" : "Delete zone dom.com in farm gslbfarm.",
   "message" : "The zone dom.com in farm gslbfarm has been deleted.",
   "success" : "true"
}

GSLB - Zones - Ressourcer

Ressourcer defineret som DNS-tjenesten løser anmodninger. De mulige DNS-ressourcer i Zevenet lastbalancer er:

  1. NS. Navn Server type rekord, det delegerer en DNS-zone til at bruge de givne autoritative navneservere.
  2. A. Adressetype-rekord, det returnerer en IPv4-adresse til en vært.
  3. CNAME. Kanonisk navn type rekord, det repræsenterer et alias af et givet navn.
  4. DYNA. Dynamisk adressetype rekord, returnerer den en dynamisk adresse angivet af en GSLB-tjeneste, der allerede er oprettet inden for gårdskonfigurationen ifølge algoritmen valgt til en sådan tjeneste.
  5. AAAA. Adressetype-rekord, det returnerer en IPv6-adresse til en vært.
  6. MX. Mail udveksling typepost, kort et domænenavn til en liste over meddelelsesoverførselsagenter for det pågældende domæne.
  7. SRV. Service locator type rekord, Generalized service location record, der bruges til nyere protokoller i stedet for at oprette protokollespecifikke poster som MX.
  8. TXT. Tekst type rekord, den bruges til at gemme tekstbaseret information, der kan tages, når det er nødvendigt. Vi ser sædvanligvis TXT-poster, der bruges til at holde SPF-data og verificere domæneejerskab.
  9. PTR. Pointer record, peger på et kanonisk navn. I modsætning til en CNAME stopper DNS-behandling, og kun navnet returneres. Den mest almindelige anvendelse er at implementere reverse DNS opslag.
  10. NAPTR. Navngivningsautoritetspeger, Tillader regelmæssig ekspressionbaseret omskrivning af domænenavne, som derefter kan bruges som URI'er, yderligere domænenavne til opslag osv.

Liste over ressourcerne

Liste over ressourcerne

Forespørgselseksempel:

curl  -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources

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

Få listen over ressourcer i en zone. id er zonen unikke identifikator.

Svar eksempel:

{
   "description" : "List zone resources",
   "params" : [
      {
         "id" : 0,
         "rdata" : "ns3",
         "rname" : "@",
         "ttl" : null,
         "type" : "NS"
      },
      {
         "id" : 1,
         "rdata" : "192.168.100.155",
         "rname" : "ns3",
         "ttl" : null,
         "type" : "A"
      },
      {
         "id" : 2,
         "rdata" : "192.168.0.9",
         "rname" : "resource2",
         "ttl" : 10,
         "type" : "A"
      },
      {
         "id" : 3,
         "rdata" : "resource2",
         "rname" : "ns2",
         "ttl" : null,
         "type" : "NS"
      }
   ]
}

Response Parametre

Dette opkald returnerer et ressourceobjekt array med bellow parametrene.

Field Type Beskrivelse
id nummer Unik identifikator for ressourcen i zonen.
rname String Resource-navnet er det nick, som DNS-tjenesten oversætter til de rigtige data i feltet rdata.
ttl nummer Den tid til live (valgfri) værdi for den aktuelle post, som det er nødvendigt for at bestemme hvor lang tid det aktuelle navn vil blive cachelagret.
typen String DNS-posttype. Indstillingerne er: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). For mere information, se på GSLB - Zones - Ressourcer sektion.
rdata String Det er de rigtige data, der kræves af posttypen, inputværdien afhænger af typen af ​​ressourcenavn, rname og ressourcetypen, typen.

Opret en ny ressource

Opret en ny ressource

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.0.9", "ttl":10, "type":"A" }' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources

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

Opret en ny ressource i en given zone i en GSLB Farm. id er zonen unikke identifikator som vil blive ændret, hvor ressourcen vil blive tilføjet.

Anmod om parametre

Field Type Beskrivelse påkrævet
rname String Resource-navnet er det nick, som DNS-tjenesten oversætter til de rigtige data i feltet rdata. sand
ttl nummer Time to Live-værdien for den aktuelle post. Det er maksimalt antal router enheder, som anmodningen kan gennem til dø. Det er nyttigt at pakken ikke indtaster i en netløkke.
typen String DNS-posttype. Indstillingerne er: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). For mere information, se på GSLB - Zones - Ressourcer sektion. sand
rdata String Det er de rigtige data, der kræves af posttypen, inputværdien afhænger af typen af ​​ressourcenavn, rname og ressourcetypen, typen. hvis DYNA er valgt i typen så skal rdata-værdien være en af ​​de konfigurerede tjenester i denne zone. sand

Svar eksempel:

{
   "description" : "New zone resource",
   "message" : "Resource added",
   "params" : {
      "rdata" : "192.168.0.9",
      "rname" : "resource2",
      "ttl" : 10,
      "type" : "A",
      "zone" : "global.com"
   }
}

Response parametre

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

Rediger en ressource

Rediger en ressource

Forespørgselseksempel:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"rname":"resource2", "rdata":"192.168.200.30","ttl":null, "type":"A" }' 
  https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1

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

Ændre parametrene for en resouce i en zone af en GSLB Farm.

Fornavn id er zonen unikke identifikator, næste id er ressourcens unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
rname String Resource-navnet er det nick, som DNS-tjenesten oversætter til de rigtige data i feltet rdata.
ttl nummer Den tid til live (valgfri) værdi for den aktuelle post, som det er nødvendigt for at bestemme hvor lang tid det aktuelle navn vil blive cachelagret.
typen String DNS-posttype. Indstillingerne er: NS, A, AAAA, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). For mere information, se på GSLB - Zones - Ressourcer sektion.
rdata String Det er de rigtige data, der kræves af posttypen, inputværdien afhænger af typen af ​​ressourcenavn, rname og ressourcetypen, typen. hvis typen er indlæst med værdi DYNA derefter rdata skal læses med en tilgængelig tjeneste navn

Svar eksempel:

{
   "description" : "Modify zone resource",
   "message" : "Resource modified",
   "params" : {
      "rdata" : "192.168.200.30",
      "rname" : "resource2",
      "ttl" : null,
      "type" : "A"
   },
   "success" : "true"
}

Response parametre

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

Slet en ressource

Slet en ressource

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3

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

Slet et bestemt resouce i en zone af en GSLB Farm

Bemærk at i DELETE URI over den første id er zonen unikke identifikator og næste id er ressourcens unikke identifikator.

Svar eksempel:

{
   "description" : "Delete zone resource",
   "message" : "Resource 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/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,
         "weight" : 2
      },
      {
         "id" : 1,
         "interface" : "eth0",
         "ip" : "192.168.100.11",
         "priority" : 2,
         "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 mulige værdier er: up, gården kører, eller ned, gården er stoppet.
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
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/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/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/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,
      "weight" : 2
   },
   {
      "id" : 7,
      "interface" : "eth0",
      "ip" : "192.168.100.11",
      "priority" : 2,
      "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.
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/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/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/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, virtuelle og bonding-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. limning: Også kaldet af en anden leverandør som trunk-grænseflader, denne slags nic kan oprettes med mere end en nic-grænseflade. Zevenet understøtter 7 forskellige typer af grænseflader.

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/zapi.cgi/interfaces/nic

GET /interfaces

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

Svar eksempel:

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "bond2",
         "netmask" : "",
         "status" : "down",
         "type" : "bond"
      },
      {
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "bond"
      },
      {
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "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",
         "ip" : "192.168.100.41",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virtiface",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "type" : "virtual"
      },
      {
         "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",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "eth2",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "true"
      },
      {
         "gateway" : "",
         "ip" : "",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "is_slave" : "true"
      }
   ]
}

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.
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 den første NIC-slave i bindingsgrænseflader. I virtuelle og VLAN-interfaces er det 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, virtuelt or obligation.
is_slave String Kun tilgængelig i NIC-grænseflader, sand, grænsefladen er en del af et bindingsinterface, falsk grænsefladen er ikke en del af et bindingsinterface.

Hent standard gateway

Hent standard gateway

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3/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/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/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,virtuelt og limning.

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/zapi.cgi/interfaces/nic

Svar eksempel:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "gateway" : "192.168.100.5",
         "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",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up"
      },
      {
         "gateway" : "",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "down"
      }
   ]
}

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.
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.
is_slave String sand grænsefladen er en del af et bindingsinterface, falsk grænsefladen er ikke en del af et bindingsinterface.

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/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",
      "is_slave" : "false",
      "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.
typen String De forskellige former for grænseflader er: nic, VLAN, virtuelt or obligation. Hver enkelt er defineret i deres undermenu i netværket.
is_slave String sand grænsefladen er en del af et bindingsinterface, falsk grænsefladen er ikke en del af et bindingsinterface.

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/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/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/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 - Bonding-grænseflader

Linux-bindingsgrænsefladen eller også kaldet af en anden leverandør som Trunk, giver en metode til aggregering af flere netværksinterfaces i en enkelt logisk "bundet" grænseflade. Opførelsen af ​​de bundne grænseflader afhænger af tilstanden, Zevenet Load Balancer understøtter følgende metoder:

Round-robin politik: Sende pakker i rækkefølge fra den første ledige slave gennem den sidste. Denne tilstand giver belastningsbalancering og fejltolerance.

Aktiv backup-politik: Kun en slave i obligationen er aktiv. En anden slave bliver aktiv, hvis og kun hvis den aktive slave fejler. Obligations MAC-adresse er eksternt synlig på kun en port (netværksadapter) for at undgå at forvirre kontakten. Denne tilstand giver fejltolerance. Den primære indstilling påvirker opførslen af ​​denne tilstand.

XOR-politik: Overfør baseret på kilde MAC-adresse XOR'd med destination MAC-adresse. Dette vælger den samme slave for hver destination MAC-adresse. Denne tilstand giver belastningsbalancering og fejltolerance.

Broadcast politik: Overfører alt på alle slave-grænseflader. Denne tilstand giver fejltolerance.

IEEE 802.3ad LACP: Opretter aggregeringsgrupper, der deler de samme hastigheds- og dupleksindstillinger. Udnytter alle slaver i den aktive aggregator i henhold til 802.3ad-specifikationen.

Forudsætninger:

  1. Netværksinterface understøttelse i basisdriverne for at hente hver enkelt slaves hastighed og duplex.

  2. En switch, der understøtter IEEE 802.3ad Dynamic link aggregation. De fleste switche kræver en form for konfiguration for at aktivere 802.3ad-tilstand.

Adaptiv transmitlastbalancering: Kanalbinding, der ikke kræver nogen særlig kontaktstøtte. Den udgående trafik fordeles i henhold til den aktuelle belastning (beregnet i forhold til hastigheden) på hver slave. Indkommende trafik modtages af den nuværende slave. Hvis den modtagende slave fejler, overtager en anden slave MAC-adressen til den mislykkede modtagelsesslav.

Forudsætning:

Base driver support for at hente hver slaves hastighed.

Adaptiv belastningsbalancering: Inkluderer Adaptive transmit load balancing plus modtage belastningsbalancering for IPV4 trafik, og kræver ikke nogen særlig switch support. Modtagebelastningsbalanceringen opnås ved ARP-forhandling. Bindingsdriveren aflyser ARP-svarene, der sendes af det lokale system på vej ud og overskriver kildehardwareadressen med den unikke hardwareadresse for en af ​​slaverne i bindingen, således at forskellige jævnaldrende bruger forskellige hardwareadresser til serveren.

Liste Bonding-grænseflader

Liste Bonding-grænseflader

Forespørgselseksempel:

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

GET /interfaces/bonding

Få konfiguration om alle bindingsgrænseflader i systemet.

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med et bindingsinterface objekt array.

Bindingsparametrene er:

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 Link lag unikt indentifier. Det er mac af den første NIC interface slave.
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.
slaver Objekt[] NIC interface medlemmer af bonding inteface.
tilstand String Det er arbejdsmodus for bonding interface. Indstillingerne er: balance-rrRound-robin-politikken; aktiv-backup, Politik for aktiv backup balance-xorXOR-politik udsende, Udsendelsespolitik; 802.3ad, IEEE 802.3ad LACP; balance-TLBAdaptiv transmitlastbalancering; balance-albAdaptiv belastningsbalancering. Disse værdier er defineret i afsnit Netværk - Bonding-grænseflader.

Slaver objekt:

Field Type Beskrivelse
navn String Navn er grænsefladen unikke identifikator for NIC slaven.

Hent bonding interface

Hent bonding interface

Forespørgselseksempel:

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

GET /interfaces/bonding/<name>

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

Svar eksempel:

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

Response parametre

Svaret vil være et JSON objekt med et bindingsinterface objekt.

Bindingsparametrene er:

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 Link lag unikt indentifier. Det er mac af den første NIC interface slave.
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.
slaver Objekt[] NIC interface medlemmer af bonding inteface.
tilstand String Det er arbejdsmodus for bonding interface. Indstillingerne er: balance-rrRound-robin-politikken; aktiv-backup, Politik for aktiv backup balance-xorXOR-politik udsende, Udsendelsespolitik; 802.3ad, IEEE 802.3ad LACP; balance-TLBAdaptiv transmitlastbalancering; balance-albAdaptiv belastningsbalancering. Disse værdier er defineret i Netværk> Limningsgrænseflader.

Slave objekt:

Field Type Beskrivelse
navn String Navn er grænsefladen unikke identifikator for NIC slaven.

Opret Bonding-grænseflade

Opret Bonding-grænseflade

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"slaves":["eth3","eth2"],"name":"bondiface","mode":"balance-rr"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding

POST /interfaces/bonding

Opret en binding grænseflade tilslutning NIC interfaces.

Den bindende MAC-adresse vil blive taget fra sin første NIC-grænseflade. Forbindelsesfunktionen kan ikke ændres, når bindingsgrænsefladen er oprettet, men medlemsgrænseflader kan tilføjes eller slettes i bindingsinterfacet efter behov. En NIC-grænseflade vil blive låst, hvis den er en del af et bindingsinterface.

Anmod om parametre

Field Type Beskrivelse påkrævet
navn String Interface navn. Det bruges som unik interface-id. sand
slaver Snor[] Alle NIC-grænseflader, der opbygger bindingen. Det kræves NIC-parameteren navn. sand
tilstand String Det er arbejdsmodus for bonding interface. Indstillingerne er: balance-rrRound-robin-politikken; aktiv-backup, Politik for aktiv backup balance-xorXOR-politik udsende, Udsendelsespolitik; 802.3ad, IEEE 802.3ad LACP; balance-TLBAdaptiv transmitlastbalancering; balance-albAdaptiv belastningsbalancering. Disse værdier er defineret i Netværk> Limningsgrænseflader. sand

Svar eksempel:

{
   "description" : "Add a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "down"
   }
}

Response parametre

Svaret vil være et JSON objekt med de bindingskonfigurerede parametre.

Field Type Beskrivelse
mac String Link lag unikt indentifier. Det er mac af den første NIC interface slave.
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.
slaver Objekt[] NIC-grænseflader, der opbygger bonding-interface.
tilstand String Det er arbejdsmodus for bonding interface. Indstillingerne er: balance-rrRound-robin-politikken; aktiv-backup, Politik for aktiv backup balance-xorXOR-politik udsende, Udsendelsespolitik; 802.3ad, IEEE 802.3ad LACP; balance-TLBAdaptiv transmitlastbalancering; balance-albAdaptiv belastningsbalancering. Disse værdier er defineret i Netværk> Limningsgrænseflader.

Slave objekt:

Field Type Beskrivelse
navn String Navn er grænsefladen unikke identifikator for NIC slaven.

Ændre Bonding-grænseflade

Ændre Bonding-grænseflade

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.121","netmask":"255.255.255.0","gateway":"192.168.100.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface

PUT /interfaces/bonding/<name>

Ændre parametrene for en bindingsinterface. 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" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0"
   }
}

Response parametre

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

Slet bindingskonfiguration

Slet bindingskonfiguration

Forespørgselseksempel:

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

DELETE /interfaces/bonding/<name>

Slet bindingskonfigurationskonfigurationen. Konfigurationsparametrene er: gateway, ip og netmaske.

navn er grænsefladen unikke identifikator.

Svar eksempel:

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

Indstil Bonding-grænseflade handling

Indstil Bonding-grænseflade handling

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"up"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/actions

POST /interfaces/bonding/<name>/actions

Anvend en handling til en bonding interface. Med dette opkald kan du slette bindingsgrænsefladen og aktivere eller deaktivere den.

Det er nødvendigt at slette bindingsgrænsefladen ved hjælp af ødelægge handling, hvis du vil låse op for de anvendte NIC-grænseflader i bindingen. Forbindelsesdriveren vil derefter gendanne de MAC-adresser, som medlemsgrænsefladerne havde, før de blev føjet til bindingsgrænsefladen.

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, ødelægge slet bindingen og genoprett NIC slaver grænseflader. sand

Svar eksempel:

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

Response parametre

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

Tilføj en bonding slave interface

Tilføj en bonding slave interface

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"eth4"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/slaves

POST /interfaces/bonding/<name>/slaves

Tilføj en NIC-grænseflade som slave til et eksisterende bindingsinterface.

navn er grænsefladen unikke identifikator.

Anmod om parametre

Field Type Beskrivelse påkrævet
navn String NIC-grænseflader navn at tilføje til bonding interface. sand

Svar eksempel:

{
   "description" : "Add a slave to a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         },
         {
            "name" : "eth4"
         }
      ],
      "status" : "up"
   }
}

Response parametre

Svaret vil være en json med opdaterede konfigurerede værdier. Se svareksempel for mere information.

Fjern en bonding slave interface

Fjern en bonding slave interface

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2

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

Slet en NIC slave-grænseflade fra et bindingsinterface. Bonding interface skal have næsten en NIC slave interface.

Fornavn navn er DELETE Opkald er bindingsnavnet unikt identifikator, næste navn i DELETE opkald er grænsefladenavnet unikt identifikator af NIC.

Svar eksempel:

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

Netværk - VLAN-interfaces

VLAN-grænsefladen gør det muligt at bruge et NIC- eller bindingsinterface 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 en prik "." 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/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/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/zapi.cgi/interfaces/vlan

POST /interfaces/vlan

Opret en VLAN-grænseflade fra en NIC eller bonding interface. 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/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/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/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, binding 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/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/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.
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.

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

Netværk - Flydende grænseflader

Denne form for grænseflade bruger en defineret virtuel grænseflade og maskerer den udgående trafik af a nic, limning or VLAN interface med et barn virtuelt grænseflade. Denne grænseflade bruges til stateful failoveradfærd i l4xnat profiler, hvis en klynge er konfigureret.

Liste Flydende grænseflader

Liste Flydende grænseflader

Forespørgselseksempel:

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

GET /interfaces/floating

Vis alle tilgængelige eller konfigurerede grænseflader, hvor der er oprettet en flydende IP.

Svar eksempel:

{
   "description" : "List floating interfaces",
   "params" : [
      {
         "floating_ip" : null,
         "interface" : "bondiface"
      },
      {
         "floating_ip" : "192.168.100.199",
         "interface" : "eth0"
      },
      {
         "floating_ip" : null,
         "interface" : "eth0.1"
      },
      {
         "floating_ip" : null,
         "interface" : "eth1"
      }
   ]
}

Response parametre

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

Flydende objekt:

Field Type Beskrivelse
floating_ip String Flydende IP bruges i grænseflade. floating_ip skal eksistere som virtuelt interface barn af grænseflade.
grænseflade String Interface maskeret af den flydende IP.

Hent flytende interface

Hent flytende interface

Forespørgselseksempel:

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

GET /interfaces/floating/<name>

Viser, om en grænseflade har en konfigureret flydende IP. Hvis den har en konfigureret, vises den her.

navn er grænsefladen unikke identifikator, som kan være af typen nic, binding eller vlan.

Svar eksempel:

{
   "description" : "Show floating interface",
   "params" : {
      "floating_ip" : "192.168.100.199",
      "interface" : "eth0"
   }
}

Response parametre

Field Type Beskrivelse
floating_ip String Flydende IP bruges i grænseflade. floating_ip skal eksistere som virtuelt interface barn af grænseflade.
grænseflade String Interface maskeret af den flydende IP.

Ændre flydende grænseflade

Ændre flydende grænseflade

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"floating_ip":"192.168.100.199"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/interfaces/floating/eth0

PUT /interfaces/floating/<name>

Konfigurer en flydende IP til en NIC, binding eller VLAN-grænseflade.

navn er grænsefladen unikke identifikator, som kan være af typen nic, binding eller vlan.

Anmod om parametre

Field Type Beskrivelse påkrævet
floating_ip String Flydende IP bruges i grænseflade. floating_ip skal eksistere som virtuelt interface barn af grænseflade. sand

Svar eksempel:

{
   "description" : "Modify floating interface",
   "message" : "Floating interface modification done",
   "success" : "true"
}

Slet Flytende konfiguration

Slet Flytende konfiguration

Forespørgselseksempel:

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

DELETE /interfaces/floating/<name>

Fjern den flydende IP-konfiguration i en grænseflade.

navn er grænsefladen unikke identifikator, som kan være af typen nic, binding eller vlan.

Svar eksempel:

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

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/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" : {
         "bond0 in in" : 234.72,
         "bond0 out out" : 0,
         "bond0.10 in in" : 0,
         "bond0.10 out out" : 0,
         "bond1 in in" : 234.72,
         "bond1 out out" : 0,
         "bond3 in in" : 815.69,
         "bond3 out out" : 4300.38,
         "eth0 in in" : 2702.29,
         "eth0 out out" : 50701.95,
         "eth0.2 in in" : 0,
         "eth0.2 out out" : 0,
         "eth1 in in" : 234.72,
         "eth1 out out" : 0,
         "eth2 in in" : 234.72,
         "eth2 out out" : 0,
         "eth3 in in" : 0,
         "eth3 out out" : 0,
         "eth4 in in" : 436.89,
         "eth4 out out" : 4300.38,
         "eth4.6 in in" : 0,
         "eth4.6 out out" : 0,
         "eth5 in in" : 301.39,
         "eth5 out out" : 0,
         "eth5.5 in in" : 0,
         "eth5.5 out out" : 0,
         "eth6 in in" : 77.42,
         "eth6 out out" : 0
      }
   }
}

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/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" : "234.72",
            "interface" : "bond1",
            "out" : "0.00"
         },
         {
            "in" : "77.42",
            "interface" : "eth6",
            "out" : "0.00"
         },
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "bond2",
            "out" : "4300.38"
        }
      ]
   }
}

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 grænsefladestatistik

Vis grænsefladestatistik

Forespørgselseksempel:

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

GET /stats/system/network/interfaces

Få et resumé af hver netværksgrænseflade.

Svar eksempel:

{
   "description" : "Interfaces info",
   "params" : {
      "bond" : [
         {
            "in" : "234.72",
            "interface" : "bond1",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "slaves" : [
               "eth2"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "815.70",
            "interface" : "bond3",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "slaves" : [
               "eth4",
               "eth5",
               "eth6"
            ],
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "bond0",
            "ip" : "",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "slaves" : [
               "eth1"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : [
               "bond0.10"
            ]
         }
      ],
      "nic" : [
         {
            "in" : "77.42",
            "interface" : "eth6",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "2704.81",
            "interface" : "eth0",
            "ip" : "192.168.101.46",
            "mac" : "9e:2e:3e:a5:2e:6a",
            "out" : "51039.13",
            "status" : "up",
            "virtual" : [
               "eth0:1",
               "eth0:2",
               "eth0.2:6"
            ],
            "vlan" : [
               "eth0.2"
            ]
         },
         {
            "in" : "234.72",
            "interface" : "eth1",
            "ip" : "192.168.101.58",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "eth2",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "0.00",
            "interface" : "eth3",
            "ip" : "192.168.101.72",
            "mac" : "16:97:ab:43:87:02",
            "out" : "0.00",
            "status" : "down",
            "virtual" : [
               "eth3:1",
               "eth3:8",
               "eth3:6"
            ],
            "vlan" : []
         },
         {
            "in" : "436.89",
            "interface" : "eth4",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "status" : "up",
            "virtual" : [
               "eth4.6:5"
            ],
            "vlan" : [
               "eth4.6"
            ]
         },
         {
            "in" : "301.39",
            "interface" : "eth5",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : [
               "eth5.5"
            ]
         }
      ]
   }
}

Response parametre

Svaret vil være en JSON med en nøgle params hvis værdi er et objekt med nøglerne obligation og nic.

Field Type Beskrivelse
obligation Objekt[] Bond interface-statistik.
nic Objekt[] NIC interface statistik.

Objektobjekt:

Field Type Beskrivelse
in String Samlet inputtrafik i MB.
grænseflade String Interface navn bruges som unik identifikator.
ip String Interface's IP.
mac String Interface MAC.
ud String Total outputtrafik i MB.
slaver String [] Liste over slaver, der opbygger bindingsgrænsefladen.
status String Interface status. Værdien kan være ned, grænsefladen er deaktiveret; up, grænsefladen er aktiveret.
virtuelt String [] Virtuelle grænseflader, der arver fra denne grænseflade.
VLAN String [] VLAN-grænseflader, der arver fra denne grænseflade.

Nic objekt:

Field Type Beskrivelse
in String Samlet inputtrafik i MB.
grænseflade String Interface navn bruges som unik identifikator.
ip String Interface's IP.
mac String Interface MAC.
ud String Total outputtrafik i MB.
status String Interface status. Værdien kan være ned, grænsefladen er deaktiveret; up, grænsefladen er aktiveret.
virtuelt String [] Virtuelle grænseflader, der arver fra denne grænseflade.
VLAN String [] VLAN-grænseflader, der arver fra denne grænseflade.

Vis hukommelsesstatistik

Vis hukommelsesstatistik

Forespørgselseksempel:

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

GET /stats/system/memory

Få et resumé af systemhukommelsen.

Svar eksempel:

{
   "description" : "Memory usage",
   "params" : {
      "Buffers" : 1.01,
      "Cached" : 42.47,
      "MemFree" : 880.11,
      "MemTotal" : 2005.01,
      "MemUsed" : 1124.91,
      "SwapCached" : 8.27,
      "SwapFree" : 565.15,
      "SwapTotal" : 672,
      "SwapUsed" : 106.84,
      "date" : "Fri Jan 27 12:27:11 2017",
      "hostname" : "api3"
   }
}

Response parametre

Svaret vil være en JSON med en nøgle params hvis værdi er et hukommelsesobjekt.

Hukommelse objekt.

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.
dato String System dato.
hostname String Værts navn.

Vis belastningsstatistik

Vis belastningsstatistik

Forespørgselseksempel:

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

GET /stats/system/load

Få et resumé af CPU systembelastningen.

Svar eksempel:

{
   "description" : "System load",
   "params" : {
      "Last_1" : 0.66,
      "Last_15" : 0.39,
      "Last_5" : 0.49,
      "date" : "Fri Jan 27 13:15:01 2017",
      "hostname" : "api3"
   }
}

Response parametre

Field Type Beskrivelse
Last_1 nummer Indlæs systembrugen sidst.
Last_5 nummer Indlæs systemanvendelsen de sidste fem minutter.
Last_15 nummer Indlæs systembrug de sidste fem minutter.
dato String System dato.
hostname String Værts navn.

Vis CPU-statistikker

Vis CPU-statistikker

Forespørgselseksempel:

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

GET /stats/system/cpu

Svar eksempel:

{
   "description" : "System CPU usage",
   "params" : {
      "cores" : 2,
      "date" : "Fri Jan 27 13:30:52 2017",
      "hostname" : "api3",
      "idle" : 94.9,
      "iowait" : 0,
      "irq" : 0,
      "nice" : 0,
      "softirq" : 0,
      "sys" : 3.06,
      "usage" : 5.1,
      "user" : 2.04
   }
}

Response parametre

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.
dato String System dato.
hostname String Værts navn.

Vis forbindelsesstatistikker

Vis forbindelsesstatistikker

Forespørgselseksempel:

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

GET /stats/system/connections

Få de samlede aktuelle forbindelser i systemet. Tælleren summerer enhver form for sporede forbindelser: ASSURED, ESTABLISHED, SYN_SENT, TIME_WAIT, LISTEN ...

Svar eksempel:

{
   "description" : "System connections",
   "params" : {
      "connections" : 324
   }
}

Response parametre

Field Type Beskrivelse
tilslutninger nummer Samlede sporede forbindelser faktisk.

Vis antal gårde

Vis antal gårde

Forespørgselseksempel:

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

GET /stats/farms/total

Vis det samlede antal bedrifter, der er oprettet i systemet.

Svar eksempel:

{
   "description" : "Number of farms.",
   "number" : 8
}

Response parametre

Field Type Beskrivelse
nummer nummer Det er antallet af bedrifter, der findes i systemet.

Vis gårdsstatistik

Vis gårdsstatistik

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/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"
      },
      {
         "established" : 0,
         "farmname" : "testGSLB",
         "pending" : 0,
         "profile" : "gslb",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "53"
      }
   ]
}

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, https or GSLB. Hver profil er defineret i sin sektion.
status String Farm status. De mulige værdier er: upgården går; ned, gården er stoppet eller nødvendige genstart, gården skal genstartes for at de seneste ændringer kan træde i kraft.
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/zapi.cgi/stats/farms/farmname

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, backend er klar til at modtage forbindelser; ned, tjenesten har opdaget, at backend'en ikke virker; fgDOWN, farmguardian har deaktiveret backend, fordi farmguardian check ikke lykkedes; vedligeholdelse, backend er markeret som ikke klar til at modtage forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver.

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.

Svareksempel for GSLB gård:

{
   "backends" : [
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "192.168.55.40",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 4,
         "ip" : "192.135.10.2",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      }
   ],
   "client" : {
      "edns_big" : 0,
      "edns_tc" : 0,
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0,
      "tc" : 0
   },
   "description" : "List farm stats",
   "extended" : {
      "badvers" : 0,
      "dropped" : 0,
      "edns" : 0,
      "edns_clientsub" : 0,
      "formerr" : 0,
      "noerror" : 0,
      "notimp" : 0,
      "nxdomain" : 0,
      "refused" : 0,
      "v6" : 0
   },
   "server" : {
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0
   }
}

Response parametre i GSLB gårde

Field Type Beskrivelse
backends Objekt[] Vis oplysninger om bagsiden.
kunde Object Statistik relateret til klienten.
udvidet Object Udvidet information om tjenesten.
server Object Statistik relateret til serveren.

Backend objekt

Field Type Beskrivelse
id nummer Backend unik identifikator.
ip String IP hvor den rigtige tjeneste lytter.
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, backend er klar til at modtage forbindelser; ned, tjenesten har opdaget, at backend'en ikke virker; vedligeholdelse, backend er markeret som ikke klar til at modtage forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver.

Klientobjekt

Field Type Beskrivelse
edns_big nummer Svar, der var større end 512 bytes.
edns_tc nummer Klientens specificerede udvidede dns-bufferstørrelse var for lille til de anmodede data.
recvfail nummer Antal UDP-fejl, hvor operativsystemet angav, at der opstod noget dårligt ved modtagelsen.
anmod nummer Samlet antal UDP-anmodninger, der håndteres af serveren.
sendfail nummer Antal UDP-fejl, hvor operativsystemet angav, at der opstod noget dårligt ved afsendelse.
tc nummer Svar, der blev afkortet med TC bit sæt.

Udvidet objekt

Field Type Beskrivelse
badvers nummer Anmodning, der havde en EDNS OPT-RR med en version, der ikke blev understøttet.
droppet nummer Mistede anmodninger om fejlformet format.
edns nummer Forespørgslen indeholdt en EDNS OPT-RR.
edns_clientsub nummer Undergruppe af edns-anmodninger, der angav indstillingen edns_client_subnet.
formerr nummer Forespørgslen var dårligt formateret, men var fornuftig nok, at vi sendte et svar med koden FORMERR.
noerror nummer Succesfulde anmodninger.
notimp nummer Forespurgt tjeneste ikke implementeret af denne dæmon, såsom anmodninger om zoneoverførsel.
nxdomain nummer Anmodning om et ikke-eksisterende domænenavn.
nægtede nummer Forespørgslen blev afvist af serveren, fordi serveren ikke er autoriseret til det forespurgte navn.
v6 nummer Anmodning fra en IPv6-klient.

Server objekt

Field Type Beskrivelse
recvfail nummer Antal TCP fejl, hvor OS viste, at der var noget dårligt ved modtagelsen.
anmod nummer Samlet antal TCP-anmodninger, der håndteres af serveren.
sendfail nummer Antal TCP fejl, hvor OS viste, at der var sket noget dårligt ved afsendelse.

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" : "fgDOWN"
      },
      {
         "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, backend er klar til at modtage forbindelser; fgDOWN, bondevogter har opdaget, at bagenden ikke virker; vedligeholdelse, backend er markeret som ikke klar til at modtage forbindelser af administratoren, denne mulighed er nyttig til backend's vedligeholdelsesopgaver.

Datalink gårdsstatistik er ikke tilgængelig faktisk.

Vis modulstatus

Vis modulstatus

Forespørgselseksempel:

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

GET /stats/farms/modules

Få et resumé af modulstatistikker. Dette opkald viser hvert modul status, antal konfigurerede, antallet af gårde sat ned og op.

Definitionen om moduler er i Gårde sektion.

Svar eksempel:

{
   "description" : "Module status",
   "params" : {
      "dslb" : {
         "down" : 1,
         "total" : 2,
         "up" : 1
      },
      "gslb" : {
         "down" : 0,
         "total" : 1,
         "up" : 1
      },
      "lslb" : {
         "down" : 2,
         "total" : 4,
         "up" : 2
      }
   }
}

Response parametre

Svaret vil være et JSON med tre nøgler: dslb, GSLB og lslb.

Field Type Beskrivelse
ned nummer Antal stoppede gårde. Disse gårde stoppes af systemadministratoren.
alt nummer Antal samlede gårde.
up nummer Antal løbende gårde.

Vis modulstatistik

Vis modulstatistik

Forespørgselseksempel:

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

GET /stats/farms/modules/<module>

Vis gårdsstatistik for et bestemt modul.

De tilgængelige værdier for modul parameter er: lslb, GSLB or dslb.

Svar eksempel:

{
   "description" : "List lslb farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "newfarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.100.199",
         "vport" : "40"
      },
      {
         "established" : 0,
         "farmname" : "nwl4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "down",
         "vip" : "192.168.100.241",
         "vport" : "88"
      },
      {
         "established" : 0,
         "farmname" : "l4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.100.102",
         "vport" : "70"
      }
   ]
}

Response parametre

Svaret bliver et JSON objekt med information om gårde i modulet.

Field Type Beskrivelse
etableret nummer Samlet antal nuværende etablerede forbindelser.
farmname String Farmens navn, unikke identifikator for gårde.
verserende nummer Antal ventende forbindelser.
profil String Type gård. De mulige værdier er: data link, l4xnat, http, https or GSLB. Hver profil er defineret selv-sektion.
status String Farm status. De mulige værdier er: upgården går; ned, gården er stoppet eller nødvendige genstart, gården skal genstartes for at de seneste ændringer kan træde i kraft.
vip String IP af gården, hvor den virtuelle tjeneste lytter.
VPort String Havnen på gården, hvor den virtuelle tjeneste lytter.

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/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",
      "gslbfarm",
      "nwl4farm",
      "httpweb"
   ],
   "interfaces" : [
      "eth0.1",
      "eth2",
      "eth1",
      "eth3",
      "bondiface",
      "eth0"
   ],
   "system" : [
      "cpu",
      "load",
      "ram",
      "swap",
      {
         "disk" : [
            "root/",
            "root/boot",
            "root/usr/local/zenloadbalancer/config",
            "root/var/log"
         ]
      }
   ]
}

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/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/zapi.cgi/graphs/interfaces/eth3

Anmod om eksempel på en disk:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/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/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/zapi.cgi/graphs/interfaces/eth3/monthly

Anmod om eksempel på en disk:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3/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.

IPDS

Dette modul er implementeringen af ​​a IPS (Intrusion Prevention System) og IDS (Intrusion Detection System) system til at tilbyde brugeren et sikkerhedslag. IPDS-modulet inspicerer trafikken lige før for at nå belastningsbalancemodulerne LSLB or GSLB, hvis trafikken opdages som skadelig, vil den blive afvist.

Det virker at anvende sikkerhedsregler på systemet, som vil blive defineret som objekt af forskellig karakter. Hver enkelt tilbyder en løsning til ekstern ondsindet eller mistænkelig handling. Dette værktøj hjælper systemadministratorer med at kontrollere trusler og angreb.

De tilgængelige regler, der gælder for Zevenet, kan være sortlister og DoS.

IPDS - Blacklists

Sortlister lader brugerne bruge lister til at filtrere eller tillade trafik ifølge kilde-IP'er (inkommende trafik).

Der er to typer lister:

  1. Fjernbetjeninger: Lister er hentet fra en webadresse, disse lister er ikke modificerede og kan afvikles for at blive downloadet.
  2. Lokal: Brugere kan oprette deres egne lister med en given politik, benægte hvis den inkommende IP matcher, bliver trafikken afvist eller tillade hvis den inkommende IP matcher så vil trafikken blive tilladt.

Dette modul indeholder forudindlæst lister leveret af Zevenet hold, listen er klar til at blive anvendt på bedrifter. Derudover kan brugerne oprette deres egne personlige lister.

Flere lister kan anvendes på samme gård, hvis kilden IP matcher i en del af listen, vil trafikken blive tilladt eller afvist afhængigt af blacklist-politikken. I øjeblikket matcher IP'en, så er der ikke foretaget flere sorte listekontroller til kilde IP.

Hvis en kilde IP er i to forskellige lister benægte og tillade, så er altid tilladelsespolitikken evallueret først.

Liste over alle blacklists regler

Liste over alle sortlister

Forespørgselseksempel:

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

GET /ipds/blacklists

Liste over alle blacklists oprettet af brugeren eller forudindlæst i systemet, der kan anvendes på gårdene.

Svar eksempel:

{
   "description" : "Get black lists",
   "params" : [
      {
         "farms" : [],
         "name" : "china",
         "policy" : "deny",
         "preload" : "true",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "russia",
         "policy" : "deny",
         "preload" : "true",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "northkorea",
         "policy" : "deny",
         "preload" : "true",
         "type" : "local"
      },
      {
         "farms" : [
            "FarmHttp1",
            "FarmGslb1",
         ],
         "name" : "remoteList",
         "policy" : "deny",
         "preload" : "false",
         "type" : "remote"
      },
      {
         "farms" : [],
         "name" : "myWhiteList",
         "policy" : "allow",
         "preload" : "false",
         "type" : "local"
      },
   ]
}

Response parametre

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

Field Type Beskrivelse
gårde Snor[] Farms liste hvor den sorte liste er anvendt.
navn String Sortlistenavn. Den bruges som unik identifikator.
politik String Handling til anvendelse på kilden. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
preload String De mulige værdier er: sand, sortlisten er forudindlæst i systemet; eller falsk, sortlisten er oprettet af systemadministrator.
typen String Hvor listen er gemt, og hvem opretholder den. Værdierne er: lokale, listen gemmes i det lokale system og kan ændres lokalt eller fjern, listen er hentet fra fjernkilde gennem a url, Det kan ikke ændres lokalt, så ændringerne skal tages i den eksterne kilde.

Hent en blacklist-regel

Hent blacklist

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/loc

GET /ipds/blacklists/<name>

Vis blacklistens konfiguration og beskrivelse parametre. navn er blacklistens unikke identifikator.

Response parametre

Response Local List Eksempel:

{
   "description" : "Get list loc",
   "params" : {
      "farms" : [],
      "name" : "loc",
      "policy" : "deny",
      "preload" : "false",
      "sources" : [
         {
            "id" : 0,
            "source" : "192.168.0.167"
         },
         {
            "id" : 1,
            "source" : "192.168.0.186"
         }
      ],
      "type" : "local"
   }
}

Lokalt sortlisteobjekt:

Field Type Beskrivelse
gårde Snor[] Farms liste hvor den sorte liste er anvendt.
navn String Sortlistenavn. Den bruges som unik identifikator.
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
preload String De mulige værdier er: sand, sortlisten er forudindlæst i systemet; eller falsk, sortlisten er oprettet af systemadministratoren.
typen String Hvor listen er gemt, og hvem opretholder den. Værdierne er: lokale, listen gemmes i systemet og vedligeholdes af systemadministratoren; eller fjern, listen er hentet fra en ekstern url.
kilder Objekt[] Liste over IP'er, som listen kontrollerer. Kilde netværk format accepteret: Netværksadresse / Mask bit eller IP

Eksempel på fjernbetjeningseksempel:

{
   "description" : "Get list remoteList",
   "params" : {
      "day" : "thursday",
      "farms" : [
         "FarmHttp1",
         "FarmGslb1",
      ],
      "frequency" : "weekly",
      "name" : "remoteList",
      "policy" : "deny",
      "sources" : [
         {
            "id" : 0,
            "source" : "78.12.0.4"
         },
         {
            "id" : 1,
            "source" : "68.100.15.5"
         },
         {
            "id" : 2,
            "source" : "65.12.12.95"
         }
      ],
      "time" : {
         "hour" : 0,
         "minutes" : 0
      },
      "update_status" : "This list isn't downloaded yet.",
      "type" : "remote",
      "url" : "http://192.168.10.10/lists/test.txt"
   }
}

Fjernt sortlistelement:

Field Type Beskrivelse
gårde Snor[] Farms liste hvor den sorte liste er anvendt.
navn String Sort liste navn. Den bruges som unik identifikator.
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
preload String De mulige værdier er: sand, sortlisten er forudindlæst i systemet; eller falsk, sortlisten er oprettet af systemadministratoren.
typen String Hvor listen er gemt, og hvem opretholder den. Værdierne er: lokale, listen gemmes i systemet og vedligeholdes af systemadministratoren; eller fjern, listen er hentet fra en fjernbetjening url.
kilder Objekt[] Ssource IP'er, som listen kontrollerer. Hvis listen er af typen fjern så vises listens indhold ikke før den første download.
Opdater status String Status for den sidste download af listen og dato for den sidste succesfulde opdatering i det lokale system.
url String Hvor fjernliste hentes fra. Fjernformatet skal være en liste over en kilde netværk / bitmaske eller IP pr. linje.
frekvens String Fjernliste opdateringsfrekvens. Indstillingerne er: dagligt, opdater alle dage, en gang eller periodisk, dette er angivet i frequency_type Mark; ugentlig, opdater en gang om ugen eller månedligt, opdater en gang om måneden.
frequency_type String Denne parameter fuldender frekvens dagligt, når dets værdi er daglig. De mulige værdier er: eksakt. definere en time om dagen eller periode, definer en periode, der skal opdateres i løbet af dagen.
dag String eller nummer Denne parameter fuldender parameteren frekvens hvornår frecuency Værdien er ugentlig or månedligt. hvis frecuency is ugentlig denne parameter skal være aday for ugen (mandag, tirsdag, onsdag, torsdag, Fredag, lørdag or Søndag) hvis frekvens Værdien er månedligt så skal denne parameter være en dag i måneden (et tal mellem 1 og 31).
tid Object Det er en struktur, der afhænger af felterne frekvens.

Tid objekt for den daglige frekvens og periode frequency_type

Field Type Beskrivelse
periode nummer Hvor ofte opdateres listen.
enhed String Periodeenhed. Indstillingerne er: minutter, angiv listen vil blive opdateret hvert konfigureret minut eller timer, listen opdateres hver konfigurerede tid.

Tid objekt for andre frekvenser

Field Type Beskrivelse
time nummer Time for at opdatere listen. Værdien skal være et tal mellem 0 og 23.
minutter nummer Minutter for at opdatere listen. Værdien skal være et tal mellem 0 og 59.

Kilder objekt

Field Type Beskrivelse
id nummer Kilde unik identifikation i listen.
kilde String IP-adresser eller net-segmenter, som listen kontrollerer.

Opret en blacklist-regel

Opret en ny sortliste

Anmod om eksempel på en lokal liste:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListLoc", "type":"local", "policy":"allow"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists

Anmod om eksempel på en fjernliste:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"newListRem", "type":"remote", "url":"https://192.168.10.12/lists/test.txt"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists

POST /ipds/blacklists

Opret en sortliste, der skal bruges på gårde. Sortlister kan bestå af to typer:

  1. Lokal: Kilderne tilføjes af brugeren. Listen gemmes lokalt.
  2. Remote: Kilderne hentes fra en fjernplacering. Denne placering er angivet med en webadresse. Det understøttede fjernlisteformat er en Netværksadresse / Mask bit or IP linje pr. linje.

Anmod om parametre

Field Type Beskrivelse påkrævet
navn String Sortlistenavn. Den bruges som unik identifikator. sand
typen String Hvor listen er gemt, og hvem vedligeholder den. Værdierne er: lokale, listen gemmes i system og vedligeholdelse for administrationssystem; eller fjern, listen er taget fra en ud service gennem a url og administrators servcie vedligeholder listen. sand
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen. Standardværdien nægtes.
url String Hvor fjernliste hentes fra. Fjernformatet skal være en liste over en kilde pr. linje i formatet Netværksadresse / Mask bit or IP. sandt for fjernliste
{
   "description" : "Post list list1",
   "params" : {
      "farms" : [],
      "name" : "newListLoc",
      "policy" : "deny",
      "preload" : "false",
      "type" : "local"
   }
}

Response parametre

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af ​​dette vil være en række af blacklist objekter, der hver indeholder følgende nøgleattributter.

Field Type Beskrivelse
gårde Snor[] Farms liste hvor den sorte liste er anvendt.
navn String Sortlistenavn. Den bruges som unik identifikator.
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
preload String De mulige værdier er: sand, sortlisten er forudindlæst i systemet; eller falsk, sortlisten er oprettet til systemadministrator.
typen String Hvor listen er gemt, og hvem vedligeholder den. Værdierne er: lokale, listen gemmes i system og vedligeholdelse for administrationssystem; eller fjern, listen er taget fra en ud service gennem a url og administrators servcie vedligeholder listen.

Ændre en blacklist-regel

Rediger en sortliste

Anmod om eksempel på en lokal liste:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"policy":"allow","source":["78.12.0.4","68.100.15.5","65.12.12.95"]}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/whiteList

PUT /ipds/blacklists/<name>

Rediger konfigurationen af ​​en blacklist-regel. navn er blacklistens unikke identifikator.

Anmod parameter for en lokal liste:

Field Type Beskrivelse
navn String Sortlistenavn. Den bruges som unik identifikator. Kun det er modificeret på nr preload lister.
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
kilde Snor[] Det er en liste over IP-adresser eller net-segmenter, som listen kontrollerer. For at ændre ændring kun en kilde, se venligst dokumentatio sektionen IPDS> Sortlister> Rediger en kilde til en sortliste. Kun kilder er ændret på nr preload lister.

Svar eksempel:

{
   "description" : "Modify list whiteList.",
   "params" : {
      "name" : "whiteList",
      "policy" : "allow",
      "preload" : "false",
      "type" : "local"
   }
}

Response parametre

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

Anmod om eksempel på en fjernliste:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"remoteList","url":"http://192.168.10.10/lists/test.txt","policy":"deny","frequency":"daily","frequency_type":"exact","time":{"hour":1,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem

Anmod om eksempel for opdatering af en liste hver 2 timer:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"daily","frequency_type":"period","time":{"period":2,"units":"hours"}}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem

Anmod om eksempel for opdatering af en liste alle dage på 2: 00 AM:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"daily","frequency_type":"exact","time":{"hour":2,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem

Anmod om eksempel for opdatering af alle mandage på 0: 00 AM:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"weekly","day":"monday","time":{"hour":0,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem

Anmod om eksempel for opdatering af dagen 1 i måneden ved 12: 00 PM:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"frequency":"monthly","day":"1","time":{"hour":12,"minutes":0}}' 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/newListRem

Anmod parameter for en fjernliste

Field Type Beskrivelse
gårde Snor[] Farms liste hvor den sorte liste er anvendt.
navn String Sortlistenavn. Den bruges som unik identifikator.
politik String Handling til anvendelse på en kilde. Indstillingerne er: benægte, bloker inputtrafikken fra kilder til listen; eller tillade acceptere trafikken fra kilder til listen.
url String Hvor fjernliste hentes fra.
frekvens String Fjernliste opdateringsfrekvens. Indstillingerne er: dagligt, opdater alle dage, en gang eller en periode, dette er angivet i frequency_type Mark; ugentlig, opdater en gang om ugen eller månedligt, opdater en gang om måneden.
frequency_type String Denne parameter fuldender frekvens dagligt, når dets værdi er daglig. De mulige værdier er: eksakt. definere en time om dagen eller periode, definer en periode, der skal opdateres i løbet af dagen.
dag String eller nummer Denne parameter fuldender frekvens når dens værdi er ugentlig eller månedlig. Hvis det er ugentlig, skal denne parameter være en ugedag (mandag, tirsdag, onsdag, torsdag, Fredag, lørdag or Søndag) ellers hvis frekvens er månedlig, så skal denne parameter være en månedsdag (nummer mellem 1 og 31).
tid Object Det er en struktur, der afhænger af felterne frekvens.

Tidsperiode objekt

Dette er felterne, når en tidsperiode vil blive konfigureret.

Det er nødvendigt at konfigurere frekvens med værdien dagligtog frequency_type med værdien periode.

Field Type Beskrivelse
periode nummer Hvor ofte opdaterer listen.
enhed String Periodeenhed. Indstillingerne er: minutter or timer, angiv måleenheden for listen opdateringer.

Tid præcis time objekt

Dette er felterne, når en eksakt timetid vil blive konfigureret.

Dette objekt bruges sammen med de følgende konfigurationer:

frekvens feltet har værdien dagligt og frequency_type is eksakt.

frekvens feltet har værdien ugentlig og dag er den ugedag, hvor listen opdateres.

frekvens feltet har værdien månedligt og dag er antallet af dagmåneder, når listen opdateres.

Field Type Beskrivelse
time nummer Time for at opdatere listen. Værdien skal være et tal mellem 0 og 23.
minutter nummer Minutter for at opdatere listen. Værdien skal være et tal mellem 0 og 59.

Svar eksempel:

{
   "description" : "Modify list newListRem.",
   "params" : {
      "day": 1,
      "frequency" : "monthly",
      "name" : "newListRem",
      "policy" : "deny",
      "preload" : "false",
      "time" : {
         "hour" : 12,
         "minutes" : 0
      },
      "type" : "remote",
      "update_status" : "Sync fail. Last update: 2017-02-16 14:23:00",
      "url" : "https://192.168.10.12/lists/test.txt"
   }
}

Response parametre

Svaret vil være en json med alle listekonfigurationer. Se svareksempel for mere information.

Opdater en fjern blacklist-regel

Opdater en fjern blacklist

Anmod om eksempel på en fjernliste:

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

POST /ipds/blacklists/<name>/actions

Opdater en fjernliste, download kilderne. navn er blacklistens unikke identifikator.

Anmod parameter for en fjernliste

Field Type Beskrivelse påkrævet
Action String Handling til at sende til listen. Denne parameter skal være opdatering. sand

Svar eksempel:

{
   "description" : "Update a remote list",
   "update" : "Sync OK. Last update: 2017-02-01 05:31:57"
}

Response parametre

Svaret bliver en json med downloadstatus. Se svareksempel for mere information.

Field Type Beskrivelse påkrævet
opdatering String Status for den sidste download af listen og dato for den sidste succesrige opdatering.

Slet en sortliste-regel

Slet en liste over sorte lister

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/remoteList

DELETE /ipds/blacklists/<name>

Slet en given sortliste. navn er blacklistens unikke identifikator.

Svar eksempel:

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

Liste kilde fra en sortliste

Liste kilde fra en sortliste

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList

GET /ipds/blacklists/<name>/sources

Liste kilder til en sortliste. navn er blacklistens unikke identifikator.

Svar eksempel:

{
   "description" : "Get localList sources",
   "params" : [
      {
         "id" : 0,
         "source" : "78.12.0.4"
      },
      {
         "id" : 1,
         "source" : "68.100.15.5"
      },
      {
         "id" : 2,
         "source" : "65.12.12.95"
      }
   ]
}

Response parametre

Svaret bliver en JSON med nøglen params og kildeobjekt array som værdi.

Kildeobjekt:

Field Type Beskrivelse
id nummer Kilde unik identifikation i listen.
kilde Snor[] IP-adresser eller net-segmenter, som listen kontrollerer.

Tilføj en kilde til en sortliste

Tilføj en kilde til en sortliste

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources

POST /ipds/blacklists/<name>/sources

Skub en ny kilde til en sortliste. Kun tilgængelig for lokale lister og ikke-forudindlæste lister. navn er blacklistens unikke identifikator.

Anmod om parametre

Field Type Beskrivelse påkrævet
kilde String IP-adresse eller net-segment, som listen kontrollerer. sand

Svar eksempel:

{
   "description" : "Post source to localList.",
   "message" : "Added 192.168.3.1 successful.",
   "params" : [
      {
         "id" : 0,
         "source" : "78.12.0.4"
      },
      {
         "id" : 1,
         "source" : "68.100.15.5"
      },
      {
         "id" : 2,
         "source" : "65.12.12.95"
      },
      {
         "id" : 3,
         "source" : "192.168.3.1"
      }
   ]
}

Response parametre

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

Rediger en kilde til en sortliste

Rediger en kilde til en sortliste

Forespørgselseksempel:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"source":"192.168.3.1"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources/2

PUT /ipds/blacklists/<name>/sources/<id>

Rediger en kilde til en sortliste.

navn er blacklistens unikke identifikator. id er kildens unikke identifikator.

Anmod om parametre

Field Type Beskrivelse påkrævet
kilde String IP-adresse eller net-segment, som listen kontrollerer. sand

Svar eksempel:

{
   "description" : "Put source into localList",
   "message" : "Source 2 has been modified successful.",
   "params" : {
         "id" : 2,
         "source" : "192.168.3.1"
    }
}

Response parametre

Svaret bliver en json med opdateret kilde. Se svareksempel for mere information.

Slet en kilde til en sortliste

Slet en kilde til en sortliste

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/blacklists/localList/sources/2

DELETE /ipds/blacklists/<name>/sources/<id>

Fjern en kilde fra en sortliste.

navn er blacklistens unikke identifikator. id er kildens unikke identifikator.

Svar eksempel:

{
   "description" : "Delete source from the list localList",
   "message" : "Source 2 has been deleted successful.",
   "success" : "true"
}

IPDS - DoS

DoS beskyttelse har forskellige regler, afhænger af beskyttelsesregel, den anvendes til en anden del af balanceren. Så der er systemet regler, at det gælder alle balancer. Forbindelsesorienterede regler, specifikke for gård arbejder med TCP-protokollen. Før du anvender en regel til a gård, opret et objekt med den ønskede konfiguration. Derefter anvendte den på alle gårde, som du har brug for den. Det systemet regler har objektet allerede oprettet og kun har en mulig konfiguration. Når du er konfigureret, skal du aktivere den.

Farm DoS regler

Det er nødvendigt at oprette et objekt før at anvende en regel på en gård.

limitsec

Begrænsning af ny forbindelse pr. Sekund og kilde. Kun tilgængelig på gårde arbejder med TCP-protokollen.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.
begrænse nummer Det er maksimalt antal nye forbindelser per sekund for en kilde.
limit_burst nummer Det er en tilladt top af nye forbindelser. En burst-enhed regenereres, når "grænse" sekunder passerer.

limitconns

Begræns totalstrømforbindelser pr. Kilde. Kun tilgængelig på gårde arbejder med TCP-protokollen.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.
limit_conns nummer Det er maksimalt antal nuværende forbindelse fra en kilde.

bogustcpflags

Check TCP-protokollen respekteres. Denne regel har ikke konfigurationsparametre, så der kun oprettes en genstand, du kan bruge på alle gårde. Kun tilgængelig på gårde arbejder med TCP-protokollen.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.

limitrst

Begræns antal nulstillingsforespørgsler pr. Sekund. Kun tilgængelig på gårde arbejder med TCP-protokollen.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.
begrænse nummer Det er maksimalt antal nulstillingsforespørgsler pr. Sekund for en kilde.
limit_burst nummer Det er en tilladt top for nulstillingsanmodning. En burst-enhed regenereres, når "grænse" sekunder passerer.

System DoS regler

I systemets DoS-regler er objektet ikke blevet oprettet.

sshbruteforce

Grænsen for den nye ssh-forbindelse.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator. Identifikatoren er defineret som ssh_brute_force.
hits nummer Antal hits for kilde før, end forbindelserne er blokeret.
tid nummer Tid i sekunder for at nulstille hits tæller.
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

dropicmp

Systemet taber icmp-anmodningen.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator. Identifikatoren er defineret som drop_icmp.
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

Angiv alle typer DoS-regler

Angiv alle typer DoS-regler

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/rules

GET /ipds/dos/rules

Vis en liste over DoS regler. De er ikke objekt, men typer til at definere det.

Hver regel har forskellige konfigurationsparametre

Svar eksempel:

{
   "description" : "Get DoS settings.",
   "params" : {
      "farm" : [
         {
            "description" : "Connection limit per seconds.",
            "rule" : "limitsec"
         },
         {
            "description" : "Total connections limit per source IP.",
            "rule" : "limitconns"
         },
         {
            "description" : "Check bogus TCP flags.",
            "rule" : "bogustcpflags"
         },
         {
            "description" : "Limit RST request per second.",
            "rule" : "limitrst"
         }
      ],
      "system" : [
         {
            "description" : "SSH brute force.",
            "rule" : "sshbruteforce"
         },
         {
            "description" : "Drop icmp packets",
            "rule" : "dropicmp"
         }
      ]
   }
}

Response parametre

JSON-responsen har to arrays gård og systemet. Hvert array-element er en type regel, der skal gælde for en gård o systemet.

Field Type Beskrivelse
beskrivelse String Kort beskrivelse af reglen.
regere String type regel unik identifikator.

Liste over alle DoS regler

Liste over alle DoS-objekter

Forespørgselseksempel:

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

GET /ipds/dos

Vis konfiguration for alle eksisterende DoS-objekter.

Svar eksempel:

{
   "description" : "Get DoS settings.",
   "params" : [
      {
         "farms" : [],
         "limit_conns" : 10,
         "name" : "limitConnHttp",
         "rule" : "limitconns",
         "type" : "farm"
      },
      {
         "farms" : [],
         "limit" : 2,
         "limit_burst" : 2,
         "name" : "limitUsers",
         "rule" : "limitsec",
         "type" : "farm"
      },
      {
         "hits" : 5,
         "name" : "ssh_brute_force",
         "port" : 22,
         "rule" : "sshbruteforce",
         "status" : "down",
         "time" : 180,
         "type" : "system"
      },
      {
         "name" : "drop_icmp",
         "rule" : "dropicmp",
         "status" : "down",
         "type" : "system"
      },
      {
         "farms" : [],
         "name" : "tcpAuth",
         "rule" : "bogustcpflags",
         "type" : "farm"
      },
      {
         "farms" : [],
         "limit" : 2,
         "limit_burst" : 2,
         "name" : "dos4",
         "rule" : "limitrst",
         "type" : "farm"
      },
   ]
}

Response parametre

Svaret er et array med alle tilgængelige DoS-objekter.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.
regere String Det er typen regelidentifikator.
typen String De mulige værdier er: gård, reglen gælder for bedrifter; eller systemet, reglen gælder for systemet.

Afhængigt af reglen, indeholder objektet de næste parametre

limitsec

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
begrænse nummer Det er maksimalt antal nye forbindelser per sekund for en kilde.
limit_burst nummer Det er en tilladt top af nye forbindelser. En burst-enhed regenereres, når "grænse" sekunder passerer.

limitconns

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
limit_conns nummer Det er maksimalt antal nuværende forbindelse fra en kilde.

bogustcpflags

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.

limitrst

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
begrænse nummer Det er maksimalt antal nulstillingsforespørgsler pr. Sekund for en kilde.
limit_burst nummer Det er en tilladt top for nulstillingsanmodning. En burst-enhed regenereres, når "grænse" sekunder passerer.

sshbruteforce

Field Type Beskrivelse
hits nummer Antal hits for kilde før, end forbindelserne er blokeret.
tid nummer Tid i sekunder for at nulstille hits tæller.
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

dropicmp

Field Type Beskrivelse
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

Hent en DoS-regel

Hent en DoS-regel

Forespørgselseksempel for landbrugsregel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/limitConnHttp

Forespørgselseksempel for systemregel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/ssh_brute_force

GET /ipds/dos/<name>

Hvert DoS-objekt kan have en anden konfiguration. navn er DoS-regelens unikke identifikator.

Svareksempel for landbrugsregel:

{
   "description" : "Get DoS limitConnHttp settings",
   "params" : {
      "farms" : [],
      "limit_conns" : 10,
      "name" : "limitConnHttp",
      "rule" : "limitconns",
      "type" : "farm"
   }
}

Svareksempel for systemregel:

{
   "description" : "Get DoS ssh_brute_force settings",
   "params" : {
      "hits" : 5,
      "name" : "ssh_brute_force",
      "port" : 22,
      "rule" : "sshbruteforce",
      "status" : "down",
      "time" : 180,
      "type" : "system"
   }
}

Response parametre

Svaret er et array med alle tilgængelige DoS-objekter.

Field Type Beskrivelse
navn String Det er objektreglen unik identifikator.
regere String Det er typen regelidentifikator.
typen String De mulige værdier er: gård, reglen gælder for bedrifter; eller systemet, reglen gælder for systemet.

Afhængigt af reglen, indeholder objektet de næste parametre

limitsec

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
begrænse nummer Det er maksimalt antal nye forbindelser per sekund for en kilde.
limit_burst nummer Det er en tilladt top af nye forbindelser. En burst-enhed regenereres, når "grænse" sekunder passerer.

limitconns

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
limit_conns nummer Det er maksimalt antal nuværende forbindelse fra en kilde.

bogustcpflags

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.

limitrst

Field Type Beskrivelse
gårde Snor[] Gårde hvor reglen anvendes.
begrænse nummer Det er maksimalt antal nulstillingsforespørgsler pr. Sekund for en kilde.
limit_burst nummer Det er en tilladt top for nulstillingsanmodning. En burst-enhed regenereres, når "grænse" sekunder passerer.

sshbruteforce

Field Type Beskrivelse
hits nummer Antal hits for kilde før, end forbindelserne er blokeret.
tid nummer Tid i sekunder for at nulstille hits tæller.
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

dropicmp

Field Type Beskrivelse
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

Opret en DoS-regel

Opret en DoS-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"name":"limitUsers", "rule":"limitsec"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos

POST /ipds/dos

Opret et DoS-objekt for at bruge det som gårde, som det er nødvendigt.

Hvert DoS-objekt kan have en anden konfiguration.

Anmod om parametre

Field Type Beskrivelse påkrævet
navn String Det er objektreglen unik identifikator. sand
regere String Det er typen regelidentifikator. Indstillingerne er: limitconns, limitsec, limitrst or bogustcpflags. sand

Svar eksempel:

{
   "description" : "Post a DoS rule",
   "params" : {
      "farms" : [],
      "limit" : 2,
      "limit_burst" : 2,
      "name" : "limitUsers",
      "rule" : "limitsec",
      "type" : "farm"
   }
}

Response parametre

Svaret vil være en json med standardkonfigurationen for den oprettede regel. Se svareksempel for mere information.

Ændre en DoS-regel

Ændre en DoS-regel

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"hits":"10","status":"up","time":"100"}'
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/ssh_brute_force

PUT /ipds/dos/<name>

Ændre en DoS-regel. navn er DoS-regelens unikke identifikator.

Anmod om parametre

Hver type regel kan være forskellige parametre. De modificerbare parametre er de næste:

limitsec

Field Type Beskrivelse
begrænse nummer Det er maksimalt antal nye forbindelser per sekund for en kilde.
limit_burst nummer Det er en tilladt top af nye forbindelser. En burst-enhed regenereres, når "grænse" sekunder passerer.

limitconns

Field Type Beskrivelse
limit_conns nummer Det er maksimalt antal nuværende forbindelse fra en kilde.

bogustcpflags

Nej har parametre.

limitrst

Field Type Beskrivelse
begrænse nummer Det er maksimalt antal nulstillingsforespørgsler pr. Sekund for en kilde.
limit_burst nummer Det er en tilladt top for nulstillingsanmodning. En burst-enhed regenereres, når "grænse" sekunder passerer.

sshbruteforce

Field Type Beskrivelse
hits nummer Antal hits for kilde før, end forbindelserne er blokeret.
tid nummer Tid i sekunder for at nulstille hits tæller.
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

dropicmp

Field Type Beskrivelse
status String Vis regelstatusen, de mulige værdier er: up systemet falder icmp anmodninger; eller ned systemet tillader icmp anmodninger.

Svar eksempel:

{
   "description" : "Put DoS rule settings",
   "params" : {
      "hits" : 10,
      "name" : "ssh_brute_force",
      "port" : 22,
      "rule" : "sshbruteforce",
      "status" : "up",
      "time" : 100,
      "type" : "system"
   },
   "success" : "true"
}

Response parametre

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

Slet en DoS-regel

Slet en DoS-regel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zenlb_server>:444/zapi/v3/zapi.cgi/ipds/dos/limitConnHttp

DELETE /ipds/dos/<name>

Systemregler kan ikke slettes. For at deaktivere den skal du sætte statusen til ned. navn er DoS-regelens unikke identifikator.

Svar eksempel:

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

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/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 version.

Vis DNS

Vis DNS

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3/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/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 SSH

Vis SSH

Forespørgselseksempel:

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

GET /system/ssh

Vis SSH-servicekonfigurationen.

Anmod om parametre

Field Type Beskrivelse
lytte String IP-system, hvor SSH-tjenesten lytter. Det Karakter * bruges til at lytte i alle konfigurerede IP'er.
port String Port konfigureret til SSH service.

Svar eksempel:

{
   "description" : "Get ssh",
   "params" : {
      "listen" : "*",
      "port" : "22"
   }
}

Response parametre

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

Ændre SSH

Ændre SSH

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"listen":"192.168.100.241","port":"22"}' 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/ssh

POST /system/ssh

Rediger SSH-servicekonfigurationen.

Anmod om parametre

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

Field Type Beskrivelse
lytte String IP-system, hvor SSH-tjenesten lytter. Det Karakter * bruges til at lytte i alle konfigurerede IP'er.
port String Port konfigureret til SSH service.

Svar eksempel:

{
   "description" : "Post ssh",
   "params" : {
      "listen" : "192.168.100.241",
      "port" : "22"
   }
}

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

Vis HTTP-server

Vis HTTP-server

Forespørgselseksempel:

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

GET /system/http

Vis HTTP-servicekonfigurationen. Det er her Zevenet API og GUI kører.

Svar eksempel:

{
   "description" : "Get http",
   "params" : {
      "ip" : "*",
      "port" : "444"
   }
}

Response parametre

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

Field Type Beskrivelse
ip String IP, hvor HTTP-serveren lytter. Det Karakter * bruges til at lytte i alle konfigurerede IP'er.
port String Port, hvor HTTP-tjenesten lytter.

Ændre HTTP-server

Ændre HTTP-server

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"ip":"192.168.100.241","port":"80"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/http

POST /system/http

Ændre HTTP-tjenesten konfiguration.

Anmod om parametre

Field Type Beskrivelse
ip String IP, hvor HTTP-serveren lytter. Det Karakter * bruges til at lytte i alle konfigurerede IP'er.
port String Port, hvor HTTP-tjenesten lytter.

Svar eksempel:

{
   "description" : "Post http",
   "params" : {
      "ip" : "192.168.100.241",
      "port" : "80"
   }
}

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

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

Download en logfil

Download en logfiler

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3/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/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/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/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/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/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/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"
   }
}

System - Notifikationer

Meddelelser er dannet af to elementer: Sender metode og type af alert.

I advarselssektionen kan du vælge hvilken type alarm du ønsker at modtage. Faktisk er advarslerne fokuseret i backend eller cluster status, så balanceren sender en besked, hvis nogle skifter.

I metode sektionen kan du vælge, hvilken afsender der skal bruges, når Zevenet skal sende en anmeldelse.

Vis advarselsstatus

Vis advarselsstatus

Forespørgselseksempel:

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

GET /system/notifications/alerts

Angiv alle typer advarsler med deres status.

Svar eksempel:

{
   "description" : "Get notifications alert status",
   "params" : [
      {
         "alert" : "backends",
         "status" : "disabled"
      },
      {
         "alert" : "cluster",
         "status" : "disabled"
      }
   ]
}

Response parametre

Field Type Beskrivelse
alert String Type alarm, den bruges som alarm unik identifikator. De tilgængelige advarsler er: backend, underrette, når en backend ændrer status; eller klynge, send en besked, når klyngemesterknuden skifter til anden knudepunkt.
status String Vis om varsling er deaktiveret, systemet sender ikke besked, når der er en begivenhed; eller aktiveret, sender systemet en advarsel, når det registreres en ændret status.

Hent meddelelsesvarsler

Hent meddelelsesvarsler

Forespørgselseksempel:

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

GET /system/notifications/alerts/<alert>

Vis konfigurationen om en type alarm.

alert er den advarsel unikke identifikator.

Svar eksempel:

{
   "description" : "Get notifications alert backends settings",
   "params" : {
      "avoidflappingtime" : 5,
      "prefix" : "",
      "status" : "disabled"
   }
}

Response parametre

Field Type Beskrivelse
avoidflappingtime nummer Nogle gange er backends tilgængelige eller ikke på kort tid, dette område tillader at konfigurere en tidsperiode for at undgå beskedmeddelelser, mens backend ændrer status, når denne tidsperiode slutter, hvis den backend-status det er anderledes at starte, så Meddelelsen er sendt.
præfiks String Det er et præfiks for e-mail-emnet, der sendes af systemet til denne form for advarsel.
status String Vis om varsling er deaktiveret, systemet sender ikke besked, når der er en begivenhed; eller aktiveret, sender systemet en advarsel, når det registreres en ændret status.

Rediger underretningsadvarsel

Rediger underretningsadvarsler

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
{"avoidflappingtime":10,"prefix":"[backend alert]"} 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts/backends

POST /system/notifications/alerts/<alert>

alert er den advarsel unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
avoidflappingtime nummer Nogle gange er backends tilgængelige eller ikke på kort tid, dette område tillader at konfigurere en tidsperiode for at undgå beskedmeddelelser, mens backend ændrer status, når denne tidsperiode slutter, hvis den backend-status det er anderledes at starte, så Meddelelsen er sendt. Denne parameter er ikke i klyngealarm, klynge har sin egen swich-tid.
præfiks String Det er et præfiks for e-mail-emnet, der sendes af systemet til denne form for advarsel.

Svar eksempel:

{
   "description" : "Set notifications alert backends",
   "params" : {
      "avoidflappingtime" : 10,
      "prefix" : "[backend alert]"
   }
}

Response parametre

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

Aktivér advarsler

Aktivér advarsler

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
{"action":"enable"} 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/alerts/backends/actions

POST /system/notifications/alerts/<alert>/actions

Aktivér eller deaktiver meddelelserne for en type alarm.

alert er den advarsel unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
Action String De handlinger, der er tilgængelige for advarsler, er deaktiveret, systemet sender ikke besked, når der er en begivenhed; eller aktiveret, sender systemet en advarsel, når det registreres en ændret status.

Svar eksempel:

{
   "description" : "Set notifications alert backends actions",
   "params" : {
      "action" : "enable"
   }
}

Response parametre

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

Hent email konfiguration

Hent email konfiguration

Forespørgselseksempel:

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

GET /system/notifications/methods/email

Vis alle konfigurationer af e-mail afsender.

Bemærk: SMTP-port, der bruges til afsendelse af e-mails, er TCP 25, selvom TLS er aktiveret.

Svar eksempel:

{
   "description" : "Get notifications email methods",
   "params" : {
      "from" : "user@zevenet.com",
      "method" : "email",
      "password" : "******",
      "server" : "smtp.gmail.com",
      "tls" : "true",
      "to" : "adminuser@zevenet.net",
      "user" : "user@zevenet.com"
   }
}

Response parametre

Field Type Beskrivelse
fra String E-mail-konto, der sender e-mailen, vises denne konto i SMTP-overskriften Fra: og den bliver brugt, hvis modtageren svarer på e-mailen.
metode String Det er metoden unikt identifikator. Faktisk er den tilgængelige metode e-mail.
adgangskode String Adgangskode til bruger SMTP-konto, er denne adgangskode nødvendig, hvis serveren kræver SMTP-godkendelse.
server String SMTP server via e-mailen er sendt.
tls String Aktivér TLS-validering for at sende e-mail, denne ejendom bruger STARTTLS, og denne funktion skal understøttes i SMTP-serveren. Nogle SMTP-servere kræver aktivering af det. De mulige værdier er: sand, TLS-validering er aktiveret til afsendelse af e-mail; eller falsk, afsendelse af e-mail bruger ikke TLS-validering.
til String E-mail-konto, der modtager e-mailen, vises denne konto i SMTP-overskriften Til.
bruger String E-mail-konto tilladt at sende e-mails, er denne konto nødvendig, hvis serveren kræver SMTP-godkendelse.

Rediger email konfiguration

Rediger email konfiguration

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json'  -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"from":"user@zevenet.com","password":"verystrongpass","server":"smtp.gmail.com","to":"adminuser@zevenet.net","tls":"true","user":"user@zevenet.com"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/methods/email

POST /system/notifications/methods/email

Rediger konfigurationen af ​​e-mail afsender metode.

Anmod om parametre

Field Type Beskrivelse
fra String E-mail-konto, der sender e-mailen, vises denne konto i SMTP-overskriften Fra: og den bliver brugt, hvis modtageren svarer på e-mailen.
adgangskode String Adgangskode til bruger SMTP-konto, er denne adgangskode nødvendig, hvis serveren kræver SMTP-godkendelse.
server String SMTP server via e-mailen er sendt.
tls String Aktivér TLS-validering for at sende e-mail, denne ejendom bruger STARTTLS, og denne funktion skal understøttes i SMTP-serveren. Nogle SMTP-servere kræver aktivering af det. De mulige værdier er: sand, TLS-validering er aktiveret til afsendelse af e-mail; eller falsk, afsendelse af e-mail bruger ikke TLS-validering.
til String E-mail-konto, der modtager e-mailen, vises denne konto i SMTP-overskriften Til.
bruger String E-mail-konto tilladt at sende e-mails, er denne konto nødvendig, hvis serveren kræver SMTP-godkendelse.

Svar eksempel:

{
   "description" : "Get notifications email methods",
   "params" : {
      "from" : "user@zevenet.com",
      "method" : "email",
      "password" : "verystrongpass",
      "server" : "smtp.gmail.com",
      "tls" : "true",
      "to" : "adminuser@zevenet.net",
      "user" : "user@zevenet.com"
   }
}

Response parametre

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

Send en test mail

Send en test mail

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json'  -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"action":"test"}' 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/notifications/methods/email/actions

POST /system/notifications/methods/email/actions

Send en test mail med e-mail-konfigurationen for at teste den.

Anmod om parametre

Field Type Beskrivelse
Action String Værdien til at sende en testmail er prøve.

Svar eksempel:

{
   "description" : "Send test mail",
   "message" : "Test mail sent successful.",
   "success" : "true"
}

Download en supportsave

Download en supportsave

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
https://<zevenet_server>:444/zapi/v3/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.

System - Cluster

Klyngen er elementet udført af en master node, at den styrer forbindelserne fordward backends, og en backup node kontrollerer master, det er parat til at swich til master node, hvis det går til down status.

Når der er status skiftet, gendanner backup-noden alle forbindelsesstatus i sig selv. Så klienten opdager ikke en afbrydelse i tjenesten.

Dette laver belastningsbalanceren i høj tilgængelighed. Så hvis der er noget problem i en Zevenet, vil tjenesten fortsætte med at arbejde med den uploadede konfiguration.

Vis klyngekonfigurationen

Vis klyngekonfigurationen

Forespørgselseksempel:

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

GET /system/cluster

Vis alle konfigurationer om klyngen.

Response Body:

{
   "description" : "Show the cluster configuration",
   "params" : {
      "check_interval" : 5,
      "failback" : "disabled",
      "interface" : "eth0",
      "nodes" : [
         {
            "ip" : "192.168.100.241",
            "name" : "canoDEV4100",
            "node" : "local"
         },
         {
            "ip" : "192.168.100.240",
            "name" : "maqvir",
            "node" : "remote"
         }
      ]
   }
}

Response parametre

Svaret vil være et JSON objekt med klyngekonfigurationen og en matrix med noderne i den.

Klusterobjekt:

Field Type Beskrivelse
check_interval nummer Det er ventetiden mellem to kontroller af master node status.
failback String Hvilken knude har præference at være herre. Værdierne kan være a navn node, for at give præference til en node; eller deaktiveret, hvis nogen node kan være mester og ikke er prioriteret for en.
grænseflade String Interface, hvor nodens IP er konfigureret.
noder Objekt[] Klyngens noder.

Node Object:

Field Type Beskrivelse
ip String Det er IP konfigureret i noden for at kontrollere nodens status og for at gøre informationsreplikationen.
navn String Det er nodens værtsnavn, og det bruges som nodens unikke identifikator.
node String De mulige værdier er: lokale, hvis node er, som modtager zapi-anmodningen; eller fjern, hvis er den anden node konfigureret i klynge.

Aktivér en klynge

Aktivér en klynge

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"local_ip":"192.168.100.241","remote_ip":"192.168.100.240","remote_password":"admin"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster

POST /system/cluster

Lav en klynge, der kommunikerer to balancere.

Anmod om parametre

Field Type Beskrivelse påkrævet
remote_ip String IP af fjernværten bruges til klyngen. sand
local_ip String IP af lokal vært brugt til klyngen. sand
remote_password String Root brugeradgangskode til fjernbalancer. sand

Response Body:

{
   "description" : "Enabling cluster",
   "message" : "Cluster enabled successfully",
   "success" : "true"
}

Ændring af klyngekonfiguration

Ændring af klyngekonfiguration

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"check_interval":4,"failback":"disabled"}'
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster

PUT /system/cluster

Konfigurer arbejdsmodusparametre for klynge.

Anmod om parametre

Field Type Beskrivelse
check_interval nummer Det er ventetiden mellem to kontroller af master node status.
failback String Hvilken knude har præference at være herre. Værdierne kan være a navn node, for at give præference til en node; eller deaktiveret, hvis nogen node kan være mester og ikke er prioriteret for en.

Response Body:

{
   "description" : "Modifying the cluster configuration",
   "params" : {
      "check_interval" : "4",
      "failback" : "disabled"
   }
}

Deaktiver klyngen

Deaktiver klyngen

Forespørgselseksempel:

curl -k -X DELETE -H 'Content-Type: application/json' 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster

DELETE /system/cluster

Fjern klyngen.

Response Body:

{
   "description" : "Disabling cluster",
   "message" : "Cluster disabled successfully",
   "success" : "true"
}

Vedligeholdelsestilstand

Vedligeholdelsestilstand

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>" 
-d '{"action":"maintenance","status":"enable"}' 
https://<zevenet_server>:444/zapi/v3/zapi.cgi/system/cluster/actions

POST /system/cluster/actions

Skift den lokale klyngenode til vedligeholdelsestilstand.

Response Body:

{
   "description" : "Setting maintenance mode",
   "message" : "Local cluster node changed to maintenance mode successfully",
   "success" : "true"
}

Anmod om parametre

Field Type Beskrivelse påkrævet
Action String Handling til anvendelse på klyngen. Den tilgængelige handling er vedligeholdelse. sand
status String Status til at sætte noden, de mulige værdier er muliggøre, læg det i vedligeholdelsestilstand eller deaktivere, sæt noden til rådighed. sand

Vis nodestatus

Vis nodestatus

Forespørgselseksempel:

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

GET /system/cluster/nodes

Vis status for alle knudepunkter.

Response Body:

{
   "description" : "Cluster nodes status",
   "params" : [
      {
         "ip" : "192.168.100.241",
         "message" : "Node online and active",
         "name" : "canoDEV4100",
         "node" : "local",
         "role" : "master",
         "status" : "ok"
      },
      {
         "ip" : "192.168.100.240",
         "message" : "Node online and passive",
         "name" : "maqvir",
         "node" : "remote",
         "role" : "backup",
         "status" : "ok"
      }
   ]
}

Response parametre

Svaret bliver en JSON med nøgle param og værdi en række node status objekt.

Node status objekt

Field Type Beskrivelse
ip String Det er IP konfigureret i noden for at kontrollere nodens status og for at gøre informationsreplikationen.
navn String Det er nodens værtsnavn, og det bruges som nodens unikke identifikator.
node String De mulige værdier er: lokale, hvis node er, som modtager zapi-anmodningen; eller fjern, hvis er den anden node konfigureret i klynge.
besked String Beskrivende besked, der angiver status og driftstilstand for noden.
rolle String Faktisk arbejdsmodus af denne knudepunkt. De mulige værdier er: Master, denne knude styrer forbindelserne mellem backends og klienter; eller backup, denne knude har svaret mesterstatusforbindelser og masterkonfiguration, og det kontrollerer, at mastertjenesten fungerer.
status String Angiv, om en vis klyngeproces fejler.

Vis lokalhost cluster status

Vis lokalhost cluster status

Forespørgselseksempel:

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

GET /system/cluster/nodes/localhost

Vis status for lokal node.

Response Body:

{
   "description" : "Cluster status for localhost",
   "params" : {
      "message" : "Node online and active",
      "name" : "canoDEV4100",
      "role" : "master",
      "status" : "ok"
   }
}

Response parametre

Field Type Beskrivelse
besked String Beskrivende besked, der angiver status og driftstilstand for noden.
navn String Det er nodens værtsnavn, og det bruges som nodens unikke identifikator.
rolle String Faktisk arbejdsmodus af denne knudepunkt. De mulige værdier er: Master, denne knude styrer forbindelserne mellem backends og klienter; eller backup, denne knude har svaret mesterstatusforbindelser og masterkonfiguration, og det kontrollerer, at mastertjenesten fungerer.
status String Angiv, om en vis klyngeproces fejler.