查询迁移任务列表
功能介绍
在设置目的端后,主机迁移服务会自动创建迁移任务,使用该接口可以查询迁移任务列表。
URI
GET /v3/tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
state |
否 |
String |
迁移任务状态 枚举值:
|
name |
否 |
String |
任务的名称 最小长度:0 最大长度:255 |
id |
否 |
String |
任务的ID 最小长度:0 最大长度:255 |
source_server_id |
否 |
String |
源端服务器的ID 最小长度:0 最大长度:255 |
limit |
否 |
Integer |
每一页记录的任务数量 最小值:0 最大值:200 缺省值:100 |
offset |
否 |
Integer |
偏移量 最小值:0 最大值:65535 缺省值:0 |
enterprise_project_id |
否 |
String |
需要查询的企业项目id 最小长度:0 最大长度:255 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
符合要求的任务数量,不受分页影响 最小值:0 最大值:2147483647 |
tasks |
Array of TasksResponseBody objects |
查询到的任务列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
迁移任务id 最小长度:0 最大长度:255 |
name |
String |
任务名称(用户自定义) 最小长度:0 最大长度:255 |
type |
String |
任务类型,创建迁移任务时必选,更新迁移任务时可选 最小长度:0 最大长度:255 枚举值:
|
os_type |
String |
操作系统类型,分为WINDOWS和LINUX,创建时必选,更新时可选 最小长度:0 最大长度:255 枚举值:
|
state |
String |
任务状态 最小长度:0 最大长度:255 |
estimate_complete_time |
Long |
预估完成时间 最小值:0 最大值:9223372036854775807 |
create_date |
Long |
任务创建时间 最小值:0 最大值:9223372036854775807 |
priority |
Integer |
进程优先级 0:低 1:标准 2:高 最小值:0 最大值:2 枚举值:
|
speed_limit |
Integer |
迁移限速 |
migrate_speed |
Double |
迁移速率,单位:MB/S 最小值:0 最大值:10000 |
compress_rate |
Double |
压缩率 最小值:0 最大值:10000 |
start_target_server |
Boolean |
迁移完成后是否启动目的端服务器 true:启动 false:停止 缺省值:false |
error_json |
String |
错误信息 最小长度:0 最大长度:1024 |
total_time |
Long |
任务总耗时 最小值:0 最大值:9223372036854775807 |
migration_ip |
String |
目的端服务器的IP地址。 公网迁移时请填写弹性IP地址 专线迁移时请填写私有IP地址 最小长度:0 最大长度:255 |
sub_tasks |
Array of SubTaskAssociatedWithTask objects |
任务关联的子任务信息 |
source_server |
任务关联的源端信息 |
|
enterprise_project_id |
String |
迁移项目id 最小长度:0 最大长度:255 |
target_server |
任务关联的目的端信息 |
|
log_collect_status |
String |
日志收集状态 枚举值:
|
clone_server |
CloneServerBrief object |
克隆服务器基本信息 |
syncing |
Boolean |
是否同步 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Long |
子任务id 最小值:0 最大值:100 |
name |
String |
子任务名称 最小长度:0 最大长度:255 |
progress |
Integer |
子任务的进度,取值为0-100之间的整数 最小值:0 最大值:100 |
start_date |
Long |
子任务开始时间 最小值:0 最大值:9223372036854775807 |
end_date |
Long |
子任务结束时间(如果子任务还没有结束,则为空) 最小值:0 最大值:9223372036854775807 |
process_trace |
String |
迁移或同步时,具体的迁移详情 最小长度:0 最大长度:2048 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
源端在SMS数据库中的ID 最小长度:0 最大长度:255 |
ip |
String |
源端服务器ip,注册源端时必选,更新非必选 最小长度:0 最大长度:255 |
name |
String |
用来区分不同源端服务器的名称 最小长度:0 最大长度:255 |
os_type |
String |
源端服务器的OS类型,分为Windows和Linux,注册必选,更新非必选 最小长度:0 最大长度:255 枚举值:
|
os_version |
String |
操作系统版本,注册必选,更新非必选 最小长度:0 最大长度:255 |
oem_system |
Boolean |
是否是OEM操作系统(Windows) |
state |
String |
当前源端服务器状态 枚举值:
|
请求示例
查询迁移任务列表
GET https://{endpoint}/v3/tasks
响应示例
状态码: 200
OK
{ "count" : 3, "tasks" : [ { "id" : "ef3b9722-07a0-40ae-89b0-889ee96dfc56", "name" : "sms_task_lxxxx11", "type" : "MIGRATE_FILE", "os_type" : "LINUX", "state" : "MIGRATE_SUCCESS", "connected" : true, "estimate_complete_time" : null, "create_date" : 1585139506000, "priority" : 1, "speed_limit" : 0, "migrate_speed" : 0.0, "start_target_server" : true, "error_json" : "", "total_time" : 3878000, "migration_ip" : "", "source_server" : { "id" : "f32ab4d6-d150-4fb3-aa55-edbb5cf9947f", "ip" : "192.168.*.107", "name" : "xxx-linux-1", "os_type" : "LINUX", "os_version" : "CENTOS_7_6_64BIT", "oem_system" : false, "state" : "AVAILABLE" }, "target_server" : { "id" : "267b25a6-4a5b-4143-96b6-29777db00da1", "vm_id" : "", "name" : "", "ip" : null, "os_type" : "LINUX", "os_version" : null }, "log_collect_status" : "INIT" }, { "id" : "a5f9cd5a-cfb2-4313-81d1-3dbf19a1e6d1", "name" : "sms_task_xxx22", "type" : "MIGRATE_BLOCK", "os_type" : "WINDOWS", "state" : "MIGRATE_SUCCESS", "connected" : true, "estimate_complete_time" : null, "create_date" : 1585138569000, "priority" : 1, "speed_limit" : 0, "migrate_speed" : 0.0, "start_target_server" : true, "error_json" : "", "total_time" : 10824000, "migration_ip" : "", "source_server" : { "id" : "91718cc3-b5bf-48ce-b196-5035ffd9ff53", "ip" : "192.168.*.245", "name" : "xxx-windows-2", "os_type" : "WINDOWS", "os_version" : "WINDOWS2012_R2_64BIT", "oem_system" : false, "state" : "AVAILABLE" }, "target_server" : { "id" : "71fe0494-442a-408f-b0b3-0143774e4de4", "vm_id" : "", "name" : "", "ip" : null, "os_type" : "WINDOWS", "os_version" : "WINDOWS2012_R2_64BIT" }, "log_collect_status" : "INIT" }, { "id" : "c51407dd-7d1a-4831-bb93-887869d3ab4b", "name" : "sms_task_leddesktop", "type" : "MIGRATE_BLOCK", "os_type" : "WINDOWS", "state" : "MIGRATE_SUCCESS", "connected" : false, "estimate_complete_time" : null, "create_date" : 1566130392000, "priority" : 1, "speed_limit" : 200, "migrate_speed" : 0.0, "start_target_server" : true, "error_json" : "", "total_time" : 882000, "migration_ip" : "192.168.1.201", "source_server" : null, "target_server" : { "id" : "f985ee82-1a94-4839-b983-fb952dbaf00b", "vm_id" : "a548a4f5-020d-46f8-9b34-59cf1dc60ab6", "name" : "xxx-sms-target", "ip" : null, "os_type" : "WINDOWS", "os_version" : "WINDOWS2008_R2_64BIT" }, "log_collect_status" : "INIT" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。