文档首页/主机迁移服务 SMS/API参考（吉隆坡区域）/API v3/任务管理/上报数据迁移进度和速率
更新时间：2025-02-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

上报数据迁移进度和速率

功能介绍

此接口由安装在源端服务器上的迁移Agent在数据迁移阶段调用，用来将迁移的具体进度上报给SMS服务端。

迁移Agent自动调用此接口用于上报数据迁移进度，您无需调用此接口。

调用方法

请参见如何调用API。

URI

PUT /v3/tasks/{task_id}/progress

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

主机迁移任务的ID

最小长度：0

最大长度：255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

X-Auth-Token

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度：1

最大长度：16384

表3 请求Body参数

参数

是否必选

参数类型

描述

subtask_name

是

String

当前上报进度的子任务名称，子任务名称包括：

创建虚拟机 CREATE_CLOUD_SERVER

配置安全通道 SSL_CONFIG

挂载代理镜像 ATTACH_AGENT_IMAGE

卸载载代理镜像 DETTACH_AGENT_IMAGE

Linux分区格式化 FORMAT_DISK_LINUX

Linux分区格式化(文件级级） FORMAT_DISK_LINUX_FILE

Linux分区格式化(块级） FORMAT_DISK_LINUX_BLOCK

Windows分区格式化 FORMAT_DISK_WINDOWS

Linux文件级数据迁移 MIGRATE_LINUX_FILE,

Linux块级数据迁移 MIGRATE_LINUX_BLOCK

Windows块级数据迁移 MIGRATE_WINDOWS_BLOCK

克隆一个虚拟机 CLONE_VM

Linux文件级数据同步 SYNC_LINUX_FILE

Linux块级数据同步 SYNC_LINUX_BLOCK

Windows块级数据同步 SYNC_WINDOWS_BLOCK

Linux配置修改 CONFIGURE_LINUX

Linux配置修改(块级）CONFIGURE_LINUX_BLOCK

Linux配置修改（文件级） CONFIGURE_LINUX_FILE

Windows配置修改 CONFIGURE_WINDOWS

最小长度：0

最大长度：255

枚举值：

  • CREATE_CLOUD_SERVER

  • SSL_CONFIG

  • ATTACH_AGENT_IMAGE

  • DETTACH_AGENT_IMAGE

  • FORMAT_DISK_LINUX

  • FORMAT_DISK_LINUX_FILE

  • FORMAT_DISK_LINUX_BLOCK

  • FORMAT_DISK_WINDOWS

  • MIGRATE_LINUX_FILE

  • MIGRATE_LINUX_BLOCK

  • MIGRATE_WINDOWS_BLOCK

  • CLONE_VM

  • SYNC_LINUX_FILE

  • SYNC_LINUX_BLOCK

  • SYNC_WINDOWS_BLOCK

  • CONFIGURE_LINUX

  • CONFIGURE_LINUX_BLOCK

  • CONFIGURE_LINUX_FILE

  • CONFIGURE_WINDOWS

progress

是

Integer

当前上报的子任务的最新百分比进度

最小值：0

最大值：100

replicatesize

是

Long

当前任务已经复制的数据量大小（B）

最小值：0

最大值：9223372036854775807

totalsize

是

Long

当前任务的总迁移数据大小

最小值：0

最大值：9223372036854775807

process_trace

是

String

迁移或同步时，具体的迁移详情

最小长度：0

最大长度：2048

migrate_speed

否

Double

实施迁移速率，单位Mb/s

最小值：0

最大值：10000

compress_rate

否

Double

实施文件压缩率

最小值：0

最大值：10000

remain_time

否

Long

剩余时间

最小值：0

最大值：2147483647

total_cpu_usage

否

Double

主机的CPU使用率，0到100，单位是百分比

最小值：0

最大值：100

agent_cpu_usage

否

Double

Agent的CPU使用率，0到100，单位是百分比

最小值：0

最大值：100

total_mem_usage

否

Double

主机的内存使用值，单位是MB

最小值：0

最大值：1048576.0

agent_mem_usage

否

Double

Agent的内存使用值，单位是MB

最小值：0

最大值：1048576.0

total_disk_io

否

Double

主机的磁盘I/O值，单位是MB/s

最小值：0

最大值：10000.0

agent_disk_io

否

Double

Agent的磁盘I/O值，单位是MB/s

最小值：0

最大值：10000.0

agent_time

否

String

agent的当前时间，用于超速检测，因为限速值是可以分时间段设置的

最小长度：0

最大长度：30

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

-

String

上报数据迁移进度和速率成功

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误代码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：255

encoded_authorization_message

String

加密授权信息

最小长度：0

最大长度：65535

error_param

Array of strings

错误参数

最小长度：0

最大长度：65535

数组长度：1 - 20

details

Array of details objects

详细错误信息

数组长度：1 - 20

表6 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

请求示例

上报具体的数据迁移进度，当前的子任务名称是ATTACH_AGENT_IMAGE，任务进度为100，当前任务总迁移数据大小为10000.

PUT https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/progress

{
  "subtask_name" : "ATTACH_AGENT_IMAGE",
  "progress" : 100,
  "replicatesize" : 1000,
  "totalsize" : 100000,
  "process_trace" : ""
}

响应示例

状态码：403

鉴权失败

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

状态码

状态码

描述

200

上报数据迁移进度和速率成功

403

鉴权失败

错误码

请参见错误码。

父主题：任务管理