请求地址:
请求地址 | 请求方法 |
/api/vm/delete | POST |
请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
vmid | String | 是 | 64 | 虚拟机ID | |
mode | Int | 否 | 1 | 响应模式:0同步、1异步,默认为1,各差异如下: 同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败) 异步:服务器会立即响应客户端,通过任务ID获得任务执行结果 | 1 |
clientid | String | 是 | 32 | 代理客户端ID |
|
异步返回示例
{
"errcode": "200",
"errmsg": "ok",
"data": {
"taskid": "05df033533f8a7e49139aed1115bb009",
"vmid": "104"
}
}
异步返回参数说明
参数 | 描述 |
vmid | 虚拟机ID |
taskid | 任务ID,可用于获取任务执行信息,详情参数参考以下同步返回参数说明 |
同步返回示例
{
"TaskID": "69427e24a453ddb564b15c0091ef03d7",
"Describe": "删除虚拟机(ID:104)",
"Content": {
"task": {
"event_name": "EVENT_VM_DELETE",
"task_errcode": "500",
"task_errmsg": "Unable to find a VM corresponding to \"104\"\" "
},
"vm": {
"vmid": "104"
}
},
"InsertTime": 1695311158,
"UpdateTime": 1695311160,
"ExpireTime": 1695397558
}
同步返回参数说明
参数 | 描述 |
TaskID | 任务ID |
Describe | 任务描述 |
Clientid | 代理客户端ID |
Content | 任务详情 |
task | 任务执行信息 |
event_name | 事件名称 |
task_errcode | 错误代码 |
task_errmsg | 错误提示 |
vm | 虚拟机信息 |
vmid | 虚拟机ID |
InsertTime | 任务创建时间 |
UpdateTime | 任务更新时间 |
ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}