Juhtimisviisid RELIANOID API Windowsilt #

Kaughaldus ja automatiseerimine a RELIANOID Load Balancerit saab tõhusalt kasutada noid-cli, Perli-põhine käsurea liidese programm. noid-cli on loodud API-kõnede tegemiseks otse käsurealt, lihtsustades selliseid toiminguid nagu virtuaalserverite konfigureerimine, süsteemi oleku jälgimine ja koormuse tasakaalustamise sätete kohandamine. See tööriist pakub komplekti eelmääratletud käske, mis abstraheerivad API interaktsioonide keerukust, võimaldades administraatoritel kiiresti toiminguid teha, ilma et oleks vaja HTTP-päringuid käsitsi koostada. Selle kasutuslihtsus ja integreerimine shelliskriptimisega muudavad selle praktiliseks valikuks tavapäraseks hoolduseks ja kiireks kohandamiseks terminalikeskkonnas.

Teisest küljest programmeerimine a PowerShelli skript koos Käivita-RestMethod API-kõnede haldamiseks RELIANOID Load Balancer pakub rohkem paindlikkust ja automatiseerimispotentsiaali. PowerShelli skriptid võivad automatiseerida keerulisi API interaktsioonide jadasid, käsitleda dünaamilisi andmeid ja integreerida teiste Windowsi-põhiste teenuste ja tööriistadega. Kasutades Käivita-RestMethod, saavad administraatorid koostada kohandatud automatiseerimisskripte, mis vastavad täpselt nende töövajadustele, näiteks tõrkesiirdeprotseduuride korraldamine, hulgivärskenduste tegemine või koormuse tasakaalustaja halduse integreerimine laiematesse süsteemihaldustöövoogudesse. See meetod kasutab PowerShelli skriptimisvõimaluste kogu võimsust, sealhulgas vigade käsitlemist, logimist ja täpsemat andmete manipuleerimist, muutes selle ideaalseks keerukate automatiseerimisülesannete ja integratsioonistsenaariumide jaoks.

Selles artiklis kirjeldatakse API-kutseid Powershelli meetodil.

Powershelli kasutamine API-kõnede tegemiseks #

Süsteemide automatiseerimiseks PowerShelli abil API-le kutse tegemine hõlmab Invoke-RestMethod cmdleti kasutamist, mis lihtsustab HTTP- ja HTTPS-päringute saatmist RESTful veebiteenustele. See cmdlet võimaldab API-dega suhtlemist, määrates lõpp-punkti URL-i, HTTP-meetodi (GET, POST, PUT, DELETE), päised (nt autoriseerimismärgid) ja päringu sisu (tavaliselt JSON-vormingus). Nii saate sihtsüsteemis ressursse hankida, luua, värskendada või kustutada. PowerShelli skriptid saavad automatiseerida korduvaid ülesandeid, näiteks virtuaalsete masinate haldamist, võrguseadmete konfigureerimist või süsteemi olekute hankimist, suurendades tegevuse efektiivsust ja järjepidevust.

Alustuseks määratlete tavaliselt API lõpp-punkti ja kõik vajalikud volikirjad. Näiteks võite päistes kasutada elementaarset autentimist või API-võtit. Seejärel peate olenevalt API toimingust ette valmistama JSON-i kasuliku koormuse POST- või PUT-päringute jaoks, mida saab hõlpsalt luua ja teisendada PowerShelli objektidest cmdleti ConvertTo-Json abil . Kui päring on koostatud ja saadetud, töötleb Invoke-RestMethod vastust, mida saate skripti järgmistes ülesannetes edasi töödelda või kasutada. See sujuv protsess muudab PowerShelli võimsaks tööriistaks süsteemiadministraatoritele ja arendajatele, kes soovivad API-de kaudu automatiseerida ja integreerida erinevaid süsteeme ja teenuseid.

Eeltingimused API kaugautomaatika lubamiseks #

API-kõnede tegemiseks PowerShellist hallata RELIANOID Load Balancer, peavad olema täidetud mitmed eeltingimused:

API lubade lubamine ja API võtme loomine #

Esiteks peate lubama API õigused kasutajakontole, mis kõnesid teeb. See hõlmab koormuse tasakaalustaja veebiliidese avamist ja menüüpunkti Süsteem > Kasutaja navigeerimist . Selles jaotises saate konfigureerida kasutajakontosid ja määrata API õigusi. Looge või valige kasutajakonto ja genereerige API-võti, mida kasutatakse API-kõnede autentimiseks. Kui kasutate rollipõhise juurdepääsu juhtimise (RBAC) kasutajaid, veenduge, et nende rollidel oleksid API-ga suhtlemiseks vajalikud õigused. See API-võti on oluline teie PowerShelli skriptide API-päringute autentimiseks ja autoriseerimiseks.

Lisateabe saamiseks lugege palun seda artiklit https://www.relianoid.com/resources/knowledge-base/system-enterprise-edition-v8-administration-guide/system-user/.

API lõpp-punkti tuvastamine #

Teiseks peate koormuse tasakaalustajaga ühenduse loomiseks tuvastama õige API lõpp-punkti. API lõpp-punkt sisaldab tavaliselt teie koormuse tasakaalustaja baas-URL-i, millele järgneb erinevate funktsioonide konkreetsed teed. Koorma tasakaalustaja rühmituse seadistuse korral on ülioluline kasutada API lõpp-punkti jaoks jagatud IP-aadressi. See jagatud IP-aadress tagab, et API-kõne suunatakse alati põhisõlmele, olenemata sellest, milline sõlm praegu ülemsõlmena töötab. Jagatud IP-aadressi kasutamine hoiab ära probleemid, kus API-kõne võidakse teha ooterežiimi sõlmele, tagades, et kõiki konfiguratsioone ja toiminguid rakendatakse järjepidevalt aktiivsele peasõlmele.

Powershelli API näited #

Powershelli vanemad versioonid ei tuvasta valikut SkipCertificateCheck . Sellisel juhul defineerige see valik oma Powershelli skripti alguses:

[System.Net.ServicePointManager]::ServerCertificateValidationCallback = { $true }

Lisaks on vaja PowerShelli skriptidesse lisada järgmine rida, et vältida viga „ Invoke-RestMethod: The underlying connection was closed: An understanding error occurred on a receive “.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12

Farmi üksikasjade hankimine #

See skript täidab GET-päringu konkreetse farmi kohta teabe hankimiseks RELIANOID Koormuse tasakaalustaja.

Eeldused

• asendama teie tegeliku API võtmega.
• asendama <RELIANOID_SERVER> teie tegeliku serveri aadressiga RELIANOID Koormuse tasakaalustaja.
• asendama tegeliku taluga.
• Veenduge, et teil on lubatud API-õigused.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Määratlege muutujad = "$apiKey " $server = "RELIANOID_SERVER>" $farmName = " " # Määrake API lõpp-punkti URL $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName" # Tehke API-kõne kasutades Invoke-RestMethod $response = Invoke -RestMethod -Uri $apiUrl -Meetod Hangi -Päised @{ "API_KEY" = $apiKey } -SkipCertificateCheck # Väljutab vastuse $response

Selgitus

1. Muutujad:

• $apiKey: teie API võti.
• $server: teie aadress RELIANOID Koormuse tasakaalustaja.
• $farmName: selle talu nimi, mille kohta soovite teavet hankida.

2. API lõpp-punkti URL:

• $apiUrl: ehitatud kasutades serveri aadressi ja farmi nime.

3. Invoke-RestMethod:

• -Uri $apiUrl: määrab API lõpp-punkti.
• - Hankimise meetod: määrab HTTP GET meetodi.
• - Päised @{ "API_KEY" = $apiKey }: lisab taotluse päistesse API võtme.
• -SkipCertificateCheck: jätab vahele SSL-sertifikaadi kontrollimise (võrdub -k-ga curl'is). See on kasulik testimisel või siis, kui server kasutab iseallkirjastatud sertifikaati.

4. Väljund:
API-kõne vastus salvestatakse $response muutuja ja väljastatakse seejärel konsooli.

Lisateavet selle kõne kohta leiate ametlikust Apidocist https://www.relianoid.com/apidoc/v4.0/#retrieve-farm-by-name

Farmis uue taustaprogrammi lisamine #

See skript täidab POST-päringu, et lisada Relianoidi koormuse tasakaalustajal farmis olevale konkreetsele teenusele uus taustsüsteem.

Eeldused

• asendama teie tegeliku API võtmega.
• asendama <RELIANOID_SERVER> teie tegeliku serveri aadressiga RELIANOID Koormuse tasakaalustaja.
• asendama tegeliku taluga.
• asendama HTTP-teenusega, kuhu taustaprogramm lisatakse.
• asendama uue taustaprogrammi IP-ga.
• asendama uue taustaprogrammi PORT-iga.
• Veenduge, et teil on lubatud API-õigused.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Määratlege muutujad = "$apiKey " $server = "RELIANOID_SERVER>" $farmName = " " $serviceName = " " # Määrake API lõpp-punkti URL $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName/services/$serviceName/backends" # Määratlege päringu sisu $ requestBody = @{ ip = " " port = kaal = 1 prioriteet = 1 } | ConvertTo-Json # Tehke API-kõne kasutades Invoke-RestMethod $response = Invoke-RestMethod -Uri $apiUrl -Meetod Postitus -Päised @{ "Content-Type" = "rakendus/json" "API_KEY" = $apiKey } -Keha $ requestBody -SkipCertificateCheck # Väljutab vastuse $response

Selgitus

1. Muutujad:

• $apiKey: teie API võti.
• $server: teie aadress RELIANOID Koormuse tasakaalustaja.
• $farmName: selle farmi nimi, kuhu soovite uue taustaprogrammi lisada.
• $serviceName: teenuse nimi farmis, kuhu taustaprogramm lisatakse.

2. API lõpp-punkti URL:

• $apiUrl: koostatud kasutades serveri aadressi, farmi nime ja teenuse nime.

3. Taotluse sisu:

• $requestBody: sisaldab JSON-i kasulikku koormust koos taustaserveri üksikasjadega. See teisendatakse JSON-vormingusse kasutades Teisenda Jsoniks.

4. Invoke-RestMethod:

• -Uri $apiUrl: määrab API lõpp-punkti.
• -Meetod Post: määrab HTTP POST-meetodi.
• - Päised @{ "Content-Type" = "application/json"; "API_KEY" = $apiKey }: lisab Sisu tüüp ja API_KEY päringu päistesse.
• -Keha $requestBody: määrab POST-päringu JSON-i kasuliku koormuse.
• -SkipCertificateCheck: jätab vahele SSL-sertifikaadi kontrollimise (võrdub -k-ga curl'is). See on kasulik testimisel või siis, kui server kasutab iseallkirjastatud sertifikaati.

5. Väljund:
API-kõne vastus salvestatakse $response muutuja ja väljastatakse seejärel konsooli.

Lisateavet selle kõne kohta leiate ametlikust Apidocist : https://www.relianoid.com/apidoc/v4.0/#create-a-new-backend

Taustaprogrammi lubamine hooldusrežiimis #

See skript täidab PUT-päringu, et seada taustaserver seadmes hooldusrežiimi RELIANOID Koormuse tasakaalustaja.

Eeldused

• asendama teie tegeliku API võtmega.
• asendama <RELIANOID_SERVER> teie tegeliku serveri aadressiga RELIANOID Koormuse tasakaalustaja.
• asendama tegeliku taluga.
• asendama HTTP-teenusega, kus taustaprogramm viiakse hooldusesse.
• asendama koos taustaprogrammi ID-ga hooldusrežiimi muutmiseks.
• Veenduge, et teil on lubatud API-õigused.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Määratlege muutujad = "$apiKey " $server = "RELIANOID_SERVER>" $farmName = " " $serviceName = " " $backendId = # Määratlege API lõpp-punkti URL $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName/services/$serviceName/backends/$backendId/maintenance" # Defineeri päringu keha $requestBody = @{ action = "maintainance" mode = "drain" } | ConvertTo-Json # Tehke API kõne kasutades Invoke-RestMethod $response = Invoke-RestMethod -Uri $apiUrl -Meetod Pane -Päised @{ "Content-Type" = "rakendus/json" "API_KEY" = $apiKey } -Keha $ requestBody -SkipCertificateCheck # Väljutab vastuse $response

Selgitus

1. Muutujad:

• $apiKey: teie API võti.
• $server: teie aadress RELIANOID Koormuse tasakaalustaja.
• $farmName: selle talu nimi, kuhu lisatakse hooldusesse lisatav taustaprogramm.
• $serviceName: teenuse nimi farmis, kus taustaprogrammi hooldatakse.
• $backendId: hooldusrežiimi lülitatava taustaprogrammi ID.

2. API lõpp-punkti URL:

• $apiUrl: koostatud kasutades serveri aadressi, farmi nime ja teenuse nime.

3. Taotluse sisu:

• $requestBody: sisaldab JSON-i kasulikku koormust koos toimingu ja režiimiga taustaprogrammi hooldusrežiimi seadmiseks. See teisendatakse JSON-vormingusse kasutades Teisenda Jsoniks.

4. Invoke-RestMethod:

• -Uri $apiUrl: määrab API lõpp-punkti.
• - Pane meetod: määrab HTTP PUT-meetodi.
• - Päised @{ "Content-Type" = "application/json"; "API_KEY" = $apiKey }: lisab Sisu tüüp ja API_KEY päringu päistesse.
• -Keha $requestBody: määrab PUT-päringu JSON-i kasuliku koormuse.
• -SkipCertificateCheck: jätab vahele SSL-sertifikaadi kontrollimise (võrdub -k-ga curl'is). See on kasulik testimisel või siis, kui server kasutab iseallkirjastatud sertifikaati.

5. Väljund:
API-kõne vastus salvestatakse $response muutuja ja väljastatakse seejärel konsooli.

Lisateavet selle kõne kohta leiate ametlikust Apidocist https://www.relianoid.com/apidoc/v4.0/#backend-in-maintenance

Täiendav API dokumentatsioon #

Üksikasjalikuma teabe saamiseks rakenduse haldamiseks saadaolevate API-kõnede kohta RELIANOID Load Balancer, saate vaadata ametlikku API dokumentatsiooni aadressil RELIANOID API dokumentatsioon. See põhjalik ressurss sisaldab iga API lõpp-punkti üksikasjalikku kirjeldust, sealhulgas nõutavad HTTP-meetodid, päringu parameetrid ja vastuse vormingud.

Dokumentatsioon on üles ehitatud nii, et see aitab teil mõista, kuidas suhelda koormuse tasakaalustaja erinevate aspektidega, nagu farmide, teenuste ja taustaprogrammide haldamine, samuti süsteemi oleku ja jõudluse jälgimine. Iga API-kõnega on kaasas näited ja selgitused, mis juhendavad teid taotluste koostamise ja vastuste käsitlemise protsessis. See on oluline ressurss süsteemiadministraatoritele ja arendajatele, kes soovivad API abil automatiseerida ja sujuvamaks muuta oma koormuse tasakaalustaja haldusülesandeid.