跨主存储迁移云主机

PUT/zstack/v1/vm-instances/{vmInstanceUuid}/actions

操作 ID

PrimaryStorageMigrateVm

起始版本

3.1.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

vmInstanceUuid
String必填
云主机UUID

请求体字段

dstPrimaryStorageUuid
String必填
目标主存储UUID
withDataVolumes
boolean
迁移包含云盘
withSnapshots
boolean
迁移包含快照
dstHostUuid
String
可选。
strategy
String
处理策略。

响应状态

200 OK

该 API 成功时返回以下响应结构。

success
boolean必填
操作是否成功。
error
ErrorCode必填
错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error
- code
  String必填
  错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001
- description
  String必填
  错误的概要描述
- details
  String必填
  错误的详细信息
- elaboration
  String必填
  保留字段，默认为null
- opaque
  LinkedHashMap必填
  保留字段，默认为null
- cause
  ErrorCode必填
  根错误，引发当前错误的源错误，若无原错误，该字段为null
inventory
VmInstanceInventory必填
详情参考inventory
uuid
String必填
资源的UUID，唯一标示该资源
name
String必填
资源名称
description
String必填
资源的详细描述
zoneUuid
String必填
区域UUID
clusterUuid
String必填
集群UUID
imageUuid
String必填
镜像UUID
hostUuid
String必填
物理机UUID
lastHostUuid
String必填
最近一次主机UUID。
instanceOfferingUuid
String必填
计算规格UUID
rootVolumeUuid
String必填
根云盘UUID
platform
String必填
平台。
architecture
String必填
架构。
defaultL3NetworkUuid
String必填
默认三层3网络UUID。
type
String必填
类型。
hypervisorType
String必填
hypervisor类型。
memorySize
Long必填
内存大小。
cpuNum
Integer必填
暂无描述。
cpuSpeed
Long必填
暂无描述。
allocatorStrategy
String必填
allocator策略。
createDate
Timestamp必填
创建时间
lastOpDate
Timestamp必填
最后一次修改时间
state
String必填
当前状态。
guestOsType
String必填
guest操作系统类型。
vmNics
List必填
详情参考vmNics
allVolumes
List必填
详情参考allVolumes
vmCdRoms
List必填
详情参考vmCdRoms
uuid
String必填
资源的UUID，唯一标示该资源
vmInstanceUuid
String必填
云主机UUID
l3NetworkUuid
String必填
三层网络UUID
ip
String必填
IP地址
mac
String必填
MAC地址。
netmask
String必填
网络掩码
gateway
String必填
网关地址
metaData
String必填
元数据。
deviceId
Integer必填
设备ID。
createDate
Timestamp必填
创建时间
lastOpDate
Timestamp必填
最后一次修改时间
usedIps
List必填
详情参考usedIps
uuid
String必填
资源的UUID，唯一标示该资源
ipRangeUuid
String必填
IP段UUID
l3NetworkUuid
String必填
三层网络UUID
ipVersion
Integer必填
IP协议号
ip
String必填
IP地址
netmask
String必填
网络掩码
gateway
String必填
网关地址
usedFor
String必填
intended使用。
ipInLong
long必填
IP地址represented长integer。
vmNicUuid
String必填
云主机网卡UUID
createDate
Timestamp必填
创建时间
lastOpDate
Timestamp必填
最后一次修改时间
uuid
String必填
资源的UUID，唯一标示该资源
name
String必填
资源名称
description
String必填
资源的详细描述
primaryStorageUuid
String必填
主存储UUID
vmInstanceUuid
String必填
云主机UUID
diskOfferingUuid
String必填
云盘规格UUID
rootImageUuid
String必填
根镜像UUID。
installPath
String必填
安装路径。
type
String必填
类型。
format
String必填
数据格式或导出格式。
size
Long必填
返回记录数。
actualSize
Long必填
实际大小。
deviceId
Integer必填
设备ID。
state
String必填
当前状态。
status
String必填
状态信息。
createDate
Timestamp必填
创建时间
lastOpDate
Timestamp必填
最后一次修改时间
isShareable
Boolean必填
是否资源可分享。
uuid
String必填
资源的UUID，唯一标示该资源
vmInstanceUuid
String必填
云主机UUID
deviceId
Integer必填
设备ID。
isoUuid
String必填
暂无描述。
isoInstallPath
String必填
iso安装路径。
name
String必填
资源名称
description
String
资源的详细描述
createDate
Timestamp必填
创建时间
lastOpDate
Timestamp必填
最后一次修改时间

请求示例

curl -X PUT '{host}/zstack/v1/vm-instances/{vmInstanceUuid}/actions' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "dstPrimaryStorageUuid": "{dstPrimaryStorageUuid}",
  "withDataVolumes": "{withDataVolumes}",
  "withSnapshots": "{withSnapshots}",
  "dstHostUuid": "{dstHostUuid}",
  "strategy": "{strategy}",
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ],
  "migrateVm": {
    "downTime": "{downTime}",
    "bandwidth": "{bandwidth}"
  }
}'

响应示例

{
  "inventory": {
    "uuid": "f483af349d39312c8078d142c40fb721",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "b7280443258337bb9e8d2abf4a014644",
    "clusterUuid": "a2c0ace5be2d35b5a365067a0127b377",
    "imageUuid": "14fb13b692e837dfa31d75ffc02d4d4d",
    "hostUuid": "f0690203b1463867bcb2f5a48a1fa91a",
    "lastHostUuid": "655acef664af39e9b6b7fec0d4de56c0",
    "instanceOfferingUuid": "772a66f21ef23ba7a69ad292e4489ebb",
    "rootVolumeUuid": "65b10a950f1336f48b770f98b25176eb",
    "platform": "Linux",
    "defaultL3NetworkUuid": "80c8af5ff0a135e18a3e7a4d2223ebd2",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 9:20:57 AM",
    "lastOpDate": "Nov 14, 2017 9:20:57 AM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "b16455db309330289acb58edbfabd4b7",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "usedIpUuid": "27787a727c143a7aada42e6c3b111887",
        "l3NetworkUuid": "80c8af5ff0a135e18a3e7a4d2223ebd2",
        "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,
        "state": "enable",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "65b10a950f1336f48b770f98b25176eb",
        "name": "Root-Volume-For-VM-f483af349d39312c8078d142c40fb721",
        "primaryStorageUuid": "55245463f914331c954909475279c3b0",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "diskOfferingUuid": "b2cb37282f5034fb808dff68dc18db9e",
        "rootImageUuid": "14fb13b692e837dfa31d75ffc02d4d4d",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-65b10a950f1336f48b770f98b25176eb/65b10a950f1336f48b770f98b25176eb.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      },
      {
        "uuid": "97bf368f3bde3490b0c08d37ac8bc747",
        "name": "Data-Volume-For-VM-f483af349d39312c8078d142c40fb721",
        "primaryStorageUuid": "4df2eddd6ac1307ebbff27d0044f72e9",
        "vmInstanceUuid": "f483af349d39312c8078d142c40fb721",
        "diskOfferingUuid": "06ea8f5a59843b8aa4d18d9c6d2b7a1d",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-97bf368f3bde3490b0c08d37ac8bc747/97bf368f3bde3490b0c08d37ac8bc747.qcow2",
        "type": "Data",
        "format": "qcow2",
        "size": 536870912000,
        "actualSize": 107374182400,
        "deviceId": 1,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 9:20:57 AM",
        "lastOpDate": "Nov 14, 2017 9:20:57 AM"
      }
    ]
  }
}

变更历史

查看全部变更历史

变更时间变更内容概要操作

变更时间
2026-08-12
新增响应字段 actualSize, allVolumes, allocatorStrategy...
查看 API

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口