文档首页/ 主机迁移服务 SMS/ API参考/ API v3/ 任务管理/ 上报数据迁移进度和速率
更新时间:2025-06-19 GMT+08:00

上报数据迁移进度和速率

功能介绍

此接口由安装在源端服务器上的迁移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

need_migration_test

Boolean

是否开启迁移演练

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" : ""
}

响应示例

状态码:200

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

{ }

状态码: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."
  } ]
}

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;


public class UpdateTaskSpeedSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateTaskSpeedRequest request = new UpdateTaskSpeedRequest();
        request.withTaskId("{task_id}");
        UpdateTaskSpeedReq body = new UpdateTaskSpeedReq();
        body.withProcessTrace("");
        body.withTotalsize(100000L);
        body.withReplicatesize(1000L);
        body.withProgress(100);
        body.withSubtaskName(UpdateTaskSpeedReq.SubtaskNameEnum.fromValue("ATTACH_AGENT_IMAGE"));
        request.withBody(body);
        try {
            UpdateTaskSpeedResponse response = client.updateTaskSpeed(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateTaskSpeedRequest()
        request.task_id = "{task_id}"
        request.body = UpdateTaskSpeedReq(
            process_trace="",
            totalsize=100000,
            replicatesize=1000,
            progress=100,
            subtask_name="ATTACH_AGENT_IMAGE"
        )
        response = client.update_task_speed(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateTaskSpeedRequest{}
	request.TaskId = "{task_id}"
	request.Body = &model.UpdateTaskSpeedReq{
		ProcessTrace: "",
		Totalsize: int64(100000),
		Replicatesize: int64(1000),
		Progress: int32(100),
		SubtaskName: model.GetUpdateTaskSpeedReqSubtaskNameEnum().ATTACH_AGENT_IMAGE,
	}
	response, err := client.UpdateTaskSpeed(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

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

403

鉴权失败

错误码

请参见错误码