Memanggil RELIANOID API REST daripada Powershell

  • Blog
  • Memanggil RELIANOID API REST daripada Powershell

Pangkalan Pengetahuan

Pengalaman Kebolehpercayaan Tapak

Lihat Kategori

Memanggil RELIANOID API REST daripada Powershell

Baca min 10

Jadual Kandungan

Cara-cara mengurus RELIANOID API daripada Windows #

Mengurus dan mengautomasikan dari jauh a RELIANOID Pengimbang Beban boleh dilakukan dengan berkesan menggunakan noid-cli, program antara muka baris arahan berasaskan Perl. noid-cli direka untuk membuat panggilan API terus daripada baris arahan, memudahkan tugas seperti mengkonfigurasi pelayan maya, memantau status sistem dan melaraskan tetapan pengimbangan beban. Alat ini menyediakan satu set perintah yang dipratentukan yang mengabstraksikan kerumitan interaksi API, membolehkan pentadbir melaksanakan operasi dengan cepat tanpa perlu membina permintaan HTTP secara manual. Kemudahan penggunaan dan penyepaduan dengan skrip shell menjadikannya pilihan praktikal untuk penyelenggaraan rutin dan pelarasan pantas dalam persekitaran terminal.

Sebaliknya, pengaturcaraan a Skrip PowerShell bersama Invoke-RestMethod untuk menguruskan panggilan API ke RELIANOID Pengimbang Beban menawarkan lebih banyak fleksibiliti dan potensi automasi. Skrip PowerShell boleh mengautomasikan jujukan kompleks interaksi API, mengendalikan data dinamik dan menyepadukan dengan perkhidmatan dan alatan berasaskan Windows yang lain. Dengan menggunakan Invoke-RestMethod, pentadbir boleh mencipta skrip automasi tersuai yang memenuhi keperluan operasi mereka dengan tepat, seperti mengatur prosedur failover, melaksanakan kemas kini pukal atau menyepadukan pengurusan pengimbang beban ke dalam aliran kerja pengurusan sistem yang lebih luas. Kaedah ini memanfaatkan kuasa penuh keupayaan skrip PowerShell, termasuk pengendalian ralat, pengelogan dan manipulasi data lanjutan, menjadikannya ideal untuk tugasan automasi yang canggih dan senario penyepaduan.

Artikel ini akan menerangkan panggilan API menggunakan kaedah Powershell.

Menggunakan Powershell untuk membuat panggilan API #

Membuat panggilan ke API menggunakan PowerShell untuk mengautomasikan sistem melibatkan memanfaatkan Invoke-RestMethod cmdlet, yang memudahkan penghantaran permintaan HTTP dan HTTPS ke perkhidmatan web RESTful. Cmdlet ini membenarkan interaksi dengan API dengan menentukan URL titik akhir, kaedah HTTP (GET, POST, PUT, DELETE), pengepala (seperti token kebenaran) dan badan permintaan (biasanya dalam format JSON). Dengan berbuat demikian, anda boleh mendapatkan semula, mencipta, mengemas kini atau memadam sumber pada sistem sasaran. Skrip PowerShell boleh mengautomasikan tugasan berulang, seperti mengurus mesin maya, mengkonfigurasi peranti rangkaian atau mengambil status sistem, meningkatkan kecekapan dan ketekalan operasi.

Untuk bermula, anda biasanya akan menentukan titik akhir API dan sebarang bukti kelayakan yang diperlukan. Sebagai contoh, anda mungkin menggunakan pengesahan asas atau kunci API dalam pengepala. Seterusnya, bergantung pada operasi API, anda mungkin perlu menyediakan muatan JSON untuk permintaan POST atau PUT, yang boleh dibuat dan ditukar dengan mudah daripada objek PowerShell menggunakan ConvertTo-Json cmdlet. Setelah permintaan dibuat dan dihantar, Invoke-RestMethod memproses respons, yang boleh anda manipulasi atau gunakan selanjutnya dalam tugasan seterusnya dalam skrip anda. Proses yang diperkemas ini menjadikan PowerShell sebagai alat yang berkuasa untuk pentadbir sistem dan pembangun yang bertujuan untuk mengautomasikan dan menyepadukan pelbagai sistem dan perkhidmatan melalui API.

Prasyarat untuk mendayakan automasi API jauh #

Untuk membuat panggilan API daripada PowerShell untuk mengurus RELIANOID Pengimbang Beban, beberapa prasyarat mesti dipenuhi:

Mendayakan Kebenaran API dan Mencipta Kunci API #

Pertama, anda perlu mendayakan kebenaran API untuk akaun pengguna yang akan membuat panggilan. Ini melibatkan mengakses GUI web pengimbang beban dan menavigasi ke Sistem> Pengguna. Dalam bahagian ini, anda boleh mengkonfigurasi akaun pengguna dan menetapkan kebenaran API. Buat atau pilih akaun pengguna dan jana Kunci API, yang akan digunakan untuk mengesahkan panggilan API. Jika anda menggunakan pengguna Kawalan Akses Berasaskan Peranan (RBAC), pastikan peranan mereka termasuk kebenaran yang diperlukan untuk berinteraksi dengan API. Kunci API ini penting untuk mengesahkan dan membenarkan permintaan API daripada skrip PowerShell anda.

Untuk maklumat lanjut, sila rujuk artikel ini https://www.relianoid.com/resources/knowledge-base/system-enterprise-edition-v8-administration-guide/system-user/ .

Mengenal pasti Titik Akhir API #

Kedua, anda perlu mengenal pasti titik akhir API yang betul untuk menyambung ke pengimbang beban. Titik akhir API biasanya termasuk URL asas pengimbang beban anda diikuti dengan laluan khusus untuk fungsi yang berbeza. Dalam kes persediaan pengimbang beban berkelompok, adalah penting untuk menggunakan alamat IP kongsi untuk titik akhir API. Alamat IP kongsi ini memastikan bahawa panggilan API sentiasa ditujukan kepada nod induk, tanpa mengira nod yang sedang bertindak sebagai induk. Menggunakan IP kongsi menghalang isu di mana panggilan API mungkin dibuat ke nod siap sedia, memastikan semua konfigurasi dan operasi digunakan secara konsisten pada nod induk yang aktif.

Contoh API Powershell #

pilihan SkipCertificateCheck tidak dapat dikenali dalam versi Powershell yang lebih lama. Jika ini adalah kes anda, sila tentukan pilihan ini pada permulaan skrip Powershell anda: 

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

Di samping itu, ia akan diperlukan untuk menambah baris berikut dalam skrip Powershell kami untuk mengelakkan ralat "Invoke-RestMethod : Sambungan asas telah ditutup: Ralat yang tidak dijangka berlaku pada penerimaan".

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

Mendapatkan butiran Ladang #

Skrip ini melaksanakan permintaan GET untuk mendapatkan maklumat tentang ladang tertentu dalam RELIANOID Pengimbang Beban.

Prasyarat

  • Ganti dengan kunci API sebenar anda.
  • Ganti <RELIANOID_SERVER> dengan alamat pelayan sebenar anda RELIANOID Pengimbang Beban.
  • Ganti dengan ladang sebenar.
  • Pastikan anda mempunyai kebenaran API yang diperlukan didayakan.
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Tentukan pembolehubah $apiKey = " " $server = "RELIANOID_SERVER>" $farmName = " " # Tentukan URL titik akhir API $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName" # Buat panggilan API menggunakan Invoke-RestMethod $response = Invoke -RestMethod -Uri $apiUrl -Method Get -Headers @{ "API_KEY" = $apiKey } -SkipCertificateCheck # Output the response $response

penjelasan

1. Pembolehubah:

  • $apiKey: Kunci API anda.
  • $server: Alamat anda RELIANOID Pengimbang Beban.
  • $farmName: Nama ladang yang anda ingin dapatkan maklumat tentang.

2. URL Titik Akhir API:

  • $apiUrl: Dibina menggunakan alamat pelayan dan nama ladang.

3. Invoke-RestMethod:

  • -Uri $apiUrl: Menentukan titik akhir API.
  • -Kaedah Dapatkan: Menentukan kaedah HTTP GET.
  • -Tajuk @{ "API_KEY" = $apiKey }: Menambah kunci API pada pengepala permintaan.
  • -SkipCertificateCheck: Melangkau pengesahan sijil SSL (bersamaan dengan -k dalam curl). Ini berguna untuk ujian atau apabila pelayan menggunakan sijil yang ditandatangani sendiri.

4. Output:
Respons daripada panggilan API disimpan dalam $response pembolehubah dan kemudian dikeluarkan ke konsol.

Sila rujuk kepada Apidoc rasmi untuk mendapatkan maklumat lanjut tentang panggilan ini https://www.relianoid.com/apidoc/v4.0/#retrieve-farm-by-name

Menambah Bahagian Belakang baharu dalam Ladang #

Skrip ini melaksanakan permintaan POST untuk menambah hujung belakang baharu pada perkhidmatan tertentu dalam ladang pada pengimbang beban Relianoid.

Prasyarat

  • Ganti dengan kunci API sebenar anda.
  • Ganti <RELIANOID_SERVER> dengan alamat pelayan sebenar anda RELIANOID Pengimbang Beban.
  • Ganti dengan ladang sebenar.
  • Ganti dengan perkhidmatan HTTP di mana bahagian belakang akan ditambahkan.
  • Ganti dengan IP bahagian belakang baharu.
  • Ganti dengan PORT bahagian belakang baharu.
  • Pastikan anda mempunyai kebenaran API yang diperlukan didayakan.
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Tentukan pembolehubah $apiKey = " " $server = "RELIANOID_SERVER>" $farmName = " " $serviceName = " " # Tentukan URL titik akhir API $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName/services/$serviceName/backends" # Tentukan badan permintaan $ requestBody = @{ ip = " "pelabuhan = berat = 1 keutamaan = 1 } | ConvertTo-Json # Buat panggilan API menggunakan Invoke-RestMethod $response = Invoke-RestMethod -Uri $apiUrl -Method Post -Headers @{ "Content-Type" = "application/json" "API_KEY" = $apiKey } -Body $ requestBody -SkipCertificateCheck # Output respons $response

penjelasan

1. Pembolehubah:

  • $apiKey: Kunci API anda.
  • $server: Alamat anda RELIANOID Pengimbang Beban.
  • $farmName: Nama ladang yang anda ingin tambahkan bahagian belakang baharu.
  • $serviceName: Nama perkhidmatan dalam ladang di mana bahagian belakang akan ditambah.

2. URL Titik Akhir API:

  • $apiUrl: Dibina menggunakan alamat pelayan, nama ladang dan nama perkhidmatan.

3. Badan Permintaan:

  • $requestBody: Mengandungi muatan JSON dengan butiran pelayan bahagian belakang. Ia ditukar kepada format JSON menggunakan ConvertTo-Json.

4. Invoke-RestMethod:

  • -Uri $apiUrl: Menentukan titik akhir API.
  • -Cara Pos: Menentukan kaedah HTTP POST.
  • -Tajuk @{ "Content-Type" = "application/json"; "API_KEY" = $apiKey }: Menambah Jenis kandungan dan API_KEY kepada tajuk permintaan.
  • -Badan $requestBody: Menentukan muatan JSON untuk permintaan POST.
  • -SkipCertificateCheck: Melangkau pengesahan sijil SSL (bersamaan dengan -k dalam curl). Ini berguna untuk ujian atau apabila pelayan menggunakan sijil yang ditandatangani sendiri.

5. Output:
Respons daripada panggilan API disimpan dalam $response pembolehubah dan kemudian dikeluarkan ke konsol.

Sila rujuk kepada Apidoc rasmi untuk mendapatkan maklumat lanjut tentang panggilan ini https://www.relianoid.com/apidoc/v4.0/#create-a-new-backend

Dayakan Bahagian Belakang dalam mod penyelenggaraan #

Skrip ini melaksanakan permintaan PUT untuk menetapkan pelayan bahagian belakang kepada mod penyelenggaraan pada RELIANOID Pengimbang Beban.

Prasyarat

  • Ganti dengan kunci API sebenar anda.
  • Ganti <RELIANOID_SERVER> dengan alamat pelayan sebenar anda RELIANOID Pengimbang Beban.
  • Ganti dengan ladang sebenar.
  • Ganti dengan perkhidmatan HTTP di mana bahagian belakang akan diletakkan dalam penyelenggaraan.
  • Ganti dengan ID bahagian belakang untuk mengubah suai mod penyelenggaraan.
  • Pastikan anda mempunyai kebenaran API yang diperlukan didayakan.
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12 # Tentukan pembolehubah $apiKey = " " $server = "RELIANOID_SERVER>" $farmName = " " $serviceName = " " $backendId = # Tentukan URL titik akhir API $apiUrl = "https://${server}:444/api/v4.0/api.cgi/farms/$farmName/services/$serviceName/backends/$backendId/maintenance" # Define badan permintaan $requestBody = @{ action = mod "penyelenggaraan" = "longkang" } | ConvertTo-Json # Buat panggilan API menggunakan Invoke-RestMethod $response = Invoke-RestMethod -Uri $apiUrl -Method Put -Headers @{ "Content-Type" = "application/json" "API_KEY" = $apiKey } -Body $ requestBody -SkipCertificateCheck # Output respons $response

penjelasan

1. Pembolehubah:

  • $apiKey: Kunci API anda.
  • $server: Alamat anda RELIANOID Pengimbang Beban.
  • $farmName: Nama ladang di mana bahagian belakang untuk diletakkan dalam penyelenggaraan ditambah.
  • $serviceName: Nama perkhidmatan dalam ladang di mana bahagian belakang akan diselenggara.
  • $backendId: ID bahagian belakang untuk dimasukkan ke dalam mod penyelenggaraan.

2. URL Titik Akhir API:

  • $apiUrl: Dibina menggunakan alamat pelayan, nama ladang dan nama perkhidmatan.

3. Badan Permintaan:

  • $requestBody: Mengandungi muatan JSON dengan tindakan dan mod untuk menetapkan bahagian belakang kepada mod penyelenggaraan. Ia ditukar kepada format JSON menggunakan ConvertTo-Json.

4. Invoke-RestMethod:

  • -Uri $apiUrl: Menentukan titik akhir API.
  • -Kaedah Meletakkan: Menentukan kaedah HTTP PUT.
  • -Tajuk @{ "Content-Type" = "application/json"; "API_KEY" = $apiKey }: Menambah Jenis kandungan dan API_KEY kepada tajuk permintaan.
  • -Badan $requestBody: Menentukan muatan JSON untuk permintaan PUT.
  • -SkipCertificateCheck: Melangkau pengesahan sijil SSL (bersamaan dengan -k dalam curl). Ini berguna untuk ujian atau apabila pelayan menggunakan sijil yang ditandatangani sendiri.

5. Output:
Respons daripada panggilan API disimpan dalam $response pembolehubah dan kemudian dikeluarkan ke konsol.

Sila rujuk kepada Apidoc rasmi untuk mendapatkan maklumat lanjut tentang panggilan ini https://www.relianoid.com/apidoc/v4.0/#backend-in-maintenance

Dokumentasi API selanjutnya #

Untuk mendapatkan maklumat yang lebih terperinci tentang panggilan API yang tersedia untuk mengurus RELIANOID Pengimbang Beban, anda boleh merujuk kepada dokumentasi API rasmi di RELIANOID Dokumentasi API. Sumber komprehensif ini menyediakan penerangan terperinci bagi setiap titik akhir API, termasuk kaedah HTTP yang diperlukan, parameter permintaan dan format respons.

Dokumentasi distrukturkan untuk membantu anda memahami cara berinteraksi dengan pelbagai aspek pengimbang beban, seperti menguruskan ladang, perkhidmatan dan bahagian belakang, serta memantau status dan prestasi sistem. Setiap panggilan API disertakan dengan contoh dan penjelasan untuk membimbing anda melalui proses merangka permintaan anda dan mengendalikan respons. Ini adalah sumber penting untuk pentadbir sistem dan pembangun yang ingin mengautomasikan dan menyelaraskan tugas pengurusan pengimbang beban mereka menggunakan API.

📄 Muat turun dokumen ini dalam format PDF #

    E-MEL: *

    Dikuasai oleh BetterDocs