从元数据注册虚拟机

POST/zstack/v1/vm-instances/metadata/register

Request

cURL

curl --request POST \
  --url '/v1/vm-instances/metadata/register' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/vm-instances/metadata/register"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "metadataPath": "/mnt/ps/vm-metadata/ff01ec80fd11327cba7519b66119d900.vmmeta",
    "primaryStorageUuid": "ff0359abb8443d2f8077cc368afa7c00",
    "zoneUuid": "ff0c268342c535aabf273d41a2be1d00",
    "clusterUuid": "ff0bcb94de7a3567b641d3fde2329d00",
    "hostUuid": "ff0192fa70113da886101145c084bd00",
    "name": "my-restored-vm"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"metadataPath":"/mnt/ps/vm-metadata/ff01ec80fd11327cba7519b66119d900.vmmeta","primaryStorageUuid":"ff0359abb8443d2f8077cc368afa7c00","zoneUuid":"ff0c268342c535aabf273d41a2be1d00","clusterUuid":"ff0bcb94de7a3567b641d3fde2329d00","hostUuid":"ff0192fa70113da886101145c084bd00","name":"my-restored-vm"}}' \
http://localhost:8080/zstack/v1/vm-instances/metadata/register

参数列表

名字	类型	位置	描述	起始版本
metadataPath	String	body(包含在`params`结构中)	元数据文件在数据存储上的路径	5.0.0
primaryStorageUuid	String	body(包含在`params`结构中)	目标数据存储UUID	5.0.0
zoneUuid	String	body(包含在`params`结构中)	数据中心UUID	5.0.0
clusterUuid	String	body(包含在`params`结构中)	集群UUID	5.0.0
hostUuid (可选)	String	body(包含在`params`结构中)	物理机UUID	5.0.0
name (可选)	String	body(包含在`params`结构中)	虚拟机名称	5.0.0
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表	5.0.0
systemTags (可选)	List	body	系统标签	5.0.0
userTags (可选)	List	body	用户标签	5.0.0

API返回

返回示例

{
  "inventory": {
    "uuid": "21d608564fe438fd8b6c29fde66a4881",
    "name": "recovered-vm"
  }
}

名字	类型	描述	起始版本
success	boolean	操作是否成功	5.0.0
inventory	VmInstanceInventory	详情参考inventory	5.0.0
error	ErrorCode	详情参考error	5.0.0

inventory

名字	类型	描述	起始版本
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	上一次启动的主机 UUID	0.6
instanceOfferingUuid	String	计算规格 UUID, 已废弃	0.6
rootVolumeUuid	String	根硬盘 UUID	0.6
platform	String	虚拟机的平台, 是 Windows / Linux 还是其它	0.6
architecture	String	虚拟机架构, 是 x86_64 / aarch64 还是其它	0.6
defaultL3NetworkUuid	String	默认使用的分布式端口组 UUID	0.6
type	String	虚拟机类型, 是用户使用虚拟机还是平台特殊用途的虚拟机	0.6
hypervisorType	String	虚拟机虚拟化类型, 一般为 KVM	0.6
memorySize	Long	内存大小	0.6
cpuNum	Integer	CPU 数量	0.6
cpuSpeed	Long	CPU 速度	0.6
allocatorStrategy	String	虚拟机分配策略	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
state	String	虚拟机是否启用的状态	0.6
guestOsType	String	虚拟机宿主操作系统类型	3.11.2
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

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

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

SDK示例

Java SDK

RegisterVmInstanceFromMetadataAction action = new RegisterVmInstanceFromMetadataAction();
action.metadataPath = "/mnt/ps/vm-metadata/ff01ec80fd11327cba7519b66119d900.vmmeta";
action.primaryStorageUuid = "ff0359abb8443d2f8077cc368afa7c00";
action.zoneUuid = "ff0c268342c535aabf273d41a2be1d00";
action.clusterUuid = "ff0bcb94de7a3567b641d3fde2329d00";
action.hostUuid = "ff0192fa70113da886101145c084bd00";
action.name = "my-restored-vm";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RegisterVmInstanceFromMetadataAction.Result res = action.call();

Python SDK

action = RegisterVmInstanceFromMetadataAction()
action.metadataPath = "/mnt/ps/vm-metadata/ff01ec80fd11327cba7519b66119d900.vmmeta"
action.primaryStorageUuid = "ff0359abb8443d2f8077cc368afa7c00"
action.zoneUuid = "ff0c268342c535aabf273d41a2be1d00"
action.clusterUuid = "ff0bcb94de7a3567b641d3fde2329d00"
action.hostUuid = "ff0192fa70113da886101145c084bd00"
action.name = "my-restored-vm"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()