VPS API, automasi pelayan awan dengan JSON REST
API pelayan awan untuk mengurus pelayan dengan kod, daripada penciptaan hingga pemadaman
- JSON REST API
- Pengesahan kunci API (Bearer)
- 300 permintaan seminit
API VPS ialah cara berprogram untuk melakukan kerja yang anda lakukan di panel kawalan, seperti mencipta, menghidupkan, mematikan dan memadam pelayan, dengan permintaan HTTP. API pelayan awan HELPER VPS percuma untuk semua ahli; selepas pembayaran pertama anda, cipta kunci API dan sambungkan dengan segera.
REST API
Semua ahli
Percuma
Dibayar setiap bulan
- JSON REST
- Kunci API (Bearer)
- 300 seminit
- Percuma
Untuk terus melihat contoh permintaan dan format respons Dokumentasi API
Apa yang boleh diautomasikan dengan VPS API?
VPS API paling bermanfaat apabila anda kerap mencipta dan memadam pelayan, atau mengurus banyak pelayan sekali gus. Berikut empat automasi yang paling kerap digunakan.
Mencipta pelayan dalam pipeline deploy
Dalam pipeline deploy seperti GitLab CI, cipta pelayan ujian dengan permintaan POST /servers, kemudian padam dengan permintaan DELETE selepas ujian selesai. Pelayan hanya wujud apabila diperlukan jadi kos kekal kemas.
Semakan status pelayan dan pengurusan kuasa
Baca senarai pelayan, status, alamat IPv4 dan IPv6, serta tarikh bil seterusnya dengan GET /servers, kemudian urus kuasa dengan permintaan start, stop dan reboot jika perlu. Sambungkan dengan alat pemantauan untuk mencipta skrip yang memulakan semula pelayan yang berhenti.
Menjual dan mengendalikan pelayan dalam perkhidmatan anda
Panggil API daripada panel pentadbir atau bot buatan sendiri untuk mencipta pelayan dan memaparkan hasilnya. Baca senarai produk GET /catalog untuk memaparkan saiz, lokasi, sistem pengendalian dan pilihan yang boleh dipilih seperti sedia ada di skrin.
Pengurusan tarikh bil dan pembaharuan
Semak tarikh bil seterusnya setiap pelayan dengan nilai paid_until, dan perbaharui dengan segera dengan permintaan renew untuk pelayan yang anda ingin bayar untuk tempoh yang lebih panjang. Pantau invois dan tarikh bil anda dalam kod untuk memastikan pelayan penting terus berjalan dengan stabil.
Panel kawalan atau VPS API, bila menggunakan yang mana?
Panel kawalan dan API berfungsi dengan akaun dan pelayan yang sama. Untuk mengurus satu atau dua pelayan secara manual, panel kawalan lebih mudah; untuk kerja berulang atau banyak pelayan, API lebih pantas.
Panel kawalan
Cara mengurus dengan klik di skrin
Sesuai untuk
- Apabila mencipta pelayan kali pertama
- Apabila mengurus sendiri satu atau dua pelayan
- Pemasangan semula sistem pengendalian dan pendaftaran kunci SSH
- Apabila melihat semula kata laluan root
VPS API
Cara mengurus dengan permintaan melalui kod
Sesuai untuk
- Persekitaran ujian yang kerap mencipta dan memadam pelayan
- Automasi pipeline deploy dan skrip
- Apabila membaca status banyak pelayan sekali gus
- Apabila menyambungkan dengan panel pentadbir atau bot buatan sendiri
Bagaimana cara menyambungkan API pelayan awan?
Ia mengambil tiga langkah. Pertama, buat pembayaran pertama anda, dan setelah disahkan, cipta kunci di halaman kunci API. Seterusnya, letakkan kunci dalam header Authorization setiap permintaan menggunakan skema Bearer. Akhir sekali, hantar permintaan ke laluan yang anda inginkan selepas alamat asas https://helpervps.com/api/v1, dan hasilnya akan dikembalikan dalam JSON.
Pada mulanya, sebaiknya panggil GET /catalog. Jenis dan saiz pelayan yang boleh dipilih sekarang, kod lokasi, kod sistem pengendalian dan aplikasi satu klik, serta harga sandaran automatik, cakera tambahan dan perlindungan DDoS dikembalikan sekali gus. Masukkan kod plan, location dan image yang diterima di sini seperti sedia ada ke dalam permintaan mencipta pelayan.
Untuk mencipta pelayan, hantar nilai plan, location, image dan label sebagai JSON ke POST /servers. Anda juga boleh memasukkan ID kunci SSH yang anda tambah dan pilihan backups, extra_disk_gb dan ddos_protection. Anda membayar untuk tempoh yang dipilih terlebih dahulu, dan respons mengandungi ID pelayan, status dan kata laluan root, jadi simpan di tempat selamat dengan segera.
Kerja apa yang boleh dilakukan dengan VPS API?
VPS API mengendalikan kitaran hayat pelayan dari awal hingga akhir. Baca senarai produk dengan GET /catalog, cipta pelayan dengan POST /servers, baca senarai pelayan anda dengan GET /servers, dan maklumat satu pelayan dengan GET /servers/{id}. Respons mengandungi nama pelayan, status, alamat IPv4 dan IPv6, kadar bulanan, pilihan yang dipilih dan tarikh bil seterusnya.
Kuasa dihidupkan, dimatikan dan dimulakan semula dengan permintaan POST /servers/{id}/start, stop dan reboot. POST /servers/{id}/renew membayar sebulan sekarang untuk terus memperbaharui tanpa menunggu tarikh bil, dan DELETE /servers/{id} memadam pelayan. Jika permintaan tidak sepadan dengan status semasa pelayan, kod wrong_state dikembalikan supaya skrip mudah menentukan tindakan seterusnya.
Ralat dikembalikan sebagai JSON yang mengandungi nilai error bersama kod status. Sebabnya dibezakan dengan kod, seperti unauthorized jika kunci salah, not_enough_balance jika baki tidak mencukupi, limit jika bilangan pelayan akaun mencapai had, dan rate_limited jika permintaan terlalu banyak, jadi mudah dikendalikan mengikut situasi dalam program. Senarai lengkap dan contoh respons ada dalam dokumentasi API.
Berapakah kos VPS API?
API VPS percuma untuk semua ahli. Pelayan dan pilihan yang dicipta dengan API dibayar pada harga yang sama seperti pelayan yang dicipta di panel kawalan.
Penggunaan API percuma
Tiada caj untuk mengeluarkan kunci API atau membuat permintaan. Mana-mana ahli yang telah membuat pembayaran pertama mereka boleh mencipta kunci dan menggunakannya dengan segera.
300 permintaan seminit
Satu kunci boleh menghantar sehingga 300 permintaan seminit. Had yang selesa untuk automasi harian seperti semakan senarai pelayan dan pengurusan kuasa.
Harga sama dengan panel kawalan
Pelayan yang dicipta melalui API mempunyai harga yang sama seperti senarai harga, pilihan ditambah dengan jumlah yang sama, dan diperbaharui pada setiap tarikh bil.
HELPER VPS dalam angka
Pilih daripada 40 wilayah, 12 sistem pengendalian dan 10 aplikasi satu klik dalam satu akaun, dan bayar dengan segera. Angka di bawah berdasarkan apa yang dijual sekarang.
40
Lokasi pusat data
12
Sistem pengendalian
10
Aplikasi satu klik
Percuma
Harga permulaan produk ini (bulanan)
Alat automasi yang digunakan bersama VPS API
Sebarang alat yang boleh menghantar permintaan HTTP boleh disambungkan ke VPS API. Daripada satu baris curl hingga skrip Python, Node.js dan pipeline deploy, semuanya digunakan dengan cara yang sama.
- Terraform
- Python
- Node.js
- GitLab CI
- Docker
Sebab memilih API HELPER VPS
JSON REST yang ringkas
Hantar permintaan dan terima respons dengan kaedah HTTP dan JSON yang biasa. Boleh terus diuji dengan curl tanpa pustaka tambahan.
Pengesahan kunci API (Bearer)
Cukup memasukkan satu kunci dalam header Authorization, jadi pengesahannya sama dalam bahasa dan alat apa pun.
300 permintaan seminit
Satu kunci boleh menghantar sehingga 300 permintaan seminit, jadi semakan status dan pengurusan kuasa banyak pelayan dikendalikan dengan selesa.
Senarai produk melalui kod
Baca saiz, lokasi, sistem pengendalian dan harga pilihan dengan GET /catalog kemudian gunakan seperti sedia ada dalam paparan dan skrip anda.
Daripada penciptaan hingga pemadaman
Penciptaan pelayan, senarai, menghidupkan, mematikan, mula semula, pembaharuan dan pemadaman semuanya diproses melalui API.
Pilih pilihan sekali gus
Semasa mencipta pelayan, masukkan sandaran automatik, cakera tambahan, perlindungan DDoS dan kunci SSH dalam satu permintaan.
Kod ralat yang menunjukkan sebabnya
Sebab ralat dibahagikan kepada kod, seperti kredit akaun tidak mencukupi, had pelayan dan ketidaksesuaian keadaan, jadi mudah dikendalikan dalam program anda.
Akaun yang sama dengan panel kawalan
Pelayan yang dicipta melalui API muncul di panel kawalan seperti sedia ada, dan dibayar serta diperbaharui dengan cara yang sama.
Percuma untuk semua ahli
Selepas membuat pembayaran pertama anda, cipta kunci API tanpa caj dan mulakan automasi dengan segera.
Soalan lazim VPS API
Jawapan tentang sambungan, pengesahan dan had permintaan VPS API
Adakah VPS API percuma?
Ya, VPS API percuma untuk semua ahli. Mengeluarkan kunci API dan membuat permintaan adalah percuma, dan pelayan serta pilihan yang dicipta melalui API dibayar pada harga yang sama seperti yang dicipta di panel kawalan. Mana-mana ahli yang telah membuat pembayaran pertama boleh mencipta kunci dengan segera di halaman kunci API.
Di manakah kunci API dicipta?
Selepas membuat pembayaran pertama anda, halaman kunci API (/api-key) dibuka dan anda boleh mencipta kunci di sana. Letakkan kunci dalam header Authorization setiap permintaan menggunakan skema Bearer. Kunci membuka kunci seluruh akaun anda, jadi jangan simpan dalam repositori kod; simpan dalam pemboleh ubah persekitaran atau storan rahsia.
Kerja apa yang boleh dilakukan dengan API?
Anda boleh membaca senarai produk (GET /catalog), membaca senarai pelayan dan maklumat satu pelayan (GET /servers, GET /servers/{id}), mencipta pelayan (POST /servers), menghidupkan, mematikan dan mula semula (start, stop, reboot), memperbaharui sebulan (renew) dan memadam (DELETE /servers/{id}). Contoh permintaan dan format respons ada dalam dokumentasi API.
Berapakah had permintaan?
Satu kunci boleh menghantar sehingga 300 permintaan seminit. Jika melebihi had, kod status 429 dan ralat rate_limited dikembalikan, jadi cukup tetapkan skrip supaya menunggu sebentar kemudian menghantar semula. Automasi harian seperti semakan senarai pelayan dan pengurusan kuasa berjalan dengan selesa dalam had ini. Tiada caj mengikut bilangan permintaan.
Jika mencipta pelayan melalui API, bagaimana bayaran ditolak?
Apabila permintaan POST /servers berjaya, bayaran untuk tempoh bil yang dipilih diproses dan pelayan dicipta. Bayaran untuk pelayan yang gagal dicipta dikembalikan ke kredit akaun anda.
Bagaimana menerima kata laluan root melalui API?
Respons permintaan mencipta pelayan mengandungi nilai root_password sekali sahaja. Simpan segera di tempat selamat sebaik respons diterima. Kata laluan juga boleh dilihat semula di panel kawalan selama 7 hari, dan jika nombor kunci SSH turut dihantar, anda terus log masuk dengan kunci tanpa kata laluan. Dengan nilai ipv4 dalam respons, akses SSH boleh terus dimulakan, sesuai untuk disambungkan ke skrip deploy.
Bolehkah kunci SSH dimasukkan melalui API?
Ya, masukkan nombor kunci SSH yang telah didaftarkan sebagai nilai ssh_key_id dalam permintaan mencipta pelayan, maka kunci itu dimasukkan ke pelayan baharu. Cukup daftar kunci sekali di halaman kunci SSH panel kawalan, dan cap jari dipaparkan dengan cara yang sama seperti ssh-keygen jadi terus kelihatan kunci yang mana. Tetapkan nombor kunci sekali dan guna semula.
Bahasa atau alat apa yang boleh digunakan?
Sebarang bahasa dan alat boleh, asalkan boleh menghantar permintaan HTTP. Uji terus dengan curl, kemudian panggil dengan alamat dan header yang sama daripada requests dalam Python, fetch dalam Node.js, langkah skrip GitLab CI atau ciri permintaan HTTP dalam Terraform. Semua respons dalam JSON jadi hasilnya mudah dibaca.
Bagaimana mengetahui jika berlaku ralat?
Ralat dikembalikan sebagai JSON yang mengandungi nilai error bersama kod status selain 2xx. Sebabnya dibezakan, seperti unauthorized jika kunci salah, bad_request jika ada nilai yang tertinggal, not_enough_balance jika baki tidak mencukupi, dan wrong_state jika permintaan tidak sepadan dengan status pelayan, jadi program boleh mengendalikan mengikut situasi.
Adakah pelayan yang dicipta melalui API juga dipaparkan di panel kawalan?
Ya, API dan panel kawalan mengendalikan akaun dan pelayan yang sama. Pelayan yang dicipta melalui API dipaparkan seperti sedia ada dalam senarai panel kawalan, dan anda boleh memasang semula sistem pengendalian atau menyemak kata laluan di panel kawalan. Had 10 pelayan setiap akaun juga terpakai untuk kedua dua cara. Walaupun kerja manual dan kerja melalui kod dicampur, status dan tarikh bil sentiasa kelihatan sama.
Panduan VPS API
Panduan yang baik dibaca semasa menyambungkan API kali pertama
- Dokumentasi APIAlamat asas, header pengesahan, contoh permintaan mengikut laluan dan format respons, serta senarai penuh kod ralat.
- Cipta dan daftar kunci SSHCara mencipta dan mendaftar kunci SSH supaya terus log masuk dengan kunci ke pelayan yang dicipta melalui API.
- Lihat kadar sekali imbasBandingkan kadar bulanan saiz pelayan dan pilihan yang boleh dipilih melalui API dalam satu halaman.
VPS API percuma untuk semua ahli, dan anda boleh mencipta kunci API selepas membuat pembayaran pertama. Pelayan dan pilihan yang dicipta melalui API dibayar pada harga yang sama seperti senarai harga dan diperbaharui secara automatik dengan jumlah yang sama pada setiap tarikh bil.
Had permintaan: 300 seminit setiap kunci API | 10 pelayan setiap akaun | Jika pembayaran gagal: pelayan digantung, kemudian dipadam 3 hari kemudian | Baki masa pada pelayan yang dipadam tidak dipulangkan. Bayaran balik dikembalikan ke kredit akaun anda.
