GPUnex
GPU Rental 6 min czytania

Dokumentacja API

Zarzadzaj instancjami GPU programowo. Dowiedz sie, jak uwierzytelnic, tworzyc instancje, sprawdzac status i wiecej przez API GPUnex.

Uzyskanie klucza API

API GPUnex pozwala zarzadzac instancjami GPU, sprawdzac salda i automatyzowac przeplywy pracy bez korzystania z panelu webowego. Przed wyslaniem jakichkolwiek zadan API musisz wygenerowac klucz API.

  1. Zaloguj sie na swoje konto GPUnex i przejdz do strony Profil lub panelu ustawien Pulpitu.

  2. Otworz sekcje kluczy API. Szukaj zakladki lub karty Klucze API w ustawieniach konta.

  3. Kliknij “Utworz nowy klucz API”. Zostaniesz poproszony o nadanie kluczowi opisowej nazwy. Wybierz cos znaczacego, np. “Serwer produkcyjny”, “Pipeline CI/CD” lub “Rozwoj lokalny”.

  4. Skopiuj klucz API natychmiast. Po wygenerowaniu klucz zostanie wyswietlony dokladnie raz. Skopiuj go i przechowaj w bezpiecznym miejscu, takim jak menedzer hasel lub zaszyfrowany sejf.

  5. Zrozum zakres klucza i odwolywanie. Kazdy klucz API jest przypisany do twojego konta i dziedziczy uprawnienia konta. Mozesz tworzyc wiele kluczy. Jesli klucz zostanie skompromitowany, mozesz go odwolac w dowolnym momencie.

Uwierzytelnianie

Wszystkie zadania do API GPUnex musza zawierac naglówek Authorization z kluczem API w schemacie Bearer token.

Format naglówka:

Authorization: Bearer TWOJ_KLUCZ_API
Terminal
$

Jesli klucz API jest brakujacy, nieprawidlowy lub odwolany, API zwróci odpowiedz 401 Unauthorized.

Glówne endpointy

API GPUnex jest zorganizowane wokól zasobów RESTful. Wszystkie endpointy uzywaja bazowego URL https://api.gpunex.com/v1.

MetodaEndpointOpis
GET/v1/instancesWyswietl wszystkie aktywne i ostatnie instancje.
POST/v1/instancesUtworz nowa instancje GPU. Wymaga body JSON z modelem GPU, frameworkiem i regionem.
GET/v1/instances/:idPobierz szczególowe informacje o konkretnej instancji.
DELETE/v1/instances/:idZakoncz dzialajaca instancje.
GET/v1/gpu-modelsWyswietl wszystkie dostepne modele GPU na marketplace.
GET/v1/balanceSprawdz aktualne saldo portfela USDC.

Przyklad: Tworzenie instancji

Terminal
$

Parametry body zadania:

ParametrTypWymaganyOpis
gpu_modelstringTakIdentyfikator modelu GPU. Uzyj /v1/gpu-models aby zobaczyc dostepne opcje.
frameworkstringTakPreinstalowany framework i wersja (np. pytorch-2.3, tensorflow-2.16, jax-0.4).
regionstringTakRegion centrum danych (np. us-east-1, eu-west-1, ap-southeast-1).

Przyklad: Sprawdzanie statusu instancji

StatusZnaczenie
provisioningInstancja jest konfigurowana. Zasoby GPU sa alokowane.
runningInstancja jest aktywna i gotowa do uzycia. Dostep SSH jest dostepny.
stoppingInstancja jest w trakcie zamykania.
terminatedInstancja zostala zatrzymana i nie generuje juz oplat.
errorWystapil blad podczas provisioningu lub dzialania.

Limity zapytan i najlepsze praktyki

Limity zapytan

  • Ogólne endpointy: 120 zapytan na minute na klucz API.
  • Tworzenie instancji: 10 zapytan na minute na klucz API.
  • Saldo i endpointy tylko do odczytu: 300 zapytan na minute na klucz API.

Najlepsze praktyki

  1. Nigdy nie eksponuj kluczy API w kodzie po stronie klienta.

Ważne

Nigdy nie eksponuj klucza API w kodzie po stronie klienta, JavaScript przegladarki ani publicznych repozytoriach. Klucze API powinny byc uzywane wylacznie w aplikacjach po stronie serwera.

  1. Uzywaj zmiennych srodowiskowych. Przechowuj klucz API w zmiennej srodowiskowej zamiast wpisywac go na stale w plikach zródlowych.

  2. Rotuj klucze okresowo. Generuj nowy klucz API co 90 dni i odwoluj stary.

  3. Uzywaj oddzielnych kluczy dla oddzielnych srodowisk.

Wskazówka

Uzywaj oddzielnych kluczy API dla srodowisk developerskiego, stagingowego i produkcyjnego. Dzieki temu odwolanie jednego klucza nie wplywa na inne srodowiska.

  1. Obsluguj bledy z wdziekiem. Implementuj logike ponowien z wykladniczym opóznieniem dla odpowiedzi 429 i 5xx.

  2. Monitoruj uzycie. Sleedz wolumen zapytan API i wydatki na instancje.