API VPS, tự động hóa máy chủ cloud bằng JSON REST
API máy chủ cloud để xử lý bằng mã từ tạo đến xóa máy chủ
- JSON REST API
- Xác thực bằng khóa API (Bearer)
- 300 yêu cầu mỗi phút
API VPS là cách lập trình để thực hiện công việc bạn sẽ làm trong bảng điều khiển, chẳng hạn như tạo, khởi động, dừng và xóa máy chủ, với các yêu cầu HTTP. API máy chủ cloud HELPER VPS miễn phí cho tất cả thành viên; sau khi thanh toán đầu tiên, tạo khóa API và kết nối ngay lập tức.
REST API
Mọi thành viên
Miễn phí
Thanh toán hàng tháng
- JSON REST
- Khóa API (Bearer)
- 300 lần mỗi phút
- Miễn phí
Để xem ngay ví dụ yêu cầu và định dạng phản hồi Tài liệu API
Tự động hóa được gì bằng API VPS?
API VPS phát huy sức mạnh lớn nhất khi bạn thường xuyên tạo và xóa máy chủ hoặc quản lý nhiều máy chủ cùng lúc. Tổng hợp bốn kiểu tự động hóa hay dùng.
Tạo máy chủ trong pipeline triển khai
Trong pipeline triển khai như GitLab CI, tạo máy chủ thử nghiệm bằng yêu cầu POST /servers và xóa bằng yêu cầu DELETE khi thử xong. Máy chủ chỉ có khi cần nên chi phí gọn gàng.
Kiểm tra trạng thái máy chủ và quản lý nguồn
Đọc danh sách máy chủ, trạng thái, địa chỉ IPv4 và IPv6, ngày thanh toán tiếp theo bằng GET /servers, khi cần thì quản lý nguồn bằng yêu cầu start, stop, reboot. Kết nối với công cụ giám sát để tạo cả script khởi động lại máy chủ bị dừng.
Bán và vận hành máy chủ trong dịch vụ của bạn
Gọi API từ giao diện quản lý hay bot tự làm để tạo máy chủ và hiển thị kết quả. Đọc nguyên kích thước, khu vực, hệ điều hành, tùy chọn chọn được bằng danh mục bán GET /catalog để hiện lên giao diện.
Quản lý ngày thanh toán và gia hạn
Kiểm tra ngày thanh toán tiếp theo của mỗi máy chủ với giá trị paid_until, và gia hạn ngay lập tức với yêu cầu gia hạn cho các máy chủ bạn muốn trả trước cho khoảng thời gian dài hơn. Theo dõi hóa đơn và ngày thanh toán của bạn trong mã để duy trì các máy chủ quan trọng hoạt động ổn định.
Bảng điều khiển và API VPS, khi nào dùng cái nào?
Bảng điều khiển và API làm việc với cùng một tài khoản và cùng các máy chủ. Để quản lý một hoặc hai máy chủ bằng tay, bảng điều khiển thuận tiện; đối với công việc lặp lại hoặc nhiều máy chủ, API nhanh hơn.
Bảng điều khiển
Cách quản lý bằng cách nhấn trên giao diện
Phù hợp với
- Khi lần đầu tạo thử máy chủ
- Khi tự quản lý một hai máy chủ
- Cài lại hệ điều hành và đăng ký khóa SSH
- Khi cần xem lại mật khẩu root
VPS API
Cách quản lý bằng yêu cầu từ mã
Phù hợp với
- Môi trường thử nghiệm thường xuyên tạo và xóa máy chủ
- Pipeline triển khai và tự động hóa bằng script
- Khi đọc trạng thái nhiều máy chủ cùng lúc
- Khi kết nối với giao diện quản lý hay bot tự làm
Kết nối API máy chủ cloud như thế nào?
Có ba bước. Đầu tiên, thực hiện thanh toán đầu tiên của bạn, và một khi được xác nhận, tạo khóa trên trang khóa API. Tiếp theo, đặt khóa vào tiêu đề Authorization của mọi yêu cầu bằng cách sử dụng sơ đồ Bearer. Cuối cùng, gửi yêu cầu đến đường dẫn bạn muốn sau địa chỉ cơ sở https://helpervps.com/api/v1, và kết quả trả về dưới dạng JSON.
Lúc đầu nên gọi thử GET /catalog. Trả về cùng lúc các loại và kích thước máy chủ chọn được hiện tại, mã khu vực, mã hệ điều hành và ứng dụng một cú nhấp, giá sao lưu tự động, ổ đĩa bổ sung, chống DDoS. Chỉ cần đưa nguyên mã plan, location, image nhận ở đây vào yêu cầu tạo máy chủ.
Để tạo máy chủ, gửi các giá trị plan, location, image và label dưới dạng JSON đến POST /servers. Bạn cũng có thể bao gồm ID của khóa SSH bạn đã thêm và các tùy chọn backups, extra_disk_gb và ddos_protection. Bạn trả trước cho khoảng thời gian đã chọn, và phản hồi chứa ID máy chủ, trạng thái và mật khẩu root, vì vậy hãy lưu chúng ở nơi an toàn ngay lập tức.
Làm được những thao tác gì bằng API VPS?
API VPS xử lý toàn bộ vòng đời máy chủ từ đầu đến cuối. Đọc danh mục bán bằng GET /catalog, tạo máy chủ bằng POST /servers, đọc danh sách máy chủ bằng GET /servers, thông tin một máy chủ bằng GET /servers/{id}. Phản hồi gồm tên máy chủ, trạng thái, địa chỉ IPv4 và IPv6, phí hàng tháng, tùy chọn đã chọn, ngày thanh toán tiếp theo.
Nguồn được bật, tắt, khởi động lại bằng yêu cầu POST /servers/{id}/start, stop, reboot. POST /servers/{id}/renew trả ngay phí một tháng để gia hạn mà không đợi ngày thanh toán, DELETE /servers/{id} xóa máy chủ. Nếu yêu cầu không khớp trạng thái hiện tại của máy chủ, sẽ báo bằng mã wrong_state để script dễ quyết định bước tiếp theo.
Lỗi trả về dạng JSON chứa giá trị error kèm mã trạng thái. Lý do được chia bằng mã như khóa không đúng là unauthorized, thiếu số dư là not_enough_balance, số máy chủ của tài khoản chạm giới hạn là limit, nhiều yêu cầu là rate_limited, nên dễ xử lý theo từng tình huống trong chương trình. Danh sách đầy đủ và ví dụ phản hồi có trong tài liệu API.
Phí API VPS là bao nhiêu?
API VPS miễn phí cho tất cả thành viên. Máy chủ và các tùy chọn được tạo bằng API được thanh toán với cùng giá như máy chủ được tạo trong bảng điều khiển.
Dùng API miễn phí
Không có phí cho việc cấp khóa API hoặc thực hiện yêu cầu. Bất kỳ thành viên nào đã thực hiện thanh toán đầu tiên đều có thể tạo khóa và sử dụng ngay lập tức.
300 yêu cầu mỗi phút
Một khóa gửi tối đa 300 yêu cầu mỗi phút. Giới hạn dư dả cho tự động hóa hằng ngày như xem danh sách máy chủ và quản lý nguồn.
Cùng giá với bảng điều khiển
Máy chủ tạo bằng API có cùng giá như bảng giá, các tùy chọn được thêm vào với cùng số tiền và chúng sẽ gia hạn vào mỗi ngày thanh toán.
HELPER VPS qua các con số
Chọn từ 40 khu vực, 12 hệ điều hành và 10 ứng dụng một cú nhấp trong một tài khoản, và thanh toán ngay lập tức. Các con số dưới đây dựa trên những gì đang được bán hiện tại.
40
Khu vực trung tâm dữ liệu
12
Hệ điều hành
10
Ứng dụng một cú nhấp
Miễn phí
Giá khởi điểm sản phẩm này (tháng)
Công cụ tự động hóa dùng cùng API VPS
Công cụ nào gửi được yêu cầu HTTP đều kết nối được với API VPS. Từ một dòng curl đến script Python, Node.js, pipeline triển khai đều dùng cùng một cách.
- Terraform
- Python
- Node.js
- GitLab CI
- Docker
Lý do chọn API của HELPER VPS
JSON REST đơn giản
Gửi yêu cầu và nhận phản hồi bằng phương thức HTTP và JSON quen thuộc. Không cần thư viện riêng, thử ngay bằng curl.
Xác thực bằng khóa API (Bearer)
Kiểu đặt một khóa vào tiêu đề Authorization nên xác thực cùng cách trên mọi ngôn ngữ và công cụ.
300 yêu cầu mỗi phút
Một khóa gửi tối đa 300 yêu cầu mỗi phút, xử lý dư dả việc kiểm tra trạng thái và quản lý nguồn nhiều máy chủ.
Danh mục bán bằng mã
Đọc kích thước, khu vực, hệ điều hành, giá tùy chọn bằng GET /catalog để dùng nguyên trên giao diện và script của bạn.
Từ tạo đến xóa
Xử lý tất cả bằng API: tạo máy chủ, danh sách, bật, tắt, khởi động lại, gia hạn, xóa.
Chọn cả tùy chọn
Khi tạo máy chủ, đưa cùng sao lưu tự động, ổ đĩa bổ sung, chống DDoS, khóa SSH vào một yêu cầu.
Mã lỗi thấy rõ lý do
Các lý do lỗi được chia thành mã, như thiếu số dư tài khoản, giới hạn máy chủ và không khớp trạng thái, nên dễ xử lý trong chương trình của bạn.
Cùng tài khoản với bảng điều khiển
Máy chủ tạo bằng API xuất hiện trong bảng điều khiển như chúng vốn có và được thanh toán và gia hạn theo cùng cách.
Miễn phí cho mọi thành viên
Khi bạn thực hiện thanh toán đầu tiên, hãy tạo khóa API miễn phí và bắt đầu tự động hóa ngay lập tức.
Câu hỏi thường gặp về API VPS
Câu trả lời về kết nối, xác thực, giới hạn yêu cầu của API VPS
API VPS có miễn phí không?
Có, API VPS miễn phí cho tất cả thành viên. Cấp khóa API và gửi yêu cầu đều miễn phí, máy chủ và các tùy chọn tạo bằng API được thanh toán với cùng giá như khi tạo trong bảng điều khiển. Bất kỳ thành viên nào đã thực hiện thanh toán đầu tiên đều có thể tạo khóa ngay trên trang khóa API.
Tạo khóa API ở đâu?
Khi bạn thực hiện thanh toán đầu tiên, trang khóa API (/api-key) sẽ mở và bạn có thể tạo khóa tại đó. Đặt khóa vào tiêu đề Authorization của mỗi yêu cầu bằng cách sử dụng Bearer scheme. Khóa này mở khóa toàn bộ tài khoản của bạn, vì vậy đừng đưa nó vào kho mã; hãy giữ nó trong biến môi trường hoặc kho lưu trữ bí mật.
Làm được những thao tác gì bằng API?
Đọc danh mục bán (GET /catalog), đọc danh sách máy chủ và thông tin một máy chủ (GET /servers, GET /servers/{id}), tạo máy chủ (POST /servers), bật, tắt và khởi động lại (start, stop, reboot), gia hạn một tháng (renew), xóa (DELETE /servers/{id}). Ví dụ yêu cầu và định dạng phản hồi có trong tài liệu API.
Giới hạn yêu cầu là bao nhiêu?
Một khóa gửi tối đa 300 yêu cầu mỗi phút. Vượt giới hạn sẽ trả về mã trạng thái 429 và lỗi rate_limited, nên trong script chỉ cần xử lý chờ một chút rồi gửi lại. Tự động hóa hằng ngày như xem danh sách máy chủ và quản lý nguồn hoạt động dư dả trong giới hạn này. Không tính phí theo số yêu cầu.
Tạo máy chủ bằng API thì phí được trừ thế nào?
Khi yêu cầu POST /servers thành công, khoản thanh toán cho chu kỳ thanh toán bạn chọn sẽ được xử lý và máy chủ sẽ được tạo. Khoản thanh toán cho máy chủ không tạo thành công sẽ được hoàn lại vào số dư tài khoản của bạn.
Nhận mật khẩu root qua API như thế nào?
Phản hồi của yêu cầu tạo máy chủ chứa giá trị root_password một lần. Nhận phản hồi là lưu ngay ở nơi an toàn. Trên bảng điều khiển cũng xem lại được trong 7 ngày, và gửi kèm số khóa SSH là kết nối ngay bằng khóa không cần mật khẩu. Bắt đầu kết nối SSH ngay bằng giá trị ipv4 trong phản hồi, rất tiện để nối với script triển khai.
Có đưa khóa SSH vào bằng API được không?
Có, đưa số khóa SSH đã đăng ký vào giá trị ssh_key_id trong yêu cầu tạo máy chủ là khóa đó được đưa vào máy chủ mới. Đăng ký khóa một lần trên màn hình khóa SSH của bảng điều khiển, dấu vân tay hiển thị như ssh-keygen để nhận ra ngay khóa nào. Số khóa định một lần rồi dùng lại.
Dùng được bằng ngôn ngữ hay công cụ nào?
Gửi được yêu cầu HTTP là ngôn ngữ và công cụ nào cũng được. Thử ngay bằng curl, và gọi bằng cùng địa chỉ và tiêu đề từ requests của Python, fetch của Node.js, bước script của GitLab CI, chức năng yêu cầu HTTP của Terraform. Phản hồi đều là JSON nên dễ đọc kết quả.
Có lỗi thì biết bằng cách nào?
Lỗi trả về dạng JSON chứa giá trị error kèm mã trạng thái không phải 2xx. Lý do được chia như khóa sai là unauthorized, thiếu giá trị là bad_request, thiếu số dư là not_enough_balance, yêu cầu không khớp trạng thái máy chủ là wrong_state để chương trình xử lý theo tình huống.
Máy chủ tạo bằng API có hiện trong bảng điều khiển không?
Có, API và bảng điều khiển làm việc với cùng tài khoản và cùng máy chủ. Máy chủ tạo bằng API hiện nguyên trong danh sách bảng điều khiển, và trên bảng điều khiển bạn cài lại hệ điều hành hay xem mật khẩu được. Giới hạn 10 máy chủ mỗi tài khoản áp dụng chung cho cả hai cách. Trộn thao tác tay và thao tác bằng mã thì trạng thái và ngày thanh toán vẫn luôn hiển thị như nhau.
Hướng dẫn API VPS
Hướng dẫn nên đọc khi lần đầu kết nối API
- Tài liệu APIDanh sách đầy đủ địa chỉ gốc, tiêu đề xác thực, ví dụ yêu cầu và định dạng phản hồi theo đường dẫn, mã lỗi.
- Tạo và đăng ký khóa SSHCách tạo và đăng ký khóa SSH để kết nối ngay bằng khóa vào máy chủ tạo bằng API.
- Bảng giá trong nháy mắtSo sánh trong một trang phí hàng tháng của các kích thước máy chủ và tùy chọn chọn được qua API.
API VPS miễn phí cho tất cả thành viên và bạn có thể tạo khóa API sau khi thực hiện thanh toán đầu tiên. Máy chủ và các tùy chọn tạo bằng API được thanh toán với cùng giá như bảng giá và tự động gia hạn với cùng số tiền vào mỗi ngày thanh toán.
Giới hạn yêu cầu: 300 mỗi phút cho mỗi khóa API | 10 máy chủ mỗi tài khoản | Nếu thanh toán thất bại: máy chủ bị tạm dừng, sau đó bị xóa sau 3 ngày | Thời gian còn lại trên máy chủ đã xóa sẽ không được hoàn lại. Các khoản hoàn tiền sẽ được chuyển vào số dư tài khoản của bạn.
