文档目录

查询容错虚拟机组(QueryFaultToleranceVm)

查询FT虚拟机组

API请求

URLs
GET zstack/v1/vm-instances/fault-tolerance
GET zstack/v1/vm-instances/fault-tolerance/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/vm-instances/fault-tolerance?q=uuid=c5ee0e70278431ea8395393399cb9b8e
curl -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" -X GET http://localhost:8080/zstack/v1/vm-instances/fault-tolerance/e03a1bf3dd7c3626beb5885aa11fad96

可查询字段

运行CLI命令行工具,输入QueryFaultToleranceVm并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "primaryVmInstanceUuid": "ff01ec80fd11327cba7519b66119d900",
      "status": "Protected",
      "uuid": "29143af975e13ecca23fe27cf41e17f2",
      "name": "Test-VM",
      "description": "Appliance VM",
      "zoneUuid": "f0e256b44d7f3d43ae1425447293fe56",
      "clusterUuid": "8e6eaa82530635ad9989a418291c1ab1",
      "imageUuid": "2f68491966cf31849a18bb05e3ca003a",
      "hostUuid": "9c41e82a18bb3c0a975e830f89991775",
      "lastHostUuid": "f26bf2d572d039c4b700e5eaa6096666",
      "instanceOfferingUuid": "be00bf01f4c93f23a412e199c6e834b3",
      "rootVolumeUuid": "a849787166773022ad1adfbbc9dec525",
      "platform": "Linux",
      "defaultL3NetworkUuid": "438062279ec7390ea33bd67bac0911f7",
      "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": "be5f5b6c35bf3cadbfe054eb359b6ba3",
          "vmInstanceUuid": "29143af975e13ecca23fe27cf41e17f2",
          "usedIpUuid": "7244210bce0c3e5b991a69e105457ab9",
          "l3NetworkUuid": "438062279ec7390ea33bd67bac0911f7",
          "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": "a849787166773022ad1adfbbc9dec525",
          "name": "Root-Volume-For-VM-29143af975e13ecca23fe27cf41e17f2",
          "primaryStorageUuid": "c6d8def978b03513b15411ac1e923606",
          "vmInstanceUuid": "29143af975e13ecca23fe27cf41e17f2",
          "diskOfferingUuid": "de1d61e08234314abe1f5e09c202fcb9",
          "rootImageUuid": "2f68491966cf31849a18bb05e3ca003a",
          "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-a849787166773022ad1adfbbc9dec525/a849787166773022ad1adfbbc9dec525.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 3.9.0
inventories List 详情参考inventories 3.9.0
#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
名字 类型 描述 起始版本
primaryVmInstanceUuid String 0.6
secondaryVmInstanceUuid String 0.6
status String 0.6
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 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 0.6
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
QueryFaultToleranceVmAction action = new QueryFaultToleranceVmAction();
action.conditions = asList("uuid=b6e4e92b187b3e1a979d1eeb04100c09");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryFaultToleranceVmAction.Result res = action.call();
Python SDK
action = QueryFaultToleranceVmAction()
action.conditions = ["uuid=b4d511cd48ae33ffb4964ffee8c721be"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
开发手册 | ZStack ZSphere · ZVF | ZStack 资源中心