添加镜像

POST/zstack/v1/images

向镜像仓库添加镜像。

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "TinyLinux",
    "url": "http://192.168.1.20/share/images/tinylinux.qcow2",
    "mediaType": "RootVolumeTemplate",
    "architecture": "x86_64",
    "system": false,
    "format": "qcow2",
    "platform": "Linux",
    "backupStorageUuids": [
      "b8fc9c1c027438c28d36af24eca06595"
    ],
    "virtio": false
  },
  "systemTags": [],
  "userTags": []
}

上述示例中userTags字段可以省略。列出是为了表示body中可以包含这个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d'{"params":{"name":"TinyLinux","url":"http://192.168.1.20/share/images/tinylinux.qcow2","mediaType":"RootVolumeTemplate","architecture":"x86_64","system":false,"format":"qcow2","platform":"Linux","backupStorageUuids":["b8fc9c1c027438c28d36af24eca06595"],"virtio":false}}' http://localhost:8080/zstack/v1/images

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	镜像名称		0.6
description (可选)	String	body(包含在params结构中)	镜像的详细描述		0.6
url	String	body(包含在params结构中)	被添加镜像的URL地址		0.6
mediaType (可选)	String	body(包含在params结构中)	镜像的类型	RootVolumeTemplate ISO DataVolumeTemplate	0.6
guestOsType (可选)	String	body(包含在params结构中)	镜像对应客户机操作系统的类型		0.6
system (可选)	boolean	body(包含在params结构中)	是否系统镜像		0.6
format (可选)	String	body(包含在params结构中)	镜像的格式，比如：raw		4.0.0
platform (可选)	String	body(包含在params结构中)	镜像的系统平台	Linux Windows WindowsVirtio Other Paravirtualization	0.6
backupStorageUuids	List	body(包含在params结构中)	指定添加镜像的镜像仓库UUID列表		0.6
type (可选)	String	body(包含在params结构中)	内部使用字段		0.6
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID。若指定，镜像会使用该字段值作为UUID。		0.6
architecture (可选)	String	body(包含在params结构中)		x86_64 aarch64 mips64el	4.0.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表		4.0.0
systemTags	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6

API返回

返回示例

{
  "inventory": {
    "uuid": "1eb26d06364036b7860d2b7dbb462b8c",
    "name": "TinyLinux",
    "url": "http://192.168.1.20/share/images/tinylinux.qcow2",
    "mediaType": "RootVolumeTemplate",
    "platform": "Linux",
    "architecture": "x86_64",
    "format": "qcow2",
    "backupStorageRefs": [
      {
        "id": 0.0,
        "imageUuid": "1eb26d06364036b7860d2b7dbb462b8c",
        "backupStorageUuid": "902dcc8d1015318fb4903df890765c4d",
        "installPath": "ceph://zs-images/f0b149e053b34c7eb7fe694b182ebffd",
        "status": "Ready"
      }
    ]
  }
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	ImageInventory	详情参考inventory	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

inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
state	String	镜像的启动状态	4.0.0
status	String	镜像的就绪状态	4.0.0
size	Long	镜像大小	4.0.0
actualSize	Long	镜像真实容量	4.0.0
md5Sum	String	镜像的md5值	4.0.0
url	String	镜像的URL地址	4.0.0
mediaType	String	镜像的类型	4.0.0
guestOsType	String	镜像对应的客户机操作系统类型	4.0.0
type	String	内部使用字段	4.0.0
platform	String	镜像的系统平台	4.0.0
format	String	镜像的格式，比如：raw	4.0.0
system	Boolean	标识是否为系统镜像	4.0.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
backupStorageRefs	List	详情参考backupStorageRefs	0.6

backupStorageRefs

名字	类型	描述	起始版本
imageUuid	String	镜像UUID	0.6
backupStorageUuid	String	镜像存储UUID	0.6
installPath	String	在镜像仓库上的安装路径	4.0.0
exportUrl	String	导出镜像的url	4.0.0
exportMd5Sum	String	导出镜像的md5值	4.0.0
status	String	镜像就绪状态	4.0.0
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

SDK示例

Java SDK

AddImageAction action = new AddImageAction();
action.name = "TinyLinux";
action.url = "http://192.168.1.20/share/images/tinylinux.qcow2";
action.mediaType = "RootVolumeTemplate";
action.architecture = "x86_64";
action.system = false;
action.format = "qcow2";
action.platform = "Linux";
action.backupStorageUuids = asList("b8fc9c1c027438c28d36af24eca06595");
action.virtio = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddImageAction.Result res = action.call();

Python SDK

AddImageAction action = AddImageAction()
action.name = "TinyLinux"
action.url = "http://192.168.1.20/share/images/tinylinux.qcow2"
action.mediaType = "RootVolumeTemplate"
action.architecture = "x86_64"
action.system = false
action.format = "qcow2"
action.platform = "Linux"
action.backupStorageUuids = [b8fc9c1c027438c28d36af24eca06595]
action.virtio = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddImageAction.Result res = action.call()