Help Center> Server Migration Service> API Reference> APIs V3.0> Task Management> Reporting Migration Progress and Rate
Updated on 2024-07-08 GMT+08:00

Reporting Migration Progress and Rate

Function

This API is called by the Agent installed on source servers during migration to report the migration progress and rate to SMS.

You do not need to make calls to this API.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/tasks/{task_id}/progress

Table 1 Path parameter

Parameter

Mandatory

Type

Description

task_id

Yes

String

The migration task ID.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

subtask_name

Yes

String

The name of the subtask for which the Agent reports the progress.

Minimum length: 0 characters

Maximum length: 255 characters

The value can be:

  • 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

Yes

Integer

The progress of the subtask, in percentage (%).

Minimum value: 0

Maximum value: 100

replicatesize

Yes

Long

The amount of data that has been replicated in the subtask, in bytes.

Minimum value: 0

Maximum value: 9223372036854775807

totalsize

Yes

Long

The total amount of data to be migrated in the subtask.

Minimum value: 0

Maximum value: 9223372036854775807

process_trace

Yes

String

Detailed progress of the migration or synchronization

Minimum length: 0 characters

Maximum length: 2,048 characters

migrate_speed

No

Double

The migration rate in Mbit/s.

Minimum value: 0

Maximum value: 10000

compress_rate

No

Double

The file compression rate.

Minimum value: 0

Maximum value: 10000

remain_time

No

Long

The remaining time.

Minimum value: 0

Maximum value: 2147483647

Response

None

Example Request

This example reports the migration progress of a task. The current subtask name is ATTACH_AGENT_IMAGE, the task progress is 100, and the total size of data migrated in the current task is 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" : ""
}

Example Response

None

SDK Sample Code

The sample code is as follows.

This example reports the migration progress of a task. The current subtask name is ATTACH_AGENT_IMAGE, the task progress is 100, and the total size of data migrated in the current task is 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
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();
        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());
        }
    }
}

This example reports the migration progress of a task. The current subtask name is ATTACH_AGENT_IMAGE, the task progress is 100, and the total size of data migrated in the current task is 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
# 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.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)

This example reports the migration progress of a task. The current subtask name is ATTACH_AGENT_IMAGE, the task progress is 100, and the total size of data migrated in the current task is 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
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.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)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.