NAV Navbar
Logo
krølle zcli

Zevenet API v4.0 Reference

ZAPI (Zevenet Anvendelsen PROGRAMMERING Interface) er værktøjet til systemadministratorer til at styre Zevenet load balancer adfærd.

Det er nødvendigt at aktivere root zapi-brugeren fra webgrænsefladen, før den bruges, System> Brugere.

Når ZAPI-brugeren er oprettet, er det muligt at sende anmodninger til HTTP-serveren. En URI-anmodning ligner:

HTTP verb https://zevenet_server: 444 / ZAPI / v4.0 / zapi.cgi /URI_path,

hvor zevenet_server er den IP, hvor HTTP-tjenesten lytter, HTTP-administrationsgrænsefladen og URI_path definerer det objekt, der vil blive anmodet om. Sådan får du adgang til og hvordan du ændrer hver Zevenet-objekt, defineres inden for hver dokumentationsafdeling.

HTTP verbs accepteret til ZAPI er:

ZAPI parametre

ZAPI parametre

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-H 'Content-Type: application/json' -d ''
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms

A PUT POST anmodninger har altid brug for næsten en parameter, selvom ZAPI-opkaldet ikke behøver nogen obligatorisk (obligatorisk) parameter. Hvis en PUT- eller POST-anmodning sendes uden parametre, returnerer ZAPI listen over forventede parametre og deres mulige valgmuligheder.

Svar eksempel:

{
   "description" : "No parameter has been sent. Please, try with:",
   "params" : [
      {
         "name" : "profile",
         "options" : [
            "required"
         ],
         "possible_values" : [
            "http",
            "gslb",
            "l4xnat",
            "datalink"
         ]
      },
      {
         "format" : "ip_addr",
         "name" : "vip",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "expects a port",
         "name" : "vport",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "The farm name is required to have alphabet letters, numbers or hypens (-) only.",
         "format" : "farm_name",
         "name" : "farmname",
         "options" : [
            "required"
         ]
      }
   ]
}

Response parametre

Svaret er en liste over felter, der beskriver parameteren og de mulige valgmuligheder for konfiguration:

Parameterbeskrivelse:

Field Type Beskrivelse
navn String Det er nøgle til den accepterede værdi. Følgende parametre bruges til at definere det.
beskrivelse String Det er information om den forventede værdi.
interval String Parameteren skal have en numerisk værdi, der respekterer de lave, høje eller begge grænser. De anvendte værdier som grænser er taget som gyldige.
format String Det kan være et tegn på det forventede format for parameteren, det kan være et regulært udtryk eller en nøgle, der identificerer dataene.
POSSIBLE_VALUES Snor[] Det er listen over mulige værdier, som parameteren skal have.
optioner Snor[] Det viser mere konfiguration at tage hensyn til.

Liste over muligheder:

Field Beskrivelse
påkrævet Denne indstilling angiver, at parameteren er obligatorisk, den skal sendes i anmodningen.
non_blank Denne mulighed gør det muligt at sende en tom streng som parameter værdi. Det kan være nyttigt at afbryde parameteren.

fejlkoder

ZAPI'en kan reagere på en af ​​følgende fejlkoder:

Fejlkode Brief Beskrivelse
400 Dårlig anmodning Nogle anmodningsparametre er forkerte.
401 Uberettiget Din ZAPI-nøgle er forkert.
402 Certifikatet er ikke gyldigt Lastbalanceren har brug for et gyldigt certifikat til behandling af anmodningen.
403 Forbudt Bruger ejeren af ​​ZAPI-nøglen har ikke tilladelser til anmodningen eller det objekt, der anvendes i det.
404 Ikke fundet Den anvendte URI eller et objekt, der anvendes i opkaldet, findes ikke.
405 Metode ikke tilladt HTTP-verben eksisterer ikke eller implementeres ikke for det nuværende ZAPI-opkald.
406 Ikke acceptabelt Denne funktion er ikke midlertidig tilgængelig.
409 Konflikt Forespørgslen er gyldig, men den kunne ikke behandles, og den nye konfiguration skabte en konflikt med den nuværende. Syslog kunne tilbyde flere oplysninger.
410 Gone Denne funktion er blevet fjernet.
500 Internal Server Error Der opstod en fejl i serveren.
504 Gateway timeout Serverrespons timeout er nået, og anmodningen er ikke færdig med behandlingen.

Ændringer log

Dette er listen over ændringer, der er inkluderet i hver version. Listen over ændringer i en ZAPI-version gælder altid før dengang.

API 4.0.2

Denne ZAPI-version er en udvidelse af version 4.0.1. Nogle parametre og URI'er blev tilføjet, men alle af dem blev fjernet.

Nyt VPN-modul:

Lagt GET|POST|PUT|DELETE /vpns/*

Nye parametre:

fejlWAF, omskriveplacering (kun tilføjet nye muligheder for zproxy), genskriverl, fastgjort forbindelse, routingpolitik, forbindelsesgrænse:

Ændret: GET|PUT /farms/<farmname>. Ændret: GET|PUT /farms/<farmname>/services/<id>.

Nye API'er til at tilføje rewriteurl:

Lagt ADD|DELETE /farms/<farmname>/service/<servicename>/rewriteurl/*

Nye API'er til at tilføje regler for omskrivning af overskrifter:

Lagt ADD|DELETE /farms/MyHttpFarm/replacerequestheader/* Lagt ADD|DELETE /farms/MyHttpFarm/replaceresponseheader/*

Tilføjede anmodninger om at administrere statiske sessioner (kun zproxy):

Lagt GET|POST|DELETE /farms/<farmname>/services/<servicename>/sessions/*

Tilføjet parameter timeout:

Ændret: GET /monitoring/fg/<name>. Ændret: POST|PUT /monitoring/fg.

Konfigurer flere ips og porte:

Modificeret ADD|POST /system/ssh, accepter nu arrays i lytte- og portparametrene.

Konfigurer flere ips og porte til cherokee server:

Modificeret ADD|POST /system/http, accepter nu arrays i ip- og portparametrene.

Konfigurer servercertifikatet:

Lagt GET|POST /system/https/certificate.

Tilføjede parametre samlede_sessioner ttl:

Ændret: GET /stats/farms/<farmname>

Tilføjet parameter waf_assistent:

Modificeret GET|POST /system/global

Nye rsyslog API'er til at konfigurere logfiler til at sende dem til fjernserver:

tilføjede: GET|POST|DELETE /system/rsyslog.

Tilføjet parameter track_interface:

Ændret: GET|PUT /system/cluster.

API 4.0.1

Denne ZAPI-version er en udvidelse af version 4.0. Nogle parametre og URI'er blev tilføjet, men alle af dem blev fjernet.

Tilføj en anmodning om at vise et træ med alle objekter i belastningsbalanceren

Tilføj: GET / id'er

Mulighed for at kopiere en gård

Ændret: POST /farms

Tilføj parametre addresponseheader fjernelse af svarhoved og udvid parameteren httpverb:

Modificeret GET /farms/<farmname>

Modificeret PUT /farms/<farmname>

Tilføj POST /farms/<farmname>/addresponseheader|removeresponseheader

Tilføj DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>

Tilføj anmodninger om at administrere statiske sessioner:

Tilføj GET /farms/<farmname>/sessions

Tilføj POST /farms/<farmname>/sessions

Tilføj DELETE /farms/<farmname>/sessions/<session>

Nyt routingmodul:

Lagt GET|POST|PUT|DELETE /routing/*

Farmguardian kan bruge backend-aliaset som værtsnavn til kontrol:

Lagt GET|PUT /monitoring/fg*/<farmguardian>

Håndter filer til WAF-regler:

Lagt GET|PUT|DELETE /ipds/waf/files

Hent systemoplysninger:

tilføjede: GET /system/info

Ændrede globale indstillinger:

tilføjede: GET|POST /system/global

Godkendelse vha. LDAP:

Lagt GET|POST /rbac/services

Lagt GET|POST /rbac/ldap*

Modificeret GET|POST /rbac/users

Modificeret GET|PUT /rbac/users/<user>

API 4.0

Skriv et resumé af de gårde og tjenester, der er grupperet for modulet:

tilføjede: /farms/modules/summary

Handlinger til at forbinde WAF-regel sæt med HTTP-bedrifter:

tilføjede: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*

Ændret: GET /farms/<farm>

Flyt certifikater i en HTTPS-bedrift:

tilføjede: POST /farms/<farm>/certificates/<cert>/actions

Modificer gårdeopkald relateret til l4xnat for at understøtte den nye kerne:

Ændret: GET|POST|PUT|DELETE /farms/<l4farm>

Tilføjet DHCP MAC funktioner i følgende ZAPI-opkald:

ændret: PUT /interfaces/nic/<if>

ændret: PUT /interfaces/bonding/<if>

ændret: POST /interfaces/vlan

ændret: PUT /interfaces/vlan/<if>

Omdøb parameter for at kopiere en gårdsbeskytter:

Ændret: POST /monitoring/fg

Forvaltning af IPDS-pakken:

tilføjede: GET /ipds/package

tilføjede: POST /ipds/package/actions

Ny webprogram firewall, WAF, funktion:

tilføjede: GET|POST|PUT|DELETE /ipds/waf/*

Fjern opkaldet til kopiering af RBL-regler. Nu er det en parameter for oprettelsen af ​​opkald:

fjernet: POST /ipds/rbl/<name>

ændret: POST /ipds/waf/<name>

Funktionerne Gendan fabriksindstillinger, proxy check pakke opdateringer er tilføjet:

tilføjede: POST /system/factory

tilføjede: GET /system/proxy

tilføjede: POST /system/proxy

tilføjede: GET /system/packages

Tilføj parameter til at administrere web GUI menuerne:

tilføjede: GET /rbac/menus

Ændret: PUT /rbac/roles/<ROLE>

Aktiveringscertifikater

Aktiveringsattesten er den licens, der udstedes af Zevenet, der muliggør fuldstændig brug af lastbalanceren i sin Enterprise version.

Vis aktiveringsattestoplysninger

Vis aktiveringsattestoplysninger

Forespørgselseksempel:

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

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/v4.0/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"
}

Slet aktiveringscertifikatet

Slet aktiveringscertifikatet

Forespørgselseksempel:

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

SSL-certifikater

Zevenet understøtter certifikater i PEM-format for at bruge dem med HTTP-bedrifter, der er oprettet med HTTPS-lytteren. Hvis du vil lære mere om, hvordan du opretter PEM certifikater, besøg venligst 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/v4.0/zapi.cgi/certificates
zcli certificate list

GET /certificates

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

Svar eksempel:

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.

{
   "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 Det er 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate download example.pem 

GET /certificates/<file>

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

Svar overskrifter:

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

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/v4.0/zapi.cgi/certificates/example.pem/info
zcli certificate get example.pem

GET /certificates/<file>/info

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

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

Slet et certifikat

Slet et certifikat

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate delete example.pem

DELETE /certificates/<file>

Slet et certifikat efter filnavn i certifikatbutikken.

Svar eksempel:

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

Opret et PEM-certifikat

Opret et PEM-certifikat

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"host.domain.com","key":"-----BEGIN PRIVATE KEY-----\nRTQwew...",
"ca","-----BEGIN CERTIFICATE-----\nFQOEW...","intermediates":"-----BEGIN CERTIFICATE-----\nQWESw..."}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/pem
zcli certificate-pem create -name host.domain.com -key "-----BEGIN PRIVATE KEY..." -ca "-----BEGIN CERTIFICATE..." -intermediates "-----BEGIN CERTIFICATE..."
"

POST /certificates/pem

Opret et PEM-certifikat (PEM-fil).

Anmod om parametre

Field Type Beskrivelse påkrævet
navn String Certifikat ID navn. sand
nøgle String Ingen krypteret privat nøgle sand
ca String Servercertifikat eller fuldkædecertifikat sand
mellemprodukter String Mellemcertifikater hvis nødvendigt falsk

Svar eksempel:

{
   "description" : "Create certificate",
   "message" : "Certificate host.domain.com created",
   "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/v4.0/zapi.cgi/certificates
zcli certificate create -name NewCSR -fqdn host.domain.com -division IT -organization 'Example Corp.' -locality Madrid -state Madrid -country ES -mail info@domain.com

POST /certificates

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 lokaliseret. 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/v4.0/zapi.cgi/certificates/example.pem
zcli certificate upload example.pem /local_path/to/example.pem

POST /certificates/<file>

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

Anmod URI-parametre

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

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

Svar eksempel:

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

Liste Cipherer

Liste Cipherer

Forespørgselseksempel:

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

GET /ciphers

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

SSL-aflæsning cipher vil kun være tilgængelig, hvis den understøttes af processoren.

Svar eksempel:

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.

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

Response parametre

Field Type Beskrivelse
params Objekt [] Liste over certifikatobjekter.

Certifikatobjekt

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

Letsencrypt SSL-certifikater

Zevenet understøtter generering og fornyelse af Letsencrypt-certifikater. Det endelige certifikat er et ZEVENET PEM-certifikat, der kan bruges med HTTPS Farms. . Hvis du vil lære mere om, hvordan du opretter PEM certifikater, besøg venligst følgende artikel: GENERERENDE CERTIFIKATER I PEM FORMAT

Vis Letsencrypt Config

Vis Letsencrypt Config

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificate-le-config list

GET /certificates/letsencryptz/config

Vis Letsencrypt-konfiguration.

Svar eksempel:

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

{
   "description" : "Get LetsEncrypt Config",
   "params" : {
      "email" : "test_le@zevenet.com"
   }
}

Response parametre

Field Type Beskrivelse
e-mail String E-mail til Letsencrypt

Rediger Letsencrypt Config

Rediger Letsencrypt Config

Forespørgselseksempel:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"email":"test_le@zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificates-le-config set -email test_le@zevenet.com

PUT /certificates/letsencryptz/config

Rediger Letsencrypt-konfigurationen.

Anmod om parametre

Field Type Beskrivelse påkrævet
e-mail String E-mail til brug som kontakt i Letsencrypt sand

Svar eksempel:

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

{
   "description" : "Modify LetsEncrypt Config",
   "message" : "The Letsencrypt Config has been updated successfully.",
   "params" : {
      "email" : "test_le@zevenet.com"
   },
   "success" : "true"
}


Response parametre

Field Type Beskrivelse
e-mail String E-mail til Letsencrypt

Liste over alle Letsencrypt-certifikater

Liste over alle Letsencrypt-certifikater

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le list 

GET /certificates/letsencryptz

Liste over alle Letsencrypt-certifikater, der er oprettet.

Svar eksempel:

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

{
   "description" : "List LetsEncrypt certificates",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "May 31 05:51:49 2021 GMT",
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "Aug 29 05:51:49 2021 GMT",
         "file" : "/usr/local/zevenet/config/letsencrypt/acme/*.wildcard.test.zevenet.com/fullchain.cer",
         "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
         "status" : "valid",
         "type" : "LE Certificate",
         "wildcard" : "true"
      },
      {
         "CN" : "*.test1.wildcard.test.zevenet.io",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.test1.wildcard.test.zevenet.io",
               "txt" : "QpbOLzMrJapoQmcbrA5_dr6ciwLzNF-y3z5XR5i-I2c"
            }
         ],
         "domains" : [
            "*.test1.wildcard.test.zevenet.io"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }

   ]
}

Response parametre

Field Type Beskrivelse
params Objekt [] Liste over certifikatobjekter.

Certifikatobjekt

Field Type Beskrivelse
CN String Domæne fælles navn.
skabelse String Oprettelsesdato.
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for.
udløb String Udløbsdato.
dnstxt Objekt[] Liste over DNS TXT Records for hvert domæne, der skal valideres, hvis certifikatet ikke er udstedt endnu.
fil String Det er certifikatets filnavn, unikt id.
udsteder String Certified Authority, der underskriver certifikatet.
status String Status for certifikatet.gyldig, certifikatet er gyldigt.ved at udløbe, certifikatet er ved at udløbe.udløbet, certifikatet er udløbet.ikke udstedt, certifikatet ventes at blive udstedt.ukendt, certifikatet er ikke gyldigt.
typen String LE certifikat.
wildcard String sand, certifikatet er for jokertegn-domæner. falsk, certifikatet er for domæner uden jokertegn.

dnstxt objekt

Field Type Beskrivelse
domæne String Domænenavn
txt String DNS txt record LetsEncrypt skal valideres. DNS TXT-posten vil være tilgængelig af _acme-challenge.domain.

Lad os kryptere SSL Wildcard-certifikater

Let's Encrypt Wildcard-certifikater er certifikater, der kun er gyldige for wildcard-domæner.

Opret et nyt Let's Encrypt Wildcard-certifikat

Opret et nyt Let's Encrypt Wildcard-certifikat

Forespørgselseksempel:

url -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"domains":["*.wildcard.test.zevenet.com"],"test":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard
zcli certificate-le-wildcard create -wildcard true 

POST /certificates/letsencryptz-wildcard

Opret et nyt Let's Encrypt jokertegn-certifikat.

Anmod om parametre

Field Type Beskrivelse påkrævet
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for. sand
prøve String sand, certifikatet er udstedt af LetsEncrypt Staging Server. falsk, certifikatet er udstedt af LetsEncrypt Server, og det vil være gyldigt for produktionsmiljøet. sand

Svar eksempel:

{
   "description" : "Create Let's Encrypt Wildcard certificate",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.wildcard.test.zevenet.com",
               "txt" : "jtt2WBHXl0cRw33mgoHUo1hbFGLipNbeb2EtTWpRORM"
            }
         ],
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }
   ]
}

Response parametre

Field Type Beskrivelse
params Objekt[] Liste over certifikatobjekter.

Certifikatobjekt

Field Type Beskrivelse
CN String Domæne fælles navn.
skabelse String Oprettelsesdato.
dnstxt Objekt[] Liste over DNS TXT Records for hvert domæne, der skal valideres, hvis certifikatet ikke er udstedt endnu.
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for.
udløb String Udløbsdato.
fil String Det er certifikatets filnavn, unikt id.
udsteder String Certified Authority, der underskriver certifikatet.
status String Status for certifikatet.gyldig, certifikatet er gyldigt.ved at udløbe, certifikatet er ved at udløbe.udløbet, certifikatet er udløbet.ikke udstedt, certifikatet ventes at blive udstedt.ukendt, certifikatet er ikke gyldigt.
typen String LE certifikat.
wildcard String sand, certifikatet er for jokertegn-domæner. falsk, certifikatet er for domæner uden jokertegn.

dnstxt objekt

Field Type Beskrivelse
domæne String Domænenavn
txt String DNS txt record LetsEncrypt skal valideres. DNS TXT-posten vil være tilgængelig af _acme-challenge.domain.

Indstil en handling i et Let's Encrypt Wildcard-certifikat

Indstil en handling i et Let's Encrypt Wildcard-certifikat

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com/actions
zcli certificate-le-wildcard renew *.example.domain.com

POST /certificates/letsencryptz-wildcard/<domain>/actions

Anvend en handling på et Let's Encrypt-certifikat, se tabellen Anmodningsparametre for handlinger.

Anmod om parametre

Field Type Beskrivelse påkrævet
aktioner String Handlingen til at udføre, mulighederne er: forny, vil certifikatet blive fornyet; prøve dns txt-posterne vil blive kontrolleret via dns-forespørgsel.
force_fornyelse String (Kun for "forny" handling ) sandtvinge certifikatet til at blive fornyet, selvom det ikke er udløbet, falsk, vil certifikatet blive fornyet, hvis det skal fornyes (mindre end 30 dage til at udløbe).
genstart String (Kun for "forny" handling ) sand, vil alle bedrifter, der bruger certifikatet, blive genstartet. falsk, ingen gårde, der bruger certifikatet, vil blive genstartet.
dns String (Kun for "test" handling ) Dns-server, der skal bruges til at teste DNS TXT-posten _acme-challenge.domain.

Svar eksempel:

{
   "description" : "Let's Encrypt wildcard certificate actions",
   "message" : "The action renew has been performed in Let's Encrypt certificate *.test1.wildcard.test.zevenet.io.",
   "params" : {
      "action" : "renew",
      "status" : "valid"
   }
}

Response parametre

Field Type Beskrivelse
params Objekt [] Liste over certifikatobjekter.

Certifikatobjekt

Field Type Beskrivelse
Action String Oprettelsesdato.
status String Status for certifikatet.gyldig, certifikatet er gyldigt.ved at udløbe, certifikatet er ved at udløbe.udløbet, certifikatet er udløbet.ikke udstedt, certifikatet ventes at blive udstedt.ukendt, certifikatet er ikke gyldigt.
dnstxt Objekt[] (Kun for "test" handling) Liste over DNS TXT Records for hvert domæne og deres DNS-forespørgselsresultater via en DNS-server.

dnstxt objekt

Field Type Beskrivelse
dns String DNS-server, der skal bruges. "tom" betyder brug af det konfigurerede i systemet.
domæne String Domænenavn
ressource Object DNS-ressource skal kontrolleres.
status String Resultat fra kontrol af DNS TXT Record via DNS-server. ned hvis DNS TXT vedr

ledningen blev ikke fundet DNS-server. up hvis DNS TXT-posten er fundet.

ressource Objekt

Field Type Beskrivelse
rname String DNS-ressourcenavn. Lad os kryptere kræver _acme-udfordring
typen String DNS record type. Lad os kryptere kræver TXT
rdata String DNS-postværdi.

Slet et jokertegn Let's Encrypt Certificate

Slet et jokertegn Let's Encrypt Certificate

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com
zcli certificate-le-wildcard delete *.example.domain.com

DELETE /certificates/letsencryptz-wildcard/<domain>

Slet et Let's Encrypt wildcard-certifikat efter domæne.

Svar eksempel:

{
   "description" : "Delete Let's Encrypt wildcard certificate",
   "message" : "Let's Encrypt wildcard Certificate example.domain.com has been deleted.",
   "success" : "true"
}

Lad os Kryptere SSL Ingen Wildcard-certifikater

Lad os kryptere ingen jokertegn-certifikater er certifikater, der kun er gyldige for ingen jokertegn-domæner.

Opret et nyt Let'sEncrypt No Wildcard-certifikat

Opret et nyt Let's Encrypt No Wildcard-certifikat

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"lefarm","domains":["test.zevenet.com"],"test":"true","wildcard":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le create -wildcard false 

POST /certificates/letsencryptz

Opret et nyt Let's Encrypt jokertegn-certifikat.

Anmod om parametre

Field Type Beskrivelse påkrævet
farmname String Gårdnavn, som en midlertidig tjeneste "Let's Encryptz" er konfigureret i. sandt, hvis param vip ikke sendes.
vip String IP af systemet, hvor en midlertidig Farm "Let's Encryptz" er konfigureret. sandt, hvis param farmname ikke sendes.
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for. sand
wildcard String sand, certifikatet er for jokertegn-domæner. falsk, certifikatet er for domæner uden jokertegn. sand
prøve String sand, certifikatet er udstedt af LetsEncrypt Staging Server. falsk, certifikatet er udstedt af LetsEncrypt Server, og det vil være gyldigt for produktionsmiljøet. sand

Svar eksempel:

{
   "description" : "Create Let's Encrypt certificate",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:05:30 2021 GMT",
      "domains" : [
         "test.zevenet.io"
      ],
      "expiration" : "Aug 29 11:05:30 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   }
}

Response parametre

Field Type Beskrivelse
params Objekt [] Liste over certifikatobjekter.

Certifikatobjekt

Field Type Beskrivelse
CN String Domæne fælles navn.
skabelse String Oprettelsesdato.
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for.
udløb String Udløbsdato.
fil String Det er certifikatets filnavn, unikt id.
udsteder String Certified Authority, der underskriver certifikatet.
status String Status for certifikatet.gyldig, certifikatet er gyldigt.ved at udløbe, certifikatet er ved at udløbe.udløbet, certifikatet er udløbet.ikke udstedt, certifikatet ventes at blive udstedt.ukendt, certifikatet er ikke gyldigt.
typen String LE certifikat.
wildcard String sand, certifikatet er for jokertegn-domæner. falsk, certifikatet er for domæner uden jokertegn.

Indstil en handling i et Let's Encrypt no Wildcard-certifikat

Indstil en handling i et Let's Encrypt No Wildcard-certifikat

Forespørgselseksempel:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","vip":"192.168.101.44","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com/actions
zcli certificate-le renew example.domain.com ( not implemented )

POST /certificates/letsencryptz/<domain>/actions

Indstil en handling i et Let's Encrypt no wildcard-certifikat, se tabellen Anmodningsparametre for handlinger.

Anmod om parametre

Field Type Beskrivelse påkrævet
Action String Handlingen der skal udføres: mulighederne er: forny, vil certifikatet blive fornyet.
farmname String Farm navn, som en midlertidig tjeneste "Let's Encryptz" er konfigureret i for at forny certifikatet. sandt, hvis param vip ikke sendes.
vip String IP af systemet, hvor en midlertidig Farm "Let's Encryptz" er konfigureret til at forny certifikatet. sandt, hvis param farmname ikke sendes.
force_fornyelse String sandtvinge certifikatet til at blive fornyet, selvom det ikke er udløbet, falsk, vil certifikatet blive fornyet, hvis det skal fornyes (mindre end 30 dage til at udløbe).
genstart String sand, vil alle bedrifter, der bruger certifikatet, blive genstartet. falsk, ingen gårde, der bruger certifikatet, vil blive genstartet.

Svar eksempel:

{
   "description" : "Let's Encrypt certificate actions",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:35:08 2021 GMT",
      "domains" : [
         "test.zevenet.com"
      ],
      "expiration" : "Aug 29 11:35:08 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   },
   "warning" : "The following farms were been restarted: testl7farm"
}

Response parametre

Hvis gårdene blev genstartet, advarsel felt beskriver det.

Field Type Beskrivelse
params Objekt [] Liste over certifikatobjekter.

Certifikatobjekt

Field Type Beskrivelse
CN String Domæne fælles navn.
skabelse String Oprettelsesdato.
Domæner Snor[] Liste over domæner, som certifikatet er gyldigt for.
udløb String Udløbsdato.
fil String Det er certifikatets filnavn, unikt id.
udsteder String Certified Authority, der underskriver certifikatet.
status String Status for certifikatet.gyldig, certifikatet er gyldigt.ved at udløbe, certifikatet er ved at udløbe.udløbet, certifikatet er udløbet.ikke udstedt, certifikatet ventes at blive udstedt.ukendt, certifikatet er ikke gyldigt.
typen String LE certifikat.
wildcard String sand, certifikatet er for jokertegn-domæner. falsk, certifikatet er for domæner uden jokertegn.

Slet et intet jokertegn Let's Encrypt-certifikat

Slet et intet jokertegn Let's Encrypt-certifikat

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com
zcli certificate-le delete example.domain.com

DELETE /certificates/letsencryptz/<domain>

Slet et Let's Encrypt-certifikat efter domæne.

Svar eksempel:

{
   "description" : "Delete Let's Encrypt certificate",
   "message" : "Let's Encrypt Certificate example.domain.com has been deleted.",
   "success" : "true"
}

Gårde

Zevenet kan 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 parametre, der er klar til at gøre en specifik handling med netværkstrafik. Det er vigtigt at forstå, hvad der kan gøre hver landbrugsprofil for at opnå de bedste resultater fra Zevenet ADC.

Skriv et resumé af bedrifter

Skriv en oversigt over gårde

Forespørgselseksempel:

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

GET /farms/modules/summary

Skriv et resumé med gårdene i systemet, grupperet efter modul.

Svar eksempel:

{
   "description" : "Farm Modules summary",
   "params" : {
      "dslb" : [],
      "gslb" : [
         {
            "name" : "dnsServ",
            "profile" : "gslb",
            "services" : []
         }
      ],
      "lslb" : [
         {
            "name" : "CatalogueWeb",
            "profile" : "http",
            "services" : [
               "technology",
               "food"
            ]
         },
         {
            "name" : "shopApp",
            "profile" : "http",
            "services" : [
               "provider",
               "clients"
            ]
         },
         {
            "name" : "VirtualApps",
            "profile" : "l4xnat"
         }
      ]
   }
}

Response parametre

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af ​​dette vil være en række gårde med deres tjenester.

Farm Object:

Field Type Beskrivelse
farmname String Farm beskrivende navn. Den bruges som en unik identifikator for gårde.
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
tjeneste Snor[] Det er listen over servicenavne, som gården indeholder. Dette felt vil være tilgængeligt i gårde af typen http, httpsog GSLB.

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/v4.0/zapi.cgi/farms
zcli farm list

GET /farms

Liste over alle tilgængelige gårde

Svar eksempel:

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

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 genbrugsgenstande, der hver især indeholder nøgleattributterne nedenfor.

Farm Object:

Field Type Beskrivelse
farmname String Farm beskrivende navn. Den bruges som en unik identifikator for gårde.
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. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip String Virtuel 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.

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/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm delete FarmHTTP

DELETE /farms/<farmname>

Slet en gård gennem sin bedriftsnavneidentifikator.

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/v4.0/zapi.cgi/farms/FarmTCP/actions
zcli farm stop FarmTCP

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 Handlingen til at udføre, mulighederne er: stoppe, gården stoppes, skærer de nuværende forbindelser og accepterer ikke flere forbindelser; starte, gården bliver startet, kører lytteren og balancerer de nye forbindelser mellem dens bagud; 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-profilen er et avanceret lag 7-belastningsbalancering (eller Application Delivery Controller) med proxy-specialegenskaber. Denne profil indeholder nogle funktioner som HTTPS belastningsbalancering kombineret med SSL offload acceleration. Denne profil er tilstrækkelig til webtjenester (inklusive 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 et virtuelt TCP port vil være 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/v4.0/zapi.cgi/farms/httpFarm
zcli farm get httpFarm

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Svar eksempel:

{
   "description" : "List farm httpFarm",
   "ipds" : {
      "blacklists" : [
         {
            "name" : "outside",
            "status" : "down"
         }
      ],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ],
      "waf" : [
         {
            "name" : "XSSi",
            "status" : "down"
         },
         {
            "name" : "SQLi",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "addheader" : [
         {
            "header" : "load-balancer: true",
            "id" : 0
         }
      ],
      "addresponseheader" : [
         {
            "header" : "Session: true",
            "id" : 0
         }
      ],
      "certlist" : [
         {
            "file" : "zencert.pem",
            "id" : 1
         }
      ],
      "cipherc" : "ALL",
      "ciphers" : "all",
      "contimeout" : 20,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "errorWAF"  : "The request was rejected by the server.",
      "error414" : "Request URI is too long.",
      "error500" : "An internal server error occurred. Please try again later.",
      "error501" : "This method may not be used.",
      "error503" : "The service is not available. Please try again later.",
      "headremove" : [
         {
            "id" : 0,
            "pattern" : "^client"
         }
      ],
      "httpverb" : "MSRPCext",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "false",
      "removeresponseheader" : [
         {
            "id" : 0,
            "pattern" : "Host"
         }
      ],
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : "check_tcp",
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "redirect" : "http://192.168.101.254/index.html",
         "redirect_code" : 302,
         "redirecttype" : "default",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
      {
         "backends" : [
            {
               "alias" : "http-server",
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null,
               "priority" : null
            }
         ],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : null,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
   ]
}

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 Objekt[] Blacklist regler anvendes på gården.
dos Objekt[] DoS regler gælder for gården.
RBL Objekt[] RBL regler anvendes på gården.
WAF Objekt[] Det er et objekt med en nøgle, navn.

Blacklist, DoS og RBL Objekt:

Field Type Beskrivelse
navn String Regelnavnet.
status String Regelstatus.

Parametre objekt for HTTP gårde:

Field Type Beskrivelse
AddHeader Objekt[] Det er en liste over objekter med overskrifterne, der skal føjes til klientanmodningen.
addresponseheader (fra 4.0.1) Objekt[] Det er en liste over objekter med overskrifterne, der skal føjes til backend-responsen.
certlist Objekt[] Kun hvis lytteren er HTTPS. Certifikatliste er blevet brugt af gården, de har i PEM-format, det er tilladt at tilføje mere end et PEM certifikat til samme gård til SNI-support. 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 felt har værdien "toldsikkerhed".
ciphers String Kun hvis lytteren er HTTPS. Bruges til at opbygge en liste over cifre accepteret af SSL-forbindelser for at hærde SSL-forbindelsen. Indstillingerne er: alle, alle cifre vil blive accepteret; highsecurity, kun cifre for høj sikkerhed vil blive accepteret; customsecurity, kun cifre indlæst i cipherc feltet vil blive accepteret eller ssloffloading, det overlader krypteringsjobbet til processen, denne chiffer afhænger af processoren.
contimeout nummer Hvor længe gården skal vente på en TCP-forbindelse til backend på sekunder.
disable_sslv2 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af en SSL-sikkerhedsprotokol med version 2 er ikke tilladt eller falsk hvis protokollen SSLv2 er tilladt.
disable_sslv3 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af en SSL-sikkerhedsprotokol med version 3 er ikke tilladt eller falsk hvis protokollen SSLv3 er tilladt.
disable_tlsv1 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1 er ikke tilladt eller falsk hvis protokollen TLSv1 er tilladt.
disable_tlsv1_1 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.1 er ikke tilladt eller falsk hvis protokollen TLSv1.1 er tilladt.
disable_tlsv1_2 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.2 er ikke tilladt eller falsk hvis protokollen TLSv1.2 er tilladt.
fejlWAF String Personlig besked til at svare, når WAF afviser en anmodning (fra 4.0.2).
error414 String Personlig besked til at reagere med 414 HTTP fejlkode.
error500 String Personlig besked til at reagere med 500 HTTP fejlkode.
error501 String Personlig besked til at reagere med 501 HTTP fejlkode.
error503 String Personlig besked til at reagere med 503 HTTP fejlkode.
headremove Objekt[] Det er en liste over regulære udtryk for at fjerne overskrifter fra klientens anmodninger. De fjernede overskrifter kommer ikke til bagenden.
httpverb String Dette felt angiver de operationer, der vil blive tilladt for HTTP-klientanmodningerne. tilgængelige værdier er: standardHTTP, accepterede HTTP-anmodninger GET, POST, HEAD. extendedHTTP, accepteret tidligere HTTP-anmodninger plus PUT, DELETE. indstillingerHTTP (fra 4.0.1), tilføj OPTIONS-verbet til de foregående. 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, BPROPPATCH, 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 sagerfølsomme.
ignore_100_continue String Hvis dette felt har værdien sand og 100 fortsætter HTTP header vil blive ignoreret; hvis værdien er falsk, 100 fortsætter overskrift behandles.
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.
logs String Gården Logger spor af HTTP-forbindelser. Hvis denne parameter har værdien sand, loggene er aktiveret; hvis det har værdien falsk, logfiler er deaktiveret.
removerresponseheader (fra 4.0.1) Objekt[] Det er en liste med regelmæssige udtryk for at fjerne overskrifter fra backend-svaret. De fjernede overskrifter når ikke klienten.
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 Objekt[] 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. Fra 4.0.2 nye muligheder: aktiveret-sti aktiveret-backends-sti. stien gælder, hvis RewriteUrl-direktivet ændrede anmodningens URL. Dette flag tvinger til at gendanne URL-transformationen, som RewriteUrl foretog.
status String Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip String IP af gården, hvor den virtuelle tjeneste lytter.
VPort nummer Havnen på gården, hvor den virtuelle tjeneste lytter.

Certlist objekt:

Field Type Beskrivelse
fil String Certifikatets navn, referencer til certifikatet i certifikatbutikken.
id nummer Certifikat-id, 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-indsætningen udføres, hvis domænet matcher indholdet af cookie. 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, tages der ikke noget.
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.
farmguardian String Det er FarmGuardian-navnet, der kontrollerer backend-status. FarmGuardian vil køre, mens gården er i up status.
httpsb String Denne parameter angiver til gården, at backendene er indstillet til at bruge HTTPS-sproget, og dataene bliver derefter krypteret 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 mindste svarbalanceringsmetode. sand ofte kontrollerer profilen, hvilken backend der tager mindre tid at svare for at sende flere forbindelser til denne, the 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 Det opfører sig som en speciel backend, da klientanmodningen besvares ved omdirigering til en ny webadresse automatisk. Hvis omdirigeringen er konfigureret, vil anmodningen ikke blive videresendt til backend, en omdirigering vil blive besvaret til klienten i stedet.
redirect_code nummer Det er HTTP-koden, der returneres, når en omdirigering er konfigureret. De mulige værdier er 301, 302, 307,
redirecttype String Hvordan omdirigering vil blive gjort, to muligheder: standard, URL'en er taget som en absolut vært og sti 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 header og klare klientsessionen.
sts_status String Status for den stramme transportsikkerhedsoverskrift. For at aktivere denne funktion er det nødvendigt at indstille bedriftslytteren som HTTPS. De mulige værdier er: sand at aktivere STS-direktivet i tjenesten eller falsk at deaktivere STS-direktivet i tjenesten.
sts_timeout nummer Tid (i sekunder), at klienten husker at tjenesten kun er tilgængelig med HTTS.
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 URL-adresse, som klienten anmoder om via 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-bedrift. PCRE regulære udtryk understøttes.
fastgjort forbindelse (fra version 4.0.2) nummer Angiv, om vi vil fastgøre alle forbindelserne, (standard: 0, ingen fastgjort). Hvis Pinnedconnection er indstillet til 1, videresender zproxy alle data direkte uden at parse eller redigere.
routingpolitik (fra version 4.0.2) String Angiv routingpolitikken. Alle algoritmerne er vægtet med alle vægtene sat i hver backend. Der er fire muligheder: RUNDE ROBIN brug round robin-algoritmen som en routingpolitik (standard). LEAST_CONNECTIONS vælg den backend med færrest etablerede forbindelser ved at bruge vægten som en proportion. RESPONSTID vælg backend med den laveste responstid ved at bruge vægten som en proportion. PENDING_CONNECTIONS vælg backend med mindst afventende forbindelser ved at bruge vægten som en proportion.
genskriver (fra version 4.0.2) Objekt[] Den tjekker et mønster for at hente strenge fra URL og erstatte dem. Der kan tilføjes flere RewriteUrl-direktiver. Alle vil blive sekventielt anvendt på den indkommende URL, medmindre det sidste flag er indstillet, som afslutter omskrivnings-url-fasen.

Backend-objekt til HTTP-bedrifter:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer Backend-id i den givne tjeneste.
ip String Backend's IP, hvor den rigtige tjeneste kører.
port nummer Backends havn, hvor den rigtige service kører.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
timeout nummer Det er den maksimale tid, der venter på backend-svaret før, men markerer det som utilgængeligt. Denne gang er i sekunder.
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. De mulige værdier er fra 1 til 9.
prioritet (fra 4.0.1) nummer (Kun når proxy ny generation virker) Det er prioritetsværdien for den aktuelle rigtige server, backend med lavere prioritetsværdi vil være klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9
forbindelsesgrænse (fra 4.0.2) nummer (Kun når proxy ny generation fungerer) Det maksimale antal etablerede forbindelse pr. backend. Med en værdi på 0 vil der ikke være en grænse i backend. Klienten vil modtage en 503-fejl, hvis der ikke er tilgængelige backends.

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newHTTPfarm -profile http -vip 192.168.100.23 -vport 80

POST /farms

Opret en ny HTTP-bedrift.

Anmod om parametre

Field Type Beskrivelse påkrævet
farmname String Farm beskrivende navn. Den bruges som en 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. Den samme virtuelle port og virtuel IP må ikke bruges af en anden gård. sand
kopi_fra (fra 4.0.1) String Denne parameter forventer navnet på en gård, der findes. Hvis denne parameter sendes, kopieres gården fra den gård, der er specificeret i den. Det farmname, vip VPort værdier overskrives.

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Ændre en gård

Ændre en gård

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP", "errorWAF":"Message error WAF",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -contimeout 22 -newfarmname FarmHTTP2 -vip 178.62.126.152 -vport 88 -ignore_100_continue true -restimeout 47 -resurrectime 12 -reqtimeout 32 -rewritelocation enabled -httpverb standardHTTP -errorcode414 'Message error 414' -logs true

PUT /farms/<farmname>

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 blacklisted backend og kontrollere, om den er i live.
reqtimeout nummer Hvor lang tid går gården til at vente på en klientanmodning om få sekunder.
disable_sslv2 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af en SSL-sikkerhedsprotokol med version 2 er ikke tilladt eller falsk hvis protokollen SSLv2 er tilladt.
disable_sslv3 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af en SSL-sikkerhedsprotokol med version 3 er ikke tilladt eller falsk hvis protokollen SSLv3 er tilladt.
disable_tlsv1 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1 er ikke tilladt eller falsk hvis protokollen TLSv1 er tilladt.
disable_tlsv1_1 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.1 er ikke tilladt eller falsk hvis protokollen TLSv1.1 er tilladt.
disable_tlsv1_2 String Kun i https-lytteren. Hvis dette felt har værdien sand forbindelserne ved hjælp af TLS-sikkerhedsprotokol med version 1.2 er ikke tilladt eller falsk hvis
rewritelocation String Hvis det er aktiveret, er bedriften tvunget til at ændre placeringen: og indholdssted: overskrifter i svar til klienter med den virtuelle vært. Indstillingerne er: aktiveret aktiveret; deaktiveret inaktiveret; eller aktiveret-backends kun backend-adressen er sammenlignet.
httpverb String Dette felt angiver de operationer, der vil blive tilladt for HTTP-klientanmodningerne. tilgængelige værdier er: standardHTTP, accepterede HTTP-anmodninger GET, POST, HEAD. extendedHTTP, accepteret tidligere HTTP-anmodninger plus PUT, DELETE. indstillingerHTTP (fra 4.0.1), tilføj OPTIONS-verbet til de foregående. 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, BPROPPATCH, 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 sagerfølsomme.
ignore_100_continue String Hvis dette felt har værdien sand og 100 fortsætter HTTP header vil blive ignoreret; hvis værdien er falsk, 100 fortsætter overskrift behandles.
fejlWAF String Personlig meddelelsesfejl WAF (fra version 4.0.2).
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.
logs String Gården Logger spor af HTTP-forbindelser. Hvis denne parameter har værdien sand, loggene er aktiveret; hvis det har værdien falsk, logfiler er deaktiveret.
ciphers String Kun i lytter med https værdi. Bruges til at opbygge en liste over cifre accepteret af SSL-forbindelser for at hærde SSL-forbindelsen. Indstillingerne er: alle, alle cifre vil blive accepteret; highsecurity, kun cifre for høj sikkerhed vil blive accepteret; customsecurity, kun cifre indlæst i cipherc feltet vil blive accepteret eller ssloffloading, det overlader krypteringsjobbet til processen, denne chiffer afhænger af processoren.
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 felt har værdien "toldsikkerhed".
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.
certifikatnavn String Https-certifikat konfigureret

Svar eksempel:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
      "ciphers" : "customsecurity",
      "contimeout" : 22,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "errorWAF" : "Message error WAF",
      "error414" : "Message error 414",
      "error500" : "Message error 500",
      "error501" : "Message error 501",
      "error503" : "Message error 503",
      "httpverb" : "standardHTTP",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "true",
      "newfarmname" : "FarmHTTP",
      "reqtimeout" : 32,
      "restimeout" : 47,
      "resurrectime" : 12,
      "rewritelocation" : "enabled",
      "vip" : "178.62.126.152",
      "vport" : 88
   }
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Føj en brugerdefineret overskrift til anmodningen

Føj en brugerdefineret overskrift til anmodningen

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

POST /farms/<farmname>/addheader

Gården vil tilføje overskriften til bagenden.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Det er en streng med overskriften, der vil blive sendt til backend. sand

Svar eksempel:

{
   "description" : "Add addheader directive.",
   "message" : "Added a new item to the addheader list",
   "status" : "needed restart",
   "success" : "true"
}

Rediger og føj en brugerdefineret overskrift til reglen for anmodning

Rediger og føj en brugerdefineret overskrift til reglen for anmodning

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/id
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

PUT /farms/<farmname>/addheader/<id>

Gården vil tilføje overskriften til bagenden.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Det er en streng med overskriften, der vil blive sendt til backend. sand

Svar eksempel:

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}

Slet en brugerdefineret overskrift fra anmodningen

Slet en brugerdefineret overskrift fra anmodningen

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/0
zcli farm-add-request-header remove MyHttpFarm 0

DELETE /farms/<farmname>/addheader/<index>

indeks er indekset for addheader arrayet, der skal slettes.

Svar eksempel:

{
   "description" : "Delete addheader directive.",
   "message" : "The addheader 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tilføj regel for at fjerne overskrifter fra anmodningen

Tilføj regel for at fjerne overskrifter fra anmodningen

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

POST /farms/<farmname>/headremove

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Add headremove directive.",
   "message" : "Added a new item to the headremove list",
   "status" : "needed restart",
   "success" : "true"
}

Rediger en Fjern overskrifter fra reglen for anmodning

Rediger en Fjern overskrifter fra reglen for anmodning

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/id
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

PUT /farms/<farmname>/headremove/<id>

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Modify an headremove directive.",
   "message" : "Modified an item from the headremove list",
   "success" : "true"
}

Slet en regel for at fjerne overskrifter fra anmodningen

Slet en regel for at fjerne overskrifter fra anmodningen

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/0
zcli farm-remove-request-header remove MyHttpFarm 0

DELETE /farms/<farmname>/headremove/<index>

indeks er indekset for headremove arrayet at slette.

Svar eksempel:

{
   "description" : "Delete headremove directive.",
   "message" : "The headremove 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Føj en brugerdefineret overskrift til svaret

Føj en brugerdefineret overskrift til svaret

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/addresponseheader

Gården tilføjer overskriften til backend-svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Det er en streng med overskriften, der vil blive sendt til backend. sand

Svar eksempel:

{
   "description" : "Add a header to the backend repsonse.",
   "message" : "Added a new header to the backend response",
   "status" : "needed restart",
   "success" : "true"
}

Rediger og føj en brugerdefineret overskrift til svarreglen

Rediger og føj en brugerdefineret overskrift til svarreglen

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/id
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

Gården tilføjer overskriften til backend-svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Det er en streng med overskriften, der vil blive sendt til backend. sand

Svar eksempel:

{
   "description" : "Modify an addresponseheader directive.",
   "message" : "Modified an item from the addresponseheader list",
   "success" : "true"
}

Slet en brugerdefineret overskrift fra svaret

Slet en brugerdefineret overskrift fra svaret

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/0
zcli farm-add-response-header remove torta 0

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/addresponseheader/<index>

indeks er indekset for den addresponseheader array, der skal slettes.

Svar eksempel:

{
   "description" : "Delete a header previously added to the backend response.",
   "message" : "The header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tilføj en regel for at fjerne overskrifter fra svar

Tilføj en regel for at fjerne overskrifter fra svar

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/removeresponseheader

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Remove a header from the backend response.",
   "message" : "Added a patter to remove reponse headers",
   "status" : "needed restart",
   "success" : "true"
}

Rediger en regel for Fjern overskrifter fra svar

Rediger en regel for Fjern overskrifter fra svar

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/id
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/removeresponseheader/<id>

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Modify a remove response header directive.",
   "message" : "Modified an item from the removeresponseheader list",
   "success" : "true"
}

Slet en regel for at fjerne overskriften fra svaret

Slet en regel for at fjerne overskriften fra svaret

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/0
zcli farm-remove-response-header remove torta 0

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/removeresponseheader/<index>

indeks er indekset for den removeresponseheader-matrix, der skal slettes.

Svar eksempel:

{
   "description" : "Delete a pattern to remove response headers.",
   "message" : "The pattern 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Tilføj en regel for at omskrive overskrifter fra anmodning

Tilføj en regel for at omskrive overskrifter fra anmodning

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/replacerequestheader

Tilføj regler for at omskrive overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

Rediger en omskrivningsoverskrift fra anmodningsregel

Rediger en omskrivningsoverskrift fra anmodningsregel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/replacerequestheader/<id>

Tilføj regler for at omskrive overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

Slet en regel for at omskrive overskrifter fra anmodning

Slet en regel for at omskrive overskrifter fra anmodning

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/0
zcli farm-replace-request-header remove MyHttpFarm 0

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/replacerequestheader/<index>

indeks er indekset for replacerequestheader-arrayet, der skal slettes.

Svar eksempel:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Flyt en Rewrite Headers fra Request-regel

Flyt en Rewrite Headers fra Request-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id/actions
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

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

Flyt en ReplaceRequest-header.

Anmod om parametre

Field Type Beskrivelse påkrævet
position nummer Ny regelposition sand

Svar eksempel:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

Tilføj en regel for at omskrive overskrifter fra svar

Tilføj en regel for at omskrive overskrifter fra svar

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/replaceresponseheader

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

Rediger en omskriv headers fra svar-regel

Rediger en omskriv headers fra svar-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/replaceresponseheader/<id>

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

Slet en regel for at omskrive overskrifter fra svar

Slet en regel for at omskrive overskrifter fra svar

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/0
zcli farm-replace-response-header remove MyHttpFarm 0

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/replaceresponseheader/<index>

indeks er indekset for replaceresponseheader-arrayet, der skal slettes.

Svar eksempel:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

Flyt en Rewrite Headers fra Request-regel

Flyt en omskrivningsoverskrift fra svarregel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

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

Flyt en ReplaceRequest-header.

Anmod om parametre

Field Type Beskrivelse påkrævet
position nummer Ny regelposition sand

Svar eksempel:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

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/v4.0/zapi.cgi/farms/httpFarm/certificates
zcli farm-certificate add httpFarm -file example.pem

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

Flyt et certifikat

Flyt et certifikat

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/v4.0/zapi.cgi/farms/newfarm/certificates/certif.pem/actions
zcli farm-certificate move newfarm zertif.pem -position 0

POST /farms/<farmname>/certificates/<file>/actions

URI file parameter er certifikatfilnavnet, der skal flyttes.

Denne funktion gør det muligt at flytte certifikaterne til at ændre den rækkefølge, de vil blive kontrolleret.

Anmod om parametre

Field Type Beskrivelse påkrævet
position Integer Det er den position, som certifikatet vil have i gårdskonfigurationen, når ZAPI-opkaldet behandles sand

Svar eksempel:

{
    "description" : "Move service",
    "params" : {
        "position" : 0
    },
    "status" : "needed restart",
    "info" : "There\'re changes that need to be applied, stop and start farm to apply them!",
    "message" : "certif.pem was moved successfully."
}

Slet et certifikat

Slet et certifikat

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
zcli farm-certificate remove MyHttpFarm example.pem

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

Slet certifikatet med det valgte filnavn fra certlisten i HTTP-gården med en HTTPS-lytter. Certifikatet vil ikke blive slettet fra 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/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists
zcli farm-blacklist add httpFarm -name china

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

Anvend en sortliste, DoS, RBL eller WAF regel til gården.

Anmod om parametre

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

Svar eksempel:

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

Flyt en IPDS-regel

Flyt en IPDS-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2

POST /farms/<farmname>/ipds/<waf|blacklists>/<name>/actions

Flyt IPDS-reglerne er kun tilgængelige for WAF- og Blacklist-regler. I denne form for regler er det vigtigt, hvilken rækkefølge der skal kontrolleres.

name URI parameter er regelsætnavnet på sættet, der skal flyttes.

Anmod om parametre

Field Type Beskrivelse påkrævet
position Integer Det er den position, som IPDS-reglen vil have i farm-konfigurationen, når ZAPI-kaldet vil blive behandlet sand

Svar eksempel:

{
    "message" : "The rule was moved properly to the position 2.",
    "description" : "Move a rule in the set test_waf_ori"
}

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/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists/china
zcli farm-blacklist remove httpFarm china

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

Fjern en sorte liste, DoS, RBL eller WAF regel fra en given gård ved hjælp af dens indikator 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

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

Hent service med ID

Hent service med ID

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/cookiefarm/services/serv
zcli farm get cookiefarm -filter services

GET /farms/<farmname>/services/<id>

Vis alle konfigurationer om en given tjeneste.

Svar eksempel:

{
   "description" : "Get services of a farm",
   "services" : {
      "backends" : [
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : 20,
            "weight" : null,
            "priority" : null,
            "connection_limit" : null
         },
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null,
            "priority" : null,
            "connection_limit" : null
         }
      ],
      "cookiedomain" : "zevenet.cpm",
      "cookieinsert" : "true",
      "cookiename" : "peasocookie",
      "cookiepath" : "/patfh",
      "cookiettl" : 20,
      "farmguardian" : "check_tcp-cut_conns",
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirect_code" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "sts_status" : "false",
      "sts_timeout" : 0,
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : "",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN",
      "replacerequestheader" : [],
      "replaceresponseheader" : [],
      "addrequestheader" : [],
      "addresponseheader" : [],
      "removerequestheader" : [],
      "removeresponseheader" : [],
      "rewriteurl" : [],
      "sessions" : []
   }
}

Response parametre

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

Servicesobjekt for HTTP-bedrifter:

Field Type Beskrivelse
backends Objekt[] Backends defineret i tjenesten.
cookiedomain String Cookie-indsætningen udføres, hvis domænet matcher indholdet af cookie. 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.
farmguardian String Det er FarmGuardian-navnet, der kontrollerer backend-status. FarmGuardian vil køre, mens gården er i up status.
httpsb String Denne parameter indikerer til gården at backendene er konfigureret til at bruge HTTPS, så dataene bliver krypteret før, før de sendes. 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 mindste svarbalanceringsmetode. sand ofte kontrollerer profilen, hvilken backend det tager mindre tid at svare på, 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 Det opfører sig som en speciel backend, da klientanmodningen besvares ved omdirigering til en ny webadresse automatisk. Hvis omdirigeringen er konfigureret, vil anmodningen ikke blive videresendt til backend, en omdirigering vil blive besvaret til klienten i stedet.
redirect_code nummer Det er HTTP-koden, der returneres, når en omdirigering er konfigureret. De mulige værdier er 301, 302, 307.
redirecttype String Hvordan omdirigering vil blive gjort, to muligheder: standard, URL'en er taget som en absolut vært og sti til omdirigering til, append, vil den originale anmodningstype eller URI blive tilføjet til den vært og sti, du angav 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 header og klare klientsessionen.
sts_status String Status for den stramme transportsikkerhedsoverskrift. For at aktivere denne funktion er det nødvendigt at indstille bedriftslytteren som HTTPS. De mulige værdier er: sand at aktivere STS-direktivet i tjenesten eller falsk at deaktivere STS-direktivet i tjenesten.
sts_timeout nummer Tid (i sekunder), at klienten husker at tjenesten kun er tilgængelig med HTTS.
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 URL-adresse, som klienten anmoder om via 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-bedrift. PCRE regulære udtryk understøttes.
fastgjort forbindelse (fra version 4.0.2) nummer Angiv, om vi vil fastgøre alle forbindelserne, (standard: 0, ingen fastgjort). Hvis Pinnedconnection er indstillet til 1, videresender zproxy alle data direkte uden at parse eller redigere.
routingpolitik (fra version 4.0.2) String Angiv routingpolitikken. Alle algoritmerne er vægtet med alle vægtene sat i hver backend. Der er fire muligheder: RUNDE ROBIN brug round robin-algoritmen som en routingpolitik (standardt). LEAST_CONNECTIONS vælg den backend med færrest etablerede forbindelser ved at bruge vægten som en proportion. RESPONSTID vælg backend med den laveste responstid ved at bruge vægten som en proportion. PENDING_CONNECTIONS vælg backend med mindst afventende forbindelser ved at bruge vægten som en proportion.
replacerequestheader (fra version 4.0.2) Objekt[] Vifte af regler til at erstatte en header på anmodning. Hvis flere regex matcher i overskriften, vil kun den første være gældende. ReplaceHeader-direktivet i tjenesterne har prioritet frem for lytteren.
replaceresponseheader (fra version 4.0.2) Objekt[] Vifte af regler til at erstatte en header som svar. Hvis flere regex matcher i overskriften, vil kun den første være gældende. ReplaceHeader-direktivet i tjenesterne har prioritet frem for lytteren.
adressequestheader (fra version 4.0.2) Objekt[] Array af regler til Tilføjelse af den definerede overskrift til den anmodning, der er sendt til klienterne. Overskriften tilføjes ordret.
addresponseheader (fra version 4.0.2) Objekt[] Array af regler, der skal tilføjes den definerede header til svaret, der er sendt til klienterne. Overskriften tilføjes ordret.
removerequestheader (fra version 4.0.2) Objekt[] Vifte af regler for at fjerne visse overskrifter fra den udgående anmodning, headeren sendt af backend sendes ikke til klienten.
removerresponseheader (fra version 4.0.2) Objekt[] Array af regler for at fjerne visse overskrifter fra det udgående svar, headeren sendt af backend sendes ikke til klienten.
genskriver (fra version 4.0.2) Objekt[] Vifte af regler til Ændrer Location og Content-Location headers i svarene for at vise den virtuelle vært, der blev sendt i anmodningen.
sessioner (fra version 4.0.2) Objekt[] Liste over statiske og dynamiske sessioner oprettet til denne gårdtjeneste.

Backend-objekt til HTTP-bedrifter:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer Backend-id i den givne tjeneste.
ip String Backend's IP, hvor den rigtige tjeneste kører.
port nummer Backends havn, hvor den rigtige service kører.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
timeout nummer Det er den maksimale tid, der venter på backend-svaret, før du sætter det ned. Denne gang er i sekunder.
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. De mulige værdier er fra 1 til 9.
prioritet (fra 4.0.1) nummer (Kun når proxy ny generation virker) Det er prioritetsværdien for den aktuelle rigtige server, backend med lavere prioritetsværdi vil være klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9.
forbindelsesgrænse (fra 4.0.2) nummer (Kun når proxy ny generation fungerer) Det maksimale antal etablerede forbindelse pr. backend. Med en værdi på 0 vil der ikke være en grænse i backend. Klienten vil modtage en 503-fejl, hvis der ikke er tilgængelige backends.

replaceRequestHeader- og replaceResponseHeader-objekter til HTTP-farmtjenester:

Field Type Beskrivelse
header String Regex med headernavnet, der skal omskrives.
match String Regex-værdi for at matche det, vi ønsker at erstatte.
erstatte String Værdi at erstatte tændstikker.

addRequestHeader og addResponseHeader-objekt til HTTP-farmtjenester:

Field Type Beskrivelse
header String Regex med headernavnet, der skal omskrives.

removeRequestHeader og removeResponseHeader-objekt til HTTP-farmtjenester:

Field Type Beskrivelse
mønster String Det er en streng med et regexp at kigge efter i klientanmodningerne. Hvis nogle overskrifter matcher i mønsteret, vil overskriften blive fjernet.

rewriteUrl-objekt til HTTP-farmtjenester:

Field Type Beskrivelse
mønster String Det er en streng med et regexp at kigge efter i url'en. Hvis url matcher i mønsteret, vil den matchede tekst blive erstattet.
erstatte String Det er en streng til at erstatte den matchede tekst.
sidste String Sandt eller falsk. Hvis sand er indstillet, afslutter det omskrivnings-url-fasen.

sessionsobjekt for HTTP-farmtjenester:

Field Type Beskrivelse
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'IP' Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65;
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen ikke er af typen statisk.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
zcli farm-service add FarmHTTP -id newserv

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 en 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_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true","pinnedconnection":0,"routingpolicy":"ROUND_ROBIN"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -vhost www.mywebserver.com -urlp ^/myapp1$ -persistence URL -redirect_code 302 -redirect http://zenloadbalancer.com -ttl 125 -sessionid sid -sts_status true -sts_timeout 21600000 -pinnedconnection 0 -routingpolicy ROUND_ROBIN

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

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

Anmod om parametre

Field Type Beskrivelse
vhost String Angiver betingelsen 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 URL-adresse, som klienten anmoder om via 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.
redirect_code nummer Det er HTTP-koden, der returneres, når en omdirigering er konfigureret. De mulige værdier er 301, 302, 307,
redirecttype String Hvordan omdirigering vil ske, to muligheder: standard, URL'en er taget som en absolut vært og sti 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 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-indsætningen udføres, hvis domænet matcher indholdet af cookie. 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 søges af profilen i HTTP-overskriften og administrere klientsessionen.
sts_status String Status for den stramme transportsikkerhedsoverskrift. For at aktivere denne funktion er det nødvendigt at indstille bedriftslytteren som HTTPS. De mulige værdier er: sand at aktivere STS-direktivet i tjenesten eller falsk at deaktivere STS-direktivet i tjenesten.
sts_timeout nummer Tid (i sekunder), at klienten husker at tjenesten kun er tilgængelig med HTTS.
leastresp String Det muliggør den mindste svarbalanceringsmetode. sand, ofte kontrollerer profilen, hvilken backend tager mindre tid til at reagere på at sende flere forbindelser til denne, falsk, profilen kontrollerer ikke, hvilken backend der tager kortere tid at svare.
httpsb String Det indikerer til gården, at backends serverne er indstillet til at bruge HTTPS, så dataene bliver krypteret før at blive sendt. sand, sender profilen trafikken i HTTPS-protokollen til bagsiden, falsk, sender profilen trafikken i HTTP-protokollen til bagsiden.
fastgjort forbindelse (fra version 4.0.2) nummer Angiv, om vi vil fastgøre alle forbindelserne, (standard: 0, ingen fastgjort). Hvis Pinnedconnection er indstillet til 1, videresender zproxy alle data direkte uden at parse eller redigere.
routingpolitik (fra version 4.0.2) String Angiv routingpolitikken. Alle algoritmerne er vægtet med alle vægtene sat i hver backend. Der er fire muligheder: RUNDE ROBIN brug round robin-algoritmen som en routingpolitik (standard). LEAST_CONNECTIONS vælg den backend med færrest etablerede forbindelser ved at bruge vægten som en proportion. RESPONSTID vælg backend med den laveste responstid ved at bruge vægten som en proportion. PENDING_CONNECTIONS vælg backend med mindst afventende forbindelser ved at bruge vægten som en proportion.
omskrivning af placering (fra version 4.0.2) 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 sammenlignes. Andre tilgængelige muligheder: aktiveret-sti aktiveret-backends-sti. stien gælder, hvis RewriteUrl-direktivet ændrede anmodningens URL. Dette flag tvinger til at gendanne URL-transformationen, som RewriteUrl foretog.

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,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirect_code" : 302,
      "redirecttype" : "default",
      "sessionid" : "sid",
      "sts_status" : "true",
      "sts_timeout" : 21600000,
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN"
   },
   "status" : "needed restart"
}

Response Parametre

Svaret bliver et JSON med anmodede parametre opdateret og status felt med gårdens nuværende status. Hvis der skal tages genstart for at anvende ændringerne på gården, vil værdien være nødvendige genstart.

Tilføj FarmGuardian

Tilføj FarmGuardian

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/fg
zcli farm-service-farmguardian add FarmHTTP service1 -name check_tcp-cut_conns

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

Anvend en FarmGuardian til en tjeneste.

URI-parameteren er den service unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
navn String FarmGuardian unikke identifikator. FarmGuardians er oprettet og ændret i overvågningsafsnittet.

Svar eksempel:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the service service1 in the farm FarmHTTP",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the service service1 in the farm FarmHTTP"
}

Fjern FarmGuardian

Fjern FarmGuardian

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove FarmHTTP service1 check_tcp-cut_conns

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

Fjern FarmGuardian fra en tjeneste på en gård.

Svar eksempel:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the service service1 in the farm FarmHTTP",
   "message" : "Sucess, check_tcp-cut_conns was removed from the service service1 in the farm FarmHTTP"
}

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/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/actions
zcli farm-service move FarmHTTP service1 -position 0

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

Denne handling 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, der vil blive ændret.

Forespørgselsparametre

Field Type Beskrivelse påkrævet
position nummer Placering hvor vil være tjenesten. Den 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1
zcli farm-service remove FarmHTTP service1

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

Slet en given tjeneste i en HTTP-profil. id er tjenesten unikke identifikator, der 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"
}

Tilføj en regel for at omskrive overskrifter fra anmodning

Tilføj en regel for at omskrive overskrifter fra anmodning

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/service/<servicename>/replacerequestheader

Tilføj regler for at omskrive overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header"
}

Rediger en omskrivningsoverskrift fra anmodningsregel

Rediger en omskrivningsoverskrift fra anmodningsregel

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

Rediger en regel for omskrivning af overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}
Rediger en omskrivningsoverskrift fra anmodningsregel

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

Rediger en regel for omskrivning af overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}

Slet en regel for at omskrive overskrifter fra anmodning

Slet en regel for at omskrive overskrifter fra anmodning

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/Index
zcli farm-service-replacerequestheader remove MyHttpFarm MyService Index

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replacerequestheader/<index>

indeks er indekset for replacerequestheader-arrayet, der skal slettes.

Svar eksempel:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

Tilføj en regel for at omskrive overskrifter fra svar

Tilføj en regel for at omskrive overskrifter fra svar

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/service/<servicename>/replaceresponseheader

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

Flyt en Rewrite Headers fra Request-regel

Flyt en Rewrite Headers fra Request-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

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

Flyt en ReplaceRequest-header.

Anmod om parametre

Field Type Beskrivelse påkrævet
position nummer Ny regelposition sand

Svar eksempel:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

Rediger en omskriv headers fra svar-regel

Rediger en omskriv headers fra svar-regel

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/service/<servicename>/replaceresponseheader/<id>

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand
match String Regex-værdi for at matche det, vi ønsker at erstatte sand
erstatte String Værdi at erstatte tændstikker sand

Svar eksempel:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

Slet en regel for at omskrive overskrifter fra svar

Slet en regel for at omskrive overskrifter fra svar

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/Index
zcli farm-service-replaceresponseheader remove MyHttpFarm MyService Index

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replaceresponseheader/<index>

indeks er indekset for replaceresponseheader-arrayet, der skal slettes.

Svar eksempel:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header <index> was deleted successfully"
}

Flyt en omskrivningsoverskrift fra svarregel

Flyt en omskrivningsoverskrift fra svarregel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

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

Flyt en ReplaceRequest-header.

Anmod om parametre

Field Type Beskrivelse påkrævet
position nummer Ny regelposition sand

Svar eksempel:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

Tilføj en regel for at tilføje en overskrift til anmodningen

Tilføj en regel for at tilføje en overskrift til anmodning

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader
farm-service-addrequestheader add farm1 -header "header: value"

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/addrequestheader

Tilføj regler for at omskrive overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand

Svar eksempel:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

Rediger en Tilføj en overskrift til reglen for anmodning

Rediger en Tilføj en overskrift til reglen for anmodning

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/id
farm-service-addrequestheader add farm1 -header "header: value"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/addrequestheader/<id>

Tilføj regler for at omskrive overskrifter fra anmodningen.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand

Svar eksempel:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

Slet en regel for at tilføje en overskrift til anmodningen

Slet en regel for at tilføje en overskrift til anmodningen

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/Index
zcli farm-service-addrequestheader remove MyHttpFarm MyService Index

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

indeks er indekset for replacerequestheader-arrayet, der skal slettes.

Svar eksempel:

{
   "message": "The add request header <index> has been deleted successfully"
}

Tilføj en regel for at tilføje en overskrift til svaret

Tilføj en regel for at tilføje en header til svar

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader
zcli farm-service-addresponseheader add farm1 -header "header: value"

Dette opkald er tilgængeligt fra version 4.0.2

POST /farms/<farmname>/addresponseheader

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand

Svar eksempel:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

Rediger en Tilføj en overskrift til svarreglen

Rediger en Tilføj en overskrift til svarreglen

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/id
zcli farm-service-addresponseheader add farm1 -header "header: value"

Dette opkald er tilgængeligt fra version 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

Tilføj regler for at omskrive overskrifter fra svaret.

Anmod om parametre

Field Type Beskrivelse påkrævet
header String Regex med headernavnet, der skal omskrives sand

Svar eksempel:

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}


Slet en regel for at tilføje en overskrift til svaret

Slet en regel for at tilføje en overskrift til svaret

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/Index
zcli farm-service-addresponseheader remove MyHttpFarm MyService Index

Dette opkald er tilgængeligt fra version 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

indeks er indekset for replaceresponseheader-arrayet, der skal slettes.

Svar eksempel:

{
   "message": "The add response header 0 has been deleted successfully"
}

Tilføj regel for at fjerne overskrifter fra anmodningen

Tilføj regel for at fjerne overskrifter fra anmodningen

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removerequestheader

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "message": "Added a new remove request header"
}

Rediger regel for at fjerne overskrifter fra anmodningen

Rediger regel for at fjerne overskrifter fra anmodningen

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/id
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removerequestheader/<id>

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

Slet en regel for at fjerne overskrifter fra anmodningen

Slet en regel for at fjerne overskrifter fra anmodningen

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removerequestheader/<index>

indeks er indekset for removerequestheader-arrayet, der skal slettes.

Svar eksempel:

{
   "message": "The remove request header <index> has been deleted successfully"
}


Tilføj regel for at fjerne overskrifter fra svaret

Tilføj regel for at fjerne overskrifter fra svaret

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removeresponseheader

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "message": "Added a new remove response header"
}

Rediger en Fjern overskrifter fra svarreglen

Rediger en Fjern overskrifter fra svarreglen

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/id
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removeresponseheader/<id>

Fjern bestemte overskrifter fra de indgående anmodninger. Alle forekomster af den tilsvarende specificerede overskrift fjernes.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med en regexp at søge efter i klientens anmodninger. Hvis nogle overskrifter passer i mønsteret, vil overskriften blive fjernet sand

Svar eksempel:

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

Slet en regel for at fjerne overskrifter fra svaret

Slet en regel for at fjerne overskrifter fra svaret

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removeresponseheader/<index>

indeks er indekset for den removeresponseheader-matrix, der skal slettes.

Svar eksempel:

{
   "message": "The remove request header <index> has been deleted successfully"
}


Tilføj regel til kontroller og omskriv mønstre fra URL

Tilføj regel til kontroller og omskriv mønstre fra URL

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

POST /farms/<farmname>/service/<servicename>/rewriteurl

Fra version 4.0.2. Det tjekker et mønster for at hente strenge fra URL og erstatte dem.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med et regexp at kigge efter i url'en. Hvis url matcher i mønsteret, vil den matchede tekst blive erstattet sand
erstatte String Det er en streng til at erstatte den matchede tekst sand
sidste String Sandt eller falsk. Hvis sand er indstillet, afslutter det omskrivnings-url-fasen sand

Svar eksempel:

{
   "message": "Added a new rewriteurl"
}

Rediger kontrolregler og omskriv mønstre fra URL

Rediger kontrolregler og omskriv mønstre fra URL

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

PUT /farms/<farmname>/service/<servicename>/rewriteurl/<id>

Fra version 4.0.2. Det tjekker et mønster for at hente strenge fra URL og erstatte dem.

Anmod om parametre

Field Type Beskrivelse påkrævet
mønster String Det er en streng med et regexp at kigge efter i url'en. Hvis url matcher i mønsteret, vil den matchede tekst blive erstattet sand
erstatte String Det er en streng til at erstatte den matchede tekst sand
sidste String Sandt eller falsk. Hvis sand er indstillet, afslutter det omskrivnings-url-fasen sand

Svar eksempel:

{
   "description" : "Modify a RewriteUrl.",
   "message" : "Modify a new rewrite url",
   "success" : "true"
}

Slet en regel for at kontrollere og omskrive mønstre fra URL

Slet en regel for at kontrollere og omskrive mønstre fra URL

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/Index
zcli arm-service-rewriteurl remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/rewriteurl/<index>

Fra version 4.0.2. indeks er indekset for rewriteurl-arrayet, der skal slettes.

Svar eksempel:

{
   "message": "The rewriteurl <index> has been deleted successfully"
}


Flyt en check og omskriv mønstre fra URL-regel

Flyt en check og omskriv mønstre fra URL-regel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

Dette opkald er tilgængeligt fra version 4.0.2

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

Flyt en ReplaceRequest-header.

Anmod om parametre

Field Type Beskrivelse påkrævet
position nummer Ny regelposition sand

Svar eksempel:

{
   "description" : "Move a rewriteurl directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

Liste over sessionerne

Liste over sessionerne

Forespørgselseksempel:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session list farm1 service0

GET /farms/<farmname>/services/<servicename>/sessions

Fra version 4.0.2. Få listen over sessioner i farm:service. Ejendom kun tilgængelig for proxy af ny generation zproxy.

Svar eksempel:

{
   "description" : "Get farm sessions",
   "params": [
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": null,
         "type": "static"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

Response Parametre

Denne anmodning returnerer en liste over sessionsobjekt, hvert sessionsobjekt indeholder følgende nøgler:

Field Type Beskrivelse
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'IP' Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65;
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen ikke er af typen statisk.

Tilføj en session

Tilføj en session

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session add farm1 service0 -backend 0 -session 10.0.0.2

POST /farms/<farmname>/services/<servicename>/sessions

Fra version 4.0.2. Det opretter en statisk session med en backend i en session. Indgangsforbindelsen, der passer til Session vil altid blive videresendt til denne backend. Ejendom kun tilgængelig for proxy af ny generation zproxy.

Anmod om parametre

Field Type Beskrivelse
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'IP', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65;

Svar eksempel:

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "id" : "0",
      "session" : "10.0.0.1",
      "ttl" : null,
      "type" : "static"
   }
}

Response Parametre

Denne anmodning returnerer sessionobjekt, der indeholder følgende taster:

Field Type Beskrivelse
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'IP', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen er af statisk type.
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.

Fjern en session

Fjern en session

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions/10.0.0.1
zcli farm-service-session remove farm1 service0 10.0.0.1

DELETE /farms/<farmname>/services/<servicename>/sessions/<session>

Det sletter en statisk session.

Svar eksempel:

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
zcli farm get httpfarm

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" : [
      {
         "alias" : null,
         "id" : 0,
         "ip" : "192.168.0.10",
         "port" : 88,
         "status" : "up",
         "timeout" : 12,
         "weight" : 1,
         "priority" : null,
         "connection_limit" : null
      },
      {
         "alias" : null,
         "id" : 1,
         "ip" : "192.168.102.245",
         "port" : 80,
         "status" : "up",
         "timeout" : 22,
         "weight" : 2,
         "priority" : null,
         "connection_limit": null
      }
   ]
}

Response Parametre

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

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
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. De mulige værdier er fra 1 til 9.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
prioritet (fra 4.0.1) nummer (Kun når proxy ny generation virker) Det er prioritetsværdien for den aktuelle rigtige server. Backend med lavere prioritetsværdi vil være klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9
forbindelsesgrænse (fra 4.0.2) nummer (Kun når proxy ny generation fungerer) Det maksimale antal etablerede forbindelse pr. backend. Med en værdi på 0 vil der ikke være en grænse i backend. Klienten vil modtage en 503-fejl, hvis der ikke er tilgængelige backends.

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,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2 -connection_limit 10

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

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. De mulige værdier er fra 1 til 9.
prioritet (fra 4.0.1) nummer (Kun når proxy ny generation virker) Det er prioritetsværdien for den aktuelle rigtige server. Backend med lavere prioritetsværdi vil være klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9
forbindelsesgrænse (fra 4.0.2) nummer (Kun når proxy ny generation fungerer) Det maksimale antal etablerede forbindelse pr. backend. Med en værdi på 0 vil der ikke være en grænse i backend. Klienten vil modtage en 503-fejl, hvis der ikke er tilgængelige backends.

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,
      "priority" : 1,
      "connection_limit" : 10
   },
   "status" : "needed restart"
}

Response Parametre

Svaret bliver et JSON med anmodede parametre opdateret og status felt med gårdens nuværende status. Hvis der skal tages genstart for at anvende ændringerne på gården, vil værdien være nødvendige genstart.Hvis der er

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,"weight":1,"priority":1,"connection_limit":10}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1 -connection_limit 10

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

Ændre parametrene for en backend HTTP-tjeneste.

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. De mulige værdier er fra 1 til 9.
prioritet (fra 4.0.1) nummer (Kun når proxy ny generation fungerer) Det er prioritetsværdien for den aktuelle rigtige server. Backend med lavere prioritetsværdi vil være klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9
forbindelsesgrænse (fra 4.0.2) nummer (Kun når proxy ny generation fungerer) Det maksimale antal etablerede forbindelse pr. backend. Med en værdi på 0 vil der ikke være en grænse i backend. Klienten vil modtage en 503-fejl, hvis der ikke er tilgængelige backends.

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,
      "priority" : 4,
      "connection_limit" : 10
   },
   "status" : "needed restart",
   "warning" : "Backends with high priority value (4) will not be used."
}

Response Parametre

Svaret bliver et JSON med anmodede parametre opdateret og status felt med gårdens nuværende status. Hvis der skal tages genstart for at anvende ændringerne på gården, vil værdien være nødvendige genstart. Hvis Prioritetsparameter opdateres med en inkonsekvent værdi, advarsel felt beskriver det.

Backend i vedligeholdelse

Backend i vedligeholdelse

Forespørgselseksempel:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
zcli farm-service-backend maintenance httpfarm newsrv 0 -mode cut

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

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

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

Anmod om parametre

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

Svar eksempel:

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

Slet en backend

Slet en backend

Forespørgselseksempel:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
zcli farm-service-backend remove newfarmHTTP service1 4

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

Slet en given backend fra en HTTP-tjeneste.

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-profilfabrikken giver mulighed for at skabe lastbalanceringsbedrifter, der arbejder i lag 4 af OSI-modellen, med meget højtydende og langt mere samtidige forbindelser end belastningsbalancerkerner i lag 7 som HTTP-landbrugsprofiler. 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 den bruges med de andre lag 7-profiler. For at være i stand til at vælge en række virtuelle porte eller en bestemt virtuel port i L4xNAT-gårde, er det obligatorisk at vælge en protokoltype. I et andet tilfælde lytter gården på alle porte fra den virtuelle IP (angivet med tegnet '*'). Når en TCP- eller UDP-protokol er valgt, vil den være tilgængelig til at specificere en port, flere porte mellem ',', porte varierer 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/v4.0/zapi.cgi/farms/l4farm
zcli farm get l4farm

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Response Body:

{
   "backends" : [
      {
         "alias" : null,
         "max_conns" : 0,
         "id" : 0,
         "ip" : "192.168.55.40",
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "alias" : "server-1",
         "id" : 1,
         "max_conns" : 500,
         "ip" : "192.168.55.41",
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "ipds" : {
      "blacklists" : [
            {
              "status" : "down",
              "name" : "blacklist"
            }
      ],
      "dos" : [
         {
             "name" : "newlimitconns",
             "status" : "down"
         }
      ],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "algorithm" : "weight",
      "farmguardian" : "check_tcp-cut_conns",
      "listener" : "l4xnat",
      "logs" : "false",
      "nattype" : "nat",
      "persistence" : "ip",
      "protocol" : "tcp",
      "status" : "down",
      "ttl" : 120,
      "vip" : "192.168.100.241",
      "vport" : "88",
      "sessions": []
   }
}

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 Objekt[] Blacklist regler anvendes på gården.
dos Objekt[] DoS regler gælder for gården.
RBL Objekt[] RBL regler anvendes på gården.

Blacklist, DoS og RBL Objekt:

Field Type Beskrivelse
navn String Regelnavnet.
status String Regelstatus.

Parametre objekt for L4xNAT gårde:

Field Type Beskrivelse
algoritme String Type aflastningsplanlægning, der bruges til at sende trafikken mellem bagsiden. Indstillingerne er: leastconn fremadgående forbindelse altid til den mindste forbindelsesserver vægt Tilslutning lineær afsendelse afhængigt af bagvægten; runde Robin Gør et sekventielt valg mellem backend-puljen, vil hver backend modtage det samme antal anmodninger; hash_srcip balancer pakker, der matcher samme kilde IP til samme backend; hash_srcip_srcport balancer pakker, der matcher samme kilde IP og port til samme backend; symhash balance pakker, der matcher samme kilde IP og port og destination IP og port, så det kunne hash en forbindelse på begge måder (under indgående og udgående).
lytter String En lytter definerer, hvordan gården skal lege med anmodningerne fra klienterne. informationsfelt, kan det ikke ændres.
logs String Farm Logs pakkeoplysninger af transportlaget, er der ikke ledige applikationslagsoplysninger. Hvis denne parameter har værdien sand, loggene er aktiveret; hvis det har værdien falsk, logfiler er deaktiveret.
nattype String Hvordan belastningsbalancelaget 4-kernen skal fungere. Indstillingerne er: NAT også kaldet sNAT-tilstand, svarer backenden til belastningsbalanceren for at sende svaret til klienten; DNAT backend vil reagere direkte på klienten, load balancer skal konfigureres som gateway i backend serveren; I DSR (Direct Server Return) -tilstanden, som klienten forbinder til VIP, ændrer loadbalanceren sin destinations MAC-adresse til MAC-adressen til backend (serveren skal være på samme linkmedie som belastningsbalanceren); Stateless DNAT. I stateless_dnat Betalingsbalancen skifter destinationsadresse for backendadressen og videresender den til backend som DNAT gør, men det klarer ikke nogen form for forbindelsesinformation.
udholdenhed String Denne parameter videresender den indkommende anmodning til den samme backend i basen på den valgte persistensfunktion. Indstillingerne er: "" tom værdi deaktiverer persistensen, hver indkommende pakke vil blive afbalanceret mellem bagsiden; ip or srcip, Source IP, vil tildele samme backend for hver indgående forbindelse afhængigt af kun kilde-IP-adressen; port, Source Port, vil tildele samme backend for hver indgående forbindelse afhængigt af kun kildeporten. srcmac, Kilde MAC, Med denne indstilling vil gården tildele samme backend for hver indgående forbindelse afhængigt af pakkeens link-lag MAC-adresse; srcip_srcport, Source IP og Source Port, vil tildele samme backend for hver indgående forbindelse afhængigt af både source IP og source port; srcip_dstport, Source IP og Destination Port, vil tildele samme backend for hver indgående forbindelse afhængigt af både kilde IP og destinationsport.
protokol String Protokol skal afbalanceres ved lag 4. Indstillingerne er: alle profilen vil indlæse balance for enhver L4-protokol; tcp belastningsbalanceren vil kun balancere TCP L4-protokollen, også for TCP, er det muligt at indstille en af ​​følgende protokoller for at analysere sine overskrifter og bruge den til at distribuere korrekt: ftp, irc, pptp eller sane; uDP belastningsbalanceren vil kun balancere UDP L4-protokollen, også for UDP, er det muligt at indstille en af ​​følgende protokoller for at analysere sine overskrifter og bruge den til at distribuere korrekt: tår, tftp, amanda, NetBIOS-ns eller snmp; SCTP, vil belastningsbalanceren kun balancere SCTP L4-protokollen. Hvis h323 er valgt, vil gården lytte til TCP UDP anmodninger og parse dets overskrifter for at afbalancere mellem backends.
status String Farm status. De tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
ttl nummer Denne feltværdi angiver det antal sekunder, som persistensen mellem klientkilden og bagenden tildeles, i sekunder. Vedholdenhed 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 ,.
farmguardian String Det er FarmGuardian-navnet, der kontrollerer backend-status. FarmGuardian vil køre, mens gården er i up status.
sessioner (fra version 4.0.2) Objekt[] Liste over statiske og dynamiske sessioner oprettet for denne farm.

Backend objekt til L4xNAT gårde:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer ID for at identificere backend i gården backends pool.
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 den / de virtuelle port (er).
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
prioritet nummer Det er den prioriterede værdi for den aktuelle reelle server. Backend med lavere prioritetsværdi er klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9.
vægt nummer Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser. De mulige værdier er fra 1 til 9.
max_conns nummer Det er det maksimale antal forbindelser, som backend vil modtage samtidigt. Hvis den er indstillet med a 0 værdi backend har ikke defineret nogen grænse.

Sessionsobjekt for L4xNAT-farme:

Field Type Beskrivelse
kunde nummer Det er en klientidentifikator.
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'mac', Session skal være en MAC, f.eks. 02: 8e: 69: 38: 12: 8e; hvis udholdenhed er 'ip' eller 'srcip', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65; hvis udholdenhed er 'havn', Session skal være en gyldig port, f.eks. 5445; hvis udholdenhed er 'srcip_srcport' eller 'srcip_dstport'; Session skal være en streng med en IP og en port forbundet med underscope '', f.eks. 122.36.54.280.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen er af statisk type.
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.

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/v4.0/zapi.cgi/farms
zcli farm create -farmname newl4farm -vip 192.168.100.241 -vport 88 -profile l4xnat

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
kopi_fra (fra 4.0.1) String Denne parameter forventer navnet på en gård, der findes. Hvis denne parameter sendes, kopieres gården fra den gård, der er specificeret i den. Det farmname, vip VPort værdier overskrives.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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","logs":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
zcli farm set newfarml4 -algorithm weight -newfarmname l4farm -protocol tcp -nattype nat -ttl 125 -vip 178.62.126.152 -vport 81 -logs true

PUT /farms/<farmname>

Rediger konfigurationen af ​​en L4xNAT gård.

Anmod om parametre

Field Type Beskrivelse
newfarmname String Den nye gårds navn. Gården skal stoppes.
logs String Farm Logs pakkeoplysninger af transportlaget, er der ikke ledige applikationslagsoplysninger. Hvis denne parameter har værdien sand, loggene er aktiveret; hvis det har værdien falsk, logfiler er deaktiveret.
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 ,.
udholdenhed String Denne parameter videresender den indkommende anmodning til den samme backend i basen på den valgte persistensfunktion. Indstillingerne er: "" tom værdi deaktiverer persistensen, hver indkommende pakke vil blive afbalanceret mellem bagsiden; ip or srcip, Source IP, vil tildele samme backend for hver indgående forbindelse afhængigt af kun kilde-IP-adressen; port, Source Port, vil tildele samme backend for hver indgående forbindelse afhængigt af kun kildeporten. srcmac, Kilde MAC, Med denne indstilling vil gården tildele samme backend for hver indgående forbindelse afhængigt af pakkeens link-lag MAC-adresse; srcip_srcport, Source IP og Source Port, vil tildele samme backend for hver indgående forbindelse afhængigt af både source IP og source port; srcip_dstport, Source IP og Destination Port, vil tildele samme backend for hver indgående forbindelse afhængigt af både kilde IP og destinationsport.
nattype String Hvordan belastningsbalancelaget 4-kernen skal fungere. Indstillingerne er: NAT også kaldet sNAT-tilstand, svarer backenden til belastningsbalanceren for at sende svaret til klienten; DNAT backend vil reagere direkte på klienten, load balancer skal konfigureres som gateway i backend serveren; I DSR (Direct Server Return) -tilstanden, som klienten forbinder til VIP, ændrer loadbalanceren sin destinations MAC-adresse til MAC-adressen til backend (serveren skal være på samme linkmedie som belastningsbalanceren); Stateless DNAT. I stateless_dnat Betalingsbalancen skifter destinationsadresse for backendadressen og videresender den til backend som DNAT gør, men det klarer ikke nogen form for forbindelsesinformation.
algoritme String Type aflastningsplanlægning, der bruges til at sende trafikken mellem bagsiden. Indstillingerne er: leastconn fremadgående forbindelse altid til den mindste forbindelsesserver vægt Tilslutning lineær afsendelse afhængigt af bagvægten; runde Robin Gør et sekventielt valg mellem backend-puljen, vil hver backend modtage det samme antal anmodninger; hash_srcip balancer pakker, der matcher samme kilde IP til samme backend; hash_srcip_srcport balancer pakker, der matcher samme kilde IP og port til samme backend; symhash balance pakker, der matcher samme kilde IP og port og destination IP og port, så det kunne hash en forbindelse på begge måder (under indgående og udgående).
protokol String Protokol skal afbalanceres ved lag 4. Indstillingerne er: alle profilen vil indlæse balance for enhver L4-protokol; tcp belastningsbalanceren vil kun balancere TCP L4-protokollen, også for TCP, er det muligt at indstille en af ​​følgende protokoller for at analysere sine overskrifter og bruge den til at distribuere korrekt: ftp, irc, pptp eller sane; uDP belastningsbalanceren vil kun balancere UDP L4-protokollen, også for UDP, er det muligt at indstille en af ​​følgende protokoller for at analysere sine overskrifter og bruge den til at distribuere korrekt: tår, tftp, amanda, NetBIOS-ns eller snmp; SCTP, vil belastningsbalanceren kun balancere SCTP L4-protokollen. Hvis h323 er valgt, vil gården lytte til TCP UDP anmodninger og parse dets overskrifter for at afbalancere mellem backends.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Tilføj FarmGuardian

Tilføj FarmGuardian

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg
zcli farm-service-farmguardian add l4Farm default_service -name check_tcp-cut_conns

POST /farms/<farmname>/fg

Anbring en FarmGuardian på gården.

Anmod om parametre

Field Type Beskrivelse
navn String FarmGuardian unikke identifikator. FarmGuardians er oprettet og ændret i overvågningsafsnittet.

Svar eksempel:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the farm fgl4",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the farm fgl4"
}

Fjern FarmGuardian

Fjern FarmGuardian

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove l4Farm default_service check_tcp-cut_conns

DELETE /farms/<farmname>/fg/<name>

Fjern FarmGuardian fra gården.

Svar eksempel:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the farm fgl4",
   "message" : "Sucess, check_tcp-cut_conns was removed from the farm fgl4"
}

Tilføj POST /farms/<farmname>/sessions

Tilføj DELETE /farms/<farmname>/sessions/<session>

Liste over sessionerne

Liste over sessionerne

Forespørgselseksempel:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session list farm1

GET /farms/<farmname>/sessions

Hent listen over sessioner på gården.

Svar eksempel:

{
   "description" : "Get farm sessions",
   "params": [
      {
         "client": 0,
         "id": "0",
         "session": "10.0.0.2_56",
         "ttl": null,
         "type": "static"
      },
      {
         "client": 1,
         "id": "0",
         "session": "10.0.0.2_54936",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "client": 2,
         "id": "0",
         "session": "10.0.0.2_54968",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

Response Parametre

Denne anmodning returnerer en liste over sessioner, hvert sessionobjekt indeholder følgende taster:

Field Type Beskrivelse
kunde nummer Det er en klientidentifikator.
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'mac', Session skal være en MAC, f.eks. 02: 8e: 69: 38: 12: 8e; hvis udholdenhed er 'ip' eller 'srcip', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65; hvis udholdenhed er 'havn', Session skal være en gyldig port, f.eks. 5445; hvis udholdenhed er 'srcip_srcport' eller 'srcip_dstport'; Session skal være en streng med en IP og en port forbundet med underscope '', f.eks. 122.36.54.280.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen er af statisk type.
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.

Tilføj en session

Tilføj en session

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2_56","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session add farm1 -id 0 -session 10.0.0.2_56

POST /farms/<farmname>/sessions

Det opretter en statisk session med en backend. Den indgangsforbindelse, der matcher med Session vil altid blive videresendt til denne backend.

Anmod om parametre

Field Type Beskrivelse
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'mac', Session skal være en MAC, f.eks. 02: 8e: 69: 38: 12: 8e; hvis udholdenhed er 'ip' eller 'srcip', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65; hvis udholdenhed er 'havn', Session skal være en gyldig port, f.eks. 5445; hvis udholdenhed er 'srcip_srcport' eller 'srcip_dstport'; Session skal være en streng med en IP og en port forbundet med underscope '', f.eks. 122.36.54.280.

Svar eksempel:

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "client" : 1,
      "id" : "0",
      "session" : "10.0.0.1_56",
      "ttl" : null,
      "type" : "static"
   }
}

Response Parametre

Denne anmodning returnerer sessionobjekt, der indeholder følgende taster:

Field Type Beskrivelse
kunde nummer Det er en klientidentifikator.
id nummer Backend-id, der modtager forbindelsen.
Session String Det er sessionidentifikatoren eller en forbindelse, dens værdi afhænger af udholdenhed parameter for gården. Hvis udholdenhed er 'mac', Session skal være en MAC, f.eks. 02: 8e: 69: 38: 12: 8e; hvis udholdenhed er 'ip' eller 'srcip', Session skal være en IPv4 eller IPv6, f.eks. 192.168.42.65; hvis udholdenhed er 'havn', Session skal være en gyldig port, f.eks. 5445; hvis udholdenhed er 'srcip_srcport' eller 'srcip_dstport'; Session skal være en streng med en IP og en port forbundet med underscope '', f.eks. 122.36.54.280.
ttl String Det er en streng med sessionstiden for at udløbe. Det ttl værdien vil være null hvis sessionen er af statisk type.
typen String Der er to typer sessioner: dynamisk er en forbindelse, der indlæser balanceringsstifter med en backend ved hjælp af landbrugsbelastningsbalanceringsalgoritmen; statisk er en forbindelse, som belastningsbalanceadministratoren fastgør med en backend. De statiske sessioner vil ikke blive omdirigeret til en anden backend, hvis dens sikkerhedskopieres ikke tilgængelig.

Fjern en session

Fjern en session

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56

DELETE /farms/<farmname>/sessions/<session>

Det sletter en statisk session.

Svar eksempel:

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists
zcli farm-blacklist add l4Farm -name china

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

Anvend sortlister, DoS eller RBL regler til en gård.

Anmod om parametre

Field Type Beskrivelse
navn String IPDS-reglenavn, der bruges som en 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/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists/china
zcli farm-blacklist remove l4Farm china

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

Fjern en blacklist, DoS eller RBL regel af IPDS modul fra en given gård ved hjælp af dens indikator 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm get l4farm

GET /farms/<farmname>/backends

Få listen over backends i en tjeneste.

Svar eksempel:

{
   "description" : "List backends",
   "params" : [
      {
         "alias" : null,
         "id" : 0,
         "ip" : "192.5.1.1",
         "max_conns" : 400,
         "port" : 787,
         "priority" : 1,
         "status" : "up",
         "weight" : 1
      },
      {
         "alias" : "server-2",
         "id" : 1,
         "ip" : "192.5.1.3",
         "max_conns" : 200,
         "port" : 787,
         "priority" : 2,
         "status" : "up",
         "weight" : 1
      },
   ]
}

Response Parametre

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

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer ID for at identificere backend i gården backends pool.
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 den / de virtuelle port (er).
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.
max_conns nummer Det er det maksimale antal samtidige forbindelser 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 højeste prioritet, hvor 1 er mest prioriteret, og 9 er mindst prioriteret.
vægt nummer Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser. De mulige værdier er fra 1 til 9.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm-service-backend add l4farm default_service -ip 192.168.5.100 -port 8080 -max_conns 400

POST /farms/<farmname>/backends

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 den / de virtuelle port (er).
max_conns nummer Det er det maksimale antal samtidige forbindelser til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
prioritet nummer Det er den prioriterede værdi for den aktuelle reelle server. Backend med lavere prioritetsværdi er klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9.
vægt nummer Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser. De mulige værdier er fra 1 til 9.

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
zcli farm-service-backend set l4farm default_service 2 -ip 192.168.5.40 -port 8080 -max_conns 220 -priority 4 -weight 7

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

Rediger parametrene for en backend til 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 den / de virtuelle port (er).
max_conns nummer Det er det maksimale antal samtidige forbindelser til backend. Hvis dette felt har værdien 0, har backend ikke konfigureret nogen forbindelsesgrænse.
prioritet nummer Det er den prioriterede værdi for den aktuelle reelle server. Backend med lavere prioritetsværdi er klar til at modtage forbindelser før end andre med højere prioritet. Standardværdi null, en prioritetsværdi 1 anvendes. De mulige værdier er fra 1 til 9.
vægt nummer Det er vægtværdien for den aktuelle virkelige server. Backends med mere vægt får flere forbindelser. De mulige værdier er fra 1 til 9.

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Backend i vedligeholdelse

Backend i vedligeholdelse

Forespørgselseksempel:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/1/maintenance
zcli farm-service-backend maintenance l4farm default_service 1 -mode cut

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

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 virkning for klienterne.
tilstand String Vælg en vedligeholdelsestilstand. De tilgængelige muligheder er: dræne, backend accepterer ikke nye forbindelser, men den vil fortsat håndtere de nuværende forbindelser; eller skære, de aktuelle forbindelser vil blive lukket.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/4
zcli farm-service-backend remove l4farm default_service 4

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

Slet en given backend for en L4xNAT Farm.

id er backend unikke identifikator.

Svar eksempel:

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

GSLB Farms

Global Service Load Balancing, 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 på DNS-applikationslaget.

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/v4.0/zapi.cgi/farms/gslbfarm
zcli farm get gslbfarm

GET /farms/<farmname>

Vis alle konfigurationer om en given gård.

Svar eksempel:

{
   "description" : "List farm gslbfarm",
   "ipds" : {
      "blacklists" : [],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "status" : "needed restart",
      "vip" : "192.168.100.155",
      "vport" : 60
   },
   "services" : [
      {
         "algorithm" : "roundrobin",
         "backends" : [
            {
               "alias" : "localhost",
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 53,
               "status" : "up"
            },
            {
               "alias" : "dns-server",
               "id" : 2,
               "ip" : "192.168.55.40",
               "port" : 53,
               "status" : "up"
            },
            {
               "alias" : null,
               "id" : 4,
               "ip" : "192.135.10.2",
               "port" : 53,
               "status" : "up"
            }
         ],
         "deftcpport" : 53,
         "farmguardian" : "dns-request",
         "id" : "service1"
      },
      {
         "algorithm" : "prio",
         "backends" : [
            {
               "alias" : "localhost",
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            },
            {
               "alias" : "localhost",
               "id" : 2,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            }
         ],
         "deftcpport" : 80,
         "farmguardian" : null,
         "id" : "prioServ"
      }
   ],
   "zones" : [
      {
         "defnamesv" : "ns3",
         "id" : "global.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns3",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns3",
               "ttl" : null,
               "type" : "A"
            },
            {
               "id" : 3,
               "rdata" : "resource2",
               "rname" : "ns2",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 4,
               "rdata" : "192.168.200.30",
               "rname" : "resource2",
               "ttl" : null,
               "type" : "A"
            }
         ]
      },
      {
         "defnamesv" : "ns1",
         "id" : "DOM.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns1",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns1",
               "ttl" : null,
               "type" : "A"
            }
         ]
      }
   ]
}

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 Objekt[] Sortlister søges på gården.
dos Objekt[] DoS regler gælder for gården.
RBL Objekt[] RBL regler anvendes på gården.

Blacklist, DoS og RBL Objekt:

Field Type Beskrivelse
navn String Regelnavnet.
status String Regelstatus.

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 tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; up, gården er op og alle backends arbejder succes.

Serviceobjekt for GSLB gårde:

Field Type Beskrivelse
backends Objekt[] Backends defineret i tjenesten.
farmguardian String Det er FarmGuardian-navnet, der kontrollerer backend-status. FarmGuardian vil køre, mens gården er i up status. Farmguardian logs er ikke tilgængelige for GSLB gårde
id String Servicenavn, der bruges som en unik identifikator.
algoritme String Type belastningsbalanceringsalgoritme anvendt i tjenesten. Indstillingerne er: runde Robin, som vil afbalancere forbindelserne 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 fastslå, at backend-tjenesten er i live. En tom værdi er deaktiveret.

Backend objekt til GSLB gårde:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer Unik identifikator for backend i tjenesten. Denne identifikator genereres af systemet.
ip String Backends IP, hvor den rigtige tjeneste lytter.
port nummer Backends havn, hvor den rigtige tjeneste lytter.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.

Zone objekt:

Field Type Beskrivelse
id nummer Zone navn bruges som en unik indetifier.
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/v4.0/zapi.cgi/farms
zcli farm create -farmname gslbfarm -vip 192.168.100.241 -vport 53 -profile gslb

POST /farms

Opret en ny GSLB gård.

Anmod om parametre

Field Type Beskrivelse påkrævet
farmname String Farmens navn bruges som den unikke id for farms. 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
kopi_fra (fra 4.0.1) String Denne parameter forventer navnet på en gård, der findes. Hvis denne parameter sendes, kopieres gården fra den gård, der er specificeret i den. Det farmname, vip VPort værdier overskrives.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm
zcli farm set gslbfarm -newfarmname gslbnewname -vip 192.168.100.155 -vport 60

PUT /farms/<farmname>

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 foretage 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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists
zcli farm farm-blacklist add gslbFarm -name china

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

Anvend en sortliste, DoS eller RBL regel til gården.

Anmod om parametre

Field Type Beskrivelse
navn String IPDS-reglenavn, der bruges som en 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/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
zcli farm-blacklist remove gslbFarm china

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

Fjern en sortliste-, DoS- eller RBL-regel fra en given bedrift ved hjælp af dens identifikator 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 højeste prioritet. 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-Passive Cluster-tjeneste med flere rigtige servere.

Services genstand for GSLB gårde

Field Type Beskrivelse
backends Objekt[] Backends defineret i tjenesten.
farmguardian String Det er FarmGuardian-navnet, der kontrollerer backend-status. FarmGuardian vil køre, mens gården er i up status.
id String Servicenavn, som bruges som den unikke identifikator.
algoritme String Type belastningsbalanceringsalgoritme anvendt i tjenesten. Indstillingerne er: runde Robin, som vil afbalancere forbindelserne 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 fastslå, at backend-tjenesten er i live. 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services
zcli farm-service add gslbfarm -id service1 -algorithm roundrobin

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, som bruges som den unikke 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 svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service set  gslbfarm service1 -deftcpport 53

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

Ændre parametrene for en GSLB-tjeneste. id er tjenesten unikke identifikator, der vil blive ændret.

Anmod om parametre

Field Type Beskrivelse
deftcpport nummer Dette er den sundhedskontrol TCP-port, som tjenesten skal kontrollere for at fastslå, at backend-tjenesten er i live.

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 svareksemplet for mere information.

Tilføj FarmGuardian

Tilføj FarmGuardian

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"dns-request"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg
zcli farm-service-farmguardian add gslbfarm service1 -name dns-request

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

Anvend en FarmGuardian til en tjeneste.

URI-parameteren er den service unikke identifikator.

Anmod om parametre

Field Type Beskrivelse
navn String FarmGuardian unikke identifikator. FarmGuardians er oprettet og ændret i overvågningsafsnittet. FarmGuardian logs er ikke tilgængelige for gslb gårde.

Svar eksempel:

{
   "description" : "Add the farm guardian dns-request to the service service1 in the farm gslbfarm",
   "message" : "Success, The farm guardian dns-request was added to the service service1 in the farm gslbfarm"
}

Fjern FarmGuardian

Fjern FarmGuardian

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
zcli farm-service-farmguardian remove gslbfarm service1 dns-request

DELETE /farms/<farmname>/fg/<name>

Fjern FarmGuardian fra en GSLB-service.

Svar eksempel:

{
   "description" : "Remove the farm guardian dns-request from the service service1 in the farm gslbfarm",
   "message" : "Sucess, dns-request was removed from the service service1 in the farm gslbfarm"
}

Slet en tjeneste

Slet en tjeneste

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service remove gslbfarm service1

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

Slet en given tjeneste hos en GSLB Farm. id er tjenesten unikke identifikator, der 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 serviceliste, 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm get gslbfarm

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" : [
      {
         "alias" : "localhost",
         "id" : 1,
         "ip" : "127.0.0.1",
         "port":53,
         "status":"up"
      },
      {
         "alias" : "dns-server",
         "id" : 2,
         "ip" : "192.168.55.40",
         "port":53,
         "status":"up"
      }
   ]
}

Response Parametre

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

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer Unik identifikator for backend i tjenesten. Denne identifikator genereres af systemet.
ip String IP af backend, hvor den rigtige tjeneste lytter.
port nummer Backends havn, hvor den rigtige tjeneste lytter.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.

Opret en ny backend

Opret en ny backend

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.135.10.2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm-service-backend add gslbfarm service1 -ip 192.135.10.2

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

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 svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/1
zcli farm-service-backend set gslbfarm service1 1 -ip 192.168.2.30

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

Ændr parametrene for en backend for en GSLB-tjeneste.

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 svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/3
zcli farm-service-backend remove gslbfarm service1 3

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

Slet en given backend i en GSLB-tjeneste.

Svar eksempel:

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

GSLB - Zones

GSLB-sektionsafsnittet beskriver DNS-domænenavnet, underdomænerne, aliaserne, osv., Som er nødvendige for 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.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones
zcli farm-zone add gslbfarm -id global.com

POST /farms/<farmname>/zones

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 brugt som den unikke identifikator. 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 svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com
zcli farm-zone set gslbfarm global.com -defnamesv ns3

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

Æ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 svareksemplet for mere information.

Slet en zone

Slet en zone

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/dom.com
zcli farm-zone remove gslbfarm dom.com

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

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, en peger til 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource list gslbfarm global.com

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

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource add gslbfarm global.com -rname resource2 -rdata 192.168.0.9 -ttl 10 -type A

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

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 det maksimale antal router-enheder, som anmodningen kan gennemføres indtil dø. Det er nyttigt, at pakken ikke indtastes i en net-loop.
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 svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
zcli farm-zone-resource set gslbfarm global.com 1 -rname resource2 -rdata 192.168.200.30 -type A

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

Æ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 svareksemplet for mere information.

Slet en ressource

Slet en ressource

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
zcli farm-zone-resource remove gslbfarm global.com 3

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

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årdprofilen eller DSLB (Datalink Service Load Balancing) tillader oprettelse af en rutebaseret gård, hvor backendene er uplink-routere eller gateways. Denne form for gårdsprofil er klar til at dele adskillige uplink WAN-routeradgang ved hjælp af belastningsbalanceren som en uplink-kanalmultiplexor (1 input og flere router line-udgange). Derfor kunne datalink-gårdene bruges som høje tilgængelige kommunikationslink, og derudover kunne de bruges som båndbreddeforøgelse, der forbinder mængden af ​​båndbredde mellem routerens 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/v4.0/zapi.cgi/farms/dlink
zcli farm get dlink

GET /farms/<farmname>

Vis alle konfigurationer om en gård.

Svar eksempel:

{
   "backends" : [
      {
         "alias" : "main-gateway",
         "id" : 0,
         "interface" : "eth0",
         "ip" : "192.168.100.10",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 2
      },
      {
         "alias" : "secondary-gateway",
         "id" : 1,
         "interface" : "eth0",
         "ip" : "192.168.100.11",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      }
   ],
   "description" : "List farm dlink",
   "ipds" : {
      "blacklists" : []
   },
   "params" : {
      "algorithm" : "weight",
      "status" : "down",
      "vip" : "192.168.100.199"
   }
}

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[] Reelle servere skabt i denne gård og dens konfiguration.

IPDS-objekt:

Field Type Beskrivelse
sortlister Snor[] Sortlister søges på gården.

Parametre genstand for datalink gårde:

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

Backend objekt for datalink gårde:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
id nummer Unik identifikator til baggårdens gård.
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 konfigureret som en prioritet, og lavere prioritet vil have præference
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.
vægt nummer Det er vægtværdien for den aktuelle virkelige server. Det vil blive brugt når algoritme feltet er konfigureret som vægt.

Opret en ny gård

Opret en ny gård

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm create -profile datalink -farmname dlink -vip 192.168.100.241

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 at oprette en gård af type datalink er nøglen data link sand
vip String IP af gården, hvor den virtuelle tjeneste lytter. sand
kopi_fra (fra 4.0.1) String Denne parameter forventer navnet på en gård, der findes. Hvis denne parameter sendes, kopieres gården fra den gård, der er specificeret i den. Det farmname vip værdier overskrives.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm set dlink -newfarmname dlink2 -vip 192.168.100.199 -algorithm weight

PUT /farms/<farmname>

Rediger konfigurationen af ​​en datalink gård.

Anmod om parametre

Field Type Beskrivelse
newfarmname String Det nye landbrugsnavn. Gården skal stoppes for at ændre dette felt.
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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists
zcli farm-blacklist add dlink2 -name china

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

Anvend en blacklist-regel til gården. En datalinkprofil accepterer kun sorte listeregler.

Anmod om parametre

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

Svar eksempel:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm dlink2.",
   "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/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists/china
zcli farm-blacklist remove dlink -name china

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

Fjern en blacklist-regel for IPDS-modulet fra en given gård ved hjælp af dens indikator navn.

Svar eksempel:

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

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm get dlink

GET /farms/<farmname>/backends

Få listen over backends i en tjeneste.

Svar eksempel:

[
   {
      "alias" : "main-gateway",
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 2
   },
   {
      "alias" : "secondary-gateway",
      "id" : 7,
      "interface" : "eth0",
      "ip" : "192.168.100.11",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 1
   }
]

Response Parametre

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

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere backend. Alias
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 konfigureret som en prioritet og lavere prioritet vil have en præference.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.
vægt nummer Det er vægtværdien for den aktuelle backend. Det vil blive brugt når algoritme feltet er konfigureret som vægt.

Opret en ny backend

Opret en ny backend

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm-service-backend add dlink default_service -ip 192.168.100.10 -interface eth0 -priority 2 -weight 2

POST /farms/<farmname>/backends

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. Det vil blive brugt, når algoritme feltet er konfigureret som en prioritet og lavere prioritet vil have en 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,"priority":1}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/datalink/backends/2
zcli farm-service-backend set datalink default_service 2 -ip 192.168.102.50 -interface eth0 -weight 1 -priority 1

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

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

Anmod om parametre

Field Type Beskrivelse
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 backend prioritet at reagere 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",
      "priority" : 1,
      "weight" : 1
   }
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends/4
zcli farm-service-backend remove dlink default_service 4

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

Slet en given backend fra 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 bindingsgrænseflader.

nic: eller netværkskort, er det en computer hardware komponent. Resten af ​​grænsefladerne er baseret på NIC'er.

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

limning: Også kaldet af andre leverandører 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 grænseflade kan oprettes over enhver form for grænseflade, der er beskrevet ovenfor, og de bruger routingtabellerne i dets overordnede grænseflade, så det skal have konfigureret i det samme netværkssegment end dets forælder. Denne slags grænseflade bør bruges til gårde.

Liste over alle grænseflader

Liste over alle grænseflader

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network list

GET /interfaces

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

Svar eksempel:

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "bond2",
         "netmask" : "",
         "status" : "down",
         "dhcp" : "false",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "dhcp" : "false",
         "type" : "vlan"
      },
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "virtual"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "eth2",
         "netmask" : "",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "true"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "dhcp" : "false",
         "is_slave" : "true"
      }
   ]
}

Response parametre

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

Interface objekt:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
ip String IP af grænsefladen. IP skal være i samme netværkssegment, at dets overordnede grænseflade i en virtuel grænseflade.
has_vlan String sand, grænsefladen det er forælder til en VLAN interface; eller falsk, grænsefladen har ikke nogen VLAN-grænseflade, der tilføjer det. Dette felt er kun til NIC-grænseflader.
netmaske String Netmaske af grænsefladen. Denne værdi kunne ikke ændres i virtuelle grænseflader, det er arvet fra overordnet grænseflade.
gateway String Gateway til grænsefladen. Denne værdi kunne ikke ændres i virtuelle grænseflader, det er arvet fra overordnet grænseflade.
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 en unik identifikator.
status String Værdierne kan være up, grænsefladen kan modtage pakker; ned, kan grænsefladen 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.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

Hent standard gateway

Hent standard gateway

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 get

GET /interfaces/gateway/<ip_version>

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.

Systemet har konfigureret to gateways, en gang for at rute IPv4 og en anden til at rute IPv6. URI forventer en IP-version ipv4 or ipv6.

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.

Rediger 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 set -interface eth0 -address 192.168.100.5

PUT /interfaces/gateway/<ip_version>

Rediger konfigurationen af ​​gateway-grænsefladen.

URI forventer, at den IP-version, der anvendes i adressefeltet. De mulige værdier er ipv4 ipv6.

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

Slet konfigurationen af ​​standard gateway-konfigurationen.

URI forventer en IP-version af standardgatewayen, der skal slettes. De mulige værdier er ipv4 ipv6.

Advarsel: Hvis gatewayen er frakoblet, 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 delete

Svarmeddelelse

Hvis gatewayen er frakoblet 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 hjælp af NIC-grænseflader som forældre kan der oprettes andre typer grænseflader med forskellige egenskaber. Tilgængelige grænseflader er VLAN, virtuelt 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network-nic list

Svar eksempel:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

Response parametre

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

NIC-grænsefladeobjekt:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
ip String IP af grænsefladen.
has_vlan String sand, grænsefladen det er forælder til en VLAN interface; eller falsk, grænsefladen har ikke nogen VLAN-grænseflade, der tilføjer det.
netmaske String Definer netværkssegmentet, hvor grænsefladen virker.
gateway String IP bruges til at sende pakker til et andet netværkssegment.
mac String Linklagets unikke identifikator. Det er umuligt.
navn String Interface navn. Det bruges som en unik interface-id.
status String Værdierne kan være up, grænsefladen kan modtage pakker; ned, kan grænsefladen 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.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

Hent NIC-grænseflade

Hent NIC-grænseflade

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic get eth1

GET /interfaces/nic/<name>

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

Svar eksempel:

{
   "description" : "Show NIC interface",
   "interface" : {
      "alias" : "gestion",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "62:30:43:36:29:ac",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "dhcp" : "false",
      "status" : "up"
   }
}

Response parametre

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
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 Linklagets unikke identifikator. Det er umuligt.
navn String Interface navn. Det bruges som en unik interface-id.
status String Værdierne kan være up, grænsefladen kan modtage pakker; ned, kan grænsefladen ikke modtage pakker.
typen String Den forskellige slags 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.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic set eth0 -ip 192.168.100.102 -netmask 255.255.255.0 -gateway 192.168.100.5

PUT /interfaces/nic/<name>

Æ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.
styrke String Hvis en gård bruger grænsefladen, kan grænsefladen ikke ændres. Derefter, hvis denne parameter sendes med værdien sand, vil grænsefladen blive tvunget til at tage den nye konfiguration, og alle gårde bruger grænsefladen vil blive genstartet.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

Svar eksempel:

{
   "description" : "Configure NIC interface",
   "params" : {
      "alias" : null,
      "dhcp" : "false",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "4a:4f:3c:d7:dd:70",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "down"
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Slet NIC-konfiguration

Slet NIC-konfiguration

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
zcli network-nic unset eth3

DELETE /interfaces/nic/<name>

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1/actions
zcli network-nic stop eth1

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Netværk - VLAN-interfaces

VLAN-grænsefladen gør det muligt at bruge et NIC- eller bindingsinterface i et andet netværk, så netværkskonfigurationen (IP, gatewayog netmaske) skal være i et andet netværkssegment. VLAN-grænsefladen arver MAC-adressen fra dens overordnede grænseflade.

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

Liste VLAN-grænseflader

Liste VLAN-grænseflader

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan list 

GET /interfaces/vlan

Få alle parametre af VLAN-interfaces.

Svar eksempel:

{
   "description" : "List VLAN interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

Response parametre

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

VLAN parametrene er:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
ip String IP af grænsefladen. Det kan være forskelligt fra den overordnede grænseflade 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 en unik identifikator. Dette navn er en kæde formateret af et overordnet interface-navn, et priktegn “.” og et nummer til VLAN-netværksgrænsefladen eller VLAN-koden.
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 interface kan ikke modtage pakker.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

Hent VLAN-grænseflade

Hent VLAN-grænseflade

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan get eth0.1

GET /interfaces/vlan/<name>

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

Svar eksempel:

{
   "description" : "Show VLAN interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0.1",
      "netmask" : "255.255.255.0",
      "dhcp" : "false",
      "status" : "up"
   }
}

Response parametre

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
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 en unik identifikator. Dette navn er en kæde formateret 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 interface kan ikke modtage pakker.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

Opret en 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","mac":"52:98:19:6a:c9:18","dhcp":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan create -name eth0.1 -ip 192.168.120.120 -netmask 255.255.255.0 -gateway 192.168.120.1 -mac 52:98:19:61:c9:18 -dhcp false

POST /interfaces/vlan

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 overordnet interface 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 en unik identifikator. Dette navn er en kæde formateret af et overordnet interface-navn, et priktegn “.” og et nummer til VLAN-netværksgrænsefladen. sand
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.
mac String Omskriver MAC'en til grænsefladen.

Svar eksempel:

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : "52:98:19:6a:c9:18",
      "name" : "eth0.1",
      "dhcp" : "false",
      "netmask" : "255.255.255.0"
   }
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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","mac":"96:23:25:8b:d4:af"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan set eth0.1 -ip 192.168.131.151 -netmask 255.255.255.0 -gateway 192.168.131.1 -mac 96:23:25:8b:d4:af

PUT /interfaces/vlan/<name>

Æ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 forskelligt fra den overordnede grænseflade IP.
netmaske String Definer netværkssegmentet, hvor grænsefladen virker.
gateway String IP bruges til at sende pakker af et andet netværkssegment.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.
mac String Omskriver MAC'en til grænsefladen.
styrke String Hvis en gård bruger grænsefladen, kan grænsefladen ikke ændres. Derefter, hvis denne parameter sendes med værdien sand, vil grænsefladen blive tvunget til at tage den nye konfiguration, og alle gårde bruger grænsefladen vil blive genstartet.

Svar eksempel:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0",
      "mac" : "96:23:25:8b:d4:af",
      "dhcp" : "false",
      "force" : "true"
   }
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Slet VLAN-grænseflade

Slet VLAN-grænseflade

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan delete eth0.1

DELETE /interfaces/vlan/<name>

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
zcli network-vlan stop eth0.1

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Netværk - Virtuelle grænseflader

Netværksgrænseflader lader brugerne indstille en anden netværksgrænseflade i samme netværkssegment end deres forældre, så virtuelle grænseflader arver altid netværkskonfigurationen fra dets forælder. Den forskellige parameter vil være ip. Den virtuelle grænseflade 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 identitet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual list

GET /interfaces/virtual

Få alle parametrene for virtuelle grænseflader.

Svar eksempel:

{
   "description" : "List virtual interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.41",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virtiface",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

Response parametre

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
ip String IP af grænsefladen. IP'en skal være i samme netværkssegment som forælder-grænsefladen.
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 en unik identifikator. Dette navn er en kæde formateret af en overordnet grænseflade, et kolontegn ":" og navnet på det 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, kan grænsefladen ikke modtage pakker.

Hent virtuel grænseflade

Hent virtuel grænseflade

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual get eth0:vip1

GET /interfaces/virtual/<name>

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

Svar eksempel:

{
   "description" : "Show virtual interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0",
      "status" : "down"
   }
}

Response parametre

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
ip String IP af grænsefladen. IP'en skal være i samme netværkssegment som forælder-grænsefladen.
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 en unik identifikator. Dette navn er en kæde, der er formateret med 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, kan grænsefladen ikke modtage pakker.

Opret en 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual create -name eth0:virtiface -ip 192.168.100.41

POST /interfaces/virtual

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 som forælder-grænsefladen. sand
navn String Interface navn. Det bruges som en unik identifikator. Dette navn er en kæde, der er formateret med 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 et JSON med interface-konfigurationen. Se svareksemplet for mere information.

Field Type Beskrivelse
ip String IP af grænsefladen. IP'en skal være i samme netværkssegment som forælder-grænsefladen.
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 en unik identifikator. Dette navn er en kæde, der er formateret med en overordnet grænseflade, et kolontegn ":" og en alfanumerisk 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual set eth0:virtiface -ip 192.168.131.155

PUT /interfaces/virtual/<name>

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

Anmod om parametre

Field Type Beskrivelse påkrævet
ip String IP af grænsefladen. IP'en skal være i samme netværkssegment som forælder-grænsefladen. sand
styrke String Hvis en gård bruger grænsefladen, kan grænsefladen ikke ændres. Derefter, hvis denne parameter sendes med værdien sand, vil grænsefladen blive tvunget til at tage den nye konfiguration, og alle gårde bruger grænsefladen vil blive genstartet.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual delete 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
zcli network-virtual stop eth0:virtiface

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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Netværk - Bonding-grænseflader

Linux-bindingsgrænsefladen eller også kaldet af andre leverandører 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 dets adfærd.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding list

GET /interfaces/bonding

Få konfiguration om alle bindingsgrænseflader i systemet.

Svar eksempel:

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

Response parametre

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

Bindingsparametrene er:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
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 Linklagets unikke identifikator. Det er mac af den første NIC interface slave.
navn String Interface navn. Det bruges som en 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 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 afsnit Netværk - Bonding-grænseflader.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding get bondiface

GET /interfaces/bonding/<name>

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

Svar eksempel:

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

Response parametre

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

Bindingsparametrene er:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
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 Linklagets unikke identifikator. Det er mac af den første NIC interface slave.
navn String Interface navn. Det bruges som en 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 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.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding create -slave eth3,eth2 -name bondiface -mode balance-rr

POST /interfaces/bonding

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 en 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 Linklagets unikke identifikator. Det er mac af den første NIC interface slave.
navn String Interface navn. Det bruges som en 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 bindingsinterfacet.
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","mac":"86:2f:0e:9a:30:14"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding set bondiface -ip 192.168.100.121 -netmask 255.255.255.0 -gateway 192.168.100.1 -mac 86:2f:0e:9a:30:14 

PUT /interfaces/bonding/<name>

Æ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.
styrke String Hvis en gård bruger grænsefladen, kan grænsefladen ikke ændres. Derefter, hvis denne parameter sendes med værdien sand, vil grænsefladen blive tvunget til at tage den nye konfiguration, og alle gårde bruger grænsefladen vil blive genstartet.
dhcp String Gør det muligt for DHCP-tjenesten at få netværkskonfigurationen for grænsefladen fra en DHCP-server. Denne parameter accepterer: sand, for at aktivere tjenesten, vil grænsefladskonfigurationen blive blokeret, mens DHCP-tjenesten er aktiveret; falsk For at stoppe tjenesten vil grænsefladen miste hele sin netværkskonfiguration.
mac String Omskriver MAC'en til grænsefladen.

Svar eksempel:

{
   "description" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0",
      "mac" : "86:2f:0e:9a:30:14",
      "dhcp" : "false",
      "force" : "true"
   }
}

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet for mere information.

Slet bindingskonfiguration

Slet bindingskonfiguration

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding delete bondiface

DELETE /interfaces/bonding/<name>

Slet bindingskonfigurationskonfigurationen. Konfigurationsparametrene er: gateway, ip 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/actions
zcli network-bond start bondiface

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 de brugte NIC-grænseflader i limningen. Bindingsdriveren gendanner derefter de MAC-adresser, som medlemsgrænsefladerne havde, før de blev føjet til limningsgræ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 et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves
zcli network-bonding-slave add bondiface -name eth4

POST /interfaces/bonding/<name>/slaves

Tilføj en NIC-grænseflade som en 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 et JSON med opdaterede konfigurerede værdier. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
zcli network-bonding-slave remove bondiface eth2

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

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

First, 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 - 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating
zcli network-floating list

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" : [
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "bondiface",
         "interface_virtual" : null
      },
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : "192.168.100.41",
         "interface" : "eth0",
         "interface_virtual" : "eth0:virtiface"
      },
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "eth0.1",
         "interface_virtual" : null
      },
      {
         "alias" : "gestion",
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "eth1",
         "interface_virtual" : null
      }
   ]
}

Response parametre

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

Flydende objekt:

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
floating_alias String Det er aliaset for den virtuelle grænseflade.
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.
interface_virtual String Det er det virtuelle interface navn på den flydende IP, der bruges til at maskere grænsefladen.

Hent flytende interface

Hent flytende interface

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating get eth0

GET /interfaces/floating/<name>

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" : {
      "alias" : null,
      "floating_alias" : null,
      "floating_ip" : "192.168.100.41",
      "interface" : "eth0",
      "interface_virtual" : "eth0:virtiface"
   }
}

Response parametre

Field Type Beskrivelse
alias String Det er et nick for at hjælpe med at identificere grænsefladen. Alias
floating_alias String Det er aliaset for den virtuelle grænseflade.
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.
interface_virtual String Det er det virtuelle interface navn på den flydende IP, der bruges til at maskere grænsefladen.

Æ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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating set eth0 -floating_ip 192.168.100.199

PUT /interfaces/floating/<name>

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating delete 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"
}

Netværk - Aliaser

Angiv et alias til en grænseflade eller en backend for at identificere det hurtigt.

Der findes to typer aliaser, interface alias kan anvendes i alle typer af grænseflader: NIC, binding, VLAN eller virtuel. Det er en nem måde at forbinde et grænsefladenavn med et mere venligt navn på.

Den anden type alias er til backends. Dette vedrører backend IP med et alias.

Aliaserne er kun visuelle oplysninger, det erstatter ikke backend-IP eller grænsefladenavnet i en ZAPI-anmodning.

Liste aliaser

Liste aliaser

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/backends
zcli network-alias-backend list

GET /aliases/<backends|interfaces>

Angiv aliaserne i systemet til grænseflader eller backends.

Svar eksempel:

{
   "description" : "List the aliases",
   "params" : [
      {
         "id" : "192.168.11.13",
         "alias" : "http-backend"
      },
      {
         "id" : "127.0.0.1",
         "alias" : "localhost"
      }
   ]
}

Response parametre

ZAPI returnerer en hash, hvor nøglen er backend IP eller grænseflades navn og værdien er dens alias.

Opret et alias

Opret et alias

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"eth0","alias":"management"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces
zcli network-alias-interface set eth0 -alias management

POST /aliases/<backends|interfaces>

Backend- eller grænsefladeobjektet, som vil modtage aliaset.

Anmod om parametre

Field Type Beskrivelse påkrævet
alias String Det er nick for elementet id sendt i URI. sand
id String Det er backend-IP'en eller interfacenavnet. sand

Svar eksempel:

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

Response parametre

ZAPI returnerer en succesmeddelelse, hvis processen var korrekt.

Rediger et alias

Rediger et alias

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"gateway"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zcli network-alias-interface set eth0 -alias gateway

PUT /aliases/<backends|interfaces>/<id>

Hvis objektet har et alias, vil det blive erstattet, ellers oprettes et alias for objektet.

id URI parameter er backend IP eller interface navn.

Anmod om parametre

Field Type Beskrivelse påkrævet
alias String Det er nick for elementet id sendt i URI. sand

Svar eksempel:

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

Response parametre

ZAPI returnerer en succesmeddelelse, hvis processen var korrekt.

Slet et alias

Slet et alias

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zli network-alias-interface delete eth0

DELETE /aliases/<backends|interfaces>/<id>

Det sletter aliaset til en grænseflade eller backend.

id URI parameter er backend IP eller interface navn.

Svar eksempel:

{
   "description" : "Delete an alias",
   "message" : "The alias has been deleted.",
   "success" : "true"
}

Response parametre

ZAPI returnerer en succesmeddelelse, hvis processen var korrekt.

Netværk - routing

Dette modul er tilgængelig fra zapi version 4.0.1.

Dette modul styrer ruterne for trafik, der går gennem eller fra belastningsafbalanceren. Denne proces beregner udgangsgrænsefladen afhænger af pakkekilden og pakkedestinationen. Til denne opgave bruger belastningsafbalanceren to slags objekter regler tabeller.

Det første trin er på udkig efter en regere hvor pakkekilden matcher, når først reglen er fundet, leder den pakkeudgående grænseflade efter i bord at regere defineret. Grænsefladen er et tegn på den rute, der matcher med pakkedestinationen.

Liste routing regler

Liste routing regler

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule list

GET /routing/rules

Liste over reguleringsregler for belastningsafbalanceren. Routeregler bruges til at få grænsefladetabellen afhængig af IP-kilden for pakken

Svar eksempel:

{
    "description" : "List routing rules",
    "params" : [
        {
            "id" : 1024,
            "not" : "true",
            "from" : "10.10.10.0/24",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "local",
            "type" : "system",
            "id" : 0,
            "priority" : 0,
            "from" : "all"
        },
        {
            "id" : 0,
            "priority" : 31000,
            "from" : "10.3.0.0/24",
            "table" : "205",
            "type" : "system"
        },
        {
            "type" : "system",
            "table" : "table_eth1",
            "priority" : 31000,
            "from" : "4.4.4.0/24",
            "id" : 0
        },
        {
            "type" : "system",
            "table" : "main",
            "priority" : 32766,
            "from" : "all",
            "id" : 0
        }
    ]
}

Response parametre

Svaret vil være en JSON-liste med alle routingsregler i systemet. Hver regel er et objekt med følgende parametre:

Field Type Beskrivelse
id nummer Det er den unikke id, der bruges til routingregler.
ikke String Dette felt bruges kombineret med parameteren fra at negere kampresultatet. Denne parameter er en boolsk streng med værdien sand for at aktivere det eller med værdien falsk hvis kampresultatet ikke bortfalder.
fra String Det er kildens IP eller netværkssegment, der bruges til at matche kildens IP-kode for pakken.
prioritet nummer Det er regelprioritet, en mindre værdi af prioritet er en høj prioritet.
bord String Det er grænsefladetabellen, der bruges til at rute, hvis pakkekilden IP stemmer overens med parameteren fra.
typen String Det er den slags regel, dette felt kan have værdierne: gård er en rute, der bruges til at dirigere trafik fra en l4xnat gård, bruger er en regel, der blev oprettet af loadbalancer-administratoren eller systemet er en regel, der genereres automatisk til systemet.

Opret routeregel

Opret routeregel

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","not":"true","priority":"30000","from":"192.168.0.0/16"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule -table table_eth1 -not true -priority 30000 -from 192.168.0.0/16

POST /routing/rules

Opret en routeregel.

Anmod om parametre

Field Type Beskrivelse påkrævet
ikke String Dette felt bruges kombineret med parameteren fra at negere kampresultatet. Denne parameter er en boolsk streng med værdien sand for at aktivere det eller med værdien falsk hvis kampresultatet ikke bortfalder.
fra String Det er kildens IP eller netværkssegment, der bruges til at matche kildens IP-kode for pakken. sand
prioritet nummer Det er regelprioritet, en mindre værdi af prioritet er en høj prioritet. De oprettede regler skal have en værdi mellem 29000 30999
bord String Det er grænsefladetabellen, der bruges til at rute, hvis pakkekilden IP stemmer overens med parameteren fra. sand

Svar eksempel:

{
    "description" : "Create a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "from" : "192.168.0.0/16",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "table_eth0",
            "type" : "system",
            "id" : 0,
            "priority" : 32765,
            "from" : "192.168.100.0/24"
        },
        {
            "from" : "all",
            "priority" : 32766,
            "id" : 0,
            "type" : "system",
            "table" : "main"
        },
        {
            "id" : 0,
            "priority" : 32767,
            "from" : "all",
            "table" : "default",
            "type" : "system"
        }
    ]
}

Response parametre

Svaret vil være et JSON-objekt med alle rutens regler i systemet. Hver rute er et objekt med parametrene:

Field Type Beskrivelse
id nummer Det er den unikke id, der bruges til routingregler.
ikke String Dette felt bruges kombineret med parameteren fra at negere kampresultatet. Denne parameter er en boolsk streng med værdien sand for at aktivere det eller med værdien falsk hvis kampresultatet ikke bortfalder.
fra String Det er kildens IP eller netværkssegment, der bruges til at matche kildens IP-kode for pakken.
prioritet nummer Det er regelprioritet, en mindre værdi af prioritet er en høj prioritet.
bord String Det er grænsefladetabellen, der bruges til at rute, hvis pakkekilden IP stemmer overens med parameteren fra.
typen String Det er den slags regel, dette felt kan have værdierne: gård er en rute, der bruges til at dirigere trafik fra en l4xnat gård, bruger er en regel, der blev oprettet af loadbalancer-administratoren eller systemet er en regel, der genereres automatisk til systemet.

Ændre routeregel

Ændre routeregel

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","from":"10.10.10.0/24","priority":"30000","not":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule set 1024 -table table_eth1 -from 10.10.10.0/24 -priority 30000 -not false

PUT /routing/rules/<id>

Rediger parametrene for en routeregel.

id URI-parameter er den unikke regelidentifikator.

Reglerne for typen bruger er det unikke, der kan ændres

Anmod om parametre

Field Type Beskrivelse påkrævet
ikke String Dette felt bruges kombineret med parameteren fra at negere kampresultatet.
fra String Det er kildens IP eller netværkssegment, der bruges til at matche kildens IP-kode for pakken. Denne parameter er en boolsk streng med værdien sand for at aktivere det eller med værdien falsk hvis kampresultatet ikke bortfalder. sand
prioritet nummer Det er regelprioritet, en mindre værdi af prioritet er en høj prioritet. De oprettede regler skal have en værdi mellem 29000 30999
bord String Det er grænsefladetabellen, der bruges til at rute, hvis pakkekilden IP stemmer overens med parameteren fra. sand

Svar eksempel:

{
    "description" : "Modify a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "priority" : 30000,
            "from" : "10.10.10.0/24",
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "id" : 0,
            "from" : "4.4.4.0/24",
            "priority" : 31000,
            "table" : "table_eth1",
            "type" : "system"
        },
        {
            "table" : "table_eth2",
            "type" : "system",
            "id" : 0,
            "from" : "5.5.5.0/24",
            "priority" : 31000
        },
        {
            "type" : "system",
            "table" : "table_eth0",
            "from" : "192.168.100.0/24",
            "priority" : 32765,
            "id" : 0
        },
    ]
}

Response parametre

Svaret vil være et JSON-objekt med alle rutens regler i systemet. Hver rute er et objekt med parametrene:

Field Type Beskrivelse
id nummer Det er den unikke id, der bruges til routingregler.
ikke String Dette felt bruges kombineret med parameteren fra at negere kampresultatet. Denne parameter er en boolsk streng med værdien sand for at aktivere det eller med værdien falsk hvis kampresultatet ikke bortfalder.
fra String Det er kildens IP eller netværkssegment, der bruges til at matche kildens IP-kode for pakken.
prioritet nummer Det er regelprioritet, en mindre værdi af prioritet er en høj prioritet.
bord String Det er grænsefladetabellen, der bruges til at rute, hvis pakkekilden IP stemmer overens med parameteren fra.
typen String Det er den slags regel, dette felt kan have værdierne: gård er en rute, der bruges til at dirigere trafik fra en l4xnat gård, bruger er en regel, der blev oprettet af loadbalancer-administratoren eller systemet er en regel, der genereres automatisk til systemet.

Slet routingregel

Slet routingregel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule remove 1024

DELETE /routing/rules/<id>

Slet en routeregel.

id URI-parameter er den unikke regelidentifikator.

Svar eksempel:

{
    "message" : "The routing rule '1024' has been deleted successfully.",
    "description" : "Delete the routing rule '1024'"
}

Liste over rutetabeller

Liste over rutetabeller

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables
zcli network-routing-table list

GET /routing/tables

Liste over rutetabeller, som belastningsafbalanceren administrerer.

Hovedtabellen er global for alle grænseflader. Det indeholder standardruter for alle grænseflader, der vil blive brugt, hvis ingen regler matcher pakken. Hver grænsefladetabel administrerer ruterne for den udgående trafik af denne grænseflade.

Svar eksempel:

{
  "description" : "List routing tables",
  "params" : [
                "main",
                "table_eth0",
                "table_eth1",
                "table_eth2",
                "table_eth3"
              ]
}

Response parametre

Svaret vil være et JSON-objekt med params nøgle, der indeholder en liste med de tabeller, der findes i systemet.

Liste ruter for en tabel

Liste routing regler

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2
zcli network-routing-table get table_eth2

GET /routing/tables/<table>

Liste over ruteposter, som en grænsefladetabel administrerer. Disse poster bruges til at matche pakkedestinationens IP. Den udgående grænseflade til pakken vil være den første grænseflade, der matcher med en indgang i tabellen.

Svar eksempel:

{
    "description" : "Get the routing table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "priority" : 10,
          "raw" : "5.5.5.0/24 dev eth2 scope link src 5.5.5.5 initcwnd 10 initrwnd 10  table table_eth2",
          "interface" : "eth2",
          "source" : "5.5.5.5",
          "type" : "system",
          "to" : "5.5.5.0/24",
          "via" : ""
        },
        {
          "via" : "",
          "to" : "192.168.100.0/24",
          "interface" : "eth0",
          "type" : "system",
          "source" : "192.168.100.241",
          "raw" : "192.168.100.0/24 dev eth0 scope link src 192.168.100.241 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10
        }
    ]
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og en liste over de ruter, der indeholder tabellen.

Field Type Beskrivelse
String Det er routingindgangen med IP-rute format.
prioritet nummer Det er den prioritet, hvor ruten vil blive undersøgt. En lavere værdi er mere prioriteret. Dette felt skal have en værdi mellem 1 10.
grænseflade String Det er den udgående grænseflade, der bruges, hvis ruten matcher.
kilde String Det er den IP, der bruges til at maskere pakken. Denne kilde skal eksistere i belastningsbalanceren som en virtuel grænseflade.
typen String Det er ruten. Ruterne kan være af type systemet der oprettes og administreres automatisk af systemet, eller bruger da ruten blev oprettet af en belastningsbalancerbruger. Kontrol af ikke styre funktion til at fjerne en systemet rute.
til String Det er de match betingelse. Hvis pakkedestinationens IP matcher den, er ruten vellykket.
via String Det er det næste hop af pakken. Det bruges som en gateway. Denne IP skal nås fra interfacenetværkssegmentet.
id nummer Det er den unikke identifikator for ruten. Denne parameter bruges til at ændre eller slette ruten og er kun tilgængelig i ruter af typen bruger.

Opret routingindtastning

Opret routingindtastning

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"source":"4.4.4.4","via":"4.4.4.45","interface":"eth1","priority":2,"to":"84.1.21.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes
zcli network-routing-table add table_eth2 -source 4.4.4.4 -via 4.4.4.45 -interface eth1 -priority 2 -to 84.1.21.5

POST /routing/tables/<table>/routes

Opret en rute til en grænseflade.

bord URI-parameter er grænsefladetabellen, hvor ruten tilføjes.

Anmod om parametre

Field Type Beskrivelse påkrævet
String Det er routingindgangen med IP-rute format. Hvis denne parameter bruges, undgås de andre.
til String Det er de match betingelse. Hvis pakkedestinationens IP matcher den, er ruten vellykket. Det kræves når sendes ikke
prioritet nummer Det er den prioritet, hvor ruten vil blive undersøgt. En lavere værdi er mere prioriteret. Dette felt skal have en værdi mellem 1 10.
grænseflade String Det er den udgående grænseflade, der bruges, hvis ruten matcher.
kilde String Det er den IP, der bruges til at maskere pakken. Denne kilde skal eksistere i belastningsbalanceren som en virtuel grænseflade.
via String Det er det næste hop af pakken. Det bruges som en gateway. Denne IP skal nås fra interfacenetværkssegmentet.

Svar eksempel:

{
    "description" : "Create a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "source" : "",
          "type" : "system",
          "interface" : "eth2",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2",
          "source" : "4.4.4.4",
          "type" : "system",
          "interface" : "eth1",
          "to" : "4.4.4.0/24",
          "via" : ""
        },
    ]
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og en liste over de ruter, der indeholder tabellen.

Field Type Beskrivelse
prioritet nummer Det er den prioritet, hvor ruten vil blive undersøgt. En lavere værdi er mere prioriteret. Dette felt skal have en værdi mellem 1 10.
String Det er routingindgangen med IP-rute format.
grænseflade String Det er den udgående grænseflade, der bruges, hvis ruten matcher.
kilde String Det er den IP, der bruges til at maskere pakken. Denne kilde skal eksistere i belastningsbalanceren som en virtuel grænseflade.
typen String Det er ruten. Ruterne kan være af type systemet der oprettes og administreres automatisk af systemet, eller bruger da ruten blev oprettet af en belastningsbalancerbruger. Kontrol af ikke styre funktion til at fjerne en systemet rute.
til String Det er de match betingelse. Hvis pakkedestinationens IP matcher den, er ruten vellykket.
via String Det er det næste hop af pakken. Det bruges som en gateway. Denne IP skal nås fra interfacenetværkssegmentet.
id nummer Det er den unikke identifikator for ruten. Denne parameter bruges til at ændre eller slette ruten og er kun tilgængelig i ruter af typen bruger.

Rediger en ruteindtastning

Rediger en ruteindtastning

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"priority":2,"source":"4.4.4.4","interface":"eth1","to":"71.71.71.0/24","via":"4.4.4.45"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table -id 1024 -priority 2 -source 4.4.4.4 -interface eth1 -to 71.71.71.0/24 -via 4.4.4.45

PUT /routing/tables/<table>/routes/<id>

Rediger parametrene for en ruteindgang.

bord URI-parameter er grænsefladetabellen på ruten, der vil blive ændret. Det id URI-parameter er den rute-unikke identifikator for den rute, der vil blive ændret.

Anmod om parametre

Field Type Beskrivelse
String Det er routingindgangen med IP-rute format. Hvis denne parameter bruges, undgås de andre.
prioritet nummer Det er den prioritet, hvor ruten vil blive undersøgt. En lavere værdi er mere prioriteret. Dette felt skal have en værdi mellem 1 10.
grænseflade String Det er den udgående grænseflade, der bruges, hvis ruten matcher.
kilde String Det er den IP, der bruges til at maskere pakken. Denne kilde skal eksistere i belastningsbalanceren som en virtuel grænseflade.
til String Det er de match betingelse. Hvis pakkedestinationens IP matcher den, er ruten vellykket.
via String Det er det næste hop af pakken. Det bruges som en gateway. Denne IP skal nås fra interfacenetværkssegmentet.

Svar eksempel:

{
    "description" : "Modify a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "71.71.71.0/24",
          "via" : "4.4.4.45",
          "raw" : "71.71.71.0/24 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "priority" : 2,
          "id" : 1024,
          "type" : "user",
          "source" : "4.4.4.4",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "interface" : "eth2",
          "source" : "",
          "type" : "system",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "via" : "",
          "to" : "4.4.4.0/24",
          "interface" : "eth1",
          "source" : "4.4.4.4",
          "type" : "system",
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2"
        },
    ]
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og en liste over de ruter, der indeholder tabellen.

Field Type Beskrivelse
prioritet nummer Det er den prioritet, hvor ruten vil blive undersøgt. En lavere værdi er mere prioriteret. Dette felt skal have en værdi mellem 1 10.
String Det er routingindgangen med IP-rute format.
grænseflade String Det er den udgående grænseflade, der bruges, hvis ruten matcher.
kilde String Det er den IP, der bruges til at maskere pakken. Denne kilde skal eksistere i belastningsbalanceren som en virtuel grænseflade.
typen String Det er ruten. Ruterne kan være af type systemet der oprettes og administreres automatisk af systemet, eller bruger da ruten blev oprettet af en belastningsbalancerbruger. Kontrol af ikke styre funktion til at fjerne en systemet rute.
til String Det er de match betingelse. Hvis pakkedestinationens IP matcher den, er ruten vellykket.
via String Det er det næste hop af pakken. Det bruges som en gateway. Denne IP skal nås fra interfacenetværkssegmentet.
id nummer Det er den unikke identifikator for ruten. Denne parameter bruges til at ændre eller slette ruten og er kun tilgængelig i ruter af typen bruger.

Slet en ruteindtastning

Slet en ruteindtastning

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table remove table_eth2 1024

DELETE /routing/tables/<table>/routes/<id>

Slet en rute i en grænsefladetabel.

bord URI-parameter er grænsefladetabellen, hvorfra ruten vil blive slettet. Det id URI-parameter er den rute-unikke identifikator for den rute, der vil blive slettet.

Svar eksempel:

{
    "description" : "Delete the routing entry '1024' from the table 'table_eth2'",
    "message" : "The routing rule '1024' has been deleted successfully."
}

Liste over grænseflader, der ikke er administreret i en tabel

Liste over grænseflader, der ikke er gemaneret i en tabel

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged get table_eth1

GET /routing/tables/<table>/unmanaged

Denne funktion bruges til at undgå trafik fra en grænseflade, der kan komme ud for en anden.

bord er routingtabellen for den indgående interface.

Liste over grænsefladerne, og hvis de kan bruges til at komme ud af trafikken.

Svar eksempel:

{
    "params" : [
      {
         "unmanaged" : "false",
         "interface" : "eth3"
      },
      {
         "unmanaged" : "false",
         "interface" : "eth0"
      }
    ],
    "description" : "Get the list of interfaces that cannot manage traffic when traffic incoming through the table 'table_eth1'"
}

Response parametre

Svaret vil være et JSON objekt med nøglen params der indeholder en liste over objekter med følgende parametre.

Field Type Beskrivelse
grænseflade String Det er navnet på outputgrænsefladen.
ikke-administreret String Det er routingens status for grænsefladen. Hvis det har værdien falsk, kan denne grænseflade nås fra tabellen; hvis det har værdien sand, det kommer ikke trafik fra bordet.

Føj en grænseflade til listen over ikke-administrerede

Fjern styring af en grænseflade

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged add table_eth1 interface eth0

POST /routing/tables/<table>/unmanaged

Deaktiver en grænseflade til udgående trafik.

bord URI-parameter er navnet på routingtabellen, hvorfra en rute ikke kan nås. Hvis bord har værdien “*”(Stjerne), den grænseflade vil ikke være tilgængelig fra noget bord.

Anmod om parametre

Field Type Beskrivelse påkrævet
grænseflade String Det er grænsefladen, der ikke kan rute fra bord. sand

Svar eksempel:

{
    "description" : "Do not route traffic through an interface for the table 'table_eth1'",
    "message" : "The interface 'eth2' is not accesible from the table 'table_eth1'"
}

Fjern en grænseflade fra listen over ikke-administrerede

Administrer en rutetabel

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged/eth2
zcli network-routing-table-unmanaged remove table_eth1 eth2

DELETE /routing/tables/<table>/unmanaged/<interface>

Tillad, at grænsefladen er synlighed fra en anden grænsefladetabel

bord URI-parameter er grænsefladetabellen, der ændres. Hvis bord har værdien “*”(Stjerne), den grænseflade administreres fra alle tabeller. Det grænseflade URI-parameter er grænsefladen, der er tilladt for bord tabel.

Svar eksempel:

{
    "description" : "Enable an interface as possible route path from the table 'table_eth1'",
    "message" : "The interface 'eth2' is now accesible from the table 'table_eth1'"
}

Overvågning - FarmGuardian

FarmGuardian bruges til avanceret overvågningstilstand bagtil. Når et problem opdages af FarmGuardian, deaktiveres den reelle server automatisk og markeres som blacklisted.

Liste FarmGuardians

Liste FarmGuardians

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian list

GET /monitoring/fg

Liste FarmGuardians. Skabeloner og brugerdefinerede FarmGuardians vises på listen.

Svar eksempel:

{
   "description" : "List farm guardian checks and templates",
   "params" : [
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp-cut_conns",
         "template" : "true",
         "backend_alias" : "false"
      },
      {
         "command" : "check_tcp -p 80 -H HOST",
         "cut_conns" : "false",
         "description" : "TCP check to the port 80",
         "farms" : [
                     "web_service",
                     "my_welcome_web"
         ],
         "interval" : 7,
         "log" : "true",
         "name" : "custom-tcp",
         "template" : "false",
         "backend_alias" : "true"
      },
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp",
         "template" : "true",
         "backend_alias" : "false"
      }
   ]
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse
kommando String Kommando for at kontrollere servicestatus i backend. De tilgængelige kommandoer findes i libexec-stien.
cut_conns String De mulige værdier er: sand, FarmGuardian skærer de nuværende forbindelser, når backend er ikke tilgængelig; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
beskrivelse String Kort beskrivelse af checken.
gårde Streng [] Gårde hvor FarmGuardian anvendes.
interval nummer Tid mellem kontrol.
log String De mulige værdier er: sand, FarmGuardian logger hver check; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
navn String Unik identifikator.
skabelon String Hvis FarmGuardian er en skabelon, anvendes den ikke på nogen gård. Skabelonerne er nyttige til at oprette en ny FarmGuardian.
backend_alias (fra 4.0.1) String Hvis denne parameter har værdien falsk, backend-værten er backend-IP. Backendets alias bruges som vært, hvis denne parameter har værdien sand, aliaset skal defineres, og belastningsbalanceren skal være i stand til at løse det.

Hent en FarmGuardian

Hent en FarmGuardian

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
zcli farmguardian get check_tcp

GET /monitoring/fg/<name>

Vis konfigurationen af ​​en FarmGuardian.

URI-parameteren navn er FarmGuardian unikke identifikator.

Svar eksempel:

{
   "description" : "Retrive the farm guardian check_tcp",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 10,
      "log" : "false",
      "name" : "check_tcp",
      "template" : "true",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse
kommando String Kommando for at kontrollere servicestatus i backend. De tilgængelige kommandoer findes i libexec-stien.
cut_conns String De mulige værdier er: sand, FarmGuardian skærer de nuværende forbindelser, når backend er ikke tilgængelig; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
beskrivelse String Kort beskrivelse af checken.
gårde Streng [] Gårde hvor FarmGuardian anvendes.
interval nummer Tid mellem kontroller. Dette er tiden fra den sidste backend på listen testes, til den første backend testes igen.
log String De mulige værdier er: sand, FarmGuardian logger hver check; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
navn String Unik identifikator.
skabelon String Hvis FarmGuardian er en skabelon, ændres den ikke. Skabelonerne er nyttige til at oprette en ny FarmGuardian eller anvende direkte på gårde.
backend_alias (fra 4.0.1) String Hvis denne parameter har værdien falsk, backend-værten er backend-IP. Backendets alias bruges som vært, hvis denne parameter har værdien sand, aliaset skal defineres, og belastningsbalanceren skal være i stand til at løse det.
tiden er gået (fra 4.0.2) nummer Timeout for hver backend. Efter dette tidspunkt under backend-testen vil det blive betragtet som nede. Som standard er timeout lig med interval.

Opret en FarmGuardian

Opret en FarmGuardian

Forespørgselseksempel:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "copy_from":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian create -name check_tcp-cut_conns -copy_from check_tcp

POST /monitoring/fg

Opret en ny FarmGuardian.

Anmod om parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse påkrævet
navn String Unik identifikator. sand
copy_from String FarmGuardian er brugt som en skabelon for at skabe den nye FarmGuardian. Hvis dette felt ikke er sendt, oprettes den nye FarmGuardian uden konfiguration.

Svar eksempel:

{
   "description" : "Create a farm guardian check_tcp-cut_conns",
   "message" : "The farm guardian check_tcp-cut_conns has been created successfully",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 5,
      "log" : "false",
      "name" : "check_tcp-cut_conns",
      "template" : "true",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse
kommando String Kommando for at kontrollere servicestatus i backend. De tilgængelige kommandoer findes i libexec-stien.
cut_conns String De mulige værdier er: sand, FarmGuardian skærer de nuværende forbindelser, når backend er ikke tilgængelig; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
beskrivelse String Kort beskrivelse af checken.
gårde Streng [] Gårde hvor FarmGuardian anvendes.
interval nummer Tid mellem kontroller. Dette er tiden fra den sidste backend på listen testes, til den første backend testes igen.
log String De mulige værdier er: sand, FarmGuardian logger hver check; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
navn String Unik identifikator.
skabelon String Hvis FarmGuardian er en skabelon, ændres den ikke. Skabelonerne er nyttige til at oprette en ny FarmGuardian eller anvende direkte på gårde.
backend_alias (fra 4.0.1) String Hvis denne parameter har værdien falsk, backend-værten er backend-IP. Backendets alias bruges som vært, hvis denne parameter har værdien sand, aliaset skal defineres, og belastningsbalanceren skal være i stand til at løse det.
tiden er gået (fra 4.0.2) nummer Timeout for hver backend. Efter dette tidspunkt under backend-testen vil det blive betragtet som nede. Som standard er timeout lig med interval.

Ændre en FarmGuardian

Ændre en FarmGuardian

Forespørgselseksempel:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian set custom-tcp -interval 7 -log true -description 'TCP check to the port 80' -command 'check_tcp -p 80 -H HOST' -cut_conns false

PUT /monitoring/fg/<name>

Ændre en FarmGuardian.

URI-parameteren navn er FarmGuardian unikke identifikator.

Anmod om parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse påkrævet
kommando String Kommando for at kontrollere servicestatus i backend. De tilgængelige kommandoer findes i libexec-stien.
cut_conns String De mulige værdier er: sand, FarmGuardian skærer de nuværende forbindelser, når backend er ikke tilgængelig; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
beskrivelse String Kort beskrivelse af checken.
interval nummer Tid mellem kontroller. Dette er tiden fra den sidste backend på listen testes, til den første backend testes igen.
log String De mulige værdier er: sand, FarmGuardian logger hver check; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
styrke String Hvis en kørende gård bruger FarmGuardian, kan FarmGuardian ikke ændres. Derefter, hvis denne parameter sendes med værdien sand, vil FarmGuardian blive tvunget til at tage den nye konfiguration.
backend_alias (fra 4.0.1) String Hvis denne parameter har værdien falsk, backend-værten er backend-IP. Backendets alias bruges som vært, hvis denne parameter har værdien sand, aliaset skal defineres, og belastningsbalanceren skal være i stand til at løse det.
tiden er gået (fra 4.0.2) nummer Timeout for hver backend. Efter dette tidspunkt under backend-testen vil det blive betragtet som nede. Som standard er timeout lig med interval.

Svar eksempel:

{
   "description" : "Modify farm guardian custom-tcp",
   "message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
   "params" : {
      "command" : "check_tcp -p 80 -H HOST",
      "cut_conns" : "false",
      "description" : "TCP check to the port 80",
      "farms" : [],
      "interval" : 7,
      "log" : "true",
      "name" : "custom-tcp",
      "template" : "false",
      "backend_alias" : "false",
      "timeout" : 7
   }
}

Response parametre

Svaret vil være et JSON objekt med nøglen params og formatet nedenfor:

Field Type Beskrivelse
kommando String Kommando for at kontrollere servicestatus i backend. De tilgængelige kommandoer findes i libexec-stien.
cut_conns String De mulige værdier er: sand, FarmGuardian skærer de nuværende forbindelser, når backend er ikke tilgængelig; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
beskrivelse String Kort beskrivelse af checken.
gårde Streng [] Gårde hvor FarmGuardian anvendes.
interval nummer Tid mellem kontroller. Dette er tiden fra den sidste backend på listen testes, til den første backend testes igen.
log String De mulige værdier er: sand, FarmGuardian logger hver check; eller falsk, hvis backend den ikke er tilgængelig, vil den blive deaktiveret, men de levende sessioner fortsætter.
navn String Unik identifikator.
skabelon String Hvis FarmGuardian er en skabelon, anvendes den ikke på nogen gård. Skabelonerne er nyttige til at oprette en ny FarmGuardian.
backend_alias (fra 4.0.1) String Hvis denne parameter har værdien falsk, backend-værten er backend-IP. Backendets alias bruges som vært, hvis denne parameter har værdien sand, aliaset skal defineres, og belastningsbalanceren skal være i stand til at løse det.
tiden er gået (fra 4.0.2) nummer Timeout for hver backend. Efter dette tidspunkt under backend-testen vil det blive betragtet som nede. Som standard er timeout lig med interval.

Slet en FarmGuardian

Slet en FarmGuardian

Forespørgselseksempel:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian delete custom-tcp

DELETE /monitoring/fg/<name>

Slet en FarmGuardian.

URI-parameteren navn er FarmGuardian unikke identifikator.

Svar eksempel:

{
   "description" : "Delete the farm guardian custom-tcp",
   "message" : "custom-tcp has been deleted successful.",
   "success" : "true"
}

Overvågning - Statistik

Vis oplysninger om systemet 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/v4.0/zapi.cgi/stats
zcli statistics-system get

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'en bruger ikke noget program.
iowait nummer CPU bruges ved input eller output proces.
IRQ nummer CPU brugt af hardwareafbrydelser.
rart nummer CPU planlægning prioritet.
softirq nummer CPU brugt af softwareafbrydelser.
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 systemprocent sidste minut.
Last_5 nummer Indlæs systemprocent for fem minutter siden.
Last_15 nummer Indlæs system procent 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 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/v4.0/zapi.cgi/stats/system/network
zcli statistic-network get

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 outputtrafik 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/v4.0/zapi.cgi/stats/system/network/interfaces
zcli statistics-network get

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 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 en 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 en 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/v4.0/zapi.cgi/stats/system/memory
zcli statistics-system get -filter 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 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/v4.0/zapi.cgi/stats/system/load
zcli statistics-system get -filter 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 systembrug i de sidste fem minutter.
Last_15 nummer Indlæs systemanvendelsen de sidste femten 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/v4.0/zapi.cgi/stats/system/cpu
zcli statistics-system get -filter 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'en bruger ikke noget program.
iowait nummer CPU bruges ved input eller output proces.
IRQ nummer CPU brugt af hardwareafbrydelser.
rart nummer CPU planlægning prioritet.
softirq nummer CPU brugt af softwareafbrydelser.
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/v4.0/zapi.cgi/stats/system/connections
zcli statistics-network-connections get

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.

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/v4.0/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/v4.0/zapi.cgi/stats/farms
statistics-farm list

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 det samlede 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 tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip String IP af gården, hvor den virtuelle tjeneste lytter.
VPort String Havnen på gården, hvor den virtuelle tjeneste lytter.

Vis landbrugsstatistik

Vis landbrugsstatistik

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/farmname
zcli statistic-farm list

GET /stats/farms/<farmname>

Viser den nuværende gårdsstatus, deres backend status og forbindelser. Hver gård vil reagere med et andet objekt, 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"
         "backend_ip" : "192.168.0.168"
         "backend_port" : 80
         "service" : "srv1",
         "session" : "192.168.0.186",
         "ttl" : "1m28s0ms"
      }
   ],
   "total_sessions" : 1
}

Response parametre i HTTP gårde

Field Type Beskrivelse
backends Objekt[] Vis oplysninger om backends.
sessioner Objekt[] Vis oplysninger om sessioner.
samlede_sessioner nummer Fra version 4.0.2. Viser det samlede antal registrerede sessioner.

Backend Object

Field Type Beskrivelse
etableret nummer Det samlede 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 en unik identifikator.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; vedligeholdelse, backend er markeret som ikke klar til modtagelse af forbindelser af administratoren, denne mulighed er nyttig til backends vedligeholdelsesopgaver; undefined, statusen for backend er ikke markeret.

Session Object

Field Type Beskrivelse
kunde String Client unikke identifikator.
id String Backend unik identifikator tildelt til klienten.
tjeneste String Service unik identifikator tildelt til klienten.
Session String Session unik identifikator. Denne værdi afhænger af persistens typen.
ttl String Fra version 4.0.2. Tid tilbage, indtil sessionen slutter
backend_ip String Fra version 4.0.2. Backend Ip tildelt til klienten.
backend_port String Fra version 4.0.2. Backend-port tildelt til klienten.

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 en unik identifikator.
status String Backend status. De mulige værdier er: up, gården løber og bagenden er klar til at modtage forbindelser; ned, gården kører og tjenesten har opdaget, at backend ikke virker; undefined, statusen for backend er ikke markeret.

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" : "down"
      },
      {
         "established" : 1,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
     "client": 0,
         "id" : 5,
         "backend_ip" : "192.168.5.100",
         "backend_port" : "8080",
         "session" : "192.168.5.100",
         "ttl" : "1m51s564ms",
         "type" : "dynamic"
      }
   ],
   "total_sessions" : 1

}

Response parametre i L4xNAT gårde

Svaret vil være et JSON med objekt backends sessioner:

Backend objekt:

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

Session objekt:

Field Type Beskrivelse
kunde nummer Session sekventiel identifikator.
id nummer Backend unik identifikator, hvor klienten er tildelt.
Session String Session unik identifikator. Det er klientens IP.
typen String Værdier er: statiske eller dynamiske. Statisk hvis sessionen blev lavet manuelt og dynamisk hvis sessionen blev lavet automatisk.
ttl String Fra version 4.0.2. Tid tilbage, indtil sessionen slutter
backend_ip String Fra version 4.0.2. Backend ip tildelt til klienten.
backend_port nummer Fra version 4.0.2. Backend-port tildelt til klienten.

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/v4.0/zapi.cgi/stats/farms/modules

GET /stats/farms/modules

Få et resumé af statistiske moduler. Dette opkald viser hvert modul status, antallet af konfigurerede, antallet af gårde ned og ned.

Definitionen af ​​moduler er i Gårde sektion.

Svar eksempel:

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

Response parametre

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

Field Type Beskrivelse
kritisk nummer Antal gårde i kritisk status. Gården er kritisk, når den er op, og alle bagenden er uopnåelige (ned eller vedligeholdelse).
ned nummer Antal stoppede gårde. Gården stoppes af systemadministratoren.
problem nummer Antal gårde i problemstatus. Gården er et problem, når det er op og næsten en backend er i ned status.
alt nummer Antal samlede gårde.
up nummer Antal løbende gårde. Her vises vedligeholdelse og skal genstarte gårdsstatus.

Vis modulstatistik

Vis modulstatistik

Forespørgselseksempel:

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

GET /stats/farms/modules/<module>

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 Det samlede antal nuværende etablerede forbindelser.
farmname String Farmens navn, en unik 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 tilgængelige statusværdier er: nedgården går ikke; nødvendige genstart, gården er op, men den afventer en genstart kritisk, gården er op og alle backends er uopnåelige eller vedligeholdelse; problem, gården er op, og der er noget backend unreachable, men næsten en backend er i up status; vedligeholdelse, gården er op, og der er backends in up status, men næsten en backend er i vedligeholdelsestilstand; up, gården er op og alle backends arbejder succes.
vip String IP af gården, hvor den virtuelle tjeneste lytter.
VPort String Havnen på gården, hvor den virtuelle tjeneste lytter.

Overvågning - Grafer

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

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

Grafer med oplysninger besvares i basis64 format.

Liste ledige grafer

Liste ledige grafer

Forespørgselseksempel:

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

Field Type Beskrivelse
gårde Snor[] Liste over landbrugsgrafer tilgængelige.
grænseflader Snor[] Liste over interfacegrafer tilgængelige.
systemet Objekt[] Liste over systemgrafer tilgængelige. Arrayet har et objekt med en matrix, der angiver diskmonteringspunkter.

System objekt:

Systemobjektet indeholder en matrixliste relateret til systemet og en 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/v4.0/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/v4.0/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/v4.0/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 Periode, der bruges til at generere grafen. De mulige værdier er: dagligt, ugentlig, månedligt or årligt.
grafer String Graf i base64 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/v4.0/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/v4.0/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/v4.0/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 Periode, der bruges 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 base64 format.

IPDS

Dette modul er implementeringen af ​​en 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 et objekt af forskellige natur. Hver enkelt tilbyder en løsning for ekstern ondsindet eller mistænkelig aktivitet. 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, DoS, RBL or WAF.

Hent IPDS-pakke

Hent IPDS-pakke

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package
zcli ipds-package get

GET /ipds/package

Hent zevenet-ipds pakkeoplysninger. Denne pakke indeholder opdaterede regler for hvert IPDS-modul.

Svar eksempel:

{
   "description" : "zevenet-ipds package status info",
   "params" : {
      "frequency" : 0,
      "mode" : "disabled",
      "ruleset_date" : "05-06-2019",
      "scheduled" : "none",
      "status" : "Updates available",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

Response parametre

Svaret bliver et JSON objekt med en nøgle indstillet til params, dens værdi vil være informationen i IPDS-pakken.

Field Type Beskrivelse
status String Viser opdateringsstatusoplysninger om IPDS-pakken. Hvis pakken er installeret, hvis den er opdateret, og hvis der foreligger opdateringer.
ruleset_date String Det er den dato, hvor pakken blev bygget. Det er ikke den installerede dato.
planlagt String Beskrivende besked forklarer tidsplanskonfigurationen.
tilstand String Det angiver, hvor ofte opdateringen vil ske eller for at deaktivere tidsplanen. De tilgængelige værdier er: Daglige Planlæg opdateringen skal udføres hver dag, det gør det muligt for feltet Frekvens at angive, hvor mange timer opdateringen skal gentages fra den angivne tid; UgentligPlanlæg opdateringen, der skal udføres en gang om ugen, gør det muligt for frekvens som ugedag for at angive hvilken dag i ugen opdateringen skal planlægges (fra mandag til søndag); månedligt, planlæg opdateringen skal udføres en gang om måneden.
frekvens nummer If tilstand er dagligt, frekvens er antallet af timer mellem pakkeopdatering fra tid; Hvis tilstand er ugentlig, den forventede værdi er nummeret hverdage (fra mandag, 1, til søndag, 7); Hvis tilstand er månedlig, den forventede værdi er nummer månedsdagen (fra 1 til 31).
tid Object Giver mulighed for at indstille, hvornår opdateringen opstår, eller fra hvilket tidspunkt vil pakken blive opdateret, hvis tilstanden er indstillet som Daglig og Frekvens er større end 0.

Tid objekt:

Dette objekt, time: minut, er den time, hvor pakken vil blive opdateret.

Field Type Beskrivelse
time nummer Er timen i formatformularen 0 til 23.
minut nummer er protokollen i formatformularen 0 til 59.

Anvend en handling til IPDS-pakken

Anvend en handling til IPDS-pakken

Anmod om eksempel for opdatering af IPDS-reglerne:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"action":"upgrade"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions
zcli ipds-package upgrade

Svar eksempel:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "ruleset_date" : "07-06-2019",
      "status" : "Installed and updated"
   }
}

Anmod om eksempel for planlægning af opdateringer:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"mode":"daily","frequency":1,"time":{"hour":0,"minute":0},"action":"schedule"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions

Svar eksempel:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "frequency" : 1,
      "mode" : "daily",
      "scheduled" : "daily from 0:00 to 23:00 each 1 hours",
      "status" : "Installed and updated",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

POST /ipds/package

Anvend handling omkring zevenet-ipds-pakken.

Anmod om parametre

Field Type Beskrivelse påkrævet
Action String Det er den handling, der skal gælde for IPDS-reglerne. Indstillingerne er: opgradering at tvinge en opgradering af pakken. planlægge at konfigurere systemet opgraderer pakken med en periodicitet.
tilstand String Det angiver, hvor ofte opdateringen vil ske eller for at deaktivere tidsplanen. De tilgængelige værdier er: Daglige Planlæg opdateringen skal udføres hver dag, det gør det muligt for feltet Frekvens at angive, hvor mange timer opdateringen skal gentages fra den angivne tid; UgentligPlanlæg opdateringen, der skal udføres en gang om ugen, gør det muligt for frekvens som ugedag for at angive hvilken dag i ugen opdateringen skal planlægges (fra mandag til søndag); månedligt, planlæg opdateringen skal udføres en gang om måneden.
frekvens nummer If tilstand er dagligt, hyppigheden er antallet af timer mellem pakkeopdateringsformularen tid; Hvis tilstand er ugentlig, den forventede værdi er nummeret hverdage (fra mandag, 1, til søndag, 7); Hvis tilstand er månedlig, den forventede værdi er nummer månedsdagen (fra 1 til 31).
tid Object Giver mulighed for at indstille, hvornår opdateringen opstår, eller fra hvilket tidspunkt vil pakken blive opdateret, hvis tilstanden er indstillet som Daglig og Frekvens er større end 0.

Tid objekt:

Dette objekt, time: minut, er den time, hvor pakken vil blive opdateret.

Field Type Beskrivelse
time nummer Er timen i formatformularen 0 til 23.
minut nummer er protokollen i formatformularen 0 til 59.

Response parametre

Svaret bliver et JSON objekt med en nøgle indstillet til params. Værdien af ​​dette vil være informationen om IPDS-pakken.

Field Type Beskrivelse
status String Viser opdateringsstatusoplysninger om IPDS-pakken. Hvis pakken er installeret, hvis den er opdateret, og hvis der foreligger opdateringer.
ruleset_date String Det er den dato, hvor pakken blev bygget. Det er ikke den installerede dato.
planlagt String Beskrivende besked forklarer tidsplanskonfigurationen.
tilstand String Det angiver, hvor ofte opdateringen vil ske eller for at deaktivere tidsplanen. De tilgængelige værdier er: Daglige Planlæg opdateringen skal udføres hver dag, det gør det muligt for feltet Frekvens at angive, hvor mange timer opdateringen skal gentages fra den angivne tid; UgentligPlanlæg opdateringen, der skal udføres en gang om ugen, gør det muligt for frekvens som ugedag for at angive hvilken dag i ugen opdateringen skal planlægges (fra mandag til søndag); månedligt, planlæg opdateringen skal udføres en gang om måneden.
frekvens nummer If tilstand er dagligt, frekvens er antallet af timer mellem pakkeopdatering fra tid; Hvis tilstand er ugentlig, den forventede værdi er nummeret hverdage (fra mandag, 1, til søndag, 7); Hvis tilstand er månedlig, den forventede værdi er nummer månedsdagen (fra 1 til 31).
tid Object Giver mulighed for at indstille, hvornår opdateringen opstår, eller fra hvilket tidspunkt vil pakken blive opdateret, hvis tilstanden er indstillet som Daglig og Frekvens er større end 0.

Tid objekt:

Dette objekt, time: minut, er den time, hvor pakken vil blive opdateret.

Field Type Beskrivelse
time nummer Er timen i formatformularen 0 til 23.
minut nummer er protokollen i formatformularen 0 til 59.

Liste over alle IPDS regler

Liste ipds regler

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds
zcli ipds list

GET /ipds

Angiv alle IPDS-regler, der findes i systemet.

Svar eksempel:

{
   "description" : "List the available IPDS rules.",
   "params" : [
      {
         "name" : "dosrst",
         "rule" : "dos",
         "type" : "farm"
      },
      {
         "name" : "ssh_brute_force",
         "rule" : "dos",
         "type" : "system"
      },
      {
         "name" : "geo_IL_israel",
         "rule" : "blacklist"
      },
      {
         "name" : "geo_ME_montenegro",
         "rule" : "blacklist"
      },
      {
         "name" : "sip",
         "rule" : "rbl"
      },
      {
         "name" : "ssh",
         "rule" : "rbl"
      }
   ]
}

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, som hver indeholder nøgleattributterne nedenfor.

Field Type Beskrivelse
navn String IPDS-reglenavn. Den bruges som en unik identifikator.
regere String Det er naturen af ​​IPDS-reglen. Det kan være sortliste, dos or RBL.
typen String Dette felt vises i dos regler, og det definerer, om reglen er systemet, det gælder for balance eller gård, gælder reglerne for en gård.

IPDS - Blacklists

Sortlister lader brugerne bruge lister til at filtrere eller tillade trafik i henhold til kilde-IP'er (indgående trafik).

Der er to typer lister:

  1. Fjernbetjeninger: Lister er hentet fra en webadresse, disse lister kan ikke ændres og kan planlægges at blive downloadet.
  2. Lokal: Brugere kan oprette deres lister med en given politik, benægte Hvis den indkommende IP matcher, afvises trafikken eller tillade Hvis den indkommende IP matcher, 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 personlige lister.

Flere lister kan søges på samme gård, hvis kilden IP matcher i nogle af listerne, hvor trafikken vil blive tilladt eller afvist afhængigt af blacklist-politikken. I øjeblikket IP-kampe bliver der ikke gjort flere blacklist-checks til kilde IP.

Hvis en kilde IP er i to forskellige lister, en af ​​typen benægte og den anden af ​​typen tillade, så vurderes først tilladelsespolitikken først.

Liste over alle blacklists regler

Liste over alle sortlister

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
zcli ipds-blacklist list

GET /ipds/blacklists

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",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "russia",
         "policy" : "deny",
         "preload" : "true",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [],
         "name" : "northkorea",
         "policy" : "deny",
         "preload" : "true",
         "status" : "down",
         "type" : "local"
      },
      {
         "farms" : [
             "FarmHttp1",
            "FarmGslb1",
         ],
         "name" : "remoteList",
         "policy" : "deny",
         "preload" : "false",
         "status" : "up",
         "type" : "remote"
      },
      {
         "farms" : [],
         "name" : "myWhiteList",
         "policy" : "allow",
         "preload" : "false",
         "status" : "down",
         "type" : "local"
      },
   ]
}

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, som hver indeholder nøgleattributterne nedenfor.

Field Type Beskrivelse
gårde Snor[] Farms liste hvor blacklisten er anvendt.
navn String Sortlistenavn. Den bruges som en 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 systemadministratoren.
status String De mulige værdier er: up, sortlisten aktiveres og blokering (eller tillader) kildekilden udgør listen; eller nedfaktisk går reglen ikke i gang, og den filtrerer ikke trafik.
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 hentes fra fjernkilden 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/loc
zcli ipds-blacklist get 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"
         }
      ],
      "status" : "up",
      "type" : "local"
   }
}

Lokalt sortlisteobjekt:

Field Type Beskrivelse
gårde Snor[] Farms liste hvor blacklisten er anvendt.
navn String Sortlistenavn. Den bruges som en 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.
status String De mulige værdier er: up, sortlisten aktiveres og blokering (eller tillader) kildekilden udgør listen; eller nedfaktisk går reglen ikke i gang, og den filtrerer ikke trafik.
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 webadresse.
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
      },
      "status" : "up",
      "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 blacklisten er anvendt.
navn String Sortlistenavn. Den bruges som en 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[] Kilde 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 / bitmask 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 frekvens Værdien er ugentlig or månedligt. hvis frekvens is ugentlig denne parameter skal være en ugedag (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 31).
tid Object Det er en struktur, der afhænger af felterne frekvens.
status String De mulige værdier er: up, sortlisten aktiveres og blokering (eller tillader) kildekilden udgør listen; eller nedfaktisk går reglen ikke i gang, og den filtrerer ikke trafik.

Tid objekt for den daglige frekvens og periode frequency_type

Field Type Beskrivelse
periode nummer Hvor ofte opdateres listen.
enheder String Periodeenhed. Indstillingerne er: minutter, angiv listen vil blive opdateret hvert konfigureret minut eller timer, listen opdateres hver konfigureret 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 23.
minutter nummer Minutter for at opdatere listen. Værdien skal være et tal mellem 0 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists
ipds-blacklist create -name newListLoc -type local -policy allow

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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists

POST /ipds/blacklists

Opret en sortliste, der skal bruges i 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 en 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 administratorens service 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 de næste nøgleattributter.

Field Type Beskrivelse
gårde Snor[] Farms liste hvor blacklisten er anvendt.
navn String Sortlistenavn. Den bruges som en 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 systemadministratoren.
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 administratorens service 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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/whiteList
zcli ipds-blacklist set whiteList -policy allow 

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 en unik identifikator. Kun det kan ændres 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 kun at ændre en kilde, se venligst dokumentationsafsnittet IPDS> Sortlister> Rediger en kilde til en sortliste. Kun kilder kan ændres på nr preload lister.

Svar eksempel:

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

Response parametre

Svaret bliver et JSON med alle opdaterede værdier opdateret. Se svareksemplet 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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/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://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/newListRem

Anmod parameter for en fjernliste

Field Type Beskrivelse
gårde Snor[] Farms liste hvor blacklisten er anvendt.
navn String Sortlistenavn. Den bruges som en 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 hverdag (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 31).
tid Object Det er en struktur, der afhænger af felterne frekvens.

Tidsperiode objekt

Dette er felterne, når en periode 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 præcis timetid vil blive konfigureret.

Dette objekt bruges sammen med de følgende konfigurationer:

frekvens feltet har værdien dagligt frequency_type is eksakt.

frekvens feltet har værdien ugentlig dag er hverdage, når listen opdateres.

frekvens feltet har værdien månedligt 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 23.
minutter nummer Minutter for at opdatere listen. Værdien skal være et tal mellem 0 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 et JSON med alle listekonfigurationer. Se svareksemplet for mere information.

Slet en sortliste-regel

Slet en liste over sorte lister

Forespørgselseksempel:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/remoteList
zcli ipds-blacklist delete remoteList

DELETE /ipds/blacklists/<name>

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 over kilder til en sortliste

Liste kilde fra en sortliste

Forespørgselseksempel:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/blacklists/localList/sources
zcli ipds-blacklist get localList

GET /ipds/blacklists/<name>/sources

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