Antontan-taratasy feno momba ny REST API ho an'ny fitantanana ireo mpizara VPS, sehatra, DNS, backups, sy ny maro hafa.
Ny VPS.org API dia ahafahanao mitantana amin'ny alalan'ny fandaharana ny lafiny rehetra amin'ny fotodrafitrasa fampiantranoana VPS anao, anisan'izany ny mpizara, sehatra, firaketana DNS, backups, ary snapshots.
Mila fanamarinana amin'ny fampiasana Bearer token ny fangatahana API rehetra. Azonao atao ny mamorona ny API token-nao avy amin'ny fikirana kaontinao ao amin'ny admin.vps.org/account/developers/.
curl -X GET https://admin.vps.org/api/v1/servers/ \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"import requests
url = "https://admin.vps.org/api/v1/servers/"
headers = {
"Authorization": "Bearer YOUR_API_TOKEN",
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())const response = await fetch('https://admin.vps.org/api/v1/servers/', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_API_TOKEN',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);Ny token tsirairay dia manana ny fahazoan-dàlana manokana, toy ny servers:list na dns:*. Ny fangatahana mila fahazoan-dàlana tsy manana ny token dia tsy ekena amin'ny alalan'ny 403 sy ny field required_permission milaza ny fahazoan-dàlana tsy misy. Fandraisana alalana
Tsy maintsy 1000 isan'ora ny fangatahana voaporofo ho an'ny kaonty iray. Tsy maintsy 100 isan'ora ny fangatahana tsy voaporofo ho an'ny adiresy IP iray ny fangatahana voaporofo. 429 no azon'ny fangatahana mihoatra ny fetra, miaraka amin'ny lohateny Retry-After manome ny isan'ny segondra tokony hiandry. Tsy misy lohateny fameperana ny tahan'ny fandefasana raha toa ka nahomby ny valinteny.
Mamaly zavatra iray ahitana ny isan'ny zavatra, manaraka, teo aloha ary ny vokany, 25 isan-pejy ny farany farany amin'ny lisitra. Mandefa pejy rehefa mifindra eo anelanelan'ny pejy, na manaraka ny URL manaraka mandra-pahatongan'ny tsy misy. Manaiky page_size, hatramin'ny 100, ihany koa ny lisitr'ireo mpizara.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}Mampiasa kaody sata HTTP mahazatra ny API mba hampisehoana ny fahombiazana na ny tsy fahombiazana:
| Kaody momba ny sata | Fanoritsoritana |
|---|---|
200 |
Fahombiazana - Vita soa aman-tsara ny fangatahana |
201 |
Voaforona - Voaforona soa aman-tsara ny loharano |
400 |
Fangatahana Ratsy - Paramètre tsy manan-kery na fangatahana tsy ara-dalàna |
202, 204 |
No ekena ary napetraka anaty filaharana (202), na fafàna tsy misy vatana (204) |
402 |
Tsy maintsy atao ny fandoavam-bola: tsy misy fomba fandoavam-bola voarakitra, tsy misy vola tsy voaloa, na tsy misy fankatoavana mialoha ny karatra |
403 |
Forbidden: the token is missing, invalid or expired, or lacks the required permission. Failed authentication also returns 403, not 401. |
404 |
Tsy hita - Tsy misy ny loharano |
409 |
Fifandirana: ohatra, efa mandeha ny fanovana habe, tsy ampy ny fahafahana, na efa mandeha ny fampidirana |
429 |
Be loatra ny fangatahana - nihoatra ny fetran'ny tahan'ny |
500 |
Hadisoana anatiny amin'ny mpizara - Nisy zavatra tsy nety teto aminay |
503 |
Tsy misy tolotra: olana vonjimaika. Andramo indray, ary ampio ny Retry-After rehefa alefa. |
JSON ny vatana tsy fetezana. Ny ankamaroany dia manana sehatra misy antsipiriany na sehatra misy tsy fetezana, indraindray misy hafatra; ny tsy fetezana amin'ny fanamarinana dia mamaritra ny olana araka ny anaran'ny sehatra.
Jereo ny antontan-taratasinay momba ny API araka ny sokajy:
Mamorona, manamarina, mametraka, manova ny haben'ny ary manafoana mpizara, mamerina mametraka ny teny fanalahidin'ny faka, mametraka DNS miverina, mandefa baiko ary mitantana famaha SSH.
Jereo ny antontan-taratasyMampiseho ny lisitry ny tahirin-kevitra ao amin'ny mpizara, manomboka tahirin-kevitra vaovao, ary mamerina mpizara iray avy amin'ny tahirin-kevitra.
Jereo ny antontan-taratasyMaka sary an-tsary misy marika ny mpizara iray, mametraka azy ireo ho lisitra ary manafoana azy ireo.
Jereo ny antontan-taratasyAlaivo ny drafitra VPS misy sy ny fampahalalana momba ny vidiny. Mahazoa antsipiriany momba ny loharanon-karena, ny vidiny ary ny fahafahana miditra.
Jereo ny antontan-taratasyMametraka ny lisitr'ireo rafitra fiasa sy ny kinova azo apetraka, toy ny Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ary Alpine.
Jereo ny antontan-taratasyJereo ny fahafahana, ny fisoratana anarana sy ny fanavaozana ny domains, ary ny fametrahana ny mpizara anarana sy ny fanavaozana hoazy.
Jereo ny antontan-taratasyNy DNS dia mampiasa ny DNSSEC mba hamoronana, hanova ary hanafoana ny A, A, CNAME, MX, TXT, SRV, CAA ary ny raki-tatitra hafa.
Jereo ny antontan-taratasyMampiseho ny toerana azo ampiasaina amin'ny fampidirana mpizara.
Jereo ny antontan-taratasyMaka ny lazan'ny profiln'ny kaonty sy ny token'ny API. Fantaro izay kaonty misy ny token ary jereo ny fahazoan-dàlana.
Jereo ny antontan-taratasyAvelao ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna, ny volavolan-dalàna.
Jereo ny antontan-taratasyManana endpoints ho an'ny fampidirana rindran'asa ihany koa ny API (/api/v1/deploy-configs/ sy /api/v1/deployments/). Tsy mbola voalaza ao anatin'ireny pejy ireny izy ireny; ny rohy mifampiresaka dia manome lisitra ny endpoints tsirairay, nateraky ny API miasa.
Manokatra ny rohy API ifanaovanaRaha manana fanontaniana na mila fanampiana momba ny API ianao dia aza misalasala mifandray aminay: