查询云主机

GET/zstack/v1/vm-instances

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

操作 ID

QueryVmInstance

起始版本

0.6

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

q
String
查询条件。

响应状态

200 OK

该 API 成功时返回以下响应结构。

error
ErrorCode必填
错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error
- code
  String必填
  错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001
- description
  String必填
  错误的概要描述
- details
  String必填
  错误的详细信息
- elaboration
  String必填
  保留字段，默认为null
- opaque
  LinkedHashMap必填
  保留字段，默认为null
- cause
  ErrorCode必填
  根错误，引发当前错误的源错误，若无原错误，该字段为null
inventories
List必填
详情参考inventories
- uuid
  String必填
  资源的UUID，唯一标示该资源
- name
  String必填
  资源名称
- description
  String必填
  资源的详细描述
- zoneUuid
  String必填
  区域UUID
- clusterUuid
  String必填
  集群UUID
- imageUuid
  String必填
  镜像UUID
- hostUuid
  String必填
  物理机UUID
- lastHostUuid
  String必填
  最近一次主机UUID。
- instanceOfferingUuid
  String必填
  计算规格UUID
- rootVolumeUuid
  String必填
  根云盘UUID
- platform
  String必填
  平台。
- architecture
  String必填
  架构类型
- defaultL3NetworkUuid
  String必填
  默认三层3网络UUID。
- type
  String必填
  云主机类型，包括： UserVm ApplianceVm
- hypervisorType
  String必填
  hypervisor类型。
- memorySize
  Long必填
  内存大小。
- cpuNum
  Integer必填
  暂无描述。
- cpuSpeed
  Long必填
  暂无描述。
- allocatorStrategy
  String必填
  allocator策略。
- createDate
  Timestamp必填
  创建时间
- lastOpDate
  Timestamp必填
  最后一次修改时间
- state
  String必填
  云主机状态，包括： Created Starting Running Stopping Stopped Rebooting Destroying Destroyed Migrating Expunging Pausing Paused Resuming VolumeMigrating Unknown
- guestOsType
  String必填
  操作系统类型
- vmNics
  List必填
  详情参考vmNics
  uuid
  String必填
  资源的UUID，唯一标示该资源
  vmInstanceUuid
  String必填
  云主机UUID
  l3NetworkUuid
  String必填
  三层网络UUID
  ip
  String必填
  IP地址
  mac
  String必填
  MAC地址
  hypervisorType
  String必填
  虚拟化类型
  netmask
  String必填
  子网掩码
  gateway
  String必填
  网关
  metaData
  String必填
  元数据。
  ipVersion
  Integer必填
  IP地址版本
  deviceId
  Integer必填
  设备ID
  type
  String必填
  网卡类型
  usedIps
  List必填
  详情参考usedIps
  uuid
  String必填
  资源的UUID，唯一标示该资源
  ipRangeUuid
  String必填
  IP段UUID
  l3NetworkUuid
  String必填
  三层网络UUID
  ipVersion
  Integer必填
  IP协议号
  ip
  String必填
  IP地址
  netmask
  String必填
  网络掩码
  gateway
  String必填
  网关地址
  usedFor
  String必填
  intended使用。
  ipInLong
  long必填
  IP地址represented长integer。
  vmNicUuid
  String必填
  云主机网卡UUID
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间
- allVolumes
  List必填
  详情参考allVolumes
  uuid
  String必填
  资源的UUID，唯一标示该资源
  name
  String必填
  资源名称
  description
  String必填
  资源的详细描述
  primaryStorageUuid
  String必填
  主存储UUID
  vmInstanceUuid
  String必填
  云主机UUID
  diskOfferingUuid
  String必填
  云盘规格UUID
  rootImageUuid
  String必填
  云盘根镜像UUID
  installPath
  String必填
  云盘在主存储上的路径
  type
  String必填
  云盘类型，数据云盘/根云盘
  format
  String必填
  云盘格式
  size
  Long必填
  云盘大小
  actualSize
  Long必填
  云盘真实大小
  deviceId
  Integer必填
  设备ID。
  state
  String必填
  云盘是否开启
  status
  String必填
  云盘状态
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间
  isShareable
  Boolean必填
  是否共享云盘
  volumeQos
  String必填
  云盘Qos，格式如total=1048576
- vmCdRoms
  List必填
  详情参考vmCdRoms
  uuid
  String必填
  资源的UUID，唯一标示该资源
  vmInstanceUuid
  String必填
  云主机UUID
  deviceId
  Integer必填
  光驱顺序号
  isoUuid
  String必填
  ISO镜像UUID
  isoInstallPath
  String必填
  ISO镜像挂载路径
  name
  String必填
  资源名称
  description
  String
  资源的详细描述
  createDate
  Timestamp必填
  创建时间
  lastOpDate
  Timestamp必填
  最后一次修改时间

请求示例

转换警告

python: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100 ^^^^^^^^^^^^^^^^^^^^^^^^^^
javascript: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100 ^^^^^^^^^^^^^^^^^^^^^^^^^^
java: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100 ^^^^^^^^^^^^^^^^^^^^^^^^^^
go: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/vm-instances?q=name=vm1&q=vmNics.ip=192.168.20.100 ^^^^^^^^^^^^^^^^^^^^^^^^^^

curl -X GET '{host}/zstack/v1/vm-instances?q={q}' \
  -H 'Authorization: Bearer {token}'

响应示例

{
  "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": 8589934592,
      "cpuNum": 1,
      "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,
          "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": 107374182400,
          "actualSize": 21474836480,
          "deviceId": 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,
          "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"
    }
  ]
}

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口