请求地址:

请求地址请求方法
/api/vm/onpowerPOST

请求参数

参数类型是否必填最大长度描述示例值
vmidString32虚拟机ID
modeint1响应模式:0同步、1异步,默认为1,各差异如下:

同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败)

异步:服务器会立即响应客户端,通过任务ID获得任务执行结果

clientidString32代理客户端ID

异步返回示例

{
    "errcode": "200",
    "errmsg": "ok",
    "data": {
        "vmid": "32",
        "taskid": "be1e6a4682502fb8ad89a12444c40998"
    }
}

异步返回参数说明

参数描述
vmid虚拟机ID
taskid任务ID,可用于获取任务执行信息


同步返回示例

{
    "TaskID": "118b59047dc8d24c7d94c5dd4628ca45",
    "Describe": "打开虚拟机电源(ID:143)",
    "Content": {
        "task": {
            "event_name": "EVENT_VM_POWER_ON",
            "task_errcode": "500",
            "task_errmsg": "虚拟机电源已打开状态,无需操作"
        },
        "vm": {
            "vmid": "143"
        }
    },
    "InsertTime": 1695447532,
    "UpdateTime": 1695447533,
    "ExpireTime": 1695533932
}

同步返回参数说明

参数描述
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":"内部错误"}