VPS.org API

ឯកសារ REST API

ឯកសារ VPS.org API

បំពេញឯកសារ REST API សម្រាប់គ្រប់គ្រងម៉ាស៊ីនមេ VPS, ដែន, DNS, ការបម្រុងទុក និងច្រើនទៀត។

URL មូលដ្ឋាន https://admin.vps.org/api/v1
ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ ថូខឹនអ្នកកាន់
កំណែ v1
ទ្រង់ទ្រាយ JSON

ការចាប់ផ្តើម

API របស់ VPS.org អនុញ្ញាតឱ្យអ្នកគ្រប់គ្រងគ្រប់ទិដ្ឋភាពទាំងអស់នៃហេដ្ឋារចនាសម្ព័ន្ធបង្ហោះ VPS របស់អ្នកដោយកម្មវិធី រួមទាំងម៉ាស៊ីនមេ ដែន កំណត់ត្រា DNS ការបម្រុងទុក និងរូបថតអេក្រង់។

ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ

សំណើ API ទាំងអស់តម្រូវឱ្យមានការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវដោយប្រើ Bearer token។ អ្នកអាចបង្កើត API token របស់អ្នកពីការកំណត់គណនីរបស់អ្នកនៅ admin.vps.org/account/developers/.

cURL
Python
JavaScript
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 និង​វាល required_ permission ដែល​ដាក់​ឈ្មោះ​សិទ្ធិ​ដែល​បាត់ ។ សេចក្ដី​យោង​សិទ្ធិ

ការកំណត់អត្រា

សំណើ​ដែល​បាន​ផ្ទៀងផ្ទាត់​ភាព​ត្រឹមត្រូវ​មាន​ដែន​កំណត់​ទៅ​ 1000 ក្នុង​មួយ​ម៉ោង​ក្នុង​មួយ​គណនី ។ សំណើ​ដែល​មិន​បាន​ផ្ទៀងផ្ទាត់​ភាព​ត្រឹមត្រូវ​មាន​ដែន​កំណត់​ទៅ 100 ក្នុង​មួយ​ម៉ោង​ក្នុង​មួយ​អាសយដ្ឋាន IP ។ សំណើ​ដែល​លើស​ពី​ដែន​កំណត់​ទទួល​បាន 429 ជាមួយ​បឋមកថា​ព្យាយាម​ម្ដង​ទៀត​បន្ទាប់​ពី​ផ្ដល់​ចំនួន​វិនាទី​រង់ចាំ ។ គ្មាន​បឋមកថា​ដែន​កំណត់​អត្រា​ត្រូវ​បាន​ផ្ញើ​លើ​ការ​ឆ្លើយតប​ដែល​ជោគជ័យ ។

ការ​ដាក់​ទំព័រ

បញ្ជី​ចំណុច​បញ្ចប់​ត្រឡប់​វត្ថុ​មួយ​ជាមួយ​នឹង​ចំនួន​បន្ទាប់ មុន និង​លទ្ធផល ២៥ ធាតុ​ក្នុង​មួយ​ទំព័រ ។ ទំព័រ​ឆ្លងកាត់​ដើម្បី​ផ្លាស់ទី​រវាង​ទំព័រ ឬ​តាម​ដាន URL បន្ទាប់​រហូត​ដល់​វា​ទទេ ។ បញ្ជី​ម៉ាស៊ីន​បម្រើ​ក៏​ទទួល​យក page_ size រហូត​ដល់ ១០០ ។

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

ការដោះស្រាយកំហុស

API ប្រើប្រាស់លេខកូដស្ថានភាព HTTP ស្តង់ដារ ដើម្បីបង្ហាញពីភាពជោគជ័យ ឬបរាជ័យ៖

លេខកូដស្ថានភាព សេចក្ដី​ពិពណ៌នា
200 ជោគជ័យ - សំណើបានបញ្ចប់ដោយជោគជ័យ
201 បានបង្កើត - ធនធានត្រូវបានបង្កើតដោយជោគជ័យ
400 សំណើមិនល្អ - ប៉ារ៉ាម៉ែត្រមិនត្រឹមត្រូវ ឬសំណើមានទម្រង់មិនត្រឹមត្រូវ
202, 204 Accepted and queued (202), or deleted with no response body (204)
402 ការទូទាត់ចាំបាច់: គ្មានវិធីសាស្រ្តទូទាត់លើឯកសារ, ថ្លៃសេវាមិនបង់ប្រាក់ឬការអនុញ្ញាតមុនកាតដែលមិនទទួលយក
403 បាន​ហាមឃាត់ ៖ បាត់​តួអក្សរ​មិន​ត្រឹមត្រូវ ឬ​ផុត​កំណត់ ឬ​គ្មាន​សិទ្ធិ​ដែល​ត្រូវការ ។ ការ​ផ្ទៀងផ្ទាត់​ភាព​ត្រឹមត្រូវ​ដែល​បាន​បរាជ័យ​ក៏​ត្រឡប់ ៤០៣ ដែរ មិន​មែន ៤០១ ។
404 រកមិនឃើញ - ធនធានមិនមានទេ
409 ប៉ះទង្គិច ៖ ឧទាហរណ៍ ការ​ប្ដូរ​ទំហំ​កំពុង​តែ​ដំណើរការ​ហើយ សមត្ថភាព​មិន​គ្រប់គ្រាន់ ឬ​ការ​ដំឡើង​កំពុង​រត់​ហើយ
429 សំណើច្រើនពេក - លើសដែនកំណត់អត្រា
500 កំហុសម៉ាស៊ីនមេខាងក្នុង - មានអ្វីមួយខុសប្រក្រតីនៅខាងយើង
503 សេវា​មិន​អាច​ប្រើ​បាន ៖ បញ្ហា​បណ្ដោះ​អាសន្ន ។ ព្យាយាម​ម្ដង​ទៀត គោរព​ព្យាយាម​ម្ដង​ទៀត​បន្ទាប់​ពី​វា​ត្រូវ​បាន​ផ្ញើ ។

តួ​កំហុស​គឺ JSON ។ ភាគច្រើន​មាន​វាល​លម្អិត ឬ​វាល​កំហុស ពេល​ខ្លះ​មាន​សារ កំហុស​ធ្វើ​ឲ្យ​មាន​សុពលភាព​រាយ​បញ្ហា​តាម​ឈ្មោះ​វាល ។

ប្រភេទ API

រកមើលឯកសារ API របស់យើងតាមប្រភេទ៖

API ម៉ាស៊ីនបម្រើ 15 ចំណុចបញ្ចប់

បង្កើត ពិនិត្យ ថាមពល ប្ដូរ​ទំហំ និង​លុប​ម៉ាស៊ីន​បម្រើ កំណត់​ពាក្យ​សម្ងាត់ root ឡើងវិញ កំណត់ DNS ត្រឡប់ រត់​ពាក្យ​បញ្ជា និង​គ្រប់គ្រង​កូនសោ SSH ។

មើលឯកសារ
API បម្រុងទុក 4 ចំណុចបញ្ចប់

រាយ​បម្រុង​ទុក​ម៉ាស៊ីន​បម្រើ​របស់​អ្នក ចាប់ផ្ដើម​បម្រុង​ទុក​ថ្មី និង​ស្ដារ​ម៉ាស៊ីន​បម្រើ​ពី​បម្រុង​ទុក ។

មើលឯកសារ
API រូបភាព​សង្ខេប 4 ចំណុចបញ្ចប់

យក​រូបថត​ដែល​មាន​ស្លាក​របស់​ម៉ាស៊ីន​បម្រើ រាយ​ពួក​វា និង​លុប​ពួក​វា ។

មើលឯកសារ
API ផែនការ 2 ចំណុចបញ្ចប់

ទាញយក​ផែនការ VPS និងព័ត៌មានតម្លៃដែលមាន។ ទទួលបានព័ត៌មានលម្អិតអំពីធនធាន តម្លៃ និងភាពអាចរកបាន។

មើលឯកសារ
API ប្រព័ន្ធប្រតិបត្តិការ 2 ចំណុចបញ្ចប់

រាយ​បញ្ជី​ប្រព័ន្ធ​ប្រតិបត្តិការ និង​កំណែ​ដែល​អ្នក​អាច​ដំឡើង​បាន ដូចជា Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora និង Alpine ។

មើលឯកសារ
ដែន API 7 ចំណុចបញ្ចប់

ពិនិត្យមើលភាពអាចរកបាន, ចុះឈ្មោះនិងដែនថ្មី, និងកំណត់ម៉ាស៊ីនបម្រើឈ្មោះនិងស្វ័យប្រវត្តិ-ថ្មី.

មើលឯកសារ
API DNS 13 ចំណុចបញ្ចប់

បង្កើតតំបន់ DNS និងបង្កើត, ធ្វើបច្ចុប្បន្នភាពនិងលុប A, A, CNAME, MX, TXT, SRV, CAA និងកំណត់ត្រាផ្សេងទៀតរបស់ពួកគេ។

មើលឯកសារ
API ទីតាំង 2 ចំណុចបញ្ចប់

រាយ​ទីតាំង​ដែល​អាច​ប្រើ​បាន​សម្រាប់​ការ​ដំឡើង​ម៉ាស៊ីន​បម្រើ ។

មើលឯកសារ
គណនី 1 ចំណុចបញ្ចប់

យក​ទម្រង់​គណនី និង​ព័ត៌មាន​តួអក្សរ API & # 160; ។ កំណត់​អត្តសញ្ញាណ​គណនី​ដែល​តួអក្សរ​ជា​របស់​វា និង​ពិនិត្យ​មើល​សិទ្ធិ​របស់​វា & # 160; ។

មើលឯកសារ
ដៃគូ 7 ចំណុចបញ្ចប់

ដកសន្លឹកបៀរបស់អ្នក, ការណែនាំ, គណៈកម្មការនិងការទូទាត់ទៅក្នុងរបាយការណ៍ផ្ទាល់ខ្លួនរបស់អ្នក, ផ្លាស់ប្តូរការកំណត់ការទូទាត់និងសំណើការទូទាត់.

មើលឯកសារ

ចំណុច​បញ្ចប់​ច្រើន

API នេះ​ក៏​មាន​ចំណុច​បញ្ចប់​សម្រាប់​ការ​បញ្ជូន​កម្មវិធី (/ api / v1 / deploy-configs / និង / api / v1 / deployments /) ។ ពួកគេ​មិន​បាន​រៀបរាប់​នៅ​លើ​ទំព័រ​ទាំងនេះ​នៅ​ឡើយ​ទេ; សេចក្ដីយោង​អន្តរកម្ម​រាយ​បញ្ជី​ចំណុច​បញ្ចប់​ទាំងអស់, បង្កើត​ពី​ API រស់ ។

បើក​សេចក្ដី​យោង API អន្តរកម្ម

ត្រូវការជំនួយ?

ប្រសិនបើអ្នកមានសំណួរ ឬត្រូវការជំនួយជាមួយ API សូមកុំស្ទាក់ស្ទើរក្នុងការទាក់ទងមកយើងខ្ញុំ៖