查询云主机(QueryVmInstance)

API请求

URLs

GET zstack/v1/vm-instances
GET zstack/v1/vm-instances/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 06771ba1b893402bb4c715b7acf3606e" \
-X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 95c7b190063f423ea6b305f054af8bf5" \
-X GET http://localhost:8080/zstack/v1/vm-instances/3b9c1b2bca5848459881bfad378540b5

可查询字段

运行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",
      "architecture": "x86_64",
      "defaultL3NetworkUuid": "3bcc70b465c4371b8a7f9bd975fdec76",
      "type": "UserVm",
      "hypervisorType": "KVM",
      "memorySize": 8.589934592E9,
      "cpuNum": 1.0,
      "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
      "createDate": "Nov 14, 2017 9:20:57 AM",
      "lastOpDate": "Nov 14, 2017 9:20:57 AM",
      "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.0,
          "createDate": "Nov 14, 2017 9:20:57 AM",
          "lastOpDate": "Nov 14, 2017 9:20:57 AM"
        }
      ],
      "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": 1.073741824E11,
          "actualSize": 2.147483648E10,
          "deviceId": 0.0,
          "state": "Enabled",
          "status": "Ready",
          "createDate": "Nov 14, 2017 9:20:57 AM",
          "lastOpDate": "Nov 14, 2017 9:20:57 AM"
        }
      ],
      "vmCdRoms": [
        {
          "uuid": "45330c110bf23b08b1e41036d6c6aa6c",
          "deviceId": 0.0,
          "isoUuid": "5887742601aa32b5ac57e9024ff38ee8",
          "name": "cd-1",
          "description": "desc",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ],
      "guestOsType": "CentOS7"
    }
  ]
}

名字	类型	描述	起始版本
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		0.6
instanceOfferingUuid	String	计算规格UUID	0.6
rootVolumeUuid	String	根云盘UUID	0.6
platform	String		0.6
architecture	String	架构类型	4.5.0
defaultL3NetworkUuid	String		0.6
type	String	云主机类型，包括： UserVm ApplianceVm	0.6
hypervisorType	String		0.6
memorySize	Long		0.6
cpuNum	Integer		0.6
cpuSpeed	Long		0.6
allocatorStrategy	String		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
state	String	云主机状态，包括： Created Starting Running Stopping Stopped Rebooting Destroying Destroyed Migrating Expunging Pausing Paused Resuming VolumeMigrating Unknown	0.6
guestOsType	String	操作系统类型	4.5.0
vmNics	List	详情参考vmNics	0.6
allVolumes	List	详情参考allVolumes	0.6
vmCdRoms	List	详情参考vmCdRoms	4.5.0

Note: 云主机状态变更总结如下：

Created 可以转换到 Starting, Destroying, Destroyed；
Starting 可以转换到 Running, Stopped, Paused, Destroying, Unknown；
Running 可以转换到 Destroying, Stopping, Stopped, Rebooting, Migrating, Pausing, Paused, Unknown；
Stopping 可以转换到 Stopped, Destroying, Running, Unknown；
Stopped 可以转换到 Starting, Running, Paused, Destroying, VolumeMigrating, Unknown；
Migrating 可以转换到 Running, Stopped, Unknown, Destroying；
VolumeMigrating 可以转换到 Stopped, Unknown, Destroying；
Rebooting 可以转换到 Running, Stopped, Unknown, Destroying；
Paused 可以转换到 Resuming, Stopped, Running, Stopping, Destroying, Unknown, Migrating；
Pausing 可以转换到 Paused, Destroying, Running, Unknown；
Resuming 可以转换到 Running, Destroying, Paused, Unknown；
Unknown 可以转换到 Destroying, Stopping, Paused, Running, Stopped；
Destroying 可以转换到 Unknown, Destroyed, Running, Expunging；
Destroyed 可以转换到 Stopped。

#vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
vmInstanceUuid	String	云主机UUID	0.6
l3NetworkUuid	String	三层网络UUID	0.6
ip	String	IP地址	0.6
mac	String	MAC地址	0.6
hypervisorType	String	虚拟化类型	0.6
netmask	String	子网掩码	0.6
gateway	String	网关	0.6
metaData	String		0.6
ipVersion	Integer	IP地址版本	0.6
deviceId	Integer	设备ID	0.6
type	String	网卡类型	0.6
usedIps	List	详情参考usedIps	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

#usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
ipRangeUuid	String	IP段UUID	0.6
l3NetworkUuid	String	三层网络UUID	0.6
ipVersion	Integer	IP协议号	3.1
ip	String	IP地址	0.6
netmask	String	网络掩码	0.6
gateway	String	网关地址	0.6
usedFor	String		0.6
ipInLong	long		0.6
vmNicUuid	String	云主机网卡UUID	3.1
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

#allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
primaryStorageUuid	String	主存储UUID	0.6
vmInstanceUuid	String	云主机UUID	0.6
diskOfferingUuid	String	云盘规格UUID	0.6
rootImageUuid	String	云盘根镜像UUID	0.6
installPath	String	云盘在主存储上的路径	0.6
type	String	云盘类型，数据云盘/根云盘	0.6
format	String	云盘格式	0.6
size	Long	云盘大小	0.6
actualSize	Long	云盘真实大小	0.6
deviceId	Integer		0.6
state	String	云盘是否开启	0.6
status	String	云盘状态	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
isShareable	Boolean	是否共享云盘	0.6
volumeQos	String	云盘Qos，格式如total=1048576	3.2.0

#vmCdRoms

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.5.0
vmInstanceUuid	String	云主机UUID	4.5.0
deviceId	Integer	光驱顺序号	4.5.0
isoUuid	String	ISO镜像UUID	4.5.0
isoInstallPath	String	ISO镜像挂载路径	4.5.0
name	String	资源名称	4.5.0
description	String	资源的详细描述	4.5.0
createDate	Timestamp	创建时间	4.5.0
lastOpDate	Timestamp	最后一次修改时间	4.5.0

SDK示例

Java SDK

QueryVmInstanceAction action = new QueryVmInstanceAction();
action.conditions = asList("name=vm1","vmNics.ip=192.168.20.100");
action.sessionId = "1a2f35770a8e4e53b4bfb9d0d7ae7e50";
QueryVmInstanceAction.Result res = action.call();

Python SDK

QueryVmInstanceAction action = QueryVmInstanceAction()
action.conditions = ["name=vm1","vmNics.ip=192.168.20.100"]
action.sessionId = "0dd4f4ec663f4502ba3fedda9d0ebc1b"
QueryVmInstanceAction.Result res = action.call()

上一篇彻底删除云主机(ExpungeVmInstance)下一篇启动云主机(StartVmInstance)