VPS.org ເອກະສານ API

ການເລີ່ມຕົ້ນ

VPS.org API ຊ່ວຍໃຫ້ທ່ານສາມາດຈັດການທຸກດ້ານຂອງໂຄງສ້າງພື້ນຖານການໂຮດຕິ້ງ VPS ຂອງທ່ານດ້ວຍໂປຣແກຣມ, ລວມທັງເຊີບເວີ, ໂດເມນ, ບັນທຶກ DNS, ການສຳຮອງຂໍ້ມູນ ແລະ snapshots.

ການພິສູດຢືນຢັນຕົວຕົນ

ການຮ້ອງຂໍ 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);

ທຸກໆ token ຈະມີສິດອຳນາດຂອງຕົນເອງ, ເຊັ່ນ servers: list ຫຼື dns: *. ຄໍາຮ້ອງຂໍທີ່ຕ້ອງການສິດອຳນາດທີ່ token ບໍ່ມີຈະຖືກປະຕິເສດດ້ວຍ 403 ແລະ required_permission field ຊື່ສິດອຳນາດທີ່ຂາດໄປ. ສິດ​ອ້າງອີງ

ການຈຳກັດອັດຕາ

ຄໍາຮ້ອງຂໍ​ທີ່​ໄດ້​ຮັບ​ການ​ຢັ້ງຢືນ​ແມ່ນ​ມີ​ຂອບເຂດ​ຈຳກັດ​ຢູ່​ທີ່ 1,000 ຕໍ່​ຊົ່ວໂມງ​ຕໍ່​ບັນຊີ. ຄໍາຮ້ອງຂໍ​ທີ່​ບໍ່​ໄດ້​ຮັບ​ການ​ຢັ້ງຢືນ​ແມ່ນ​ມີ​ຂອບເຂດ​ຈຳກັດ​ຢູ່​ທີ່ 100 ຕໍ່​ຊົ່ວໂມງ​ຕໍ່​ທີ່ຢູ່ IP. ຄໍາຮ້ອງຂໍ​ທີ່​ເກີນ​ຂອບເຂດ​ຈະ​ໄດ້ຮັບ 429 ພ້ອມ​ກັບ​ຫົວ​ຂໍ້ Retry- After ​ທີ່​ໃຫ້​ຈຳນວນ​ວິນາທີ​ທີ່​ຈະ​ລໍຖ້າ. ບໍ່ມີ​ຫົວ​ຂໍ້​ຈໍາກັດ​ອັດຕາ​ຈະ​ຖືກ​ສົ່ງ​ເມື່ອ​ຕອບ​ຮັບ​ໄດ້​ດີ.

ຕົວ​ເລກ​ໜ້າ

ລາຍຊື່​ຈຸດ​ຈົບ​ສົ່ງ​ຄືນ​ສິ່ງ​ທີ່​ມີ​ຈໍານວນ, ຕໍ່ໄປ, ກ່ອນ​ໜ້າ ແລະ ຜົນ​ໄດ້​ຮັບ, 25 ລາຍການ​ຕໍ່​ໜ້າ. ສົ່ງ​ໜ້າ​ໄປ​ເພື່ອ​ເຄື່ອນ​ໄຫວ​ລະຫວ່າງ​ໜ້າ ຫຼື ຕາມ​ URL ຕໍ່ໄປ​ຈົນ​ກວ່າ​ມັນຈະ​ເປັນ​ລົບ. ລາຍຊື່​ເຊີບເວີ​ຍັງ​ຮັບ​ເອົາ page_ size, ເຖິງ 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
• ເອກະສານ: ເອກະສານຄົບຖ້ວນ