此接口采用强制关闭虚拟机电源,非需要不建议强制关闭电源,可能会导致系统无法进入桌面现象。
请求地址:
请求地址 | 请求方法 |
/api/vm/offpower | POST |
请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
vmid | String | 是 | 32 | 虚拟机ID | |
mode | int | 否 | 1 | 响应模式:0同步、1异步,默认为1,各差异如下: 同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败) 异步:服务器会立即响应客户端,通过任务ID获得任务执行结果 | |
clientid | String | 是 | 32 | 代理客户端ID |
异步返回示例
{ "errcode": "200", "errmsg": "ok", "data": { "vmid": "32", "taskid": "121e6a4682502fb8ad89a12444c40008" } }
异步返回参数说明
参数 | 描述 |
vmid | 虚拟机ID |
taskid | 任务ID,可用于获取任务执行信息 |
同步返回示例
{ "TaskID": "bbb8427a939ffa44233fabe03fffb3dc", "Describe": "关闭虚拟机电源(ID:147)", "Content": { "task": { "event_name": "EVENT_VM_POWER_OFF", "task_errcode": "200", "task_errmsg": "success" }, "vm": { "vm_state": "33", "vmid": "147" } }, "InsertTime": 1695449794, "UpdateTime": 1695449795, "ExpireTime": 1695536194 }
同步返回参数说明
参数 | 描述 |
TaskID | 任务ID |
Describe | 任务描述 |
Clientid | 代理客户端ID |
Content | 任务详情 |
task | 任务执行信息 |
event_name | 事件名称 |
task_errcode | 错误代码 |
task_errmsg | 错误提示 |
vm | 虚拟机信息 |
vmid | 虚拟机ID |
vm_state | 虚拟机状态: 0 : 等待配置 1 : 有未解决问题消息 2 : 尝试一次解决问题消息 3 : 已处理问题消息 4 : 解决问题消息超时,需要手动到ESXI后台解决 10 : 运行中 20 : 配置中 30 : 电源打开中 31 : 电源已打开 32 : 电源关闭中 33 : 电源已关闭 99 : 出现异常 |
InsertTime | 任务创建时间 |
UpdateTime | 任务更新时间 |
ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}