请求地址：
| 请求地址 | 请求方法 |
| /api/vm/list | POST |
请求参数
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
| index | Int | 否 | N | 索引，从0开始(第一条)计算，默认为0 | 0 |
| filter | String | 否 | N | 筛选字段，多个","隔开，默认全部字段 datastore:存储和文件 runstate:运行状态 diskinfo:磁盘信息 networks:网络信息 toolsInfo:VMware Tools信息 | datastore,runstate |
| size | Int | 否 | N | 显示条数，默认为1 | 10 |
| type | Int | 否 | 1 | 筛选类型：0列出全部，1只列出运行中的，默认为0 | 0 |
| input | String | 否 | 32 | 筛选关键字：虚拟机ID或者虚拟机名称 | |
| mode | Int | 否 | 1 | 响应模式：0同步、1异步，默认为1，各差异如下： 同步：服务器不会立即响应客户端，一直等待超时或者任务已被执行(不管成功与失败) 异步：服务器会立即响应客户端，通过任务ID获得任务执行结果 | 0 |
| clientid | String | 是 | 32 | 代理客户端ID |
异步返回示例
{
"errcode": "200",
"errmsg": "ok",
"data": {
"taskid": "2e80705f2bf0078c965c8aad435f1ce8"
}
}异步返回参数说明
| 参数 | 描述 |
| vmid | 虚拟机ID |
| taskid | 任务ID，可用于获取任务执行信息 |
同步返回示例
{
"TaskID": "da460d132cf12fc926d06cc0da571b5a",
"Describe": "虚拟机列表",
"Content": {
"task": {
"event_name": "EVENT_VM_LISTS",
"task_errcode": "200",
"task_errmsg": "success"
},
"vm": {
"index": 1,
"list": [
{
"createDate": "2022-12-16T14:49:38.240517Z",
"datastore": {
"name": "data_1t",
"path": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/"
},
"diskinfo": [
{
"fileName": "[data_1t] user/win7-x64-60/win7-x64-60.vmdk",
"key": "2000",
"label": "Hard disk 1",
"summary": "50 GB",
"unitNumber": "0",
"uuid": "6000C290-f6e9-aaf9-5413-91aeefd8398a"
}
],
"fileinfo": {
"logDirectory": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/user/win7-x64-60",
"snapshotDirectory": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/user/win7-x64-60",
"suspendDirectory": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/user/win7-x64-60",
"vmPath": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/user/win7-x64-60",
"vmPathName": "/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/user/win7-x64-60/win7-x64-60.vmx"
},
"guestFullName": "Microsoft Windows 7 (64-bit)",
"hostName": "",
"memoryMB": "512",
"name": "win7-x64-60",
"networks": {
"accessible": "true",
"ipAddress": "",
"ipPoolName": "",
"macAddress": "",
"name": "VM Network",
"network": "vim.Network:HaNetwork-VM Network"
},
"runstate": "1",
"toolsInfo": {
"afterPowerOn": "true",
"afterResume": "true",
"toolsInstallType": "guestToolsTypeMSI",
"toolsVersion": "10304"
},
"uuid": "564d2a44-7105-c68a-3a0b-a94cb67b7ce5",
"vcpu": {
"numCPU": "1",
"numCoresPerSocket": "1",
"numberSlots": "1"
},
"version": "vmx-14",
"vmUsedSize": "15.1G",
"vmid": "154"
}
],
"show": 2,
"total": 2
}
},
"InsertTime": 1696397840,
"UpdateTime": 1696397844,
"ExpireTime": 1696484240
}同步返回参数说明
| 参数 | 描述 |
| TaskID | 任务ID |
| Describe | 任务描述 |
| Clientid | 代理客户端ID |
| Content | 任务详情 |
| task | 任务执行信息 |
| event_name | 事件名称 |
| task_errcode | 错误代码 |
| task_errmsg | 错误提示 |
| vm | 虚拟机信息 |
| index | 当前索引 |
| show | 显示数量 |
| total | 总记录数 |
| list | 列表合集 |
| vmid | 虚拟机ID |
| createDate | 创建时间 |
| guestFullName | 客户机操作系统 |
| hostName | 主机名 |
| memoryMB | 内存大小，MB单位 |
| name | 虚拟机名称 |
| runstate | 虚拟机运行状态:0错误、1电源已打开、2电源已关闭、3暂停 |
| uuid | 虚拟机唯一ID |
| version | 版本号 |
| vmUsedSize | 虚拟机占用空间大小 |
| isDelete | 是否可删除标记,1不可删除 |
| datastore | 数据存储信息 |
| name | 存储名称 |
| path | 所绑定路径 |
| diskinfo | 磁盘信息 |
| fileName | 磁盘文件名 |
| label | 磁盘标签 |
| summary | 磁盘容量 |
| unitNumber | 磁盘SCSI 控制器单元号 |
| uuid | 磁盘唯一ID |
| fileinfo | 文件信息 |
| logDirectory | 日志存放目录 |
| snapshotDirectory | 快照存放目录 |
| suspendDirectory | 挂起目录 |
| vmPathName | 虚拟机配置文件 |
| vmPath | 虚拟机所在目录 |
| networks | 网络信息 |
| name | 网络名称 |
| accessible | 是否已连接 |
| ipPoolName | IP池名称 |
| ipAddress | IP地址 |
| macAddress | MAC地址 |
| vcpu | cpu信息 |
| numCPU | CPU 内核数 |
| numCoresPerSocket | 每个插槽内核数 |
| numberSlots | 插槽数 |
| toolsInfo | VMware Tools信息 |
| toolsVersion | 版本号 |
| toolsInstallType | 安装类型 |
| afterPowerOn | 电源打开 |
| InsertTime | 任务创建时间 |
| UpdateTime | 任务更新时间 |
| ExpireTime | 任务有效时间 |
异常示例
{"errcode":"500","errmsg":"内部错误"}