请求地址:
请求地址 | 请求方法 |
/api/vm/ovf/export | POST |
请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
vmname | String | 是 | 32 | 虚拟机名称 | |
mode | Int | 否 | 1 | 响应模式:0同步、1异步,默认为1,各差异如下: 同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败) 异步:服务器会立即响应客户端,通过任务ID获得任务执行结果 | 1 |
clientid | String | 是 | 32 | 代理客户端ID | |
异步返回示例
{
"errcode": "200",
"errmsg": "ok",
"data": {
"taskid": "05df033533f8a7e49139aed1115bb009",
"vm_name": "winx1"
}
}
异步返回参数说明
参数 | 描述 |
vm_name | 虚拟机名称 |
taskid | 任务ID,可用于获取任务执行信息,详情参数参考以下同步返回参数说明 |
同步返回示例
{
"TaskID":"9dc1dc61e178376e75d383c25e80d4cc",
"Describe":"导出虚拟机OVF模板",
"Content":{
"client":{
"id":"76803510cea5fbbfeeeb86d608d381fa"
},
"task":{
"config_progress_bar":"100%",
"config_progress_describe":"导出OVF模板(win7x64-tpl)",
"config_progress_type":"export_ovf",
"event_name":"EVENT_VM_OVFTPL",
"task_errcode":"200",
"task_errmsg":"success"
},
"vm":{
"ovf_save_path":"E:/golang-xiangmu/src/go_code/AuxEsxi/data2/ovf/",
"vm_name":"win7x64-tpl",
"vmid":"156"
}
},
"InsertTime":1700656128,
"UpdateTime":1700657114,
"ExpireTime":1700742528
}
同步返回参数说明
参数 | 描述 |
TaskID | 任务ID |
Describe | 任务描述 |
Clientid | 代理客户端ID |
Content | 任务详情 |
task | 任务执行信息 |
event_name | 事件名称 |
task_errcode | 错误代码,如果不存在表示任务未完成 |
task_errmsg | 错误提示,如果不存在表示任务未完成 |
config_progress_bar | 任务进度 |
config_progress_describe | 任务进度描述 |
config_progress_type | 任务类型:export_ovf导出模板 |
vm | 虚拟机信息 |
vmid | 虚拟机ID |
ovf_save_path | 模板存放路径 |
vm_name | 虚拟机名称 |
InsertTime | 任务创建时间 |
UpdateTime | 任务更新时间 |
ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}