Starting a Migration Task

Function

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

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: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 length: 1 character Maximum length: 1,024 characters
task_id	Yes	String	The migration task ID. Minimum length: 1 character Maximum length: 1,024 characters

Request

**Table 2** 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

**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 tasks. Minimum length: 1 character Maximum length: 100 characters
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 tasks. Minimum length: 1 character Maximum length: 100 characters
json_auth_file	No	String	The file used for Google Cloud Storage authentication. Minimum length: 0 characters Maximum length: 65,535 characters
src_security_token	No	String	The temporary token for accessing the source node. Minimum length: 0 characters Maximum length: 16,384 characters
dst_ak	Yes	String	The AK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters
dst_sk	Yes	String	The SK for accessing the destination node. Enter a maximum of 100 characters. Minimum length: 1 character Maximum length: 100 characters
dst_security_token	No	String	The temporary token for accessing the destination node. Minimum length: 0 characters Maximum length: 16,384 characters
source_cdn_authentication_key	No	String	The CDN authentication key. Minimum length: 0 characters Maximum length: 255 characters
migrate_failed_object	No	Boolean	Whether to migrate all objects in the migration task. The default value is false (full migration). If the value is true, only failed objects will be migrated again. If the value is blank or false, all objects in the migration task will be migrated again. Default value: false

Response

Status code: 200

Status code: 400

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

Example Request

This example starts a paused task that does not use the URL list-based migration method, using the AK/SK pairs of both source and destination accounts as input parameters.

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 account as input parameters.
```
POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/start

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

Example Response

None

SDK Sample Code

The following shows the sample SDK code.

This example starts a paused task that does not use the URL list-based migration method, using the AK/SK pairs of both source and destination accounts as input parameters.

        
         
           
           
             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}");
        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 account as input parameters.

        
         
           
           
             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}");
        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 both source and destination accounts as input parameters.

        
         
           
           
             # 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 account as input parameters.

        
         
           
           
             # 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 both source and destination accounts as input parameters.

        
         
           
           
             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 = "{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 account as input parameters.

        
         
           
           
             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 = "{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 code examples in more programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.