Listing Migration Tasks

Function

After the target server is configured for a source server, SMS automatically creates a migration task. This API is used to list all your migration tasks.

Calling Method

For details, see Calling APIs.

Authorization

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

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

If you are using identity policy-based authorization, the permission listed below is required.

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

URI

GET /v3/tasks

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
state	No	String	The migration task status. READY: The migration task is ready for execution. RUNNING: The migration task is being executed. SYNCING: The incremental data is being synchronized. MIGRATE_SUCCESS: The migration succeeds. MIGRATE_FAIL: The migration fails. ABORTING: The migration task is being stopped. ABORT: The migration task is stopped. DELETING: The migration task is being deleted. SYNC_F_ROLLBACKING: The synchronization fails and the task is being rolled back. SYNC_F_ROLLBACK_SUCCESS: The synchronization fails and the rollback is successful. The value can be: READY RUNNING SYNCING MIGRATE_SUCCESS MIGRATE_FAIL ABORTING ABORT DELETING SYNC_F_ROLLBACKING SYNC_F_ROLLBACK_SUCCESS
name	No	String	The task name.
id	No	String	The task ID.
source_server_id	No	String	The source server ID.
limit	No	Integer	The number of tasks recorded on each page. Range 0 to 200 Default Value 100
offset	No	Integer	The offset. Range 0 to 65535 Default Value 0
enterprise_project_id	No	String	The ID of the enterprise project to be queried.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	The number of tasks that meet the search criteria, which is not affected by pagination. Range 0 to 2147483647
tasks	Array of TasksResponseBody objects	The information about the queried tasks.

**Table 4** **TasksResponseBody** field description
Parameter	Type	Description
id	String	The migration task ID.
name	String	The task name, which is defined by the user.
type	String	The task type. This parameter is mandatory for creating a task and optional for updating a task. MIGRATE_FILE: file-level migration MIGRATE_BLOCK: block-level migration The value can be: 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. The value can be: WINDOWS LINUX
state	String	The task status.
estimate_complete_time	Long	The estimated completion time. Range 0 to 9223372036854775807
create_date	Long	The task creation time. Range 0 to 9223372036854775807
priority	Integer	The migration process priority. 0: low 1: standard 2: high Range 0 to 2 The value can be: 0 1 2
speed_limit	Integer	The migration rate limit. Range 0 to 65535
migrate_speed	Double	The migration rate, in Mbit/s. Range 0 to 10000
compress_rate	Double	The compression rate. Range 0 to 10000
start_target_server	Boolean	Indicates whether the target server is started after the migration is complete. true: indicates that the target server will be launched after the migration is complete. false: indicates that the target server will be stopped after the migration is complete. Default Value false
error_json	String	The error message.
total_time	Long	The task duration. Range 0 to 9223372036854775807
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 the private IP address of the target server.
sub_tasks	Array of SubTaskAssociatedWithTask objects	The information about subtasks associated with the migration task
source_server	SourceServerAssociatedWithTask object	The information about the source server associated with the migration task.
enterprise_project_id	String	The migration project ID.
target_server	TargetServerAssociatedWithTask object	The information about the target server associated with the migration task.
log_collect_status	String	The log collection status. INIT TELL_AGENT_TO_COLLECT WAIT_AGENT_COLLECT_ACK AGENT_COLLECT_FAIL AGENT_COLLECT_SUCCESS WAIT_SERVER_COLLECT SERVER_COLLECT_FAIL SERVER_COLLECT_SUCCESS TELL_AGENT_RESET_ACL WAIT_AGENT_RESET_ACL_ACK The value can be: INIT TELL_AGENT_TO_COLLECT WAIT_AGENT_COLLECT_ACK AGENT_COLLECT_FAIL AGENT_COLLECT_SUCCESS WAIT_SERVER_COLLECT SERVER_COLLECT_FAIL SERVER_COLLECT_SUCCESS TELL_AGENT_RESET_ACL WAIT_AGENT_RESET_ACL_ACK
clone_server	CloneServerBrief object	The information about the cloned server.
syncing	Boolean	Indicates whether synchronization is enabled.
network_check_info	NetworkCheckInfoRequestBody object	The network performance metrics and measurement results.
special_config	Array of ConfigBody objects	The configuration information of advanced migration options.
total_cpu_usage	Double	The CPU usage of the server, in percentage. Range 0 to 100
agent_cpu_usage	Double	The CPU usage of the Agent, in percentage. Range 0 to 100
total_mem_usage	Double	The memory usage of the server, in MB. Range 0 to 1048576.0
agent_mem_usage	Double	The memory usage of the Agent, in MB. Range 0 to 1048576.0
total_disk_io	Double	The disk I/O of the server, in Mbit/s. Range 0 to 10000.0
agent_disk_io	Double	The disk I/O of the Agent, in Mbit/s. Range 0 to 10000.0
need_migration_test	Boolean	Indicates whether migration drilling is enabled.
subtask_info	String	The current subtask and progress.

**Table 5** **SubTaskAssociatedWithTask** field description
Parameter	Type	Description
id	Long	The subtask ID. Range 0 to 9223372036854775807
name	String	The subtask name.
progress	Integer	The progress of the subtask. The value is an integer ranging from 0 to 100. Range 0 to 100
start_date	Long	The start time of the subtask. Range 0 to 9223372036854775807
end_date	Long	The end time of the subtask. If the subtask is not complete, this parameter is left blank. Range 0 to 9223372036854775807
process_trace	String	The detailed progress of the migration or synchronization.

**Table 6** **SourceServerAssociatedWithTask** field description
Parameter	Type	Description
id	String	The ID of the source server in the SMS database.
ip	String	The IP address of the source server. This parameter is mandatory for registering the source server with SMS and optional for updating the information about the source server.
name	String	The source server name in SMS.
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. The value can be: WINDOWS LINUX
os_version	String	The OS version. This parameter is mandatory for source server registration and optional for source server updates.
oem_system	Boolean	Indicates whether the OS is an OEM version (Windows).
state	String	The source server status. unavailable: The source server fails the environment check. waiting: The source server is waiting for migration. initialize: The migration of the source server is being initialized. replicate: The source server is being replicated. syncing: The source server is being synchronized. stopping: The migration of the source server is being stopped. stopped: The migration of the source server is stopped. skipping: The operation is being skipped. deleting: The source server record is being deleted. error: An error occurs during the migration of the source server. cloning: The paired target server is being cloned. testing: The test is in progress. finished: The paired target server is launched. clearing: The snapshot resources are being cleared. cleared: The snapshot resources have been cleared. clearfailed: The snapshot resources fail to be cleared. premigready: The migration drill is ready. premiging: The migration drill is in progress. premiged: The migration drill has been completed. premigfailed: The migration drill fails. The value can be: unavailable waiting initialize replicate syncing stopping stopped skipping deleting error cloning testing finished clearing cleared clearfailed premigready premiging premiged premigfailed

**Table 7** **TargetServerAssociatedWithTask** field description
Parameter	Type	Description
id	String	The ID of the target server in the SMS database.
vm_id	String	The ID of the target server.
name	String	The name of the target server.
ip	String	The IP address of the target server.
os_type	String	The OS type of the target server. WINDOWS: a Windows OS LINUX: a Linux OS The value can be: WINDOWS LINUX
os_version	String	The OS version.

**Table 8** **CloneServerBrief** field description
Parameter	Type	Description
vm_id	String	The ID of the cloned server.
name	String	The name of the cloned server.

**Table 9** **NetworkCheckInfoRequestBody** field description
Parameter	Type	Description
domain_connectivity	Boolean	The connectivity to domain names.
destination_connectivity	Boolean	The connectivity to the target server.
network_delay	Double	The network latency. Range 0 to 10000.0
network_jitter	Double	The network jitter. Range 0 to 10000
migration_speed	Double	The bandwidth. Range 0 to 10000
loss_percentage	Double	The packet loss rate. Range 0 to 100
cpu_usage	Double	The CPU usage. Range 0 to 100
mem_usage	Double	The memory usage. Range 0 to 100
evaluation_result	String	The network evaluation result.

**Table 10** **ConfigBody** field description
Parameter	Type	Description
config_key	String	The advanced migration option. The value can be EXCLUDE_MIGRATE_PATH, SYNC_EXCLUDE_PATH, or ONLY_SYNC_PATH.
config_value	String	The value specified for the advanced migration option. It is stored in the database and parsed on the Agent.
config_status	String	The reserved field that describes the configuration status.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	The error code.
error_msg	String	The error message.
encoded_authorization_message	String	The encrypted authorization information.
error_param	Array of strings	Invalid parameters.
details	Array of details objects	The error details.

**Table 12** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code.
error_msg	String	The SMS error message.

Example Request

This example lists all migration tasks.

GET https://{endpoint}/v3/tasks

Example Response

Status code: 200

The list of migration tasks was obtained.

{
  "count" : 3,
  "tasks" : [ {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_lxxxx11",
    "type" : "MIGRATE_FILE",
    "os_type" : "LINUX",
    "state" : "MIGRATE_SUCCESS",
    "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "",
      "name" : "",
      "ip" : null,
      "os_type" : "LINUX",
      "os_version" : null
    },
    "log_collect_status" : "INIT"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_xxx22",
    "type" : "MIGRATE_BLOCK",
    "os_type" : "WINDOWS",
    "state" : "MIGRATE_SUCCESS",
    "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "ip" : "192.168.*.245",
      "name" : "xxx-windows-2",
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2012_R2_64BIT",
      "oem_system" : false,
      "state" : "AVAILABLE"
    },
    "target_server" : {
      "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "",
      "name" : "",
      "ip" : null,
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2012_R2_64BIT"
    },
    "log_collect_status" : "INIT"
  }, {
    "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
    "name" : "sms_task_leddesktop",
    "type" : "MIGRATE_BLOCK",
    "os_type" : "WINDOWS",
    "state" : "MIGRATE_SUCCESS",
    "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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "vm_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
      "name" : "xxx-sms-target",
      "ip" : null,
      "os_type" : "WINDOWS",
      "os_version" : "WINDOWS2008_R2_64BIT"
    },
    "log_collect_status" : "INIT"
  } ]
}

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

    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();
        ListTasksRequest request = new ListTasksRequest();
        try {
            ListTasksResponse response = client.listTasks(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 = ListTasksRequest()
        response = client.list_tasks(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.ListTasksRequest{}
	response, err := client.ListTasks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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