查询虚拟机(QueryVmInstance)
查询虚拟机
API请求
URLs
GET zstack/v1/vm-instances
GET zstack/v1/vm-instances/{uuid}Headers
Authorization: OAuth the-session-uuidCurl示例
curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/vm-instances/72573bf842273c02a09f33dc061bb6f8可查询字段
运行CLI命令行工具，输入QueryVmInstance并按Tab键查看所有可查询字段以及可跨表查询的资源名。
API返回
返回示例
{
"inventories": [
{
"uuid": "a43716db0d713c319be06811ebcc00a1",
"name": "Test-VM",
"description": "web server VM",
"zoneUuid": "dfa731eef1f13f1da298855d6ce282bd",
"clusterUuid": "743b07830cb6324192a2e0cc34186814",
"imageUuid": "ea51c3f89cb53b0db4abdd648c476f80",
"hostUuid": "d808c413110a32cab4d9c4d034818eb0",
"lastHostUuid": "3da349b211ba3cebb5629c0f90aadf63",
"instanceOfferingUuid": "1a3f2ce111cf318688f7bb0cc217d5ff",
"rootVolumeUuid": "b677bd698e1d3e4b9787fa81827d13d4",
"platform": "Linux",
"defaultL3NetworkUuid": "3bcc70b465c4371b8a7f9bd975fdec76",
"type": "UserVm",
"hypervisorType": "KVM",
"memorySize": 8589934592,
"cpuNum": 1,
"allocatorStrategy": "LastHostPreferredAllocatorStrategy",
"createDate": "Nov 14, 2017 2:20:57 PM",
"lastOpDate": "Nov 14, 2017 2:20:57 PM",
"state": "Running",
"vmNics": [
{
"uuid": "39da5aec41f336929db3458395614151",
"vmInstanceUuid": "a43716db0d713c319be06811ebcc00a1",
"usedIpUuid": "69008cc8dbd03aeba1787ec024a0b326",
"l3NetworkUuid": "3bcc70b465c4371b8a7f9bd975fdec76",
"ip": "192.168.1.10",
"mac": "00:0c:29:bd:99:fc",
"hypervisorType": "KVM",
"netmask": "255.255.255.0",
"gateway": "192.168.1.1",
"deviceId": 0,
"createDate": "Nov 14, 2017 2:20:57 PM",
"lastOpDate": "Nov 14, 2017 2:20:57 PM"
}
],
"allVolumes": [
{
"uuid": "b677bd698e1d3e4b9787fa81827d13d4",
"name": "Root-Volume-For-VM-a43716db0d713c319be06811ebcc00a1",
"primaryStorageUuid": "413b0d61df4e3b088f5ee045ff84b65b",
"vmInstanceUuid": "a43716db0d713c319be06811ebcc00a1",
"diskOfferingUuid": "37c73ea89a2b3a7bb7126f5fe7a32dc6",
"rootImageUuid": "ea51c3f89cb53b0db4abdd648c476f80",
"installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b677bd698e1d3e4b9787fa81827d13d4/b677bd698e1d3e4b9787fa81827d13d4.qcow2",
"type": "Root",
"format": "qcow2",
"size": 107374182400,
"actualSize": 21474836480,
"deviceId": 0,
"state": "Enabled",
"status": "Ready",
"createDate": "Nov 14, 2017 2:20:57 PM",
"lastOpDate": "Nov 14, 2017 2:20:57 PM"
}
]
}
]
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 0.6 |
| inventories | List | 详情参考inventories | 0.6 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 0.6 |
| description | String | 错误的概要描述 | 0.6 |
| details | String | 错误的详细信息 | 0.6 |
| elaboration | String | 保留字段，默认为null | 0.6 |
| opaque | LinkedHashMap | 保留字段，默认为null | 0.6 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 0.6 |
#inventories
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 0.6 |
| name | String | 资源名称 | 0.6 |
| description | String | 资源的详细描述 | 0.6 |
| zoneUuid | String | 数据中心 UUID | 0.6 |
| clusterUuid | String | 集群 UUID | 0.6 |
| imageUuid | String | 镜像 UUID | 0.6 |
| hostUuid | String | 主机 UUID | 0.6 |
| lastHostUuid | String | 上一次启动的主机 UUID | 0.6 |
| instanceOfferingUuid | String | 计算规格 UUID, 已废弃 | 0.6 |
| rootVolumeUuid | String | 根硬盘 UUID | 0.6 |
| platform | String | 虚拟机的平台, 是 Windows / Linux 还是其它 | 0.6 |
| architecture | String | 虚拟机架构, 是 x86_64 / aarch64 还是其它 | 0.6 |
| defaultL3NetworkUuid | String | 默认使用的分布式端口组 UUID | 0.6 |
| type | String | 虚拟机类型, 是用户使用虚拟机还是平台特殊用途的虚拟机 | 0.6 |
| hypervisorType | String | 虚拟机虚拟化类型, 一般为 KVM | 0.6 |
| memorySize | Long | 内存大小 | 0.6 |
| cpuNum | Integer | CPU 数量 | 0.6 |
| cpuSpeed | Long | CPU 速度 | 0.6 |
| allocatorStrategy | String | 虚拟机分配策略 | 0.6 |
| createDate | Timestamp | 创建时间 | 0.6 |
| lastOpDate | Timestamp | 最后一次修改时间 | 0.6 |
| state | String | 虚拟机是否启用的状态 | 0.6 |
| guestOsType | String | 虚拟机宿主操作系统类型 | 3.11.2 |
| vmNics | List | 详情参考vmNics | 0.6 |
| allVolumes | List | 详情参考allVolumes | 0.6 |
| vmCdRoms | List | 详情参考vmCdRoms | 0.6 |
#vmNics
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 3.17.13 |
| vmInstanceUuid | String | 虚拟机UUID | 3.17.13 |
| l3NetworkUuid | String | 分布式端口组UUID | 3.17.13 |
| ip | String | 3.17.13 | |
| mac | String | 3.17.13 | |
| hypervisorType | String | 3.17.13 | |
| netmask | String | 3.17.13 | |
| gateway | String | 3.17.13 | |
| metaData | String | 3.17.13 | |
| ipVersion | Integer | 3.17.13 | |
| driverType | String | 3.17.13 | |
| internalName | String | 3.17.13 | |
| deviceId | Integer | 3.17.13 | |
| type | String | 3.17.13 | |
| state | String | 网卡状态 | 3.17.13 |
| createDate | Timestamp | 创建时间 | 3.17.13 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.17.13 |
| usedIps | List | 详情参考usedIps | 3.17.13 |
#usedIps
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 4.10.0 |
| ipRangeUuid | String | IP段UUID | 4.10.0 |
| l3NetworkUuid | String | 分布式端口组UUID | 4.10.0 |
| ipVersion | Integer | IP协议号 | 4.10.0 |
| ip | String | IP地址 | 4.10.0 |
| netmask | String | 子网掩码 | 4.10.0 |
| gateway | String | 网关地址 | 4.10.0 |
| usedFor | String | 分配原因 | 4.10.0 |
| ipInLong | long | Long存储的IP地址，仅ipv4有效 | 4.10.0 |
| vmNicUuid | String | 虚拟机网卡UUID | 4.10.0 |
| createDate | Timestamp | 创建时间 | 4.10.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.10.0 |
#allVolumes
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 3.17.13 |
| name | String | 资源名称 | 3.17.13 |
| description | String | 资源的详细描述 | 3.17.13 |
| primaryStorageUuid | String | 数据存储UUID | 3.17.13 |
| vmInstanceUuid | String | 虚拟机UUID | 3.17.13 |
| diskOfferingUuid | String | 硬盘规格UUID | 3.17.13 |
| rootImageUuid | String | 3.17.13 | |
| installPath | String | 3.17.13 | |
| type | String | 3.17.13 | |
| format | String | 3.17.13 | |
| size | Long | 3.17.13 | |
| actualSize | Long | 3.17.13 | |
| deviceId | Integer | 3.17.13 | |
| state | String | 3.17.13 | |
| status | String | 3.17.13 | |
| createDate | Timestamp | 创建时间 | 3.17.13 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.17.13 |
| isShareable | Boolean | 3.17.13 | |
| volumeQos | String | 3.17.13 | |
| lastDetachDate | Timestamp | 3.17.13 | |
| lastVmInstanceUuid | String | 3.17.13 | |
| encrypted | Boolean | 5.1.0 |
#vmCdRoms
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 3.17.13 |
| vmInstanceUuid | String | 虚拟机UUID | 3.17.13 |
| deviceId | Integer | 3.17.13 | |
| isoUuid | String | 3.17.13 | |
| isoInstallPath | String | 3.17.13 | |
| name | String | 资源名称 | 3.17.13 |
| description | String | 资源的详细描述 | 3.17.13 |
| createDate | Timestamp | 创建时间 | 3.17.13 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.17.13 |
SDK示例
Java SDK
QueryVmInstanceAction action = new QueryVmInstanceAction();
action.conditions = asList("name=vm1","vmNics.ip=192.168.20.100");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryVmInstanceAction.Result res = action.call();Python SDK
action = QueryVmInstanceAction()
action.conditions = ["name=vm1","vmNics.ip=192.168.20.100"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()