Listing Migration Tasks

Function

This API is used to list all migration tasks in an account.

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
oms:task:list	List	task *	-	-	-

URI

GET /v2/{project_id}/tasks

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID. Minimum length: 1 character Maximum length: 1,024 characters

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
group_id	No	String	The migration task group ID. Minimum length: 1 character Maximum length: 100 characters
limit	No	Integer	The maximum number of migration tasks displayed on one page. By default, 10 migration tasks are displayed on one page. A maximum of 100 migration tasks can be returned. Minimum value: 1 Maximum value: 100 Default value: 10
offset	No	Integer	The start serial number of a migration task. The default value is 0. The value must be greater than or equal to 0. If this parameter is set to 0, the query starts from the first record. Minimum value: 0 Maximum value: 2147483647 Default value: 0
status	No	Integer	The migration task status. If this parameter is not specified, migration tasks in all statuses are queried. 1: waiting for scheduling 2: migrating 3: paused 4: failed 5: succeeded 7: pausing Minimum value: 1 Maximum value: 7

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tasks	Array of TaskResp objects	The details of queried migration tasks. Array length: 0 to 100
count	Long	The total number of migration tasks that meet the search criteria. Minimum value: 0 Maximum value: 9223372036854775807

**Table 5** TaskResp
Parameter	Type	Description
bandwidth_policy	Array of BandwidthPolicyDto objects	The traffic limiting rules. A maximum of five traffic limiting rules can be set for a single task. Array length: 0 to 5
complete_size	Long	The size (in bytes) of the objects that have been processed in the task. Minimum value: 0 Maximum value: 9223372036854775807
description	String	The task description. If this parameter is not set, the value is an empty string. Minimum length: 0 characters Maximum length: 255 characters
dst_node	DstNodeResp object	The destination node information.
enable_failed_object_recording	Boolean	Whether the function of recording failed objects is enabled. If this function is enabled, information about objects that fail to be migrated will be stored in the destination bucket.
enable_kms	Boolean	Whether KMS is used to encrypt the data to be stored in the destination OBS bucket.
enable_metadata_migration	Boolean	Whether metadata migration is enabled. This function is disabled by default. Even if this function is disabled, the Content-Type metadata will still be migrated to ensure a successful migration.
enable_restore	Boolean	Whether automatic restoration of archived data is enabled. It takes a long time to restore archived data in the source bucket, which will greatly slow down the migration speed. You are advised to restore the archived data before the migration. If this function is enabled, archived objects will be automatically restored and then migrated. If this function is disabled, archived objects will be ignored during the migration, and their information will be recorded in the list of failed objects.
error_reason	ErrorReasonResp object	The task failure cause. The value is an empty string if the task is not in the Failed state.
failed_num	Long	The number of objects that fail to be migrated. Minimum value: 0 Maximum value: 9223372036854775807
failed_object_record	FailedObjectRecordDto object	The record of objects that failed to be migrated. If recording succeeds, the path for storing the list of failed objects is displayed. If recording fails, the failure cause is displayed.
group_id	String	The ID of the migration task group to which the task belongs. If a task is created by a migration task group, the group ID is included. Minimum length: 0 characters Maximum length: 36 characters
id	Long	The task ID. Minimum value: 0 Maximum value: 999999999999999
is_query_over	Boolean	Whether the statistics of source objects in the migration task have been scanned.
left_time	Long	The remaining time of the task, in milliseconds. Minimum value: 0 Maximum value: 9223372036854775807
migrate_since	Long	A timestamp in milliseconds. Only source objects that are modified after the specified timestamp will be migrated. The default value 0 indicates that no time is specified. Minimum value: 0 Maximum value: 9223372036854775807
migrate_speed	Long	The migration speed (byte/s). Minimum value: 0 Maximum value: 9223372036854775807
name	String	The task name. Minimum length: 0 characters Maximum length: 10,240 characters
progress	Double	The task progress. For example, 0.522 represents the progress is 52.2%, and 1 represents the progress is 100%. Minimum value: 0 Maximum value: 1
real_size	Long	The total size (in bytes) of the migrated objects. The size of ignored objects is not included. Minimum value: 0 Maximum value: 9223372036854775807
skipped_num	Long	The number of objects skipped during migration, including those last modified before the specified migration time and those already present in the destination bucket. Minimum value: 0 Maximum value: 9223372036854775807
src_node	SrcNodeResp object	The source node information.
start_time	Long	The start time (Unix timestamp, in milliseconds) of the migration task. Minimum value: 0 Maximum value: 9223372036854775807
status	Integer	The task status. 1: waiting 2: migrating 3: paused 4: failed 5: succeeded 6: retrying 7: pausing Minimum value: 1 Maximum value: 7
successful_num	Long	The number of successfully migrated objects. Minimum value: 0 Maximum value: 9223372036854775807
task_type	String	The task type. If this parameter is left empty, the default value object is used. list: a list of objects object: files and folders prefix: objects that match the specified prefixes url_list: a list of object URLs Default value: object Enumerated values: list object prefix url_list
group_type	String	The migration group type. NORMAL_TASK: general migration tasks SYNC_TASK: migration tasks generated for a synchronization task GROUP_TASK: migration tasks in a task group Default value: NORMAL_TASK Enumerated values: NORMAL_TASK SYNC_TASK GROUP_TASK
total_num	Long	The total number of objects that need to be migrated in the task. Minimum value: 0 Maximum value: 9223372036854775807
total_size	Long	The size (in bytes) of objects that need to be migrated in the task. Minimum value: 0 Maximum value: 9223372036854775807
total_time	Long	The total time used, in milliseconds. Minimum value: 0 Maximum value: 9223372036854775807
smn_info	SmnInfo object	The SMN notification results.
source_cdn	SourceCdnResp object	Whether migration from CDN is enabled. If it is enabled, the source objects to be migrated are obtained from the specified CDN domain name during migration. If this parameter is included, migration from CDN is supported. Otherwise, it is not supported.
success_record_error_reason	String	The error code returned for the failure in recording the list of objects that are successfully migrated. If the recording is successful, this parameter is left blank. Minimum length: 0 characters Maximum length: 255 characters
skip_record_error_reason	String	The error code returned for the failure in recording the list of objects that are ignored. If the recording is successful, this parameter is left blank. Minimum length: 0 characters Maximum length: 255 characters
object_overwrite_mode	String	How a source object handles its paired destination object, either overwriting the object or skipping the migration. The default value is SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE. NO_OVERWRITE: The system always skips source objects and keeps their paired destination objects. SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE: The system allows overwriting based on the results of size or modification time checks. This is the default value. If a source object has the same name as the paired destination object, the system compares the sizes and last modification time of the source and destination objects to determine whether to overwrite the destination object. The encryption status of the source and destination objects must be the same. If the source object has a different size or was last modified more recently than its paired destination object, the destination object will be overwritten. CRC64_COMPARISON_OVERWRITE: The system allows overwriting if the source and destination objects have different CRC64 checksums. This option is only available for migration within Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object has a CRC64 checksum different from its paired destination object, the destination object will be overwritten. The encryption status of the source and destination objects must be the same. If there are no CRC64 checksums in the metadata, the SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE value is used. FULL_OVERWRITE: The system always allows source objects to overwrite their paired destination objects. Enumerated values: NO_OVERWRITE SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE CRC64_COMPARISON_OVERWRITE FULL_OVERWRITE
dst_storage_policy	String	The destination storage class. This parameter is required only when the destination is Huawei Cloud OBS. The default value is STANDARD. STANDARD: Huawei Cloud OBS Standard storage IA: Huawei Cloud OBS Infrequent Access storage ARCHIVE: Huawei Cloud OBS Archive storage DEEP_ARCHIVE: Huawei Cloud OBS Deep Archive storage SRC_STORAGE_MAPPING: The source storage class is retained and mapped to Huawei Cloud OBS storage class. Default value: STANDARD Minimum length: 0 characters Maximum length: 128 characters Enumerated values: STANDARD IA ARCHIVE DEEP_ARCHIVE SRC_STORAGE_MAPPING
consistency_check	String	The method for checking whether objects are consistent before and after migration. The encryption status of the source and destination objects must be the same. The check method and results will be recorded in the object list. The default value is size_last_modified. size_last_modified (default): The system checks object consistency with object size and last modification time. If the source and destination objects have the same size and the destination's last modification time is not earlier than the source's, the system considers the source object does not need to be migrated or has been already migrated successfully. crc64: This value is only available for migration within Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object and its paired destination object have CRC64 checksums in the metadata, the checksums are checked. Otherwise, their sizes and last modification times are checked. no_check: This value is only available for migration of HTTP/HTTPS data. This option takes effect for source objects whose sizes cannot be obtained from the Content-Length field in the standard HTTP protocol. In this case, the migration is considered successful once the data is downloaded successfully, without requiring additional data check. These source objects will overwrite their paired destination objects directly. If the size of a source object can be obtained from the Content-Length field in the standard HTTP protocol, its size and last modification time will be checked. Enumerated values: size_last_modified crc64 no_check
enable_requester_pays	Boolean	Whether Requester Pays is enabled. If this function is enabled, the requester pays for the request and data transmission.
task_priority	String	HIGH: high priority MEDIUM: medium priority LOW: low priority Default value: MEDIUM Enumerated values: HIGH MEDIUM LOW

**Table 6** BandwidthPolicyDto
Parameter	Type	Description
end	String	The time when traffic limiting is ended. The format is hh:mm, for example, 12:03.
max_bandwidth	Long	The maximum traffic bandwidth allowed in the specified period. The unit is byte/s. The value ranges from 1,048,576 bytes/s (equivalent to 1 MB/s) to 209,715,200 bytes/s (equivalent to 200 MB/s). Minimum value: 1048576 Maximum value: 209715200
start	String	The time when traffic limiting is started. The format is hh:mm, for example, 12:03.

**Table 7** DstNodeResp
Parameter	Type	Description
bucket	String	The name of the destination bucket. Maximum length: 1,024 characters
region	String	The region where the destination bucket is located. The value must be the same as that of the service endpoint. Minimum length: 0 characters Maximum length: 100 characters
save_prefix	String	The path prefix used to organize object locations in the destination bucket. The prefix is added before an object key to form a new key. The length of the new key cannot exceed 1,024 characters. Minimum length: 0 characters Maximum length: 1,024 characters

**Table 8** ErrorReasonResp
Parameter	Type	Description
error_code	String	The error code returned when a migration fails. Minimum length: 0 characters Maximum length: 10 characters
error_msg	String	The migration failure cause. Minimum length: 0 characters Maximum length: 1,024 characters

**Table 9** FailedObjectRecordDto
Parameter	Type	Description
result	Boolean	Whether retransmission of failed objects is supported.
list_file_key	String	The path for storing the list of failed objects. Minimum length: 0 characters Maximum length: 1,024 characters
error_code	String	The error code returned when the list of failed objects fails to be uploaded. Minimum length: 0 characters Maximum length: 10 characters

**Table 10** SrcNodeResp
Parameter	Type	Description
bucket	String	The name of the source bucket. Minimum length: 0 characters Maximum length: 1,024 characters
cloud_type	String	The source cloud service provider. The value can be AWS, Azure, Aliyun, Tencent, HuaweiCloud, QingCloud, KingsoftCloud, Baidu, Google, Qiniu, URLSource, or UCloud. The default value is Aliyun. Enumerated values: AWS Azure Aliyun Tencent HuaweiCloud QingCloud KingsoftCloud Baidu Qiniu URLSource UCloud Google
region	String	The region where the source bucket is located. Minimum length: 0 characters Maximum length: 100 characters
app_id	String	This parameter is returned when cloud_type is Tencent. Minimum length: 0 characters Maximum length: 255 characters
object_key	Array of strings	If task_type is set to object, this parameter indicates the names of objects to be migrated. If task_type is set to prefix, this parameter indicates the name prefixes of objects to be migrated. Minimum length: 0 characters Maximum length: 1,024 characters Array length: 0 to 500
list_file	ListFile object	The configurations of the list file. This parameter is mandatory when task_type is set to list or url_list.

**Table 11** ListFile
Parameter	Type	Description
list_file_key	String	The object names in the object or URL list file. Minimum length: 1 character Maximum length: 1,024 characters
obs_bucket	String	The name of the OBS bucket for storing object list files. Ensure that this bucket is in the same region as the destination bucket, or the task creation will fail. Minimum length: 0 characters Maximum length: 1,024 characters
list_file_num	String	The number of stored object list files. Minimum length: 0 characters Maximum length: 65,535 characters

**Table 12** SmnInfo
Parameter	Type	Description
notify_result	Boolean	Whether SMN messages are sent successfully after a migration task is complete.
notify_error_message	String	The error codes presenting why SMN messages failed to be sent. The value is empty if the migration task is successful. Minimum length: 0 characters Maximum length: 1,024 characters
topic_name	String	The SMN topic name. The value is empty if SMN messages are sent successfully. Minimum length: 0 characters Maximum length: 5,120 characters

**Table 13** SourceCdnResp
Parameter	Type	Description
domain	String	The domain name used to obtain objects to be migrated. Minimum length: 0 characters Maximum length: 1,024 characters
protocol	String	The protocol type. HTTP and HTTPS are supported. Enumerated values: http https
authentication_type	String	The authentication type. NONE: public access without authentication type QINIU_PRIVATE_AUTHENTICATION: Qiniu private URL signature ALIYUN_OSS_A: Alibaba Cloud URL signature, simple and universal ALIYUN_OSS_B: Alibaba Cloud header signature, used for API calling ALIYUN_OSS_C: Alibaba Cloud STS temporary security token, the most secure KSYUN_PRIVATE_AUTHENTICATION: Kingsoft Cloud private URL signature AZURE_SAS_TOKEN: Microsoft Azure shared access signature, flexible and secure TENCENT_COS_A: Tencent Cloud multi-signature scenarios (not recommended) TENCENT_COS_B: Tencent Cloud single-signature scenarios, the most secure TENCENT_COS_C: Tencent Cloud header signature, used for API calling TENCENT_COS_D: Tencent Cloud header signature, used for API calling Enumerated values: NONE QINIU_PRIVATE_AUTHENTICATION ALIYUN_OSS_A ALIYUN_OSS_B ALIYUN_OSS_C KSYUN_PRIVATE_AUTHENTICATION AZURE_SAS_TOKEN TENCENT_COS_A TENCENT_COS_B TENCENT_COS_C TENCENT_COS_D

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_msg	String	The error message.
error_code	String	The error code.

Example Request

This example queries 10 failed tasks in the project 2c0689c860ad4728a497c91ec0844383.

GET https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/tasks?offset=0&limit=10&status=4

Example Response

Status code: 200

{
  "tasks" : [ {
    "bandwidth_policy" : [ {
      "end" : "23:59",
      "max_bandwidth" : 0,
      "start" : "00:00"
    } ],
    "complete_size" : 0,
    "description" : "test log",
    "dst_node" : {
      "bucket" : "dst_bucket",
      "region" : "cn-north-1"
    },
    "enable_failed_object_recording" : true,
    "enable_kms" : true,
    "enable_restore" : false,
    "error_reason" : {
      "error_code" : "string",
      "error_msg" : "string"
    },
    "failed_num" : 0,
    "failed_object_record" : {
      "result" : true,
      "list_file_key" : "string",
      "error_code" : "string"
    },
    "group_id" : "string",
    "id" : 0,
    "is_query_over" : true,
    "left_time" : 0,
    "migrate_since" : 0,
    "migrate_speed" : 0,
    "name" : "string",
    "progress" : 0,
    "real_size" : 0,
    "skipped_num" : 0,
    "src_node" : {
      "bucket" : "src_bucket",
      "cloud_type" : "AWS",
      "region" : "cn-north-1",
      "app_id" : "string",
      "object_key" : [ "string", "string" ],
      "list_file" : {
        "list_file_key" : "object_list_file.txt",
        "obs_bucket" : "obs_bucket"
      }
    },
    "start_time" : 0,
    "status" : 0,
    "successful_num" : 0,
    "task_type" : "list",
    "total_num" : 0,
    "total_size" : 0,
    "total_time" : 0,
    "smn_info" : {
      "notify_result" : true,
      "notify_error_message" : "string",
      "topic_name" : "string"
    },
    "source_cdn" : {
      "domain" : "xxx.xxx.xxx",
      "protocol" : "http",
      "authentication_type" : "string"
    }
  } ],
  "count" : 1
}

SDK Sample Code

The following shows the sample SDK code.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.oms.v2.region.OmsRegion;
import com.huaweicloud.sdk.oms.v2.*;
import com.huaweicloud.sdk.oms.v2.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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.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 BasicCredentials
from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkoms.v2 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = OmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OmsRegion.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/basic"
    oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := oms.NewOmsClient(
        oms.OmsClientBuilder().
            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.