CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF

属性

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源属性			0.6
name	请参见资源属性			0.6
description	请参见资源属性	是		0.6
zoneUuid	所在区域的uuid，请参见区域(Zone) 和 location	是		0.6
clusterUuid	所在集群的uuid, 请参见集群(Cluster) 和 location	是		0.6
hostUuid	运行云主机当前的物理主机uuid, 请参见物理主机(Host) and location	是		0.6
lastHostUuid	上一次运行云主机的物理主机uuid, 请参见物理主机(Host)and location	是		0.6
imageUuid	用于创建云主机根云盘的镜像uuid，请参见镜像(Image)			0.6
instanceOfferingUuid	计算规格的uuid，请参见计算规格(Instance Offering)			0.6
rootVolumeUuid	云主机根云盘的uuid，请参见云盘(Volume)			0.6
platform				4.5.0
architecture	架构类型			4.5.0
memorySize				4.5.0
defaultL3NetworkUuid	云主机默认L3网络的uuid，请参见 L3 network和 networks			0.6
cpuSpeed	VCPU速度, 请参见 CPU capacity			0.6
cpuNum	VCPU数目, 请参见 CPU capacity			0.6
allocatorStrategy	主机分配策略, 请参见 allocator strategy		DefaultHostAllocatorStrategy LastHostPreferredAllocatorStrategy LeastVmPreferredHostAllocatorStrategy MinimumCPUUsageHostAllocatorStrategy MinimumMemoryUsageHostAllocatorStrategy MaxInstancePerHostHostAllocatorStrategy	0.6
type	云主机类型 UserVm: 用户创建的云主机 ApplianceVm: ZStack Cloud创建的帮助管理云的云主机		UserVm ApplianceVm	0.6
hypervisorType	云主机的虚拟机管理程序类型, 请参见物理主机(Host)和 hypervisor type		KVM	0.6
state	云主机的可用状态, 请参见state		Created Starting Running Stopping Stopped Rebooting Destroying Destroyed Migrating Expunging Pausing Paused Resuming VolumeMigrating Unknown	0.6
guestOsType	操作系统类型			4.5.0
createDate	请参见资源属性			0.6
lastOpDate	请参见资源属性			0.6

示例

{
    "inventories": [
        {
            "allVolumes": [
                {
                    "actualSize": 7995392,
                    "createDate": "Sep 29, 2022 5:33:11 PM",
                    "description": "Root volume for VM[uuid:d223cdf002924bd6a8d7eac1542e8387]",
                    "deviceId": 0,
                    "format": "qcow2",
                    "installPath": "/cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-5239c2c6714047d19e6db2d693a54d80/5239c2c6714047d19e6db2d693a54d80.qcow2",
                    "isShareable": false,
                    "lastOpDate": "Sep 29, 2022 5:33:11 PM",
                    "name": "ROOT-for-test",
                    "primaryStorageUuid": "e6493bf67dbf42e3867912d51252c289",
                    "rootImageUuid": "7e90e873a776485d8b65a6471e278330",
                    "size": 12682240,
                    "state": "Enabled",
                    "status": "Ready",
                    "type": "Root",
                    "uuid": "5239c2c6714047d19e6db2d693a54d80",
                    "vmInstanceUuid": "d223cdf002924bd6a8d7eac1542e8387"
                }
            ],
            "allocatorStrategy": "LeastVmPreferredHostAllocatorStrategy",
            "architecture": "x86_64",
            "clusterUuid": "26ddf9a8da2e41ee806c135e73979d00",
            "cpuNum": 1,
            "cpuSpeed": 0,
            "createDate": "Sep 29, 2022 5:33:11 PM",
            "defaultL3NetworkUuid": "0b0d6fc9a3574d77bdc66c3854b76305",
            "description": "",
            "guestOsType": "Linux",
            "hostUuid": "6010271d3375483dbc922553fd232f86",
            "hypervisorType": "KVM",
            "imageUuid": "7e90e873a776485d8b65a6471e278330",
            "instanceOfferingUuid": "a2013b25ee1b4f4abd2d9ea41162e56f",
            "lastHostUuid": "6010271d3375483dbc922553fd232f86",
            "lastOpDate": "Sep 29, 2022 5:33:13 PM",
            "memorySize": 1073741824,
            "name": "test",
            "platform": "Linux",
            "rootVolumeUuid": "5239c2c6714047d19e6db2d693a54d80",
            "state": "Running",
            "type": "UserVm",
            "uuid": "d223cdf002924bd6a8d7eac1542e8387",
            "vmCdRoms": [
                {
                    "createDate": "Sep 29, 2022 5:33:11 PM",
                    "deviceId": 0,
                    "lastOpDate": "Sep 29, 2022 5:33:11 PM",
                    "name": "vm-d223cdf002924bd6a8d7eac1542e8387-cdRom",
                    "uuid": "cfe7b9a90fae4de688a688d9843a8e3b",
                    "vmInstanceUuid": "d223cdf002924bd6a8d7eac1542e8387"
                }
            ],
            "vmNics": [
                {
                    "createDate": "Sep 29, 2022 5:33:11 PM",
                    "deviceId": 0,
                    "driverType": "virtio",
                    "gateway": "192.168.1.254",
                    "hypervisorType": "KVM",
                    "internalName": "vnic3.0",
                    "ip": "192.168.1.37",
                    "l3NetworkUuid": "0b0d6fc9a3574d77bdc66c3854b76305",
                    "lastOpDate": "Sep 29, 2022 5:33:11 PM",
                    "mac": "fa:1c:43:88:06:00",
                    "netmask": "255.255.0.0",
                    "type": "VNIC",
                    "usedIps": [
                        {
                            "createDate": "Sep 29, 2022 5:33:11 PM",
                            "gateway": "192.168.1.254",
                            "ip": "192.168.1.37",
                            "ipInLong": 3232235813,
                            "ipRangeUuid": "65b4d8c93f7d4f768ceb40e2b7a8a5eb",
                            "ipVersion": 4,
                            "l3NetworkUuid": "0b0d6fc9a3574d77bdc66c3854b76305",
                            "lastOpDate": "Sep 29, 2022 5:33:11 PM",
                            "netmask": "255.255.0.0",
                            "uuid": "d870314be51b349882352da7b8c10593",
                            "vmNicUuid": "08859ad18bf64b7fb1640f84839e7110"
                        }
                    ],
                    "uuid": "08859ad18bf64b7fb1640f84839e7110",
                    "vmInstanceUuid": "d223cdf002924bd6a8d7eac1542e8387"
                }
            ],
            "zoneUuid": "398ba10f6bf54a9faf54a5edb6523b4d"
        }
    ],
    "success": true
}

位置（Location）

云平台通过区域（zones）、集群（clusters）和物理主机（hosts）组织计算资源（computing resources），因此云主机的位置可以通过zoneUuid、 clusterUuid 和hostUuid标识。

当云主机开始运行后，这些UUIDs会被设置为标识云主机当前位置的值；
当云主机停止运行后， hostUuid会被设置为NULL，zoneUuid和clusterUuid会保持不变；
lastHostUuid比较特别，因为它代表了云主机上次运行的物理主机；
对于新创建的云主机， lastHostUuid被设置为NULL；
一旦云主机停止运行, lastHostUuid就被设置为之前的hostUuid值。

网络（Networks）

云主机可以有一个或多个L3网络；vm nics 包含了每个L3网络的IP地址、子网掩码和MAC地址信息。

如果一个云主机有不止一个L3网络，那么它必须设置一个默认的L3网络，这个网络提供默认的路由（routing)、 DNS 和物理主机名；
如果一个云主机只有一个L3网络，那么它就自动成为默认的L3网络。

下面的示例帮助理解什么是默认的L3网络。假设有一个如图 1所示的用户云主机：

云主机所连接的三个L3网络都提供SNAT服务，并且默认的L3网络是10.10.1.0/24：

CIDR: 10.10.1.0/24
Gateway: 10.10.1.1
DNS domain: web.tier.mycompany.com

那么云主机的路由表（routing table）将会是这样：

default via 10.10.1.1 dev eth0
10.10.1.0/24 dev eth0  proto kernel  scope link  src 10.10.1.99
192.168.0.0/24 dev eth1  proto kernel  scope link  src 192.168.0.10
172.16.0.0/24 dev eth2  proto kernel  scope link  src 172.16.0.55

可见，默认路由（default routing）指向了10.10.1.1，也就是默认L3网络的网关；同时云主机的/etc/resolv.conf如下所示：

search web.tier.mycompany.com
nameserver 10.10.1.1

就是说DNS域也是来自默认L3网络； DNS域名服务器（DNS name server）也是设置为10.10.1.1，因为默认L3网络提供了DNS服务器；最终，云主机的FQDN(Full Qualified Domain Name)看起来会像这样：

vm2.web.tier.mycompany.com

它是从DNS域扩展而来的。

云主机网络接口清单（VM Nic Inventory）

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		0.6
vmInstanceUuid	父云主机的uuid		0.6
l3NetworkUuid	网卡所绑定的三层网络UUID		0.6
ip	IP地址		0.6
mac	MAC地址		0.6
hypervisorType	虚拟化类型		0.6
netmask	子网掩码		0.6
gateway	网关		0.6
metaData	内部使用的保留域	是	0.6
deviceId	标识网卡在客户操作系统（guest operating system）以太网设备中顺序的整形数字。例如， 0通常代表eth0，1通常代表eth1。		0.6
usedIps			0.6
ipVersion	IP地址版本		0.6

示例

{
    "inventories": [
        {
            "createDate": "Sep 1, 2021 1:19:41 PM",
            "deviceId": 0,
            "driverType": "virtio",
            "gateway": "10.34.0.1",
            "hypervisorType": "KVM",
            "internalName": "vnic7.0",
            "ip": "10.34.0.199",
            "l3NetworkUuid": "fa7ae74a3bc64532b672bcdac820c3c6",
            "lastOpDate": "Sep 1, 2021 1:19:41 PM",
            "mac": "fa:4e:29:d7:6e:00",
            "netmask": "255.255.255.0",
            "type": "VNIC",
            "usedIps": [
                {
                    "createDate": "Sep 1, 2021 1:19:41 PM",
                    "gateway": "10.34.0.1",
                    "ip": "10.34.0.199",
                    "ipInLong": 170000583,
                    "ipRangeUuid": "e04aea52053443de9bb7b82af8233303",
                    "ipVersion": 4,
                    "l3NetworkUuid": "fa7ae74a3bc64532b672bcdac820c3c6",
                    "lastOpDate": "Sep 1, 2021 1:19:41 PM",
                    "netmask": "255.255.255.0",
                    "uuid": "0a678264c3d338358a6c1615d808a8e4",
                    "vmNicUuid": "2e1d6026e32e402ca1d3db5119940f29"
                }
            ],
            "uuid": "2e1d6026e32e402ca1d3db5119940f29",
            "vmInstanceUuid": "8049b3be8efb46c6aa143236d184c843"
        }
    ],
    "success": true
}

云盘（Volumes）

allVolumes域是由Volumes组成的列表，其中包含了根云盘（root volume）和数据云盘（data volumes）。如果要找出其中的根云盘，用户可以通过迭代这个列表，并检查云盘的类型或者使用域`rootVolumeUuid`来匹配云盘的UUID。根云盘会一直伴随云主机，直到云主机被删除。

虚拟机管理程序类型（Hypervisor Type）

根据云主机创建方式的不同，云主机的虚拟机管理程序类型可能是从镜像的虚拟机管理程序类型，或物理主机的虚拟机管理程序类型继承而来的。

从RootVolumeTemplate创建的虚拟机：
由于镜像中已经安装有操作系统，云主机会被创建在和镜像有相同虚拟机管理程序类型的物理主机上，因此云主机的虚拟机管理程序类型是从镜像继承而来的。
从ISO文件创建的虚拟机：
由于会使用ISO安装操作系统到云主机的空白根云盘上，云主机可能被创建在拥有任何类型的虚拟机管理程序的物理主机上，因此云主机的虚拟机管理程序类型是从创建的物理主机上继承而来的。

可用状态（State）

云主机的生命周期中有以下数种可用状态。

Created
在这种状态时，云主机还只是创建于数据库中的一个记录而已，并没有在任何物理主机上启动。这个状态仅在创建一个新的云主机的时候出现。
Starting
在这种状态时，云主机正在一个物理主机上启动。
Runnig
在这种状态时，云主机正在一个物理主机上运行。
Stopping
在这种状态时，云主机正在一个物理主机上停止过程中。
Stopped
在这种状态时，云主机已经停止，没有运行在任何物理主机上。
Rebooting
在这种状态时，云主机正在上次运行的物理主机上重启。
Destroying
在这种状态时，云主机正在被删除。
Destroyed
在这种状态时，云主机已经被删除。
Migrating
在这种状态时，云主机正在被迁移到另一个物理主机上。
Expunging
在这种状态时，云主机的数据库正在被删除。
Pausing
在这种状态时，云主机正在一个物理主机上暂停运行过程中。
Paused
在这种状态时，云主机已经暂停运行。
Resuming
在这种状态时，云主机正在从暂停状态恢复到运行状态的过程中。
VolumeMigrating
在这种状态时，云主机根云盘正在从本地存储迁移到其它物理主机。
Unknown
由于某些原因，例如，由于失去和物理主机的连接，云平台不能检查物理主机的可用状态。

如图 2所示：

云平台会使用VmTracer来周期性的跟踪云主机的状态；默认的间隔时间（interval）是60秒。云主机的状态可能会被云平台之外的因素影响。

例如，物理主机掉电（power outage）会导致所有该物理主机上运行的云主机停止运行；一旦VmTracer检测到云主机的实际状态和数据库中的记录不匹配，数据库会被更新为实际的状态。
如果VmTracer不能成功检查云主机的状态，例如，由于云平台管理节点和物理主机之间的连接丢失，云主机会被设置为Unknown状态；一旦VmTracer再次成功检测到云主机的状态，例如，云平台管理节点和物理主机之间的连接恢复之后，云主机的状态也会被更新为实际的状态。

CDROM清单（VmCdRom inventory）

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.3.0
name	请参见资源属性		3.3.0
description	请参见资源属性	是	3.3.0
deviceId	标识虚拟光驱在客户操作系统（guest operating system）中顺序的整形数字。例如， 0通常代表CDRO，1通常代表eth1。	是	3.3.0
isoInstallPath	在镜像服务器上的安装路径		3.3.0
isoUuid	ISO的UUID		3.3.0
vmInstanceUuid	云主机UUID		3.3.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.3.0
createDate	请参见资源属性		3.3.0
lastOpDate	请参见资源属性		3.3.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.3.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.3.0

示例

{
    "inventories": [
        {
            "createDate": "Jan 15, 2019 4:59:25 PM",
            "deviceId": 0,
            "lastOpDate": "Jan 15, 2019 4:59:25 PM",
            "name": "vm-6e243d2edf8443a4968d3878a4fed2a6-cdRom",
            "uuid": "29f6e8c277a94e57bd0b7c627bd65e85",
            "vmInstanceUuid": "6e243d2edf8443a4968d3878a4fed2a6"
        }
    ],
    "success": true
}

云主机优先级配置清单(VmPriorityConfig Inventory)

名字	描述	可选的	起始支持版本
uuid	请参见资源属性		3.7.0
accountUuid	账号UUID		3.7.0
cpuShares			3.7.0
level	优先级级别		3.7.0
oomScoreAdj			3.7.0
groupBy	以字段分组，相当于MySQL中的group by关键字。例如groupBy=type	是	3.7.0
createDate	请参见资源属性		3.7.0
lastOpDate	请参见资源属性		3.7.0
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	3.7.0
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	3.7.0

示例

{
    "inventories": [
        {
            "cpuShares": 512,
            "createDate": "Oct 16, 2019 9:51:40 AM",
            "lastOpDate": "Oct 16, 2019 9:51:40 AM",
            "level": "Normal",
            "oomScoreAdj": 0,
            "uuid": "b29df0c34e874a1c83033a3cfe61f086"
        },
        {
            "cpuShares": 1024,
            "createDate": "Oct 16, 2019 9:51:40 AM",
            "lastOpDate": "Oct 16, 2019 9:51:40 AM",
            "level": "High",
            "oomScoreAdj": -900,
            "uuid": "c804903064f54e36b3a066be0cd24aef"
        }
    ],
    "success": true
}

云主机GuestTools状态清单（GuestToolsState Inventory）

名字	描述	起始支持版本
vmInstanceUuid	云主机UUID	4.6.21
version	云主机GuestTools版本	4.6.21
platform	云主机OS平台类型	4.6.21
osType	云主机OS类型	4.6.21
qgaState		4.6.21
zwatchState		4.6.21
createDate	请参见资源属性	4.6.21
lastOpDate	请参见资源属性	4.6.21

示例

{
    "inventories": [
        {
            "createDate": "Apr 12, 2023 1:10:34 PM",
            "lastOpDate": "Apr 12, 2023 1:10:34 PM",
            "osType": "ubuntu 18.04",
            "platform": "Linux",
            "qgaState": "NotInstalled",
            "version": "4.6.21",
            "vmInstanceUuid": "93d0afea996d40cc99b49c22960187ba",
            "zwatchState": "Running"
        }
    ],
    "success": true
}