调用此接口虚拟机必须安装VMware Tools才生效。
请求地址:
请求地址 | 请求方法 |
/api/vm/close | POST |
请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
vmid | String | 是 | 32 | 虚拟机ID | |
type | Int | 否 | 1 | 类型:0关机、1重启,默认为0 |
|
mode | Int | 否 | 1 | 响应模式:0同步、1异步,默认为1,各差异如下: 同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败) 异步:服务器会立即响应客户端,通过任务ID获得任务执行结果 | |
clientid | String | 是 | 32 | 代理客户端ID |
|
异步返回示例
{
"errcode": "200",
"errmsg": "ok",
"data": {
"vmid": "32",
"taskid": "be1e6a4682502fb8ad89a12444c40998"
}
}
异步返回参数说明
参数 | 描述 |
vmid | 虚拟机ID |
taskid | 任务ID,可用于获取任务执行信息 |
同步返回示例
{
"TaskID": "72ea58764c7f37c8a38cb6ca830f7501",
"Describe": "关闭虚拟机(ID:143)",
"Content": {
"task": {
"event_name": "EVENT_HOST_CLOSE",
"task_errcode": "200",
"task_errmsg": "success"
},
"vm": {
"vmid": "143"
}
},
"InsertTime": 1695560050,
"UpdateTime": 1695560050,
"ExpireTime": 1695646450
}
同步返回参数说明
参数 | 描述 |
TaskID | 任务ID |
Describe | 任务描述 |
Clientid | 代理客户端ID |
Content | 任务详情 |
task | 任务执行信息 |
event_name | 事件名称 |
task_errcode | 错误代码 |
task_errmsg | 错误提示 |
vm | 虚拟机信息 |
vmid | 虚拟机ID |
InsertTime | 任务创建时间 |
UpdateTime | 任务更新时间 |
ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}