Help Center/ Object Storage Migration Service/ API Reference/ APIs V2/ Migration Task Group Management/ Restarting a Failed Migration Task Group with a Specified ID
Updated on 2026-06-30 GMT+08:00

Restarting a Failed Migration Task Group with a Specified ID

Function

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

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

Maximum: 1024

group_id

Yes

String

The task group ID.

Minimum: 1

Maximum: 1024

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

Minimum: 0

Maximum: 100

src_sk

No

String

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

Minimum: 0

Maximum: 100

src_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

src_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

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

dst_ak

No

String

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

Minimum: 0

Maximum: 100

dst_sk

No

String

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

Minimum: 0

Maximum: 100

dst_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

dst_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

source_cdn_authentication_key

No

String

The CDN authentication key.

Minimum: 0

Maximum: 255

source_cdn_crypto_type

No

String

The encryption/decryption type. The default value is DEFAULT. The options are DEFAULT and KMS.

Default: DEFAULT

Minimum: 1

Maximum: 32

Enumeration values:

  • DEFAULT

  • KMS

source_cdn_kms_key_id

No

String

The KMS key ID, which contains 36 characters.

Minimum: 0

Maximum: 36

migrate_failed_object

No

Boolean

Whether to migrate all objects or only failed objects in the failed tasks again. The default value is false, indicating they are all migrated 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 are skipped.

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.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

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 Responses

None

Status Codes

Status Code

Description

200

Ok

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.