Wolkra API https://api.wolkra.com/v1 ünvanında yerləşən REST API-dir və serverləri, volume-ları, şəbəkələri, firewall-ları və yük balanslaşdırıcılarını öz kodunuzdan yaratmağa və idarə etməyə imkan verir. Sorğular layihəyə bağlı tokenlərlə autentifikasiya olunur; bu tokenləri yalnız oxuma hüququ, müəyyən IP ünvanları və sabit istifadə müddəti ilə məhdudlaşdıra bilərsiniz.
API nələri əhatə edir
API konsolda gördüyünüz işləri təkrarlayır. Tipik tapşırıqlar:
- Bulud serverləri yaratmaq, ölçüsünü böyütmək, yenidən qurmaq, yandırıb-söndürmək və silmək
- Blok yaddaş volume-larını yaratmaq, qoşmaq, böyütmək və ayırmaq
- Ehtiyat nüsxələri aktivləşdirmək və snapshot-lar çəkmək
- Şəxsi şəbəkələr və NAT gateway-lər qurmaq
- Firewall-ları, yük balanslaşdırıcılarını, üzən IP-ləri və reverse DNS-i idarə etmək
Hər şey HTTPS üzərindən JSON ilə, standart HTTP metodları və status kodları ilə işləyir.
API tokenləri
Tokenlər konsolda layihənizin ayarlarında yaradılır.
| Seçim | Nə edir |
|---|---|
| Layihə əhatəsi | Token yalnız bir layihə üçün işləyir |
wk_ prefiksi |
Wolkra tokenlərini kodda və secret skanerlərində asanlıqla tanımağa kömək edir |
| Oxuma və ya oxuma/yazma | Yalnız oxuma tokenləri siyahı çıxarır və baxır, oxuma/yazma tokenləri dəyişiklik edə bilir |
| IP icazə siyahısı | İstəyə bağlıdır, başqa ünvanlardan gələn sorğuları rədd edir |
| Bitmə müddəti | İstəyə bağlıdır, token seçdiyiniz tarixdən sonra işləməyi dayandırır |
Hər skriptə və ya xidmətə işi görməyə kifayət edən ən dar hüquqlarla ayrıca token verin. Monitorinq skriptinə yalnız oxuma kifayətdir. Deploy pipeline-ına isə oxuma/yazma, runner-ləri üçün icazə siyahısı və vaxtaşırı yenilədiyiniz bitmə müddəti lazımdır.
İlk sorğu
Tokeni bearer token kimi göndərin:
curl -H "Authorization: Bearer wk_your_token_here" \
https://api.wolkra.com/v1/servers
Cavabda tokenin aid olduğu layihədəki serverlərin siyahısı qayıdır. API tokenləri sənədi token yaratmağı və ilk sorğuları addım-addım izah edir.
Komandalar API-dən necə istifadə edir
- Deploy pipeline-ları server yaradır, onun açılmasını gözləyir, deploy edir və yük balanslaşdırıcısını yeniləyir.
- Failover skriptləri aktiv server cavab verməyi dayandıranda üzən IP-ni başqa serverə keçirir.
- Təhlükəsiz relizlər üçün hər relizdən əvvəl snapshot çəkilir, köhnələri isə sonra silinir.
- Qısamüddətli mühitlər bir branch və ya test üçün serverlər qaldırır və iş bitəndə onları silir. Saatlıq hesablama sayəsində iki saat işləyən server iki saatlıq pul tutur. Bax: inkişaf mühitləri.
- Elastik CI runner-lər növbələr uzananda server əlavə edir, boşalanda isə silir.
- Daxili dashboard-lar yalnız oxuma tokeni ilə serverləri və qrafikləri oxuyur.
Konsol, Composer və API birlikdə
Konsol, Composer və API eyni resurslar üzərində işləyir. Stack-i Composer-də çəkə, tətbiq edə və sonra skriptlərlə idarə edə bilərsiniz. Hər birindən edilən dəyişikliklər layihənin fəaliyyət jurnalında görünür, beləliklə komanda kimin nə etdiyini görür. Bax: komandalar və təhlükəsizlik.
İstənilən dillə işləmək
API JSON ilə adi REST olduğu üçün xüsusi kitabxanaya ehtiyac yoxdur. curl və jq ilə shell skripti, HTTP klienti olan Python skripti, Go xidməti və ya Node.js tapşırığı eyni cür işləyir: bearer token ilə sorğu göndərin, JSON cavabı oxuyun, status kodunu yoxlayın. Cavablar hər resursu ID, ad, etiketlər və vəziyyəti ilə təsvir edir; beləliklə skript server yarada, o işə düşənə qədər vəziyyəti yoxlaya, sonra ona volume qoşa və ya onu yük balanslaşdırıcısına əlavə edə bilər.
Skriptlər üçün faydalı vərdişlər:
- ID-ləri koda yazmaq əvəzinə resursları etiketlərlə tapın.
- Hər sorğunun HTTP status kodunu yoxlayın və xəta olduqda dayanın.
- Vəziyyət dəyişikliklərini sıx dövrədə deyil, sorğular arasında fasilə verərək yoxlayın.
- Fərqli işlər üçün ayrı tokenlər saxlayın ki, birini ləğv etmək digərlərini pozmasın.
Təhlükəsizlik qeydləri
- Tokenlərə parol kimi yanaşın. Onları secret manager-də və ya CI sisteminizin secret anbarında saxlayın, heç vaxt açıq repozitoriyada yox.
- Sabit ünvanlardan işləyən tokenlər üçün IP icazə siyahısından istifadə edin.
- Podratçılar və müvəqqəti işlər üçün tokenlərə bitmə müddəti qoyun.
- Tokenin sızdığından şübhələndiyiniz anda onu konsolda ləğv edin.
Bilməli olduğunuz məhdudiyyətlər
- Wolkra-nı avtomatlaşdırmağın yolu API-dir. curl və ya istənilən HTTP klientindən istifadə edin.
- Hər token bir layihə daxilində işləyir.
- Resurslar hazırda yeganə lokasiyamız olan Frankfurtda yaradılır.
Əlaqəli səhifələr
Avtomatlaşdırmağa başlayın
Layihə yaradın, token generasiya edin və bir neçə dəqiqəyə ilk sorğunuzu göndərin. Wolkra-da hesab yaradın.
Tez-tez verilən suallar
Wolkra API haradadır?
REST API https://api.wolkra.com/v1 ünvanındadır. HTTPS üzərindən JSON ilə işləyir və Authorization başlığında göndərilən API tokeni ilə autentifikasiya olunur.
API tokenləri necə işləyir?
Tokenləri konsolda yaradırsınız. Hər token bir layihəyə aiddir, wk_ ilə başlayır və ya yalnız oxuma, ya da oxuma/yazma hüququna malikdir. Ona IP icazə siyahısı və bitmə tarixi əlavə edə bilərsiniz.
API ilə hansı alətlərdən istifadə edə bilərəm?
HTTPS və JSON ilə işləyən istənilən alət uyğundur: shell skriptindəki curl-dan tutmuş sevdiyiniz proqramlaşdırma dilinin HTTP klientinə qədər.
API ilə nə edə bilərəm?
API konsolda idarə etdiyiniz resursları əhatə edir: serverlər, volume-lar, şəbəkələr, firewall-lar, yük balanslaşdırıcıları və IP ünvanları.
API-dən istifadə pulsuzdurmu?
Bəli. API sorğuları üçün ödəniş yoxdur. Yalnız yaratdığınız resursların haqqını ödəyirsiniz, o da əvvəlcədən ödənilmiş balansınızdan saatlıq hesablanır.