请求地址:

请求地址请求方法
/api/agent/ovf/listPOST

请求参数

参数类型是否必填最大长度描述示例值
modeInt1

响应模式:0同步、1异步,默认为1,各差异如下:

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

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

1
clientidString32代理客户端ID

异步返回示例

{
    "errcode": "200",
    "errmsg": "ok",
    "data": {
        "taskid": "05df033533f8a7e49139aed1115bb009"
    }
}

异步返回参数说明

参数描述
taskid任务ID,可用于获取任务执行信息,详情参数参考以下同步返回参数说明


同步返回示例

{
    "TaskID":"b643265e31c2e31d18df73e2589a8cb3",
    "Describe":"代理客户端OVF模板列表",
    "Content":{
        "client":{
            "id":"76803510cea5fbbfeeeb86d608d381fa"
        },
        "ovf":{
            "list":[
                {
                    "create_time":"2023-11-22 20:40:25",
                    "filename":"win-x51.ovf",
                    "id":"b9863b46bebd0c3c5130053a26a42998",
                    "path":"E:/golang-xiangmu/src/go_code/AuxEsxi/data2/ovf/win-x51/win-x51.ovf"
                },
                {
                    "create_time":"2023-11-22 20:45:14",
                    "filename":"win7x64-tpl.ovf",
                    "id":"25acaab6ace3d6229a33d326d5ba16b9",
                    "path":"E:/golang-xiangmu/src/go_code/AuxEsxi/data2/ovf/win7x64-tpl/win7x64-tpl.ovf"
                }
            ]
        },
        "task":{
            "event_name":"EVENT_AGENT_OVFLIST",
            "task_errcode":"200",
            "task_errmsg":"success"
        }
    },
    "InsertTime":1700667137,
    "UpdateTime":1700667137,
    "ExpireTime":1700753537
}

同步返回参数说明

参数描述
TaskID任务ID
Describe任务描述
Clientid代理客户端ID
Content任务详情
    task任务执行信息
        event_name事件名称
        task_errcode错误代码,如果不存在表示任务未完成
        task_errmsg错误提示,如果不存在表示任务未完成
    ovf.list虚拟机信息
        create_time创建时间
        filename模板名称
        id模板ID
        path模板所在路径
InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间


异常示例

{"errcode":"500","errmsg":"内部错误"}