查询云主机(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" \
-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" \
-H "Authorization: OAuth 95c7b190063f423ea6b305f054af8bf5" \
-X GET http://localhost:8080/zstack/v1/vm-instances/3b9c1b2bca5848459881bfad378540b5

可查询字段

运行zstack-cli命令行工具，输入QueryVmInstance并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "bece18afd5af4a8cbcc87496aa3ae8a8",
      "name": "Test-VM",
      "description": "web server VM",
      "zoneUuid": "c0e8b8f5d43f454d8feccc0e1e5cf119",
      "clusterUuid": "e54efff1e153434395450e1dffa646df",
      "imageUuid": "21185daf4c3e46718be48005cbd7893d",
      "hostUuid": "474924e1b9c743119cb892e4223598d2",
      "lastHostUuid": "d059fbc6f21e44f1a9c5d84ee22c6913",
      "instanceOfferingUuid": "83c3e86180354d4e800104b9393842f7",
      "rootVolumeUuid": "b24130cd01b14e2ca1ee1e46fb0011bb",
      "platform": "Linux",
      "defaultL3NetworkUuid": "3d875625d62944069cd042aacf64b940",
      "type": "UserVm",
      "hypervisorType": "KVM",
      "memorySize": 8.589934592E9,
      "cpuNum": 1.0,
      "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
      "createDate": "May 11, 2017 1:23:02 PM",
      "lastOpDate": "May 11, 2017 1:23:02 PM",
      "state": "Running",
      "vmNics": [
        {
          "uuid": "e4c2726154ba431d9b7d3fab19d5a969",
          "vmInstanceUuid": "bece18afd5af4a8cbcc87496aa3ae8a8",
          "usedIpUuid": "41be2de0c7e64c519e5ccc6f739f6094",
          "l3NetworkUuid": "3d875625d62944069cd042aacf64b940",
          "ip": "192.168.1.10",
          "mac": "00:0c:29:bd:99:fc",
          "netmask": "255.255.255.0",
          "gateway": "192.168.1.1",
          "deviceId": 0.0,
          "createDate": "May 11, 2017 1:23:02 PM",
          "lastOpDate": "May 11, 2017 1:23:02 PM"
        }
      ],
      "allVolumes": [
        {
          "uuid": "b24130cd01b14e2ca1ee1e46fb0011bb",
          "name": "Root-Volume-For-VM-bece18afd5af4a8cbcc87496aa3ae8a8",
          "primaryStorageUuid": "2fc0cd0b063543089d0c13b9fe37e706",
          "vmInstanceUuid": "bece18afd5af4a8cbcc87496aa3ae8a8",
          "diskOfferingUuid": "9cea3663fd2f4aa58232ad72ef7a423c",
          "rootImageUuid": "21185daf4c3e46718be48005cbd7893d",
          "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-b24130cd01b14e2ca1ee1e46fb0011bb/b24130cd01b14e2ca1ee1e46fb0011bb.qcow2",
          "type": "Root",
          "format": "qcow2",
          "size": 1.073741824E11,
          "actualSize": 2.147483648E10,
          "deviceId": 0.0,
          "state": "Enabled",
          "status": "Ready",
          "createDate": "May 11, 2017 1:23:02 PM",
          "lastOpDate": "May 11, 2017 1:23:02 PM"
        }
      ]
    }
  ]
}
名字 类型 描述 起始版本
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
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
vmNics List 详情参考vmNics 0.6
allVolumes List 详情参考allVolumes 0.6
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 0.6
mac String 0.6
netmask String 0.6
gateway String 0.6
metaData String 0.6
deviceId Integer 0.6
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 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

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()