Updated on 2024-09-12 GMT+08:00

Restarting a Migration Task Group

Function

This API is used to restart a failed migration task group.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/taskgroups/{group_id}/retry

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum length: 1 character

Maximum length: 1,024 characters

group_id

Yes

String

The task group 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. Enter a maximum of 100 characters.

Minimum length: 0 characters

Maximum length: 100 characters

src_sk

No

String

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

Minimum length: 0 characters

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

dst_ak

No

String

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

Minimum length: 0 characters

Maximum length: 100 characters

dst_sk

No

String

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

Minimum length: 0 characters

Maximum length: 100 characters

source_cdn_authentication_key

No

String

The CDN authentication key.

Minimum length: 0 characters

Maximum length: 255 characters

migrate_failed_object

No

Boolean

The retry mode of failed tasks. It specifies whether to migrate all objects in the failed tasks again. If the value is true, only failed objects will be migrated again. If the value is false or not specified, all objects will be migrated again. By default, the objects that have been migrated to the destination are skipped.

Default value: false

Response

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

This example retries the migration task group whose ID is 2c11d99a-9596-4bc6-a6ad-2336455b149c using the AK/SK pairs of the source and destination accounts.

PUT https://{endpoint}/v2/{project_id}/taskgroups/2c11d99a-9596-4bc6-a6ad-2336455b149c/retry

{
  "src_ak" : "src_AK",
  "src_sk" : "src_SK",
  "dst_ak" : "dst_AK",
  "dst_sk" : "dst_SK",
  "migrate_failed_object" : false
}

Example Response

None

SDK Sample Code

The sample code is as follows:

This example retries the migration task group whose ID is 2c11d99a-9596-4bc6-a6ad-2336455b149c 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
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 RetryTaskGroupSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                .build();
        RetryTaskGroupRequest request = new RetryTaskGroupRequest();
        RetryTaskGroupReq body = new RetryTaskGroupReq();
        body.withMigrateFailedObject(false);
        body.withDstSk("dst_SK");
        body.withDstAk("dst_AK");
        body.withSrcSk("src_SK");
        body.withSrcAk("src_AK");
        request.withBody(body);
        try {
            RetryTaskGroupResponse response = client.retryTaskGroup(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 retries the migration task group whose ID is 2c11d99a-9596-4bc6-a6ad-2336455b149c 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
# 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"]

    credentials = BasicCredentials(ak, sk)

    client = OmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RetryTaskGroupRequest()
        request.body = RetryTaskGroupReq(
            migrate_failed_object=False,
            dst_sk="dst_SK",
            dst_ak="dst_AK",
            src_sk="src_SK",
            src_ak="src_AK"
        )
        response = client.retry_task_group(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 retries the migration task group whose ID is 2c11d99a-9596-4bc6-a6ad-2336455b149c 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
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")

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

    client := oms.NewOmsClient(
        oms.OmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RetryTaskGroupRequest{}
	migrateFailedObjectRetryTaskGroupReq:= false
	dstSkRetryTaskGroupReq:= "dst_SK"
	dstAkRetryTaskGroupReq:= "dst_AK"
	srcSkRetryTaskGroupReq:= "src_SK"
	srcAkRetryTaskGroupReq:= "src_AK"
	request.Body = &model.RetryTaskGroupReq{
		MigrateFailedObject: &migrateFailedObjectRetryTaskGroupReq,
		DstSk: &dstSkRetryTaskGroupReq,
		DstAk: &dstAkRetryTaskGroupReq,
		SrcSk: &srcSkRetryTaskGroupReq,
		SrcAk: &srcAkRetryTaskGroupReq,
	}
	response, err := client.RetryTaskGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

For details, see Error Codes.