查询指定ID的迁移任务

功能介绍

查询指定ID的迁移任务。

URI

GET /v3/tasks/{task_id}

表1 路径参数
参数	是否必选	参数类型	描述
task_id	是	String	迁移任务id 最小长度：0 最大长度：255

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。最小长度：1 最大长度：16384

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
name	String	任务名称（用户自定义）最小长度：0 最大长度：255
type	String	任务类型，创建时必选，更新时可选最小长度：0 最大长度：255 枚举值： MIGRATE_FILE MIGRATE_BLOCK
os_type	String	操作系统类型，分为WINDOWS和LINUX，创建时必选，更新时可选枚举值： WINDOWS LINUX
id	String	迁移任务id 最小长度：0 最大长度：255
priority	Integer	进程优先级 0：低 1：标准（默认） 2：高最小值：0 最大值：2 枚举值： 0 1 2
region_id	String	目的端服务器的区域ID 最小长度：0 最大长度：255
start_target_server	Boolean	迁移完成后是否启动目的端服务器 true：启动 false：停止缺省值：true
enterprise_project_id	String	企业项目id 最小长度：1 最大长度：255
migration_ip	String	目的端服务器的IP地址。公网迁移时请填写弹性IP地址专线迁移时请填写私有IP地址最小长度：0 最大长度：255
region_name	String	目的端服务器的区域名称最小长度：0 最大长度：255
project_name	String	目的端服务器所在项目名称最小长度：0 最大长度：255
project_id	String	目的端服务器所在项目ID 最小长度：0 最大长度：255
vm_template_id	String	模板ID 最小长度：0 最大长度：255
source_server	SourceServer object	源端服务器
target_server	TaskTargetServer object	目的端服务器
state	String	任务状态最小长度：0 最大长度：255
estimate_complete_time	Long	预估完成时间最小值：0 最大值：9223372036854775807
connected	Boolean	连接状态
create_date	Long	任务创建时间最小值：0 最大值：9223372036854775807
start_date	Long	任务开始时间最小值：0 最大值：9223372036854775807
finish_date	Long	任务结束时间最小值：0 最大值：9223372036854775807
migrate_speed	Double	迁移速率，单位：MB/S 最小值：0 最大值：10000
compress_rate	Double	压缩率最小值：0 最大值：10000
error_json	String	错误信息最小长度：0 最大长度：1024
total_time	Long	任务总耗时最小值：0 最大值：9223372036854775807
float_ip	String	暂时保留float,兼容现网老版本的SMS-Agent 最小长度：0 最大长度：255
remain_seconds	Long	迁移剩余时间（秒）最小值：0 最大值：9223372036854775807
target_snapshot_id	String	目的端的快照id 最小长度：0 最大长度：255
clone_server	CloneServer object	克隆服务器类
sub_tasks	Array of SubTask objects	任务包含的子任务列表

表4 SourceServer
参数	参数类型	描述
id	String	源端在SMS数据库中的ID 最小长度：0 最大长度：255
ip	String	源端服务器ip，注册源端时必选，更新非必选最小长度：0 最大长度：255
name	String	用来区分不同源端服务器的名称最小长度：0 最大长度：255
hostname	String	源端主机名，注册源端必选，更新非必选最小长度：0 最大长度：255
os_type	String	源端服务器的OS类型，分为Windows和Linux，注册必选，更新非必选最小长度：0 最大长度：255 枚举值： WINDOWS LINUX
os_version	String	操作系统版本，注册必选，更新非必选最小长度：0 最大长度：255
firmware	String	源端服务器启动类型，如BIOS或者UEFI 最小长度：0 最大长度：255 枚举值： BIOS UEFI
cpu_quantity	Integer	CPU个数，单位vCPU 最小值：0 最大值：65535
memory	Long	内存大小，单位MB 最小值：0 最大值：9223372036854775807
disks	Array of ServerDisk objects	源端服务器的磁盘信息
btrfs_list	Array of BtrfsFileSystem objects	Linux 必选，源端的Btrfs信息。如果源端不存在Btrfs，则为[]
networks	Array of NetWork objects	源端服务器的网卡信息
domain_id	String	租户的domainId 最小长度：0 最大长度：255
has_rsync	Boolean	是否安装rsync组件，Linux系统此参数为必选
paravirtualization	Boolean	Linux场景必选，源端是否是半虚拟化
raw_devices	String	Linux必选，裸设备列表最小长度：0 最大长度：255
driver_files	Boolean	Windows 必选，是否缺少驱动文件
system_services	Boolean	Windows必选，是否存在不正常服务
account_rights	Boolean	Windows必选，权限是否满足要求
boot_loader	String	Linux必选，系统引导类型，BOOT_LOADER(GRUB/LILO) 枚举值： GRUB LILO
system_dir	String	Windows必选，系统目录最小长度：0 最大长度：255
volume_groups	Array of VolumeGroups objects	Linux必选，如果没有卷组，输入[]
agent_version	String	Agent版本最小长度：0 最大长度：255

表5 ServerDisk
参数	参数类型	描述
name	String	磁盘名称最小长度：0 最大长度：255
partition_style	String	磁盘的分区类型，添加源端时源端磁盘必选枚举值： MBR GPT
device_use	String	磁盘类型枚举值： BOOT OS
size	Long	磁盘总大小，以字节为单位最小值：0 最大值：9223372036854775807
used_size	Long	磁盘已使用大小，以字节为单位最小值：0 最大值：9223372036854775807
physical_volumes	Array of PhysicalVolume objects	磁盘上的物理分区信息
os_disk	Boolean	是否为系统盘
relation_name	String	Linux系统目的端ECS中与源端关联的磁盘名称最小长度：0 最大长度：255

表6 PhysicalVolume
参数	参数类型	描述
device_use	String	分区类型，普通分区，启动分区，系统分区最小长度：0 最大长度：255
file_system	String	文件系统类型最小长度：0 最大长度：255
index	Integer	顺序最小值：0 最大值：2147483647
mount_point	String	挂载点最小长度：0 最大长度：255
name	String	名称，windows表示盘符，Linux表示设备号最小长度：0 最大长度：255
size	Long	大小最小值：0 最大值：9223372036854775807
used_size	Long	使用大小最小值：0 最大值：9223372036854775807
uuid	String	GUID，可从源端查询最小长度：0 最大长度：255
size_per_cluster	Integer	每个cluster大小最小值：0 最大值：2147483647

表7 BtrfsFileSystem
参数	参数类型	描述
name	String	文件系统名称最小长度：0 最大长度：255
label	String	文件系统标签，若无标签为空字符串最小长度：0 最大长度：255
uuid	String	文件系统的uuid 最小长度：0 最大长度：255
device	String	btrfs包含的设备名称最小长度：0 最大长度：255
size	Long	文件系统数据占用大小最小值：0 最大值：9223372036854775807
nodesize	Long	btrfs节点大小最小值：0 最大值：9223372036854775807
sectorsize	Integer	扇区大小最小值：0 最大值：2147483647
data_profile	String	数据配置（RAD）最小长度：0 最大长度：255
system_profile	String	文件系统配置（RAD）最小长度：0 最大长度：255
metadata_profile	String	元数据配置（RAD）最小长度：0 最大长度：255
global_reserve1	String	Btrfs文件系统信息最小长度：0 最大长度：255
g_vol_used_size	Long	Btrfs卷已使用空间大小最小值：0 最大值：9223372036854775807
default_subvolid	String	默认子卷ID 最小长度：0 最大长度：255
default_subvol_name	String	默认子卷名称最小长度：0 最大长度：255
default_subvol_mountpath	String	默认子卷挂载路径/BTRFS文件系统的挂载路径最小长度：0 最大长度：255
subvolumn	Array of BtrfsSubvolumn objects	子卷信息

表8 BtrfsSubvolumn
参数	参数类型	描述
uuid	String	父卷的uuid 最小长度：0 最大长度：255
is_snapshot	String	子卷是否为快照最小长度：0 最大长度：255
subvol_id	String	子卷的id 最小长度：0 最大长度：255
parent_id	String	父卷id 最小长度：0 最大长度：255
subvol_name	String	子卷的名称最小长度：0 最大长度：255
subvol_mount_path	String	子卷的挂载路径最小长度：0 最大长度：255

表9 NetWork
参数	参数类型	描述
name	String	网卡的名称最小长度：0 最大长度：255
ip	String	该网卡绑定的IP 最小长度：0 最大长度：255
netmask	String	掩码最小长度：0 最大长度：255
gateway	String	网关最小长度：0 最大长度：255
mtu	Integer	Linux必选，网卡的MTU 最小值：0 最大值：2147483647
mac	String	Mac地址最小长度：0 最大长度：255
id	String	数据库Id 最小长度：0 最大长度：255

**表10** TaskTargetServer
参数	参数类型	描述
id	String	目的端在SMS数据库中的ID 最小长度：0 最大长度：255
vm_id	String	目的端服务器ID，自动创建虚拟机不需要这个参数最小长度：0 最大长度：255
name	String	目的端服务器的名称最小长度：0 最大长度：255
ip	String	目的端服务器ip 最小长度：0 最大长度：255
os_type	String	源端服务器的OS类型，分为Windows和Linux，注册必选，更新非必选最小长度：0 最大长度：255 枚举值： WINDOWS LINUX
os_version	String	操作系统版本，注册必选，更新非必选最小长度：0 最大长度：255
system_dir	String	Windows必选，系统目录最小长度：0 最大长度：255
disks	Array of TargetDisk objects	目的端磁盘信息，一般和源端保持一致
volume_groups	Array of VolumeGroups objects	lvm信息，一般和源端保持一致
btrfs_list	Array of strings	Linux 必选，源端的Btrfs信息。如果源端不存在Btrfs，则为[]
image_disk_id	String	目的端代理镜像磁盘id 最小长度：0 最大长度：255
cutovered_snapshot_ids	String	目的端回滚快照id 最小长度：0 最大长度：255

**表11** TargetDisk
参数	参数类型	描述
device_use	String	判断是普通分区，启动分区还是系统分区缺省值：NORMAL 枚举值： NORMAL OS BOOT
disk_id	String	磁盘id 最小长度：0 最大长度：255
name	String	磁盘名称最小长度：0 最大长度：255
physical_volumes	Array of TargetPhysicalVolumes objects	逻辑卷信息
size	Long	大小最小值：0 最大值：9223372036854775807
used_size	Long	已使用大小最小值：0 最大值：9223372036854775807

**表12** TargetPhysicalVolumes
参数	参数类型	描述
device_use	String	分区类型缺省值：NORMAL 枚举值： NORMAL OS BOOT
file_system	String	文件系统最小长度：0 最大长度：255
index	Integer	编号最小值：0 最大值：2147483647
mount_point	String	挂载点最小长度：0 最大长度：255
name	String	名称最小长度：0 最大长度：255
size	Long	大小最小值：0 最大值：9223372036854775807
used_size	Long	使用大小最小值：0 最大值：9223372036854775807
uuid	String	uuid 最小长度：0 最大长度：255

**表13** VolumeGroups
参数	参数类型	描述
components	String	Pv信息最小长度：0 最大长度：255
free_size	Long	剩余空间最小值：0 最大值：9223372036854775807
logical_volumes	Array of LogicalVolumes objects	lv信息
name	String	名称最小长度：0 最大长度：255
size	Long	大小最小值：0 最大值：9223372036854775807

**表14** LogicalVolumes
参数	参数类型	描述
block_count	Integer	块数量最小值：0 最大值：4294967296 缺省值：0
block_size	Long	块大小最小值：0 最大值：1048576 缺省值：0
file_system	String	文件系统最小长度：0 最大长度：255
inode_size	Integer	inode数量最小值：0 最大值：4294967296
mount_point	String	挂载点最小长度：0 最大长度：256
name	String	名称最小长度：0 最大长度：1024
size	Long	大小最小值：0 最大值：9223372036854775807
used_size	Long	使用大小最小值：0 最大值：9223372036854775807
free_size	Long	剩余空间最小值：0 最大值：9223372036854775807

**表15** CloneServer
参数	参数类型	描述
vm_id	String	克隆服务器ID 最小长度：0 最大长度：255
name	String	克隆虚拟机的名称最小长度：0 最大长度：255
clone_error	String	克隆错误信息最小长度：0 最大长度：255
clone_state	String	克隆状态最小长度：0 最大长度：255
error_msg	String	克隆错误信息描述最小长度：0 最大长度：1024

**表16** SubTask
参数	参数类型	描述
name	String	子任务名称最小长度：0 最大长度：255
progress	Integer	子任务的进度，取值为0-100之间的整数最小值：0 最大值：100
start_date	Long	子任务开始时间最小值：0 最大值：9223372036854775807
end_date	Long	子任务结束时间（如果子任务还没有结束，则为空）最小值：0 最大值：9223372036854775807
migrate_speed	Double	迁移速率，Mbit/s 最小值：0 最大值：10000
user_op	String	触发子任务的用户操作名称最小长度：0 最大长度：50
process_trace	String	迁移或同步时，具体的迁移详情最小长度：0 最大长度：2048

请求示例

查询指定ID的迁移任务

GET https://{endpoint}/v3/tasks/ef3b9722-07a0-40ae-89b0-889ee96dfc56

响应示例

状态码： 200

{
  "id" : "1dcbf9f2-9f2a-4df8-88dc-27e5614a1187",
  "name" : "MigrationTask",
  "type" : "MIGRATE_BLOCK",
  "os_type" : "WINDOWS",
  "state" : "RUNNING",
  "estimate_complete_time" : null,
  "create_date" : 1598435778000,
  "start_date" : 1598435784000,
  "finish_date" : null,
  "priority" : 1,
  "speed_limit" : 0,
  "migrate_speed" : 0.0,
  "start_target_server" : true,
  "error_json" : "",
  "total_time" : 115,
  "float_ip" : null,
  "migration_ip" : null,
  "vm_template_id" : "38d53ae9-70e3-4587-89c9-6219d3d4e962",
  "region_name" : "region name",
  "region_id" : "region id",
  "project_name" : "project name",
  "project_id" : "b276e6fb38c74aa2ba4598f049745ce9",
  "sub_tasks" : [ {
    "id" : 7278,
    "name" : "CREATE_CLOUD_SERVER",
    "progress" : 0,
    "start_date" : 1598435802000,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7279,
    "name" : "SSL_CONFIG",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7280,
    "name" : "ATTACH_AGENT_IMAGE",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7281,
    "name" : "FORMAT_DISK_WINDOWS",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  }, {
    "id" : 7282,
    "name" : "MIGRATE_WINDOWS_BLOCK",
    "progress" : 0,
    "start_date" : null,
    "end_date" : null,
    "user_op" : "REPLICATE",
    "process_trace" : null
  } ],
  "source_server" : {
    "id" : "1cce5dab-df33-4abe-b2ac-e94fa05d6a01",
    "ip" : "192.168.0.154",
    "name" : "longbin-win16",
    "os_type" : "WINDOWS",
    "os_version" : "WINDOWS2016_64BIT",
    "oem_system" : false,
    "state" : "initialize",
    "migration_cycle" : "replicating"
  },
  "target_server" : {
    "id" : "c1bd67b6-1caa-403e-9e32-81d2feafcda9",
    "vm_id" : "",
    "name" : "",
    "ip" : null,
    "os_type" : "WINDOWS",
    "os_version" : "WINDOWS2016_64BIT",
    "system_dir" : "Y:\\Windows\\System32",
    "disks" : [ {
      "id" : 88008,
      "name" : "Disk 1",
      "relation_name" : null,
      "disk_id" : "0",
      "partition_style" : "MBR",
      "size" : 42949672960,
      "used_size" : 42947575808,
      "device_use" : "OS",
      "os_disk" : true,
      "physical_volumes" : [ {
        "id" : 135055,
        "uuid" : "\\\\?\\Volume{586b7157-0000-0000-0000-100000000000}\\",
        "index" : 1,
        "name" : "Z:",
        "relation_name" : null,
        "device_use" : "BOOT",
        "file_system" : "NTFS",
        "mount_point" : null,
        "size" : 524288000,
        "used_size" : 410275840,
        "free_size" : 114012160
      }, {
        "id" : 135056,
        "uuid" : "\\\\?\\Volume{586b7157-0000-0000-0000-501f00000000}\\",
        "index" : 2,
        "name" : "Y:",
        "relation_name" : null,
        "device_use" : "OS",
        "file_system" : "NTFS",
        "mount_point" : null,
        "size" : 42423287808,
        "used_size" : 23170301952,
        "free_size" : 19252985856
      } ],
      "disk_index" : "\u0000"
    } ],
    "volume_groups" : [ ],
    "image_disk_id" : null,
    "cutovered_snapshot_ids" : null
  },
  "clone_server" : null
}

状态码

状态码	描述
200	OK

错误码

请参见错误码。

父主题： 任务管理

上一篇：删除指定ID的迁移任务

下一篇：更新指定ID的迁移任务

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消