Tổng quan API quản lý vòng đời VM

Hướng dẫn REST API đầy đủ cho quản lý vòng đời máy ảo trong VergeOS - tạo, quản lý, cấu hình và xóa VM bằng chương trình

Các điểm chính

• REST API hoàn chỉnh cho quản lý vòng đời và tự động hóa máy ảo
• Tạo, cấu hình, quản lý và xóa VM theo chương trình bằng các điểm cuối HTTP
• Luồng công việc API bốn giai đoạn: Tạo → Quản lý nguồn điện → Cấu hình → Thao tác nâng cao
• Tài liệu API toàn diện được tối ưu cho nhà phát triển và công cụ tự động hóa

Giai đoạn: Tổng quan API (Điểm vào) Đầu vào: Yêu cầu của nhà phát triển, nhu cầu tự động hóa Đầu ra: Quy trình hướng dẫn đến tài liệu API cụ thể Đường dẫn điều hướng:

• Bắt đầu tại đây → Chọn thao tác cụ thể → Làm theo các hướng dẫn chi tiết
• Vòng đời hoàn chỉnh: Tạo → Nguồn điện → Cấu hình → Nâng cao

Tài liệu này hỗ trợ

• "Tổng quan API VM và bắt đầu"
• "Luồng công việc REST API cho quản lý VM"
• "Tài liệu tham chiếu điểm cuối API và điều hướng"
• "Hướng dẫn nhập môn cho nhà phát triển về VergeOS APIs"
• "Lập kế hoạch hạ tầng dưới dạng mã"
• "Thiết kế luồng công việc tự động hóa"
• "Hướng dẫn tích hợp API"
• "Chiến lược tự động hóa quản lý VM"

Các giai đoạn luồng công việc API

1. API Tạo VM

Tạo máy ảo theo chương trình với ổ đĩa, thiết bị và giao diện mạng bằng các lệnh gọi REST API. → Xem: Tạo VM

2. API Quản lý nguồn điện VM

Khởi động, tắt, khởi động lại và giám sát trạng thái nguồn của VM thông qua các điểm cuối API. → Xem: Quản lý nguồn VM

3. API Cấu hình VM

Sửa đổi CPU, RAM, ổ lưu trữ và cài đặt mạng thông qua các lệnh gọi API. → Xem: Cấu hình VM

4. API Thao tác VM nâng cao

Sao chép VM, tạo snapshot, xóa máy ảo và khắc phục sự cố bằng các phương thức API. → Xem: Các thao tác nâng cao của VM

Các khái niệm API chính

• VM Key so với Machine Key: Phân biệt API cho cài đặt VM và thao tác phần cứng
• Xác thực REST API: Yêu cầu xác thực bằng token Bearer cho mọi lệnh gọi API
• Nhóm tài nguyên: Tham số API dựa trên UUID cho passthrough thiết bị (GPU, thiết bị PCI)
• Bậc lưu trữ: Các mức hiệu năng có thể cấu hình bằng API (1-5) cho việc đặt ổ đĩa
• Phương thức HTTP: Các thao tác GET, POST, PUT, DELETE cho quản lý đầy đủ vòng đời VM

Các điểm cuối API chính

Thao tác API	Phương thức HTTP	Điểm cuối REST	Mục đích
Tạo VM	POST	/api/v4/vms	Tạo máy ảo mới
Hành động VM	POST	/api/v4/vm_actions	Thao tác nguồn điện, sao chép, snapshot
Cập nhật VM	PUT	/api/v4/vms/{id}	Sửa đổi cấu hình VM
Thêm lưu trữ	POST	/api/v4/machine_drives	Gắn ổ đĩa vào VM
Thêm mạng	POST	/api/v4/machine_nics	Cấu hình giao diện mạng
Thêm thiết bị	POST	/api/v4/machine_devices	Gắn thiết bị GPU/PCI
Xóa VM	DELETE	/api/v4/vms/{id}	Xóa máy ảo
Trạng thái VM	GET	/api/v4/vms/{id}	Truy vấn thông tin VM
Trạng thái nguồn điện	GET	/api/v4/machine_status/{id}	Kiểm tra trạng thái thời gian chạy

Tham khảo nhanh API theo giai đoạn

Giai đoạn	Các thao tác chính	Các điểm cuối chính	Tài liệu
Tạo	Tạo VM, Thêm ổ đĩa, Thêm NIC, Thêm thiết bị	POST /api/v4/vms, POST /api/v4/machine_*	Tạo VM
Nguồn điện	Khởi động, Tắt, Khởi động lại, Giám sát	POST /api/v4/vm_actions, GET /api/v4/machine_status	Quản lý nguồn VM
Cấu hình	Cập nhật CPU/RAM, Quản lý ổ đĩa, Quản lý NIC	PUT /api/v4/vms, POST/PUT/DELETE /api/v4/machine_*	Cấu hình VM
Nâng cao	Sao chép, Snapshot, Xóa, Khắc phục sự cố	POST /api/v4/vm_actions, DELETE /api/v4/vms	Các thao tác nâng cao của VM

Các tình huống lỗi API thường gặp

• Sự cố xác thực: Khóa API không hợp lệ, token hết hạn, quyền không đủ
• Giới hạn tài nguyên: Không đủ dung lượng lưu trữ, giới hạn bộ nhớ, vượt quá hạn ngạch CPU
• Lỗi cấu hình: Tham số không hợp lệ, thiếu trường bắt buộc, JSON sai định dạng
• Xung đột trạng thái: VM đã đang chạy, thao tác đang diễn ra, tài nguyên bị khóa
• Sự cố mạng: Hết thời gian chờ API, từ chối kết nối, dịch vụ không khả dụng
• Lỗi xác thực dữ liệu: Tên VM không hợp lệ, cấu hình không được hỗ trợ, vi phạm ràng buộc

Hướng dẫn bắt đầu với API

1. Tạo VM - Các lệnh gọi REST API để tạo máy ảo
2. Điều khiển nguồn điện - Các điểm cuối API để khởi động, tắt và quản lý VM
3. Cấu hình VM - Các phương thức API để sửa đổi cài đặt và phần cứng VM
4. Các thao tác nâng cao - Các lệnh gọi API để sao chép, sao lưu và khắc phục sự cố

Các trường hợp sử dụng API phổ biến

• Cấp phát VM tự động: Tạo VM theo chương trình cho tự động hóa đám mây
• Hạ tầng dưới dạng mã: Quản lý hạ tầng máy ảo thông qua các lệnh gọi API
• Tích hợp DevOps: Tích hợp quản lý VM vào các pipeline CI/CD bằng REST API
• Giám sát và cảnh báo: Truy vấn trạng thái VM và trạng thái nguồn điện qua các điểm cuối API
• Sao lưu và khôi phục: Tự động hóa snapshot và sao chép VM thông qua các thao tác API
• Quản lý tài nguyên: Quản lý theo chương trình CPU, bộ nhớ và phân bổ lưu trữ của VM

Xác thực API

Tất cả các điểm cuối API vòng đời VM đều yêu cầu xác thực:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://your-vergeos.example.com/api/v4/vms

Bắt đầu với tài liệu API Tạo VM để khởi đầu tự động hóa quy trình quản lý máy ảo của bạn.