文档目录

镜像

概览

镜像:云主机或云盘使用的镜像模板文件,包括两种类型:系统镜像、云盘镜像。
  • 系统镜像:包含用户运行业务所需的操作系统的镜像,用于创建云主机,支持ISO、Image类型。
  • 云盘镜像:只包含用户业务数据的镜像,用于创建云盘,仅支持Image类型。
  • Image类型支持raw、qcow2和vmdk三种格式。
  • 镜像保存在镜像服务器上,首次创建云主机/云盘时,会下载到主存储上作为镜像缓存。

清单

属性

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见 资源属性 0.6
description 请参见 资源属性 0.6
state 请参见 state
  • Enabled
  • Disabled
0.6
status 请参见 status
  • Creating
  • Downloading
  • Ready
0.6
size 镜像大小, 单位是字节 0.6
url 镜像注册的url, 请参见 url 0.6
mediaType 镜像的媒介类型, 请参见 media type
  • RootVolumeTemplate
  • DataVolumeTemplate
  • ISO
0.6
guestOsType 该字符串描述了虚拟机的操作系统类型 0.6
platform 虚拟机的操作系统平台, 请参见 platform
  • Linux
  • Windows
  • Paravirtualization
  • Other
0.6
system 请参见 system image 0.6
format 请参见 format
  • qcow2
  • raw
0.6
md5Sum 镜像的md5校验值 0.6
type 保留的域
  • zstack
0.6
actualSize 真实大小 0.6
exportMd5Sum 0.6
exportUrl 0.6
backupStorageRefs image backstorage ref列表 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6

示例

{
    "inventories": [
        {
            "actualSize": 293641216,
            "backupStorageRefs": [
                {
                    "backupStorageUuid": "ae840e03a0044b759b0a8c09a141a46b",
                    "createDate": "Oct 30, 2017 4:32:11 PM",
                    "imageUuid": "fccc12fee6a411d68c42763ded705630",
                    "installPath": "zstore://fccc12fee6a411d68c42763ded705630/b08ea6cad1f10217223192343a1d8fb72279ed47",
                    "lastOpDate": "Oct 30, 2017 4:32:11 PM",
                    "status": "Ready"
                }
            ],
            "createDate": "Oct 30, 2017 4:32:11 PM",
            "description": "",
            "exportMd5Sum": "9b38fe1fd43385b86a1c9b12ac1960fe",
            "exportUrl": "http://10.0.146.122:8001/imagestore/download/image-b08ea6cad1f10217223192343a1d8fb72279ed47.qcow2",
            "format": "qcow2",
            "lastOpDate": "Oct 30, 2017 7:35:38 PM",
            "md5Sum": "42e98b8fc79cd8aeffe1b34a2a7021fed621eec0be926139d46e8afc26e78b7d",
            "mediaType": "RootVolumeTemplate",
            "name": "vr-test-2",
            "platform": "Linux",
            "size": 8589934592,
            "state": "Enabled",
            "status": "Ready",
            "system": true,
            "type": "zstack",
            "url": "http://192.168.200.100/mirror/diskimages/zstack-vrouter-latest.qcow2",
            "uuid": "fccc12fee6a411d68c42763ded705630"
        }
    ],
    "success": true
}

可用状态(State)

镜像有两种状态:
  • Enabled:

    在这种状态下,允许创建基于该镜像的云主机。

  • Disabled:

    在这种状态下,不允许创建基于该镜像的云主机。

连接状态(Status)

连接状态反映了镜像的生命周期:
  • Creating:

    正在从云盘创建镜像;未就绪不能使用。

  • Downloading:

    正在从url下载镜像;未就绪不能使用。

  • Ready:

    镜像已经在镜像服务器中;已就绪可以使用。

URL

镜像在镜像服务器中创建的方式不同,url的含义也会不同。
  • 如果镜像是从网页服务器下载的,url就是HTTP/HTTPS链接;
  • 如果镜像是从云盘或者云盘快照创建的, url就是云盘或云盘快照的UUID的字符串编码,例如:
    volume://b395386bdb4a4ff1b1850a457c949c5e
    volumeSnapshot://b395386bdb4a4ff1b1850a457c949c5e

媒介类型(Media Type)

媒介类型指示了镜像的用途。
  • RootVolumeTemplate:

    镜像被用来创建根云盘。

  • DataVolumeTemplate:

    镜像被用来创建数据云盘。

  • ISO:

    镜像被用来在空白的根云盘上安装操作系统。

平台(Platform)

ZStack Cloud根据平台来判断是否要使用半虚拟化(paravirtualization)。

使用半虚拟化
  • Linux
  • Paravirtualization
不使用半虚拟化(虚拟机磁盘使用IDE模式,网卡使用e1000)
  • Windows
  • Other

系统镜像(System Image)

系统镜像仅被用来创建特殊应用云主机(appliance VMs),因而不被用户云主机使用。

格式(Format)

格式反映了虚拟机管理程序和镜像之间的关系。 例如,qcow2格式的镜像仅能被KVM虚拟机使用。ZStack Cloud当前版本仅支持KVM虚拟机管理程序, 因此关系表如下:
虚拟机管理程序类型 格式
KVM
  • qcow2
  • raw

创建的云盘会从其所基于的镜像继承格式信息。 例如, 从qcow2格式的镜像创建的根云盘同样会是qcow2格式。raw格式是个特例,从raw格式的镜像创建的云盘会使用qcow2格式,因为ZStack Cloud会通过qcow2格式使用thin-clone。

镜像服务器引用(Backup Storage Reference)

一个镜像可以存储在一个或多个镜像服务器中。 对于所存储的每个镜像服务器, 镜像都有一个包含了镜像服务器uuid以及镜像安装路径的镜像服务器引用。
名字 描述 可选的 可选的参数值 起始支持版本
imageUuid 镜像的uuid 0.6
backupStorageUuid 镜像服务器的uuid,请参见 backup storage 0.6
installPath 在镜像服务器上的安装路径 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
示例
{
                    "backupStorageUuid": "ae840e03a0044b759b0a8c09a141a46b",
                    "createDate": "Oct 30, 2017 4:32:11 PM",
                    "imageUuid": "fccc12fee6a411d68c42763ded705630",
                    "installPath": "zstore://fccc12fee6a411d68c42763ded705630/b08ea6cad1f10217223192343a1d8fb72279ed47",
                    "lastOpDate": "Oct 30, 2017 4:32:11 PM",
                    "status": "Ready"
                }

操作(Operations)

添加镜像(AddImage)

管理员可以使用AddImage添加镜像。例如:
AddImage name=testimage url=http://192.168.200.100/mirror/diskimages/CentOS6-test-image-4G.qcow2 system=false format=qcow2 platform=Linux backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f mediaType=RootVolumeTemplate

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 镜像名称 0.6
description 镜像的详细描述 0.6
url 被添加镜像的URL地址 0.6
mediaType 镜像的类型
  • RootVolumeTemplate
  • ISO
  • DataVolumeTemplate
0.6
guestOsType 镜像对应客户机操作系统的类型 0.6
system 是否系统镜像 0.6
format 镜像的格式
  • raw
  • qcow2
  • iso
0.6
platform 镜像的系统平台
  • Linux
  • Windows
  • Windows Virtio
  • Other
  • Paravirtualization
0.6
backupStorageUuids 指定添加镜像的镜像服务器uuid列表 0.6
type 内部使用字段 0.6
resourceUuid 资源uuid。若指定,镜像会使用该字段值作为uuid 0.6
architecture
  • x86_64
  • aarch64
  • mips64el
4.0.0
tagUuids 签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

删除镜像(DeleteImage)

管理员可以使用DeleteImage删除镜像。例如:
DeleteImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f uuid=d10dd071a8b04c5aa4a8d98a83c1f979 \
deleteMode=Permissive

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

彻底删除镜像(ExpungeImage)

管理员可以使用ExpungeImage彻底删除镜像。例如:
ExpungeImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f \
imageUuid=d10dd071a8b04c5aa4a8d98a83c1f979

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
imageUuid 镜像uuid 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

查询镜像(QueryImage)

管理员可以使用QueryImage查询镜像。例如:
QueryImage status=Ready system=true
QueryImage volume.vmInstanceUuid=85ab231e392d4dfb86510191278e9fc3

原生域查询(Primitive Fields of Query)

请参见 image inventory

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
backupStorage backup storage inventory 该镜像所在的镜像服务器 0.6
volume volume inventory 从该镜像创建的所有云盘 0.6
backupStorageRefs backup storage reference 用来查询镜像服务器安装路径的引用 0.6

恢复镜像(RecoverImage)

管理员可以使用RecoverImage恢复删除(但未彻底删除)的镜像。例如:
RecoverImage backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f \
imageUuid=2aa6ae40c4954143be0ecb9a6a160b5b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
imageUuid 镜像uuid 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

修改镜像状态(ChangeImageState)

管理员可以使用ChangeImageState修改镜像状态。例如:
ChangeImageState uuid=2aa6ae40c4954143be0ecb9a6a160b5b stateEvent=disable

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
stateEvent 镜像的状态
  • enable
  • disable
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

更新镜像信息(UpdateImage)

管理员可以使用UpdateImage更新镜像信息。例如:
UpdateImage uuid=2aa6ae40c4954143be0ecb9a6a160b5b name=new-image

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
name 镜像名称 0.6
description 镜像的详细描述 0.6
mediaType 镜像的类型
  • RootVolumeTemplate
  • ISO
  • DataVolumeTemplate
0.6
guestOsType 镜像对应客户机操作系统的类型 0.6
system 是否系统镜像 0.6
format 镜像的格式
  • raw
  • qcow2
  • iso
0.6
platform 镜像的系统平台
  • Linux
  • Windows
  • Windows Virtio
  • Other
  • Paravirtualization
0.6
architecture
  • x86_64
  • aarch64
  • mips64el
4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

刷新镜像大小信息(SyncImageSize)

管理员可以使用SyncImageSize刷新镜像大小信息。例如:
SyncImageSize uuid=2aa6ae40c4954143be0ecb9a6a160b5b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

删除镜像包(DeleteImagePackage)

管理员可以使用DeleteImagePackage删除镜像包。例如:
DeleteImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 4.4.6
deleteMode 4.4.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 4.4.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 4.4.6
timeout

更新镜像包信息(UpdateImagePackage)

管理员可以使用UpdateImagePackage更新镜像包信息。例如:
UpdateImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 4.4.6
name 资源名称 4.4.6
description 资源的详细描述 4.4.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 4.4.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 4.4.6
timeout

查询镜像包(QueryImagePackage)

管理员可以使用QueryImagePackage查询镜像包。例如:
QueryImagePackage uuid=2aa6ae40c4954143be0ecb9a6a160b5b

原生域查询(Primitive Fields of Query)

请参见 image inventory

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
backupStorage backup storage inventory 该镜像所在的镜像服务器 4.4.6
vmInstance vmInstance inventory 源虚拟机 4.4.6

获取镜像服务器候选(GetCandidateBackupStorageForCreatingImage)

管理员可以使用GetCandidateBackupStorageForCreatingImage获取创建镜像的镜像服务器候选。例如:
GetCandidateBackupStorageForCreatingImage volumeUuid=493a22431c434505b49afb16a5a6cda6

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
volumeUuid 云盘uuid,注意:volumeUuid 和 volumeSnapshotUuid 二选一 0.6
volumeSnapshotUuid 云盘快照uuid,注意:volumeUuid 和 volumeSnapshotUuid 二选一 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

从根云盘创建根云盘镜像(CreateRootVolumeTemplateFromRootVolume)

管理员可以使用CreateRootVolumeTemplateFromRootVolume从根云盘创建根云盘镜像。例如:
CreateRootVolumeTemplateFromRootVolume rootVolumeUuid=cc83fc9639cf456c8e43c35f6d2d52cd \
backupStorageUuids=ab3d53288bd14e6eba6ea56324b66a3f name=new-rootvolume

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 根云盘镜像名称 0.6
description 根云盘镜像的详细描述 0.6
guestOsType 根云盘镜像对应客户机操作系统类型 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
rootVolumeUuid 根云盘uuid 0.6
platform 根云盘镜像对应的系统平台
  • Linux
  • Windows
  • Windows Virtio
  • Other
  • Paravirtualization
0.6
system 是否系统根云盘镜像 0.6
resourceUuid 资源uuid。若指定,根云盘镜像会使用该字段值作为uuid 0.6
architecture 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout
Note:
  • ZStack Cloud从根云盘创建根云盘镜像时支持从云主机拷贝GuestTools标签值到镜像, 使用该镜像创建云主机时,从镜像拷贝GuestTools标签值到新云主机。SystemTags增加GuestTools选项。
    • 选项格式为:GuestTools::TOOLS_VERSION,其中TOOLS_VERSION初值为1.0.0,未来随着工具版本的提升,这个值会随之变化。
    • 例如:GuestTools::1.0.0
    • 补充说明:云主机根云盘创建镜像时,从云主机拷贝GuestTools标签值到镜像。

从云盘快照创建根云盘镜像(CreateRootVolumeTemplateFromVolumeSnapshot)

管理员可以使用CreateRootVolumeTemplateFromVolumeSnapshot从云盘快照创建根云盘镜像。例如:
CreateRootVolumeTemplateFromVolumeSnapshot name=root-volume-template \
snapshotUuid=30a129c7f06243499b1ed5ec9e4a778e backupStorageUuids=e05cad1e1e3a4778a3a0b57cddd847f3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 根云盘镜像名称 0.6
description 根云盘镜像的详细描述 0.6
guestOsType 根云盘镜像对应客户机操作系统类型 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
snapshotUuid 快照uuid 0.6
platform 根云盘镜像对应的系统平台
  • Linux
  • Windows
  • Windows Virtio
  • Other
  • Paravirtualization
0.6
system 是否系统根云盘镜像 0.6
resourceUuid 资源uuid。若指定,根云盘镜像会使用该字段值作为uuid 0.6
architecture 4.0.0
tagUuids 标签UUID列表 4.0.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

从云盘创建数据云盘镜像(CreateDataVolumeTemplateFromVolume)

管理员可以使用CreateDataVolumeTemplateFromVolume从云盘创建数据云盘镜像。例如:
CreateDataVolumeTemplateFromVolume name=test    \
volumeUuid=3eb74bba9a5448368158c2ee6f0a61ef

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
volumeUuid 起始云盘uuid 0.6
name 数据云盘镜像名称 0.6
description 数据云盘镜像的详细描述 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
resourceUuid 数据云盘镜像uuid。若指定,数据云盘镜像会使用该字段值作为uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

从云盘快照创建数据云盘镜像(CreateDataVolumeTemplateFromVolumeSnapshot)

管理员可以使用CreateDataVolumeTemplateFromVolumeSnapshot从云盘快照创建数据云盘镜像。例如:
CreateDataVolumeTemplateFromVolumeSnapshot name=data-volume-template \
snapshotUuid=30a129c7f06243499b1ed5ec9e4a778e backupStorageUuids=e05cad1e1e3a4778a3a0b57cddd847f3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 数据云盘镜像名称 0.6
description 数据云盘镜像的详细描述 0.6
guestOsType 数据云盘镜像对应客户机操作系统类型 0.6
backupStorageUuids 镜像服务器uuid列表 0.6
snapshotUuid 快照uuid 0.6
platform 数据云盘镜像对应的系统平台
  • Linux
  • Windows
  • Windows Virtio
  • Other
  • Paravirtualization
0.6
system 是否系统数据云盘镜像 0.6
resourceUuid 资源uuid。若指定,数据云盘镜像会使用该字段值作为uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

获取镜像Qga(GetImageQga)

管理员可以使用GetImageQga获取镜像Qga。例如:
GetImageQga uuid=0ed799bb11b940229e97b1fc0b09a7d3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

设置镜像Qga(SetImageQga)

管理员可以使用SetImageQga设置镜像Qga。例如:
SetImageQga enable=true uuid=0ed799bb11b940229e97b1fc0b09a7d3

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 镜像uuid 0.6
enable 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ImageVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ImageVO 0.6
timeout

设置镜像启动模式(SetImageBootMode)

用户可以使用SetImageBootMode设置镜像启动模式。 例如:
SetImageBootMode uuid=4efcba4c12cc35f4a1b262038f7e7b80 bootMode=Legacy

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.9.0
bootMode 镜像启动模式
  • Legacy
  • UEFI
  • UEFI_WITH_CSM
3.9.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.9.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.9.0
timeout

获取上传镜像任务详情(GetUploadImageJobDetails)

用户可以使用GetUploadImageJobDetails获取上传镜像任务详情。 例如:
GetUploadImageJobDetails imageId=4efcba4c12cc35f4a1b262038f7e7b80

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
imageId 上传镜像的唯一标识,由用户自定义,推荐使用 md5 4.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 4.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 4.1.0
timeout

标签(Tags)

用户可以使用resourceType=ImageVO在镜像上创建用户标签。 例如:
CreateUserTag resourceType=ImageVO tag=golden-image \
resourceUuid=ff7c04c4e2874a21a3e795501f1bc516
CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心