HELPER VPS

VPS API: automatyzacja serwerów w chmurze przez JSON REST

API serwerów w chmurze obsługiwane z kodu od utworzenia do usunięcia

  • JSON REST API
  • Uwierzytelnianie kluczem API (Bearer)
  • 300 żądań na minutę

VPS API to programowy sposób na wykonywanie czynności, które wykonujesz w panelu sterowania, takich jak tworzenie, uruchamianie, zatrzymywanie i usuwanie serwerów, za pomocą żądań HTTP. API serwera w chmurze HELPER VPS jest darmowe dla wszystkich członków; po pierwszej płatności utwórz klucz API i połącz się od razu.

  • REST API

    Wszyscy użytkownicy

    Bezpłatnie

    Opłata miesięczna

    • JSON REST
    • Klucz API (Bearer)
    • 300 na minutę
    • Bezpłatnie
    Zacznij

Aby od razu zobaczyć przykłady żądań i format odpowiedzi Dokumentacja API

Co można zautomatyzować przez VPS API?

VPS API pokazuje swoją siłę, gdy serwery często się tworzy i usuwa lub trzeba zarządzać wieloma serwerami naraz. Oto cztery popularne scenariusze automatyzacji.

Panel czy VPS API: kiedy czego używać?

Panel sterowania i API działają z tym samym kontem i tymi samymi serwerami. Do zarządzania jednym lub dwoma serwerami ręcznie panel sterowania jest wygodny; do powtarzalnych zadań lub wielu serwerów API jest szybsze.

Panel sterowania

Zarządzanie klikaniem w interfejsie

Dla kogo

  • Gdy tworzysz serwer pierwszy raz
  • Gdy sam prowadzisz jeden-dwa serwery
  • Ponowna instalacja systemu i dodawanie kluczy SSH
  • Gdy chcesz ponownie zobaczyć hasło root

VPS API

Zarządzanie żądaniami z kodu

Dla kogo

  • Środowiska testowe, w których serwery często się tworzy i usuwa
  • Potoki wdrożeniowe i automatyzacja skryptami
  • Gdy chcesz naraz odczytać stan wielu serwerów
  • Gdy podłączasz własny panel lub bota

Jak podłączyć API serwerów w chmurze?

To trzy kroki. Najpierw dokonaj pierwszej płatności, a po jej potwierdzeniu utwórz klucz na stronie kluczy API. Następnie umieść klucz w nagłówku Authorization każdego żądania za pomocą schematu Bearer. Na koniec wysyłaj żądania na wybraną ścieżkę po adresie bazowym https://helpervps.com/api/v1, a wyniki wracają w formacie JSON.

Na początek warto wywołać GET /catalog. Od razu zwraca dostępne rodzaje i rozmiary serwerów, kody regionów, kody systemów i aplikacji jednym kliknięciem oraz ceny automatycznych kopii, dodatkowego dysku i ochrony DDoS. Otrzymane kody plan, location i image po prostu wstaw do żądania tworzenia serwera.

Aby utworzyć serwer, wyślij wartości plan, location, image i label jako JSON do POST /servers. Możesz również dodać ID klucza SSH, który dodałeś, oraz opcje backups, extra_disk_gb i ddos_protection. Płacisz za wybrany okres z góry, a odpowiedź zawiera ID serwera, status i hasło root, więc natychmiast zapisz je w bezpiecznym miejscu.

Jakie działania są dostępne przez VPS API?

VPS API obejmuje cały cykl życia serwera. GET /catalog czyta katalog, POST /servers tworzy serwer, GET /servers zwraca listę Twoich serwerów, a GET /servers/{id} dane jednego serwera. Odpowiedź zawiera nazwę serwera, stan, adresy IPv4 i IPv6, cenę miesięczną, wybrane opcje i następną datę płatności.

Zasilaniem sterujesz żądaniami POST /servers/{id}/start, stop i reboot. POST /servers/{id}/renew opłaca miesiąc od razu, bez czekania na datę płatności, a DELETE /servers/{id} usuwa serwer. Jeśli żądanie nie pasuje do obecnego stanu serwera, przychodzi kod wrong_state, więc skryptowi łatwo zdecydować o kolejnym kroku.

Błędy wracają w JSON z wartością error razem z kodem stanu. Przyczyny są rozdzielone kodami: zły klucz unauthorized, brak środków not_enough_balance, limit serwerów konta limit, zbyt wiele żądań rate_limited, więc w programie wygodnie obsłużysz każdą sytuację. Pełna lista i przykłady odpowiedzi są w dokumentacji API.

Ile kosztuje VPS API?

VPS API jest darmowe dla wszystkich członków. Serwery i opcje utworzone za pomocą API są płatne w tych samych cenach co serwery utworzone w panelu sterowania.

HELPER VPS w liczbach

Wybierz spośród 40 regionów, 12 systemów operacyjnych i 10 aplikacji jednym kliknięciem w jednym koncie i zapłać od razu. Poniższe liczby odpowiadają aktualnej ofercie.

Narzędzia automatyzacji do pracy z VPS API

Z VPS API połączy się każde narzędzie, które potrafi wysyłać żądania HTTP. Od jednej linii curl po skrypty w Pythonie i Node.js oraz potoki wdrożeniowe wszystko działa tak samo.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Dlaczego warto wybrać API HELPER VPS

Najczęstsze pytania o VPS API

Odpowiedzi o podłączaniu, uwierzytelnianiu i limitach żądań VPS API

Czy VPS API jest darmowe?

Tak, VPS API jest darmowe dla wszystkich użytkowników. Wydawanie kluczy API i wysyłanie żądań jest bezpłatne, a serwery i opcje utworzone za pomocą API są opłacane w tych samych cenach, co te utworzone w panelu kontrolnym. Każdy użytkownik, który dokonał pierwszej płatności, może od razu utworzyć klucz na stronie kluczy API.

Gdzie utworzyć klucz API?

Po dokonaniu pierwszej płatności strona kluczy API (/api-key) zostaje odblokowana i możesz tam tworzyć klucze. Umieść klucz w nagłówku Authorization każdego żądania, korzystając ze schematu Bearer. Klucz daje dostęp do całego konta, więc nie umieszczaj go w repozytoriach kodu; przechowuj go w zmiennych środowiskowych lub magazynie sekretów.

Jakie działania są dostępne przez API?

Możesz czytać katalog (GET /catalog), listę serwerów i dane jednego serwera (GET /servers, GET /servers/{id}), tworzyć serwer (POST /servers), włączać, wyłączać i restartować (start, stop, reboot), odnawiać na miesiąc (renew) i usuwać (DELETE /servers/{id}). Przykłady żądań i format odpowiedzi są w dokumentacji API.

Jaki jest limit żądań?

Do 300 żądań na minutę na klucz. Po przekroczeniu limitu wraca kod stanu 429 i błąd rate_limited, więc w skrypcie wystarczy chwilę odczekać i wysłać ponownie. Codzienna automatyzacja, jak sprawdzanie listy serwerów i zarządzanie zasilaniem, działa w tym limicie z zapasem. Nie ma opłat za liczbę żądań.

Jak pobierana jest opłata przy tworzeniu serwera przez API?

Gdy żądanie POST /servers zakończy się sukcesem, opłata za wybrany okres rozliczeniowy jest przetwarzana, a serwer jest tworzony. Opłata za serwer, którego nie udało się utworzyć, wraca na saldo kredytowe Twojego konta.

Jak otrzymać hasło root przez API?

Wartość root_password przychodzi jeden raz w odpowiedzi na żądanie utworzenia serwera. Zapisz ją w bezpiecznym miejscu zaraz po otrzymaniu odpowiedzi. W panelu również zobaczysz ją przez 7 dni, a jeśli przekażesz też numer klucza SSH, od razu zalogujesz się kluczem bez hasła. Z wartością ipv4 z odpowiedzi od razu zaczniesz połączenie SSH, co wygodnie łączyć ze skryptami wdrożeniowymi.

Czy mogę przekazać klucz SSH przez API?

Tak, podaj w żądaniu utworzenia serwera numer dodanego klucza SSH w wartości ssh_key_id, a ten klucz trafi na nowy serwer. Klucz wystarczy raz dodać na ekranie kluczy SSH w panelu, a odcisk jest pokazywany tak samo jak w ssh-keygen, więc od razu widać, który to klucz. Numer klucza ustalasz raz i używasz wielokrotnie.

Z jakimi językami i narzędziami działa API?

Pasuje każdy język i narzędzie, które potrafi wysyłać żądania HTTP. Testuj od razu przez curl, a z requests w Pythonie, fetch w Node.js, kroku skryptu GitLab CI i żądań HTTP w Terraform wywołuj ten sam adres z tymi samymi nagłówkami. Wszystkie odpowiedzi są w JSON, więc wynik łatwo odczytać.

Jak rozpoznać błąd?

Błąd wraca z kodem stanu innym niż 2xx i JSON z wartością error. Przyczyny są rozdzielone: zły klucz unauthorized, brakująca wartość bad_request, brak środków not_enough_balance, żądanie niezgodne ze stanem serwera wrong_state, więc w programie wygodnie obsłużysz każdą sytuację.

Czy serwery utworzone przez API widać w panelu?

Tak, API i panel obsługują to samo konto i te same serwery. Serwery utworzone przez API widać na liście w panelu, a w panelu zainstalujesz ponownie system lub sprawdzisz hasło. Limit 10 serwerów na konto obowiązuje łącznie dla obu sposobów. Nawet gdy łączysz pracę ręczną i kod, stan i daty płatności zawsze wyglądają tak samo.

Poradniki VPS API

Przydatne materiały przy pierwszym podłączeniu API

VPS API jest darmowe dla wszystkich użytkowników, a klucz API możesz utworzyć po dokonaniu pierwszej płatności. Serwery i opcje utworzone za pomocą API są opłacane w tych samych cenach, co w cenniku, i automatycznie odnawiają się za tę samą kwotę w każdym dniu rozliczeniowym.

Limit żądań: 300 na minutę na klucz API | 10 serwerów na konto | W przypadku nieudanej płatności: serwer zawieszony, następnie usunięty po 3 dniach | Pozostały czas na usuniętych serwerach nie jest zwracany. Zwroty trafiają na saldo kredytowe Twojego konta.