Help Center/ Object Storage Migration Service/ API Reference/ APIs V2 (Recommended)/ Migration Task Management/ Start a Migration Task
Updated on 2026-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Start a Migration Task

Function

This API is used to start a migration task when the migration task is paused or failed.

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:update

    Write

    task *

    -

    -

    -

URI

POST /v2/{project_id}/tasks/{task_id}/start

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum: 1

Maximum: 1024

task_id

Yes

Long

The migration task ID.

Minimum: 0

Maximum: 999999999999999

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The token used for IAM authentication.

Minimum: 1

Maximum: 16384
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

src_ak

No

String

The AK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list–based migration task groups.

Minimum: 1

Maximum: 100

src_sk

No

String

The SK for accessing the source node. Enter a maximum of 100 characters. This parameter is not required for URL list–based migration task groups.

Minimum: 1

Maximum: 100

connection_string

No

String

The connection string, which is used for Microsoft Azure Blob authentication.

Minimum: 0

Maximum: 2048

json_auth_file

No

String

The file used for Google Cloud Storage authentication.

Minimum: 0

Maximum: 65535

src_security_token

No

String

The temporary token for accessing the source node.

Minimum: 0

Maximum: 16384

dst_ak

Yes

String

The AK for accessing the destination node. Enter a maximum of 100 characters.

Minimum: 1

Maximum: 100

dst_sk

Yes

String

The SK for accessing the destination node. Enter a maximum of 100 characters.

Minimum: 1

Maximum: 100

dst_security_token

No

String

The temporary token for accessing the destination node.

Minimum: 0

Maximum: 16384

source_cdn_authentication_key

No

String

The CDN authentication key.

Minimum: 0

Maximum: 255

migrate_failed_object

No

Boolean

Indicates whether to migrate all objects in the migration task. The default value is false, which indicates a full migration.

If the value is true, only failed objects will be migrated again.

If the value is false or not specified, all objects in the migration task will be migrated again.

Default: false

Response Parameters

Status code: 200

OK

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

  • This example starts a paused task that does not use the URL list–based migration method using the AK/SK pairs of the source and destination accounts.

    POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/start

{
  "src_ak" : "src_ak",
  "src_sk" : "src_sk",
  "dst_ak" : "dst_ak",
  "dst_sk" : "dst_sk",
  "migrate_failed_object" : false
}

  • This example starts a paused task that uses the URL list–based migration method using the AK/SK pair of the destination bucket.

    POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/start

{
  "dst_ak" : "dst_ak",
  "dst_sk" : "dst_sk",
  "migrate_failed_object" : false
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

  • This example starts a paused task that does not use the URL list–based migration method using the AK/SK pairs of the source and destination accounts.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    		 
    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 StartTaskSolution {

    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();
        StartTaskRequest request = new StartTaskRequest();
        request.withTaskId({task_id}L);
        StartTaskReq body = new StartTaskReq();
        body.withMigrateFailedObject(false);
        body.withDstSk("dst_sk");
        body.withDstAk("dst_ak");
        body.withSrcSk("src_sk");
        body.withSrcAk("src_ak");
        request.withBody(body);
        try {
            StartTaskResponse response = client.startTask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • This example starts a paused task that uses the URL list–based migration method using the AK/SK pair of the destination bucket.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    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 StartTaskSolution {

    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();
        StartTaskRequest request = new StartTaskRequest();
        request.withTaskId({task_id}L);
        StartTaskReq body = new StartTaskReq();
        body.withMigrateFailedObject(false);
        body.withDstSk("dst_sk");
        body.withDstAk("dst_ak");
        request.withBody(body);
        try {
            StartTaskResponse response = client.startTask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • This example starts a paused task that does not use the URL list–based migration method using the AK/SK pairs of the source and destination accounts.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
    		 
    # 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 = StartTaskRequest()
        request.task_id = {task_id}
        request.body = StartTaskReq(
            migrate_failed_object=False,
            dst_sk="dst_sk",
            dst_ak="dst_ak",
            src_sk="src_sk",
            src_ak="src_ak"
        )
        response = client.start_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)

  • This example starts a paused task that uses the URL list–based migration method using the AK/SK pair of the destination bucket.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import 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 = StartTaskRequest()
        request.task_id = {task_id}
        request.body = StartTaskReq(
            migrate_failed_object=False,
            dst_sk="dst_sk",
            dst_ak="dst_ak"
        )
        response = client.start_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)

  • This example starts a paused task that does not use the URL list–based migration method using the AK/SK pairs of the source and destination accounts.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    		 
    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.StartTaskRequest{}
	request.TaskId = int64({task_id})
	migrateFailedObjectStartTaskReq:= false
	srcSkStartTaskReq:= "src_sk"
	srcAkStartTaskReq:= "src_ak"
	request.Body = &model.StartTaskReq{
		MigrateFailedObject: &migrateFailedObjectStartTaskReq,
		DstSk: "dst_sk",
		DstAk: "dst_ak",
		SrcSk: &srcSkStartTaskReq,
		SrcAk: &srcAkStartTaskReq,
	}
	response, err := client.StartTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • This example starts a paused task that uses the URL list–based migration method using the AK/SK pair of the destination bucket.

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    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.StartTaskRequest{}
	request.TaskId = int64({task_id})
	migrateFailedObjectStartTaskReq:= false
	request.Body = &model.StartTaskReq{
		MigrateFailedObject: &migrateFailedObjectStartTaskReq,
		DstSk: "dst_sk",
		DstAk: "dst_ak",
	}
	response, err := client.StartTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Migration Task Management