VPS.org API ကိုစာရွက်စာတမ်းများ

စတင်အသုံးပြုခြင်း

VPS.org API သည် ဆာဗာများ၊ ဒိုမိန်းများ၊ DNS မှတ်တမ်းများ၊ အရန်ကူးယူမှုများနှင့် snapshot များ အပါအဝင် သင်၏ VPS hosting infrastructure ၏ ရှုထောင့်အားလုံးကို ပရိုဂရမ်ဖြင့် စီမံခန့်ခွဲနိုင်စေပါသည်။

အထောက်အထားစိစစ်ခြင်း

API တောင်းဆိုမှုအားလုံးသည် Bearer token ကို အသုံးပြု၍ အထောက်အထားစိစစ်ခြင်း လိုအပ်ပါသည်။ သင်၏အကောင့်ဆက်တင်များမှ သင်၏ API token ကို generate လုပ်နိုင်ပါသည်။ 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);

တစ်ခုချင်းစီကို token ကိုထိုကဲ့သို့သော servers: list သို့မဟုတ် dns: * အဖြစ်သူ့ကိုယ်ပိုင်ခွင့်ပြုချက်ကိုဆောင်ကြဉ်း. အဆိုပါ token ကိုမရှိဘဲခွင့်ပြုချက်လိုအပ်သောတစ်ဦးတောင်းဆိုချက်ကို 403 နှင့်အတူငြင်းပယ်သည်နှင့် missing ခွင့်ပြုချက်ကိုခေါ် required_permission ဧရိယာ. ခွင့်ပြုချက် ရည်ညွှန်းချက်

နှုန်းထားကန့်သတ်ခြင်း

Authenticated requests are limited to 1,000 per hour per account. Unauthenticated requests are limited to 100 per hour per IP address. စည်းကမ်းချက်ထက်တစ်ဦးတောင်းဆိုချက်ကိုလက်ခံရရှိ 429 စောင့်ရှောက်ဖို့စက္ကန့်အရေအတွက်ပေးခြင်းတစ်ဦး Retry-After header နဲ့အတူ. No rate limit headers are sent on successful responses.

စာမျက်နှာ

စာရင်း endpoints စာရင်း, နောက်ထပ်, ယခင်နှင့်ရလဒ်များ, 25 စာမျက်နှာတစ်မျက်နှာလျှင် items များကိုအတူ object ကိုပြန်ပေးပို့. စာမျက်နှာများအကြားသွားလာဖို့စာမျက်နှာကိုဖြတ်သန်း, ဒါမှမဟုတ် null ဖြစ်ပါသည်အထိနောက်ထပ် URL ကိုလိုက်နာ. ဆာဗာများစာရင်းကိုလည်း page_size ကိုလက်ခံရရှိ, 100 အထိ.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

အမှားအယွင်းကိုင်တွယ်ခြင်း

API သည် အောင်မြင်မှု သို့မဟုတ် ကျရှုံးမှုကို ဖော်ပြရန် စံ HTTP status ကုဒ်များကို အသုံးပြုသည်-

Error body များ JSON များဖြစ်ကြသည်။ အများစုမှာအသေးစိတ် Field ကိုသို့မဟုတ်အမှား Field ကိုရှိပါတယ်, တစ်ခါတစ်ရံတွင်တစ်ဦးမက်ဆေ့ခ်ျနှင့်အတူ; validation errors field name အားဖြင့်ပြဿနာများကိုစာရင်းပြုစု။

API အမျိုးအစားများ

ကျွန်ုပ်တို့၏ API စာရွက်စာတမ်းများကို အမျိုးအစားအလိုက် ကြည့်ရှုပါ-

အခြားအဆုံးသတ်ချက်

API ကို app ကိုဖြန့်ချိများအတွက် endpoints ရှိပါတယ် (/ api / v1 / deploy-configs / နှင့် / api / v1 / deployments / ). သူတို့ကဒီစာမျက်နှာများပေါ်တွင်အသေးစိတ်မဖော်ပြကြသေးပါဘူး; အားလုံး endpoints တွေကိုအပြန်အလှန်အကြံပြုစာရင်း, သက်သေခံ API ကိုမှ generated.

အကူအညီ လိုအပ်ပါသလား။

API နှင့် ပတ်သက်၍ မေးခွန်းများရှိပါက သို့မဟုတ် အကူအညီလိုအပ်ပါက အောက်ပါလိပ်စာသို့ ဆက်သွယ်ရန် တုံ့ဆိုင်းမနေပါနှင့်-

• ပံ့ပိုးမှုလက်မှတ်များ- ပံ့ပိုးမှုလက်မှတ်တစ်ခုဖွင့်ပါ
• အီးမေးလ်- hello@vps.org
• စာရွက်စာတမ်းများ - စာရွက်စာတမ်းအပြည့်အစုံ