List Migration Tasks

Function

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

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
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: 1 Maximum: 1024

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

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Minimum: 1 Maximum: 16384

Response Parameters

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 - 100
count	Long	The total number of migration tasks that meet the search criteria. Minimum: 0 Maximum: 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 - 5
complete_size	Long	The size (in bytes) of the objects that have been processed in the task. Minimum: 0 Maximum: 9223372036854775807
description	String	The task description. If this parameter is not set, the value is an empty string. Minimum: 0 Maximum: 255
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_metadata_migration	Boolean	Indicates whether metadata migration is enabled. The default value is false. Even if this function is disabled, the Content-Type metadata will still be migrated to ensure a successful migration.
enable_restore	Boolean	Indicates 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 the information about these objects 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 status.
failed_num	Long	The number of objects that failed to be migrated. Minimum: 0 Maximum: 9223372036854775807
failed_object_record	FailedObjectRecordDto object	The record of the objects that fail to be migrated. If the recording succeeds, the path for storing the list of failed objects is displayed. If the 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 ID of the migration task group is included. Minimum: 0 Maximum: 36
id	Long	The task ID. Minimum: 0 Maximum: 999999999999999
is_query_over	Boolean	Indicates whether the statistics of source objects in the migration task have been scanned.
left_time	Long	The remaining time (in milliseconds) of the task. Minimum: 0 Maximum: 9223372036854775807
migrate_since	Long	The specified time point (timestamp, in milliseconds) for filtering source data. Only source objects that are modified after the specified time will be migrated. Default value 0 indicates that no time is specified. Minimum: 0 Maximum: 9223372036854775807
migrate_speed	Long	The migration speed (byte/s). Minimum: 0 Maximum: 9223372036854775807
name	String	Task name. Minimum: 0 Maximum: 10240
progress	Double	The task progress. For example, 0.522 represents the progress is 52.2%, and 1 represents the progress is 100%. Minimum: 0 Maximum: 1
real_size	Long	The total size (in bytes) of the migrated objects. The size of ignored objects is not counted. Minimum: 0 Maximum: 9223372036854775807
skipped_num	Long	The number of objects that are skipped during the migration. The following objects will be skipped: objects whose last modification time is earlier than the specified migration time, and objects that already exist in the destination bucket. Minimum: 0 Maximum: 9223372036854775807
src_node	SrcNodeResp object	The source node information.
start_time	Long	The start time (UNIX timestamp, in milliseconds) of the migration task. Minimum: 0 Maximum: 9223372036854775807
status	Integer	The task status. 1: waiting 2: migrating 3: paused 4: failed 5: succeeded 6: retrying 7: pausing Minimum: 1 Maximum: 7
successful_num	Long	The number of successfully migrated objects. Minimum: 0 Maximum: 9223372036854775807
task_type	String	The task type. If this parameter is left empty, the default value object is used. list: migrates only the objects recorded in a predefined object list. object: migrates only the specified files and folders. prefix: migrates only the objects that match the specified prefixes. url_list: migrates only the objects recorded in a predefined URL list. Default: object Enumeration values: list object prefix url_list
group_type	String	The group type. NORMAL_TASK: Common migration tasks. SYNC_TASK: Migration tasks to which synchronization tasks belongs. GROUP_TASK: Migration tasks in a task group. Default: NORMAL_TASK Enumeration values: NORMAL_TASK SYNC_TASK GROUP_TASK
total_num	Long	The total number of the objects that have been migrated in the task. Minimum: 0 Maximum: 9223372036854775807
total_size	Long	The size (in bytes) of objects to be migrated. Minimum: 0 Maximum: 9223372036854775807
total_time	Long	The total time used (in milliseconds). Minimum: 0 Maximum: 9223372036854775807
smn_info	SmnInfo object	The SMN notification results.
source_cdn	SourceCdnResp object	Indicates 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 field 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 migrated objects in a list. If migrated objects are recorded in a list successfully, this parameter is left blank. Minimum: 0 Maximum: 255
skip_record_error_reason	String	The error code returned for the failure in recording skipped objects in a list. If skipped objects are recorded in a list successfully, this parameter is left blank. Minimum: 0 Maximum: 255
object_overwrite_mode	String	Indicates whether a source object is allowed to overwrite its paired destination object. The default value is SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE.NO_OVERWRITE indicates the system never allows overwriting. The system always skips source objects and keeps their paired destination objects.SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE indicates the system allows overwriting based on the results of size or modification time checks. It is the default setting. 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 differs in size or has a more recent modification date than the paired destination object, the destination will be overwritten.CRC64_COMPARISON_OVERWRITE indicates the system allows overwriting if the source and destination objects have different CRC64 checksums. This option is only available for migration on Huawei Cloud or from Alibaba Cloud or Tencent Cloud. If a source object has a CRC64 checksum different from the paired destination object, the source object will overwrite the destination object. Otherwise, the source object will be skipped. If either of them lacks a CRC64 checksum in the metadata, their sizes and last modification times are checked.FULL_OVERWRITE indicates the system always allows overwriting. The system always allows source objects to overwrite their paired destination objects. Enumeration 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: STANDARD Minimum: 0 Maximum: 128 Enumeration values: STANDARD IA ARCHIVE DEEP_ARCHIVE SRC_STORAGE_MAPPING
obs_system	String	OBS system type. BUCKET: general bucket. PFS: parallel file system. Enumeration values: BUCKET PFS
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: The default value. 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 option is only available for migration on 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 option 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. Enumeration values: size_last_modified crc64 no_check
enable_requester_pays	Boolean	Indicates whether to let the requester make payment. After this function is enabled, the requester pays the request and data transmission fees.
task_priority	String	HIGH: high priority MEDIUM: medium priority LOW: low priority Default: MEDIUM Enumeration 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: 1048576 Maximum: 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: 1024
region	String	The region where the destination bucket is located. The value must be the same as that of the service endpoint. Minimum: 0 Maximum: 100
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: 0 Maximum: 1024

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

**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: 0 Maximum: 1024
error_code	String	The error code returned when the list of failed objects fails to be uploaded. Minimum: 0 Maximum: 10

**Table 10** SrcNodeResp
Parameter	Type	Description
bucket	String	The name of the source bucket. Minimum: 0 Maximum: 1024
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. Enumeration values: AWS Azure Aliyun Tencent HuaweiCloud QingCloud KingsoftCloud Baidu Qiniu URLSource UCloud Google
region	String	The region where the source bucket is located. Minimum: 0 Maximum: 100
app_id	String	Tencent Cloud app ID. This parameter is returned if cloud_type is Tencent. Minimum: 0 Maximum: 255
object_key	Array of strings	The names of the objects to be migrated if task_type is set to object. If task_type is set to prefix, this parameter indicates the name prefixes of the objects to be migrated. Minimum: 0 Maximum: 1024 Array Length: 0 - 500
list_file	ListFile object	The list file configuration. list_file 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 list file or URL list file. Minimum: 1 Maximum: 1024
obs_bucket	String	The name of the OBS bucket for storing the object list files. Ensure that this bucket is in the same region as the destination bucket, or the task creation will fail. Minimum: 0 Maximum: 1024
list_file_num	String	The number of stored object list files. Minimum: 0 Maximum: 65535

**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 code that records why the SMN messages failed to be sent. The value is empty if migration tasks are successful. Minimum: 0 Maximum: 1024
topic_name	String	The SMN topic name. The value is empty if SMN messages are sent successfully. Minimum: 0 Maximum: 5120

**Table 13** SourceCdnResp
Parameter	Type	Description
domain	String	The domain name used to obtain objects to be migrated. Minimum: 0 Maximum: 1024
protocol	String	The protocol type. HTTP and HTTPS are supported. Enumeration values: http https
authentication_type	String	The authentication type. The value can be: 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 Enumeration 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	Error message.
error_code	String	Error code.

Example Requests

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

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

Example Responses

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_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 SDK sample code is as follows.

      
       
         
         
           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)
    }
}

          

        

      
     