微信扫一扫article
README
🚀 虚拟机管理API文档
本API文档提供了一系列用于管理虚拟机的接口，涵盖了虚拟机的创建、查询、更新、删除以及状态控制等功能，方便用户对虚拟机进行全面管理。
🚀 快速开始
以下是各个接口的详细信息：
📚 详细文档
1. 获取虚拟机状态
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId} - 请求方式：
GET - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于获取指定虚拟机的详细信息，包括运行状态、配置和资源使用情况等。
2. 创建新虚拟机
- 接口地址：
/api/vps/v1/virtual-machines - 请求方式：
POST - 参数：
template_id：模板ID（必需）data_center_id：数据中心ID（必需）post_install_script_id：事后安装脚本IDpassword：虚拟机密码，若未提供则自动生成随机密码。hostname：自定义主机名install_monarx：是否安装Monarx恶意软件扫描程序（如果支持）enable_backups：是否启用每周备份计划
- 说明：此接口用于创建一个新的虚拟机实例，参数包括模板选择、数据中心位置、脚本配置等。
3. 更新虚拟机信息
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId} - 请求方式：
PUT - 参数：
virtualMachineId：虚拟机ID（必需）hostname：新的主机名template_id：新模板IDdata_center_id：新数据中心IDpost_install_script_id：新事后安装脚本IDpassword：新密码
- 说明：此接口用于更新指定虚拟机的信息，包括主机名、模板、数据中心等配置。
4. 删除虚拟机
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId} - 请求方式：
DELETE - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于删除指定的虚拟机实例。
5. 获取所有虚拟机列表
- 接口地址：
/api/vps/v1/virtual-machines - 请求方式：
GET - 参数：无
- 说明：此接口用于获取所有用户拥有的虚拟机列表，返回每个虚拟机的ID、主机名、状态等信息。
6. 启动虚拟机
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/start - 请求方式：
POST - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于启动指定的虚拟机实例，若虚拟机已运行，则无任何效果。
7. 停止虚拟机
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/stop - 请求方式：
POST - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于停止指定的虚拟机实例，若虚拟机已关闭，则无任何效果。
8. 重启虚拟机
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/restart - 请求方式：
POST - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于重启指定的虚拟机实例，相当于完全停止后再启动。
9. 获取虚拟机快照
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot - 请求方式：
GET - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于获取指定虚拟机的快照信息。
10. 创建虚拟机快照
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot - 请求方式：
POST - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于创建指定虚拟机的快照，捕获当前状态和数据。注意：创建新快照会覆盖现有快照。
11. 删除虚拟机快照
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot - 请求方式：
DELETE - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于删除指定虚拟机的快照。
12. 恢复虚拟机快照
- 接口地址：
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot - 请求方式：
PUT - 参数：
virtualMachineId：虚拟机ID（必需）
- 说明：此接口用于将指定虚拟机恢复到其快照状态。