VPS.org API ஆவணமாக்கல்

தொடங்குதல்

VPS.org API, சேவையகங்கள், டொமைன்கள், DNS பதிவுகள், காப்புப்பிரதிகள் மற்றும் ஸ்னாப்ஷாட்கள் உட்பட உங்கள் VPS ஹோஸ்டிங் உள்கட்டமைப்பின் அனைத்து அம்சங்களையும் நிரல் ரீதியாக நிர்வகிக்க உங்களை அனுமதிக்கிறது.

அங்கீகாரம்

அனைத்து API கோரிக்கைகளுக்கும் Bearer டோக்கனைப் பயன்படுத்தி அங்கீகாரம் தேவைப்படுகிறது. உங்கள் கணக்கு அமைப்புகளிலிருந்து உங்கள் API டோக்கனை உருவாக்கலாம் 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);

ஒவ்வொரு டாக்கனும் அதன் சொந்த அனுமதிகளைக் கொண்டுள்ளது, servers:list அல்லது dns:* போன்றவை. டாக்கனுக்கு அனுமதி தேவைப்படும் ஒரு கோரிக்கை, டாக்கனுக்கு இல்லை என்றால், 403 மற்றும் missing_permission என்ற புலத்தில் காணப்படாத அனுமதியை பெயர் மாற்றி நிராகரிக்கப்படும். அனுமதிகள் குறிப்பு

விகித வரம்பு

உறுதிப்படுத்தப்பட்ட கோரிக்கைகள் கணக்கிற்கு மணிக்கு 1000 வரை வரையறுக்கப்பட்டுள்ளது. உறுதிப்படுத்தப்படாத கோரிக்கைகள் IP முகவரிக்கு மணிக்கு 100 வரையறுக்கப்பட்டுள்ளது. வரம்புக்கு மேல் கோரிக்கை பெறப்படும் 429 மற்றும் Retry-After தலைப்பு எதிர்பார்க்க வேண்டிய நொடிகளின் எண்ணிக்கையை தரும். வெற்றிகரமான பதில்களில் எந்த விகித வரம்பு தலைப்புகளும் அனுப்பப்படுவதில்லை.

பக்கம்

பட்டியல் முடிவு புள்ளிகள் எண்ணிக்கை, அடுத்த, முந்தைய மற்றும் முடிவுகளுடன் ஒரு பொருளை திரும்பத் தரும், ஒவ்வொரு பக்கத்திற்கும் 25 பொருள்கள். பக்கங்களுக்கு இடையே நகர்த்த பக்கத்தை நகர்த்து, அல்லது அடுத்த URL ஐ பின்பற்று அது நூலாக இருக்கும் வரை. சேவையக பட்டியல் பக்க அளவை ஏற்றுக் கொள்கிறது, 100 வரை.

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

பிழை கையாளுதல்

வெற்றி அல்லது தோல்வியைக் குறிக்க API நிலையான HTTP நிலைக் குறியீடுகளைப் பயன்படுத்துகிறது:

பிழை உடல் JSON. பெரும்பாலானவை விவர புலத்தை அல்லது பிழை புலத்தை கொண்டுள்ளன, சில சமயங்களில் ஒரு செய்தி; சரிபார்ப்பு பிழைகள் புலப் பெயரின்படி பிரச்சனைகளை பட்டியலிடுகிறது.

API வகைகள்

வகை வாரியாக எங்கள் API ஆவணங்களை உலாவுக:

அதிக முடிவு புள்ளிகள்

API க்கு பயன்பாடுகள் நிறுவ முடிவதற்கான முடிவு புள்ளிகளும் உள்ளன (/api/v1/deploy-configs/ மற்றும் /api/v1/deployments/). இவை இந்த பக்கங்களில் இன்னும் விவரிக்கப்படவில்லை; ஒவ்வொரு முடிவு புள்ளிகளையும் பட்டியலிடும் நேரடி API யிலிருந்து உருவாக்கப்பட்டுள்ள இடைமுகம்.

உதவி தேவை?

API தொடர்பாக ஏதேனும் கேள்விகள் இருந்தால் அல்லது உதவி தேவைப்பட்டால், தயங்காமல் எங்களைத் தொடர்பு கொள்ளவும்:

• ஆதரவு டிக்கெட்டுகள்: ஆதரவு டிக்கெட்டைத் திறக்கவும்
• மின்னஞ்சல்: hello@vps.org
• ஆவணமாக்கம்: முழு ஆவணம்