Help Center/ Server Migration Service/ API Reference/ API/ Task Management/ Querying a Migration Task with a Specified ID

Updated on 2026-01-28 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying a Migration Task with a Specified ID

Function

This API is used to query a migration task with a specified ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
sms:server:getTask	Read	server *	-	sms:server:queryServer	-
sms:server:getTask	Read	-	g:EnterpriseProjectId	sms:server:queryServer	-

URI

GET /v3/tasks/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The migration task ID. Minimum: 1 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name	String	The task name, which is defined by the user. Minimum: 0 Maximum: 255
type	String	The task type. This parameter is mandatory for creating a task and optional for updating a task. MIGRATE_FILE MIGRATE_BLOCK Minimum: 0 Maximum: 255 Enumeration values: MIGRATE_FILE MIGRATE_BLOCK
os_type	String	The OS type, which can be Windows or Linux. This parameter is mandatory for creating a task and optional for updating a task. Enumeration values: WINDOWS LINUX
id	String	The migration task ID. Minimum: 0 Maximum: 255
priority	Integer	The migration process priority. 0: low 1: standard (default) 2: high Minimum: 0 Maximum: 2 Enumeration values: 0 1 2
speed_limit	Integer	The migration rate limit. Minimum: 0 Maximum: 65535
region_id	String	The ID of the region where the target server is located. Minimum: 0 Maximum: 255
start_target_server	Boolean	Indicates whether the target server is started after the migration is complete. true: yes false: no Default: true
enterprise_project_id	String	Enterprise project ID. Minimum: 1 Maximum: 255
migration_ip	String	The IP address of the target server. If you use a public network for migration, enter the EIP bound to the target server. If you use a private line for migration, enter a private IP address of the target server. Minimum: 0 Maximum: 255
region_name	String	The name of the region where the target server is located. Minimum: 0 Maximum: 255
project_name	String	The name of the project to which the target server belongs. Minimum: 0 Maximum: 255
project_id	String	The ID of the project to which the target server belongs. Minimum: 0 Maximum: 255
vm_template_id	String	The template ID. Minimum: 0 Maximum: 255
source_server	SourceServerResponse object	The returned source server information.
target_server	TaskTargetServer object	The target server information.
state	String	The migration task status. READY RUNNING SYNCING MIGRATE_SUCCESS SYNC_SUCCESS MIGRATE_FAIL SYNC_FAIL ABORTING ABORT SKIPPING DELETING RESETING Enumeration values: READY RUNNING SYNCING MIGRATE_SUCCESS SYNC_SUCCESS MIGRATE_FAIL SYNC_FAIL ABORTING ABORT SKIPPING DELETING RESETING
estimate_complete_time	Long	The estimated completion time. Minimum: 0 Maximum: 9223372036854775807
connected	Boolean	The connection status.
create_date	Long	The task creation time. Minimum: 0 Maximum: 9223372036854775807
start_date	Long	The task start time. Minimum: 0 Maximum: 9223372036854775807
finish_date	Long	The task end time. Minimum: 0 Maximum: 9223372036854775807
migrate_speed	Double	The migration rate, in Mbit/s. Minimum: 0 Maximum: 10000
compress_rate	Double	The compression rate. Minimum: 0 Maximum: 10000
error_json	String	The error message. Minimum: 0 Maximum: 1024
total_time	Long	The task duration. Minimum: 0 Maximum: 9223372036854775807
float_ip	String	Retain this parameter temporarily to ensure the compatibility with the earlier versions of SMS-Agent. Minimum: 0 Maximum: 255
remain_seconds	Long	The remaining migration time in seconds. Minimum: 0 Maximum: 9223372036854775807
target_snapshot_id	String	The ID of the snapshot for the target server. Minimum: 0 Maximum: 255
clone_server	CloneServer object	The information about the cloned server.
sub_tasks	Array of SubTask objects	The subtasks contained in the migration task. Array Length: 0 - 65535
network_check_info	NetworkCheckInfoRequestBody object	The network measurement results.
total_cpu_usage	Double	The CPU usage of the server, in percentage. Minimum: 0 Maximum: 100
agent_cpu_usage	Double	The CPU usage of the Agent, in percentage. Minimum: 0 Maximum: 100
total_mem_usage	Double	The memory usage of the server, in MB. Minimum: 0 Maximum: 1048576.0
agent_mem_usage	Double	The memory usage of the Agent, in MB. Minimum: 0 Maximum: 1048576.0
total_disk_io	Double	The disk I/O of the server, in Mbit/s. Minimum: 0 Maximum: 10000.0
agent_disk_io	Double	The disk I/O of the Agent, in Mbit/s. Minimum: 0 Maximum: 10000.0
need_migration_test	Boolean	Indicates whether migration drilling is enabled.
subtask_info	String	The current subtask and progress. Minimum: 0 Maximum: 255

**Table 4** SourceServerResponse
Parameter	Type	Description
id	String	The ID of the source server in the SMS database. Minimum: 0 Maximum: 255
ip	String	The IP address of the source server. This parameter is mandatory for source server registration and optional for source server updates. Minimum: 0 Maximum: 255
name	String	The source server name in SMS. Minimum: 0 Maximum: 255
os_type	String	The OS type of the source server, which can be Windows or Linux. This parameter is mandatory for source server registration and optional for source server updates. Minimum: 0 Maximum: 255 Enumeration values: WINDOWS LINUX
os_version	String	The OS version. This parameter is mandatory for registration and optional for updates. Minimum: 0 Maximum: 255
oem_system	Boolean	Indicates whether the OS is an OEM OS (Windows).
state	String	The source server status. unavailable (The source server fails the environment check.) waiting initialize replicate syncing stopping stopped skipping deleting clearing cleared (snapshot resources cleared) clearfailed (snapshot resource clearing failed) premigready (migration drill ready) premiged (migration drill completed) premigfailed (migration drill failed) cloning cutovering (target server being launched) finished (target server launched) error Enumeration values: unavailable waiting initialize replicate syncing stopping stopped skipping deleting clearing cleared clearfailed premigready premiged premigfailed cloning cutovering finished error
migration_cycle	String	The migration stage. cutovering (target server being launched) cutovered (target server launched) checking setting replicating syncing Minimum: 0 Maximum: 255 Enumeration values: cutovering cutovered checking setting replicating syncing

**Table 5** TaskTargetServer
Parameter	Type	Description
id	String	The ID of the target server in the SMS database. Minimum: 0 Maximum: 255
vm_id	String	The ID of the target server. This parameter is not required for automatically created target servers. Minimum: 0 Maximum: 255
name	String	The name of the target server. Minimum: 0 Maximum: 255
ip	String	The IP address of the target server. Minimum: 0 Maximum: 255
os_type	String	The OS type of the source server, which can be Windows or Linux. This parameter is mandatory for source server registration and optional for source server updates. Minimum: 0 Maximum: 255 Enumeration values: WINDOWS LINUX
os_version	String	The OS version. This parameter is mandatory for registration and optional for updates. Minimum: 0 Maximum: 255
system_dir	String	The system directory. This parameter is mandatory for Windows. Minimum: 0 Maximum: 255
disks	Array of TargetDisk objects	The information about target server disks, which is generally the same as that of the source server. Array Length: 0 - 65535
volume_groups	Array of VolumeGroups objects	The information about logical volumes on the target server, which is generally the same as that on the source server. Array Length: 0 - 65535
btrfs_list	Array of strings	The information about the Btrfs file systems on the source server. This parameter is mandatory for Linux. If there are no Btrfs file systems on the source server, the value is an empty array []. Minimum: 0 Maximum: 255 Array Length: 0 - 65535
image_disk_id	String	The ID of the disk that hosts the agent image on the target server. Minimum: 0 Maximum: 255
cutovered_snapshot_ids	String	The ID of the snapshot used for rollback on the target server. Minimum: 0 Maximum: 255

**Table 6** TargetDisk
Parameter	Type	Description
id	Long	The disk ID. Minimum: 0 Maximum: 9223372036854775807
device_use	String	The partition function. The partition can be a general, boot, or OS partition. BOOT: boot device OS: system device NORMAL: general device Default: NORMAL Enumeration values: NORMAL OS BOOT
disk_id	String	The disk ID. Minimum: 0 Maximum: 255
name	String	The disk name. Minimum: 0 Maximum: 255
physical_volumes	Array of TargetPhysicalVolumes objects	The logical volume information. Array Length: 0 - 65535
size	Long	The size. Minimum: 0 Maximum: 9223372036854775807
used_size	Long	The used space. Minimum: 0 Maximum: 9223372036854775807
disk_index	String	The disk index. Minimum: 0 Maximum: 255
os_disk	Boolean	Indicates whether the disk is the system disk.
partition_style	String	The disk partition type. This parameter is mandatory for source server registration. MBR: Master Boot Record GPT: GUID Partition Table Enumeration values: MBR GPT
relation_name	String	The name of the paired disk on the Linux target ECS server. Minimum: 0 Maximum: 255

**Table 7** TargetPhysicalVolumes
Parameter	Type	Description
id	Long	The logical volume ID. Minimum: 0 Maximum: 9223372036854775807
device_use	String	The partition function. NORMAL: general device OS: system device BOOT: boot device Default: NORMAL Enumeration values: NORMAL OS BOOT
file_system	String	The file system. Minimum: 0 Maximum: 255
index	Integer	No. Minimum: 0 Maximum: 2147483647
mount_point	String	The mount point. Minimum: 0 Maximum: 255
name	String	Name. Minimum: 0 Maximum: 255
size	Long	The size. Minimum: 0 Maximum: 9223372036854775807
used_size	Long	The used space. Minimum: 0 Maximum: 9223372036854775807
uuid	String	uuid Minimum: 0 Maximum: 255
relation_name	String	The name of the paired disk on the Linux target ECS server. Minimum: 0 Maximum: 255
free_size	Long	The idle partition space. Minimum: 0 Maximum: 9223372036854775807

**Table 8** VolumeGroups
Parameter	Type	Description
components	String	The physical volume information. Minimum: 0 Maximum: 255
free_size	Long	The available space. Minimum: 0 Maximum: 9223372036854775807
logical_volumes	Array of LogicalVolumes objects	The logical volume information. Array Length: 0 - 50
name	String	Name. Minimum: 0 Maximum: 255
size	Long	Size. Minimum: 0 Maximum: 9223372036854775807

**Table 9** LogicalVolumes
Parameter	Type	Description
block_count	Integer	The number of blocks. Minimum: 0 Maximum: 2147483647 Default: 0
block_size	Long	Block size. Minimum: 0 Maximum: 1048576 Default: 0
file_system	String	The file system. Minimum: 0 Maximum: 255
inode_size	Integer	The number of inodes. Minimum: 0 Maximum: 2147483647
inode_nums	Long	The number of inodes. Minimum: 0 Maximum: 9223372036854775807
device_use	String	Partition type. This is not mandatory and can be left blank. The common values are as follows: NORMAL OS: system device BOOT VOLUME_GROUP BTRFS Minimum: 0 Maximum: 255
mount_point	String	The mount point. Minimum: 0 Maximum: 256
name	String	Name. Minimum: 0 Maximum: 1024
size	Long	The size. Minimum: 0 Maximum: 9223372036854775807
used_size	Long	The used space. Minimum: 0 Maximum: 9223372036854775807
free_size	Long	The available space. Minimum: 0 Maximum: 9223372036854775807

**Table 10** CloneServer
Parameter	Type	Description
vm_id	String	The ID of the cloned server. Minimum: 0 Maximum: 255
name	String	The name of the cloned server. Minimum: 0 Maximum: 255
clone_error	String	The error code returned for a clone failure. Minimum: 0 Maximum: 255
clone_state	String	The clone status. NOT_READY READY PREPARING CREATING ERROR FINISHED Enumeration values: NOT_READY READY PREPARING CREATING ERROR FINISHED
error_msg	String	The error message returned for a clone failure. Minimum: 0 Maximum: 1024

**Table 11** SubTask
Parameter	Type	Description
id	Long	The subtask ID. Minimum: 0 Maximum: 9223372036854775807
name	String	The subtask name. Minimum: 0 Maximum: 255
progress	Integer	The progress of the subtask. The value is an integer ranging from 0 to 100. Minimum: 0 Maximum: 100
start_date	Long	The start time of the subtask. Minimum: 0 Maximum: 9223372036854775807
end_date	Long	The end time of the subtask. If the subtask is not complete, this parameter is left blank. Minimum: 0 Maximum: 9223372036854775807
migrate_speed	Double	The migration speed, in Mbit/s. Minimum: 0 Maximum: 10000
user_op	String	The user operation that triggers the subtask. Minimum: 0 Maximum: 50
process_trace	String	The detailed progress of the migration or synchronization. Minimum: 0 Maximum: 2048

**Table 12** NetworkCheckInfoRequestBody
Parameter	Type	Description
domain_connectivity	Boolean	The connectivity to domain names.
destination_connectivity	Boolean	The connectivity to the target server.
network_delay	Double	Network latency (ms). Minimum: 0 Maximum: 10000.0
network_jitter	Double	Network jitter (ms). Minimum: 0 Maximum: 10000
migration_speed	Double	Bandwidth (Mbit/s). Minimum: 0 Maximum: 10000
loss_percentage	Double	Packet loss rate (%). Minimum: 0 Maximum: 100
cpu_usage	Double	CPU usage (%). Minimum: 0 Maximum: 100
mem_usage	Double	Memory usage (%). Minimum: 0 Maximum: 100
evaluation_result	String	The network evaluation result. Minimum: 5 Maximum: 9

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 14** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

This example queries a migration task with a specified ID.

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

Example Responses

Status code: 200

The migration task with a specified ID was queried successfully.

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
  "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
  "region_name" : "region name",
  "region_id" : "region id",
  "project_name" : "project name",
  "project_id" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
  "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "ip" : "192.168.0.154",
    "name" : "name-win16",
    "os_type" : "WINDOWS",
    "os_version" : "WINDOWS2016_64BIT",
    "oem_system" : false,
    "state" : "initialize",
    "migration_cycle" : "replicating"
  },
  "target_server" : {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "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" : "0"
    } ],
    "volume_groups" : [ ],
    "image_disk_id" : null,
    "cutovered_snapshot_ids" : null
  },
  "clone_server" : null
}

Status code: 403

Authentication failed.

{
  "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 Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 ShowTaskSolution {

    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();
        ShowTaskRequest request = new ShowTaskRequest();
        request.withTaskId("{task_id}");
        try {
            ShowTaskResponse response = client.showTask(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ShowTaskRequest()
        request.task_id = "{task_id}"
        response = client.show_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.ShowTaskRequest{}
	request.TaskId = "{task_id}"
	response, err := client.ShowTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     