请求地址:
请求地址 | 请求方法 |
/api/vm/disk/remove | POST |
请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
vmid | String | 是 | 32 | 虚拟机ID | 66 |
scsi | Int | 否 | 1 | SCSI 控制器编号0-4,默认为0 | 0 |
unit | Int | 否 | 2 | SCSI 控制器单元号0-15,默认为0 | 0 |
isfile | Int | 否 | 1 | 是否删除磁盘文件,1为删除 | 0 |
mode | Int | 否 | 1 | 响应模式:0同步、1异步,默认为1,各差异如下: 同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败) 异步:服务器会立即响应客户端,通过任务ID获得任务执行结果 | 0 |
clientid | String | 是 | 32 | 代理客户端ID |
异步返回示例
{ "errcode": "200", "errmsg": "ok", "data": { "vmid": "32", "taskid": "121e6a4682502fb8ad89a12444c40008" } }
异步返回参数说明
参数 | 描述 |
vmid | 虚拟机ID |
taskid | 任务ID,可用于获取任务执行信息 |
同步返回示例
{ "TaskID": "d160683c2d9d9b59066bcb40ef4ef1bb", "Describe": "移除虚拟机磁盘", "Content": { "task": { "event_name": "EVENT_VM_DISK_DELETE", "task_errcode": "200", "task_errmsg": "success" }, "vm": { "delete_file": "yes", "scsi": "0", "unit": "2", "vmid": "111" } }, "InsertTime": 1696256223, "UpdateTime": 1696256225, "ExpireTime": 1696342623 }
同步返回参数说明
参数 | 描述 |
TaskID | 任务ID |
Describe | 任务描述 |
Clientid | 代理客户端ID |
Content | 任务详情 |
task | 任务执行信息 |
event_name | 事件名称 |
task_errcode | 错误代码 |
task_errmsg | 错误提示 |
vm | 虚拟机信息 |
vmid | 虚拟机ID |
delete_file | 删除磁盘文件标识,"yes"为删除 |
scsi | SCSI磁盘控制器编号 |
unit | SCSI磁盘控制器单元号 |
InsertTime | 任务创建时间 |
UpdateTime | 任务更新时间 |
ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}